Protected__The Map of components. All components must be managed in this map
No use yet
Collection of tags associated with this object
StaticcurrentCurrent maximum object count for UID generation
Static ReadonlyinvalidInvalid Entity UID constant value
Static ReadonlyInvalidInvalid object UID constant
Gets the unique identifier of this entity.
The entity's unique ID
Gets the unique object identifier
The object's UID
Gets the unique name of this object
The unique name string
InternalCopies tag data from another RnObject instance to this object
The source RnObject to copy tags from
Destroys this entity and releases all associated resources.
InternalRemoves a component from this entity by its component type identifier.
The component type identifier of the component to remove
Retrieves a component by its unique component type identifier.
The component type identifier to look up
The component instance if found, undefined otherwise
Retrieves a complete tag object (name and value) for the specified tag name
The name of the tag to retrieve
A Tag object containing the name and value
Retrieves the value associated with a specific tag name
The name of the tag whose value to retrieve
The tag value, or undefined if the tag doesn't exist
Checks whether this entity has a component of the specified type.
The constructor/class of the component to check for
True if the entity has a component of the specified type, false otherwise
Checks whether this object has a tag with the specified name
The name of the tag to check for
True if the tag exists (value is not null/undefined), false otherwise
Checks if this object has a tag with the specified name and value
The tag name to match
The tag value to match
True if the object has a matching tag, false otherwise
Checks if this object has all the specified tags with exactly matching values
Object containing tag names as keys and expected values
True if all specified tags exist with matching values, false otherwise
Checks if the object's combined tag string contains all the provided search strings. This allows for flexible searching within tag names and values.
Array of strings that must all be present in the combined tag string
True if all strings are found in the combined tag string, false otherwise
Removes a tag from this object
The name of the tag to remove
Attempts to retrieve the AnimationComponent from this entity.
The AnimationComponent if this entity has one, undefined otherwise
Attempts to retrieve the AnimationStateComponent from this entity.
The AnimationStateComponent if this entity has one, undefined otherwise
Attempts to retrieve the BlendShapeComponent from this entity.
The BlendShapeComponent if this entity has one, undefined otherwise
Attempts to retrieve the CameraComponent from this entity.
The CameraComponent if this entity has one, undefined otherwise
Attempts to retrieve the CameraControllerComponent from this entity.
The CameraControllerComponent if this entity has one, undefined otherwise
Attempts to retrieve the ConstraintComponent from this entity.
The ConstraintComponent if this entity has one, undefined otherwise
Attempts to retrieve the EffekseerComponent from this entity.
The EffekseerComponent if this entity has one, undefined otherwise
Attempts to retrieve the LightComponent from this entity.
The LightComponent if this entity has one, undefined otherwise
Attempts to retrieve the MeshComponent from this entity.
The MeshComponent if this entity has one, undefined otherwise
Attempts to retrieve the MeshRendererComponent from this entity.
The MeshRendererComponent if this entity has one, undefined otherwise
Attempts to retrieve the PhysicsComponent from this entity.
The PhysicsComponent if this entity has one, undefined otherwise
Attempts to retrieve the RaymarchingComponent from this entity.
The RaymarchingComponent if present, undefined otherwise
Attempts to retrieve the SceneGraphComponent from this entity.
The SceneGraphComponent if this entity has one, undefined otherwise
Attempts to retrieve the SkeletalComponent from this entity.
The SkeletalComponent if this entity has one, undefined otherwise
Attempts to retrieve the TransformComponent from this entity.
The TransformComponent if this entity has one, undefined otherwise
Attempts to retrieve the VrmComponent from this entity.
The VrmComponent if this entity has one, undefined otherwise
Attempts to set a tag on this object. If the tag already exists, it will be replaced.
The tag object containing the name and value to set
True if the tag was successfully set, false if the tag name contains invalid characters
Attempts to set a unique name for this object
The desired unique name
If true, appends UID to make name unique when conflicts occur; if false, fails on conflict
True if the name was successfully set, false if there was a conflict and toAddNameIfConflict was false
Unregisters this object from all tracking collections. Should be called when the object is being destroyed.
Validates that a tag string contains only allowed characters (alphanumeric and underscore)
The string to validate
True if the string contains only valid characters, false if it contains invalid characters
Static_InternalResets all static object tracking data. Used primarily for testing.
StaticgetRetrieves an RnObject instance by its unique identifier
The unique identifier of the object to retrieve
The RnObject instance or undefined if not found or garbage collected
StaticgetRetrieves an RnObject instance by its unique name
The unique name of the object to retrieve
The RnObject instance or undefined if not found or garbage collected
StaticsearchSearches for the first object that has a specific tag with the given value
The tag name to search for
The tag value to match
WeakRef to the first matching object, or undefined if not found
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.