The constructor of the Component class. When creating a Component, use the createComponent method of the ComponentRepository class instead of directly calling this constructor.
The engine instance
Unique ID of the corresponding entity
Scoped ID of the Component
The instance of the EntityRepository class (Dependency Injection)
Whether this component is being reused from a pool
Protected__Protected__Protected__the instance of EntityRepository
Protected__the entity unique Id which this component belongs to
Protected__Protected__the instance of MemoryManager
Collection of tags associated with this object
OptionalarrayOptionaluriStatic Readonly_Static ReadonlyANIMATION_Static ReadonlyANIMATION_Static ReadonlyANIMATION_StaticcurrentCurrent maximum object count for UID generation
Static ReadonlyInvalidInvalid object UID constant
Static OptionalUnzipStaticwasmGets the ComponentMemoryRegistry for this component's engine.
Gets the Scoped ID of this Component instance. The SID is unique within the component type and represents the instance index.
The component scoped ID
Gets the Type ID of this Component instance. This is overridden by concrete component classes to provide unique type identification.
The component type ID (default: 0)
Gets the current process stage of the component. This determines which update methods are currently being called.
The current process stage
Gets the entity that owns this component. This provides access to the entity and its other components.
The entity instance that owns this component
Gets the unique ID of the entity that owns this component.
The entity unique ID
Gets the unique object identifier
The object's UID
Gets the unique name of this object
The unique name string
StaticcomponentGets the Type ID of the Component class. This is overridden by concrete component classes to provide unique type identification.
The component type ID (default: 0)
InternalCopies tag data from another RnObject instance to this object
The source RnObject to copy tags from
InternalMarks this component as destroyed and no longer alive. This is used internally to manage component lifecycle.
Performs a shallow copy of data from another component of the same type. This method should be implemented by concrete component classes as needed.
Add this component to the entity
the target entity
the component class to add
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 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 whether the specified ProcessStage method exists in this Component instance. This is used to determine if this component can handle a particular process stage.
The process stage to check for
True if the method exists, 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
Transitions the component to a different process stage. This affects which update methods will be called during the frame processing.
The target stage to move to
Registers a dependency relationship with another component. This method is intended for future use in managing component dependencies.
Removes a tag from this object
The name of the tag to remove
Allocates memory for all member fields of this component instance. This method is called during component initialization to set up memory layout and allocate space for the specified number of entities.
The number of components per buffer view
Whether to reuse existing memory allocations
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.
StaticdoesChecks whether the specified ProcessStage method exists in the given Component class. This is used to determine if a component can handle a particular process stage.
The component class to check
The process stage to check for
True if the method exists, false otherwise
StaticgetStaticgetStaticgetGets the ComponentType of a specific member field in a component class. This is useful for understanding the primitive data type of component members.
The ComponentType of the member or undefined if not found
StaticgetGets the CompositionType of a specific member field in a component class. This is useful for understanding the data structure of component members.
The CompositionType of the member or undefined if not found
StaticgetGets the pixel location offset in the buffer for a specific member of a component type. This is useful for GPU texture-based data access where locations are measured in pixels.
The pixel location offset in the buffer
StaticgetGets the member info of the component. This is useful for getting the member info of the component.
The member info of the component
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
StaticgetGets the state version of the component memory layout. This is incremented whenever the component's memory layout changes.
The engine instance
The state version number
StaticprocessProcesses all components of a given type for a specific process stage. This method iterates through all components of the specified type and calls their corresponding process stage method if they are in that stage.
The component class to process
The process stage to execute
StaticregisterRegisters a member field of the component class for memory allocation. This method defines the memory layout and characteristics of component data members.
The intended purpose/type of buffer use
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
Staticsort_StaticupdateUpdates components specifically for the render stage with render pass context. This method calls the sort_$render method of the component class to handle render-specific processing and sorting.
The component class to update
The current render pass context
The result of the sort_$render method
Component is a functional unit that can be added to an Entity instance. This is the base class for all components in the ECS (Entity-Component-System) architecture. Components provide specific functionality and data to entities.