The constructor of the Component class. When creating a Component, use the createComponent method of the ComponentRepository class instead of directly calling this constructor.
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__currentProtected__entitythe instance of EntityRepository
Protected__entitythe entity unique Id which this component belongs to
Protected__memorythe instance of MemoryManager
Collection of tags associated with this object
Static ReadonlyInvalidInvalid object UID constant
Static Readonly_processStaticcurrentCurrent maximum object count for UID generation
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 unique ID of the entity that owns this component.
The entity unique ID
Gets the maximum number of components of this type that can exist.
The maximum number of components
Gets the unique object identifier
The object's UID
Gets the unique name of this object
The unique name string
StaticcomponentTIDGets 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
Performs a shallow copy of data from another component of the same type. This method should be implemented by concrete component classes as needed.
The source component to copy from
Adds this component to an entity, extending the entity with component-specific methods. This is a virtual method that should be overridden by concrete component classes.
The target entity to add this component to
The component class being added
The entity extended with component methods
Gets detailed byte information about a specific member field of this component. This includes offsets, lengths, and location information for GPU access.
The name of the member field
Detailed byte information object
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 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.
The component to depend on
Whether this dependency is required
Registers 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
The name of the member field
The class type of the data
The primitive data type (e.g., Float32, Int32)
Initial values for the member field
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 entities to allocate memory for
Whether to reuse existing memory allocations
Allocates memory for a specific member field of this component instance. This method takes one memory slot from the shared memory pool for the specified member.
The name of the member field
The data class type for the member
Initial values to set for the member
Whether to reuse an existing memory slot
The component scoped ID
null on success
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
Static_resetStaticdoesChecks 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
StaticgetGets the memory accessor for a specific member field of a component class. The accessor provides access to the underlying typed array data.
The name of the member field
The component class
The accessor for the member field
StaticgetGets the total byte length of all member fields for a specific buffer use type in the given component class.
The buffer use type
The component class
The total byte length of members
StaticgetGets the byte offset of the first element of a specific member field within the buffer.
The name of the member field
The component class
The byte offset in the buffer
StaticgetGets the byte offset of the first element of a specific member field within the buffer view.
The name of the member field
The component class
The byte offset in the buffer view
StaticgetGets the byte offset of the component type's data within the buffer.
The buffer use type
The component class
The byte offset in the buffer
StaticgetGets the ComponentType of a specific member field in a component class. This is useful for understanding the primitive data type of component members.
The name of the member field
The component class to query
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 name of the member field
The component class to query
The CompositionType of the member or undefined if not found
StaticgetGets detailed byte information about a member field by Component SID. This is a static version that looks up the component by its scoped ID.
The component class type
The scoped ID of the component
The name of the member field
Detailed byte information object or undefined if component not found
StaticgetGets detailed byte information about a specific member field of a component. This includes offsets, lengths, and location information for GPU access.
The component instance to analyze
The name of the member field
Detailed byte information object
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 component class type
The name of the member field
The pixel location offset in the buffer
StaticgetStaticgetStaticprocessProcesses 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
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
StatictakeCreates and configures a memory accessor for a specific member field. This method allocates buffer memory and creates an accessor for efficient data access.
The intended use of the buffer
The name of the member field
The component class
The composition type (e.g., Vec3, Mat4)
The component data type (e.g., Float32, Int32)
The number of components to allocate for
Result containing the accessor or an error
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 render process stage
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.