Class Entity

The class that represents an entity.

Remarks

The Rhodonite Entity Class which are an entities that exists in space. Entities can acquire various functions by having components on themselves.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

__components _isAlive _myLatestCopyEntityUID _tags InvalidObjectUID currentMaxObjectCount invalidEntityUID

Accessors

entityUID objectUID uniqueName

Methods

_copyFrom _destroy _removeComponent _setComponent getComponent getComponentByComponentTID getTag getTagValue hasComponent hasTag matchTag matchTags matchTagsAsFreeStrings removeTag tryToGetAnimation tryToGetAnimationState tryToGetBlendShape tryToGetCamera tryToGetCameraController tryToGetConstraint tryToGetEffekseer tryToGetLight tryToGetMesh tryToGetMeshRenderer tryToGetPhysics tryToGetSceneGraph tryToGetSkeletal tryToGetTransform tryToGetVrm tryToSetTag tryToSetUniqueName unregister validateTagString _reset getRnObject getRnObjectByName searchByTag

Constructors

constructor

  • new Entity(entityUID, isAlive, components?): Entity

  • Creates a new Entity instance.

    Parameters

    • entityUID: number

      The unique identifier for this entity

    • isAlive: boolean

      Whether this entity is alive or not

    • Optionalcomponents: Map<number, Component>

      Optional map of existing components to initialize with

    Returns Entity

    Remarks

    When creating an Entity, use the createEntity method of the EntityRepository class instead of directly calling this constructor.

Properties

Protected__components

__components: Map<number, Component>

The Map of components. All components must be managed in this map

_isAlive

_isAlive: boolean

No use yet

_myLatestCopyEntityUID

_myLatestCopyEntityUID: number = Entity.invalidEntityUID

_tags

_tags: RnTags = {}

Collection of tags associated with this object

Static ReadonlyInvalidObjectUID

InvalidObjectUID: -1 = -1

Invalid object UID constant

StaticcurrentMaxObjectCount

currentMaxObjectCount: number = 0

Current maximum object count for UID generation

Static ReadonlyinvalidEntityUID

invalidEntityUID: -1 = -1

Invalid Entity UID constant value

Accessors

entityUID

objectUID

uniqueName

Methods

_copyFrom

_destroy

  • _destroy(): void

  • Destroys this entity and releases all associated resources.

    Returns void

    Remarks

    This method calls the destroy method on all components attached to this entity and marks the entity as no longer alive. After calling this method, the entity should not be used.

_removeComponent

  • _removeComponent(componentTID): void
  • Internal

    Removes a component from this entity by its component type identifier.

    Parameters

    • componentTID: number

      The component type identifier of the component to remove

    Returns void

_setComponent

  • _setComponent(componentType, component): void
  • Internal

    Sets a component on this entity.

    Parameters

    • componentType: typeof Component

      The constructor/class of the component to set

    • component: Component

      The component instance to attach to this entity

    Returns void

    Remarks

    This method associates a component instance with this entity using the component's type ID. If a component of the same type already exists, it will be replaced.

getComponent

  • getComponent(componentType): undefined | Component

  • Retrieves a component of the specified type from this entity.

    Parameters

    • componentType: typeof Component

      The constructor/class of the component to retrieve

    Returns undefined | Component

    The component instance if found, undefined if the entity doesn't have this component type

getComponentByComponentTID

getTag

  • getTag(tagName): Tag

  • Retrieves a complete tag object (name and value) for the specified tag name

    Parameters

    • tagName: string

      The name of the tag to retrieve

    Returns Tag

    A Tag object containing the name and value

getTagValue

hasComponent

  • hasComponent(componentType): boolean

  • Checks whether this entity has a component of the specified type.

    Parameters

    • componentType: typeof Component

      The constructor/class of the component to check for

    Returns boolean

    True if the entity has a component of the specified type, false otherwise

hasTag

  • hasTag(tagName): boolean

  • Checks whether this object has a tag with the specified name

    Parameters

    • tagName: string

      The name of the tag to check for

    Returns boolean

    True if the tag exists (value is not null/undefined), false otherwise

matchTag

  • matchTag(tagName, tagValue): boolean

  • Checks if this object has a tag with the specified name and value

    Parameters

    • tagName: string

      The tag name to match

    • tagValue: string

      The tag value to match

    Returns boolean

    True if the object has a matching tag, false otherwise

matchTags

  • matchTags(tags): boolean

  • Checks if this object has all the specified tags with exactly matching values

    Parameters

    • tags: RnTags

      Object containing tag names as keys and expected values

    Returns boolean

    True if all specified tags exist with matching values, false otherwise

matchTagsAsFreeStrings

  • matchTagsAsFreeStrings(stringArray): boolean

  • Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.

    Parameters

    • stringArray: string[]

      Array of strings that must all be present in the combined tag string

    Returns boolean

    True if all strings are found in the combined tag string, false otherwise

removeTag

tryToGetAnimation

tryToGetAnimationState

  • tryToGetAnimationState(): undefined | AnimationStateComponent

  • Attempts to retrieve the AnimationStateComponent from this entity.

    Returns undefined | AnimationStateComponent

    The AnimationStateComponent if this entity has one, undefined otherwise

    Remarks

    This is a convenience method that provides type-safe access to the AnimationStateComponent without requiring explicit type casting.

tryToGetBlendShape

tryToGetCamera

  • tryToGetCamera(): undefined | CameraComponent

  • Attempts to retrieve the CameraComponent from this entity.

    Returns undefined | CameraComponent

    The CameraComponent if this entity has one, undefined otherwise

    Remarks

    This is a convenience method that provides type-safe access to the CameraComponent without requiring explicit type casting.

tryToGetCameraController

tryToGetConstraint

  • tryToGetConstraint(): undefined | ConstraintComponent

  • Attempts to retrieve the ConstraintComponent from this entity.

    Returns undefined | ConstraintComponent

    The ConstraintComponent if this entity has one, undefined otherwise

    Remarks

    This is a convenience method that provides type-safe access to the ConstraintComponent without requiring explicit type casting.

tryToGetEffekseer

tryToGetLight

  • tryToGetLight(): undefined | LightComponent

  • Attempts to retrieve the LightComponent from this entity.

    Returns undefined | LightComponent

    The LightComponent if this entity has one, undefined otherwise

    Remarks

    This is a convenience method that provides type-safe access to the LightComponent without requiring explicit type casting.

tryToGetMesh

  • tryToGetMesh(): undefined | MeshComponent

  • Attempts to retrieve the MeshComponent from this entity.

    Returns undefined | MeshComponent

    The MeshComponent if this entity has one, undefined otherwise

    Remarks

    This is a convenience method that provides type-safe access to the MeshComponent without requiring explicit type casting.

tryToGetMeshRenderer

tryToGetPhysics

  • tryToGetPhysics(): undefined | PhysicsComponent

  • Attempts to retrieve the PhysicsComponent from this entity.

    Returns undefined | PhysicsComponent

    The PhysicsComponent if this entity has one, undefined otherwise

    Remarks

    This is a convenience method that provides type-safe access to the PhysicsComponent without requiring explicit type casting.

tryToGetSceneGraph

tryToGetSkeletal

tryToGetTransform

tryToGetVrm

  • tryToGetVrm(): undefined | VrmComponent

  • Attempts to retrieve the VrmComponent from this entity.

    Returns undefined | VrmComponent

    The VrmComponent if this entity has one, undefined otherwise

    Remarks

    This is a convenience method that provides type-safe access to the VrmComponent without requiring explicit type casting.

tryToSetTag

  • tryToSetTag(tag): boolean

  • Attempts to set a tag on this object. If the tag already exists, it will be replaced.

    Parameters

    • tag: Tag

      The tag object containing the name and value to set

    Returns boolean

    True if the tag was successfully set, false if the tag name contains invalid characters

tryToSetUniqueName

  • tryToSetUniqueName(name, toAddNameIfConflict): boolean

  • Attempts to set a unique name for this object

    Parameters

    • name: string

      The desired unique name

    • toAddNameIfConflict: boolean

      If true, appends UID to make name unique when conflicts occur; if false, fails on conflict

    Returns boolean

    True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false

unregister

validateTagString

Static_reset

StaticgetRnObject

  • getRnObject(objectUid): undefined | RnObject

  • Retrieves an RnObject instance by its unique identifier

    Parameters

    • objectUid: number

      The unique identifier of the object to retrieve

    Returns undefined | RnObject

    The RnObject instance or undefined if not found or garbage collected

StaticgetRnObjectByName

StaticsearchByTag

  • searchByTag(tag, value): undefined | WeakRef<RnObject>

  • Searches for the first object that has a specific tag with the given value

    Parameters

    • tag: string

      The tag name to search for

    • value: string

      The tag value to match

    Returns undefined | WeakRef<RnObject>

    WeakRef to the first matching object, or undefined if not found

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods