Interface IEntity

The Interface for an Entity.

interface IEntity {
    _isAlive: boolean;
    _myLatestCopyEntityUID: number;
    entityUID: number;
    objectUID: number;
    uniqueName: string;
    _copyFrom(rnObject: RnObject): void;
    _destroy(): void;
    _removeComponent(componentTID: number): void;
    _setComponent(componentType: typeof Component, com: Component): void;
    getComponent(componentType: typeof Component): undefined | Component;
    getComponentByComponentTID(componentTID: number): undefined | Component;
    getTagValue(tagName: string): any;
    hasComponent(componentType: typeof Component): boolean;
    matchTag(tagName: string, tagValue: string): boolean;
    matchTags(tags: RnTags): boolean;
    matchTagsAsFreeStrings(stringArray: string[]): boolean;
    tryToGetAnimation(): undefined | AnimationComponent;
    tryToGetAnimationState(): undefined | AnimationStateComponent;
    tryToGetBlendShape(): undefined | BlendShapeComponent;
    tryToGetCamera(): undefined | CameraComponent;
    tryToGetCameraController(): undefined | CameraControllerComponent;
    tryToGetConstraint(): undefined | ConstraintComponent;
    tryToGetEffekseer(): undefined | EffekseerComponent;
    tryToGetLight(): undefined | LightComponent;
    tryToGetMesh(): undefined | MeshComponent;
    tryToGetMeshRenderer(): undefined | MeshRendererComponent;
    tryToGetPhysics(): undefined | PhysicsComponent;
    tryToGetSceneGraph(): undefined | SceneGraphComponent;
    tryToGetSkeletal(): undefined | SkeletalComponent;
    tryToGetTransform(): undefined | TransformComponent;
    tryToGetVrm(): undefined | VrmComponent;
    tryToSetTag(tag: Tag): boolean;
    tryToSetUniqueName(name: string, toAddNameIfConflict: boolean): boolean;
    validateTagString(val: string): boolean;
}

Hierarchy (view full)

IRnObject
- IEntity

Implemented by

Entity

Properties

_isAlive

_isAlive: boolean

_myLatestCopyEntityUID

_myLatestCopyEntityUID: number

entityUID

entityUID: number

objectUID

objectUID: number

Unique identifier for the object

uniqueName

uniqueName: string

Unique name string for the object

Methods

_copyFrom

_copyFrom(rnObject): void
Internal
Copies properties from another RnObject instance
Parameters
- rnObject: RnObject
  The source object to copy from
Returns void
Inherited from IRnObject._copyFrom
- Defined in foundation/core/RnObject.ts:80

_destroy

_destroy(): void
Internal
Destroys this entity and releases all associated resources.

Returns void
- Defined in foundation/core/Entity.ts:160

_removeComponent

_removeComponent(componentTID): void
Internal
Removes a component from this entity.
Parameters
- componentTID: number
  The component type identifier to remove
Returns void
- Defined in foundation/core/Entity.ts:64

_setComponent

_setComponent(componentType, com): void
Internal
Sets a component on this entity.
Parameters
- componentType: typeof Component
  The constructor/class of the component
- com: Component
  The component instance to set
Returns void
- Defined in foundation/core/Entity.ts:50

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 otherwise
- Defined in foundation/core/Entity.ts:35

getComponentByComponentTID

getComponentByComponentTID(componentTID): undefined | Component
Retrieves a component by its unique component type identifier.
Parameters
- componentTID: number
  The component type identifier
Returns undefined | Component
The component instance if found, undefined otherwise
- Defined in foundation/core/Entity.ts:42

getTagValue

getTagValue(tagName): any
Retrieves the value of a specific tag
Parameters
- tagName: string
  The name of the tag to retrieve
Returns any
The tag value or undefined if not found
Inherited from IRnObject.getTagValue
- Defined in foundation/core/RnObject.ts:51

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
Returns boolean
True if the entity has the component, false otherwise
- Defined in foundation/core/Entity.ts:57

matchTag

matchTag(tagName, tagValue): boolean
Checks if an object matches a specific tag name and value
Parameters
- tagName: string
  The tag name to match
- tagValue: string
  The tag value to match
Returns boolean
True if the tag matches, false otherwise
Inherited from IRnObject.matchTag
- Defined in foundation/core/RnObject.ts:59

matchTags

matchTags(tags): boolean
Checks if the object has all the specified tags with matching values
Parameters
- tags: RnTags
  The tags object to match against
Returns boolean
True if all tags match, false otherwise
Inherited from IRnObject.matchTags
- Defined in foundation/core/RnObject.ts:73

matchTagsAsFreeStrings

matchTagsAsFreeStrings(stringArray): boolean
Checks if the object's combined tag string contains all provided strings
Parameters
- stringArray: string[]
  Array of strings to search for in tags
Returns boolean
True if all strings are found, false otherwise
Inherited from IRnObject.matchTagsAsFreeStrings
- Defined in foundation/core/RnObject.ts:66

tryToGetAnimation

tryToGetAnimation(): undefined | AnimationComponent
Attempts to retrieve the AnimationComponent from this entity.

Returns undefined | AnimationComponent
The AnimationComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:130

tryToGetAnimationState

tryToGetAnimationState(): undefined | AnimationStateComponent
Attempts to retrieve the AnimationStateComponent from this entity.

Returns undefined | AnimationStateComponent
The AnimationStateComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:136

tryToGetBlendShape

tryToGetBlendShape(): undefined | BlendShapeComponent
Attempts to retrieve the BlendShapeComponent from this entity.

Returns undefined | BlendShapeComponent
The BlendShapeComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:70

tryToGetCamera

tryToGetCamera(): undefined | CameraComponent
Attempts to retrieve the CameraComponent from this entity.

Returns undefined | CameraComponent
The CameraComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:76

tryToGetCameraController

tryToGetCameraController(): undefined | CameraControllerComponent
Attempts to retrieve the CameraControllerComponent from this entity.

Returns undefined | CameraControllerComponent
The CameraControllerComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:82

tryToGetConstraint

tryToGetConstraint(): undefined | ConstraintComponent
Attempts to retrieve the ConstraintComponent from this entity.

Returns undefined | ConstraintComponent
The ConstraintComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:148

tryToGetEffekseer

tryToGetEffekseer(): undefined | EffekseerComponent
Attempts to retrieve the EffekseerComponent from this entity.

Returns undefined | EffekseerComponent
The EffekseerComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:154

tryToGetLight

tryToGetLight(): undefined | LightComponent
Attempts to retrieve the LightComponent from this entity.

Returns undefined | LightComponent
The LightComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:88

tryToGetMesh

tryToGetMesh(): undefined | MeshComponent
Attempts to retrieve the MeshComponent from this entity.

Returns undefined | MeshComponent
The MeshComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:94

tryToGetMeshRenderer

tryToGetMeshRenderer(): undefined | MeshRendererComponent
Attempts to retrieve the MeshRendererComponent from this entity.

Returns undefined | MeshRendererComponent
The MeshRendererComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:100

tryToGetPhysics

tryToGetPhysics(): undefined | PhysicsComponent
Attempts to retrieve the PhysicsComponent from this entity.

Returns undefined | PhysicsComponent
The PhysicsComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:106

tryToGetSceneGraph

tryToGetSceneGraph(): undefined | SceneGraphComponent
Attempts to retrieve the SceneGraphComponent from this entity.

Returns undefined | SceneGraphComponent
The SceneGraphComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:112

tryToGetSkeletal

tryToGetSkeletal(): undefined | SkeletalComponent
Attempts to retrieve the SkeletalComponent from this entity.

Returns undefined | SkeletalComponent
The SkeletalComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:118

tryToGetTransform

tryToGetTransform(): undefined | TransformComponent
Attempts to retrieve the TransformComponent from this entity.

Returns undefined | TransformComponent
The TransformComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:124

tryToGetVrm

tryToGetVrm(): undefined | VrmComponent
Attempts to retrieve the VrmComponent from this entity.

Returns undefined | VrmComponent
The VrmComponent if present, undefined otherwise
- Defined in foundation/core/Entity.ts:142

tryToSetTag

tryToSetTag(tag): boolean
Attempts to set a tag on the object
Parameters
- tag: Tag
  The tag object containing name and value
Returns boolean
True if the tag was successfully set, false otherwise
Inherited from IRnObject.tryToSetTag
- Defined in foundation/core/RnObject.ts:44

tryToSetUniqueName

tryToSetUniqueName(name, toAddNameIfConflict): boolean
Attempts to set a unique name for the object
Parameters
- name: string
  The desired unique name
- toAddNameIfConflict: boolean
  Whether to modify the name if it conflicts with existing names
Returns boolean
True if the name was successfully set, false otherwise
Inherited from IRnObject.tryToSetUniqueName
- Defined in foundation/core/RnObject.ts:30

validateTagString

validateTagString(val): boolean
Validates a tag string to ensure it contains only allowed characters
Parameters
- val: string
  The string to validate
Returns boolean
True if the string is valid, false otherwise
Inherited from IRnObject.validateTagString
- Defined in foundation/core/RnObject.ts:37

Interface IEntity

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

_isAlive

_myLatestCopyEntityUID

entityUID

objectUID

uniqueName

Methods

_copyFrom

Parameters

Returns void

_destroy

Returns void

_removeComponent

Parameters

Returns void

_setComponent

Parameters

Returns void

getComponent

Parameters

Returns undefined | Component

getComponentByComponentTID

Parameters

Returns undefined | Component

getTagValue

Parameters

Returns any

hasComponent

Parameters

Returns boolean

matchTag

Parameters

Returns boolean

matchTags

Parameters

Returns boolean

matchTagsAsFreeStrings

Parameters

Returns boolean

tryToGetAnimation

Returns undefined | AnimationComponent

tryToGetAnimationState

Returns undefined | AnimationStateComponent

tryToGetBlendShape

Returns undefined | BlendShapeComponent

tryToGetCamera

Returns undefined | CameraComponent

tryToGetCameraController

Returns undefined | CameraControllerComponent

tryToGetConstraint

Returns undefined | ConstraintComponent

tryToGetEffekseer

Returns undefined | EffekseerComponent

tryToGetLight

Returns undefined | LightComponent

tryToGetMesh

Returns undefined | MeshComponent

tryToGetMeshRenderer

Returns undefined | MeshRendererComponent

tryToGetPhysics

Returns undefined | PhysicsComponent

tryToGetSceneGraph

Returns undefined | SceneGraphComponent

tryToGetSkeletal

Returns undefined | SkeletalComponent

tryToGetTransform

Returns undefined | TransformComponent

tryToGetVrm

Returns undefined | VrmComponent

tryToSetTag

Parameters

Returns boolean

tryToSetUniqueName

Parameters