Class ComponentRepository

constructor

• new ComponentRepository(engine: Engine): ComponentRepository

  Parameters

  • engine: Engine

  Returns ComponentRepository

Static ReadonlyinvalidComponentSID

_getComponents

• _getComponents(componentClass: typeof Component): Component[] | undefined
  Internal

  Gets an array of all component instances of the specified type. This is an internal method that includes undefined slots in the array.

  Parameters

  • componentClass: typeof Component

    The component class to retrieve instances for

  Returns Component[] | undefined

  Array of component instances with potential undefined elements, or undefined if type not found

_getComponentsIncludingDead

• _getComponentsIncludingDead(
      componentClass: typeof Component,
  ): Component[] | undefined
  Internal

  Gets an array of all component instances including deleted/dead components. This internal method provides access to the raw component array with undefined slots.

  Parameters

  • componentClass: typeof Component

    The component class to retrieve instances for

  Returns Component[] | undefined

  Array of component instances including dead components, or undefined if type not found

createComponent

• createComponent(
      componentTid: number,
      entityUid: number,
      entityRepository: EntityRepository,
  ): Component

  Creates a new component instance for the specified entity. This method handles ComponentSID allocation, including reusing SIDs from deleted components.

  Parameters

  • componentTid: number

    The ComponentTID of the component type to create

  • entityUid: number

    The EntityUID of the entity that will own this component

  • entityRepository: EntityRepository

    Reference to the entity repository for entity management

  Returns Component

  The newly created component instance

  Throws

  If the component class is not registered or invalid

  Example

  const component = ComponentRepository.createComponent(
    MyComponent.componentTID,
    entityUID,
    entityRepository
  );
  Copy

deleteComponent

• deleteComponent(component: Component): void

  Deletes a component instance from the repository. This marks the component's slot as available for reuse and removes it from the active components.

  Parameters

  • component: Component

    The component instance to delete

  Returns void

  Example

  ComponentRepository.deleteComponent(myComponent);
  Copy

getComponent

• getComponent(
      componentClass: typeof Component,
      componentSid: number,
  ): Component | undefined

  Retrieves a specific component instance by its class and ComponentSID.

  Parameters

  • componentClass: typeof Component

    The component class to search for

  • componentSid: number

    The ComponentSID of the specific component instance

  Returns Component | undefined

  The component instance, or undefined if not found

  Example

  const component = ComponentRepository.getComponent(MyComponent, componentSID);
  Copy

getComponentFromComponentTID

• getComponentFromComponentTID(
      componentTid: number,
      componentSid: number,
  ): Component | undefined

  Retrieves a specific component instance by ComponentTID and ComponentSID.

  Parameters

  • componentTid: number

    The ComponentTID of the component type

  • componentSid: number

    The ComponentSID of the specific component instance

  Returns Component | undefined

  The component instance, or undefined if not found

  Example

  const component = ComponentRepository.getComponentFromComponentTID(componentTID, componentSID);
  Copy

getComponentsWithType

• getComponentsWithType(componentType: typeof Component): Component[]

  Retrieves all active (non-null) component instances of the specified type. This method filters out deleted components and returns only valid instances.

  Parameters

  • componentType: typeof Component

    The component class to retrieve instances for

  Returns Component[]

  Array of active component instances (never includes undefined elements)

  Example

  const activeComponents = ComponentRepository.getComponentsWithType(MyComponent);
  activeComponents.forEach(component => {
    // Process each active component
  });
  Copy

getComponentsWithTypeWithoutFiltering

• getComponentsWithTypeWithoutFiltering(
      componentType: typeof Component,
  ): (Component | undefined)[]
  Internal

  Gets an array of all component instances of the specified type. This is an internal method that includes undefined slots in the array.

  Parameters

  • componentType: typeof Component

  Returns (Component | undefined)[]

  Array of component instances with potential undefined elements, or undefined if type not found

getComponentTIDs

• getComponentTIDs(): number[]

  Retrieves all registered component type IDs in sorted order. This provides access to all ComponentTIDs that have been registered with the repository.

  Returns number[]

  Array of all ComponentTIDs currently registered, sorted in ascending order

  Example

  const allComponentTIDs = ComponentRepository.getComponentTIDs();
  console.log(`Total component types: ${allComponentTIDs.length}`);
  Copy

getRenderingComponentTIDs

• getRenderingComponentTIDs(): number[]

  Retrieves all rendering-related component type IDs. This returns ComponentTIDs for components that are involved in the rendering pipeline.

  Returns number[]

  Array of ComponentTIDs for rendering components

  Example

  const renderingTIDs = ComponentRepository.getRenderingComponentTIDs();
  // Process rendering components during render loop
  Copy

StaticderegisterComponentClass

• deregisterComponentClass(componentTID: number): void

  Unregisters a component class from the repository. This removes the component class associated with the given ComponentTID.

  Parameters

  • componentTID: number

    The ComponentTID of the component class to unregister

  Returns void

  Example

  ComponentRepository.deregisterComponentClass(MyComponent.componentTID);
  Copy

StaticgetComponentClass

• getComponentClass(componentTid: number): typeof Component | undefined

  Retrieves the component class constructor associated with the specified ComponentTID.

  Parameters

  • componentTid: number

    The ComponentTID to look up

  Returns typeof Component | undefined

  The component class constructor, or undefined if not found

  Example

  const ComponentClass = ComponentRepository.getComponentClass(componentTID);
  if (ComponentClass) {
    // Use the component class
  }
  Copy

StaticregisterComponentClass

• registerComponentClass(componentClass: typeof Component): void

  Registers a component class with the repository. This method associates a component class with its unique ComponentTID for later instantiation.

  Parameters

  • componentClass: typeof Component

    The component class constructor to register

  Returns void

  Throws

  If the component class is invalid or already registered

  Example

  ComponentRepository.registerComponentClass(MyCustomComponent);
  Copy