Interface Family<TNode>

The interface for classes that are used to manage NodeLists (set as the familyClass property in the Engine object). Most developers don't need to use this since the default implementation is used by default and suits most needs.

Type Parameters

Hierarchy

  • Family

Implemented by

Properties

nodeList

Methods

cleanUp componentAddedToEntity componentRemovedFromEntity newEntity removeEntity

Properties

Readonly nodeList

nodeList: NodeList<TNode>

Returns the NodeList managed by this class. This should be a reference that remains valid always since it is retained and reused by Systems that use the list. i.e. never recreate the list, always modify it in place.

Methods

cleanUp

  • The family is about to be discarded. Clean up all properties as necessary. Usually, you will want to empty the NodeList at this time.

    Returns void

componentAddedToEntity

  • A component has been added to an entity. Test whether the entity's inclusion in this family's NodeList should be modified.

    Parameters

    Returns void

componentRemovedFromEntity

  • A component has been removed from an entity. Test whether the entity's inclusion in this family's NodeList should be modified.

    Parameters

    Returns void

newEntity

  • An entity has been added to the engine. It may already have components so test the entity for inclusion in this family's NodeList.

    Parameters

    Returns void

removeEntity

  • An entity has been removed from the engine. If it's in this family's NodeList it should be removed.

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc