Class EntityManager

Adds a component to the entity

Example

const spriteRenderer = entityManager.addComponent(entity, SpriteRenderer);
Copy

Adds an instance of a component to an entity

Example

const spriteRenderer = new SpriteRenderer();
entityManager.addComponent(entity, spriteRenderer);
Copy

Creates multiple entities based on an array of component collections

Example

const player =  [
  new Transform({position: new Vector2(100, 100)}),
  SpriteRenderer,
  Player
];

const enemy =  [
  new Transform({position: new Vector2(-100, 100)}),
  SpriteRenderer,
  Enemy
];

const entities = entityManager.createEntities([player, enemy]);
Copy

Creates an entity without component

Example

const entity = entityManager.createEntity();
Copy

Creates an Entity based on an Archetype

Example

// Using ArchetypeComponent to define components
const entity = entityManager.createEntity({
  components: [
    {type: Transform, data: {position: new Vector2(100, 100)}},
    {type: SpriteRenderer, data: {image: "images/player.png"}},
    {type: Player},
  ],
  children: [
    {
      components: [
        {type: Transform, data: {position: new Vector2(8, 0)}},
        {type: SpriteRenderer, data: {image: "images/sword.png"}},
        {type: Weapon, data: {damage: 10}},
      ],
    },
    {
      components: [
        {type: Transform, data: {position: new Vector2(-8, 0)}},
        {type: SpriteRenderer, data: {image: "images/shield.png"}},
        {type: Shield, data: {defense: 5}, enabled: false},
      ],
    },
    {
      components: [
        {type: Transform, data: {position: new Vector2(8, 0)}},
        {type: SpriteRenderer, data: {image: "images/staf.png"}},
        {type: Staff, data: {mana: 5}},
      ],
      enabled: false,
    }
  ]
});
Copy

Example

// Using Component instances as templates
const entity = entityManager.createEntity({
  components: [
    new Transform({position: new Vector2(100, 100)}),
    new SpriteRenderer({image: "images/player.png"}),
    new Player(),
  ],
  children: [
    {
      components: [
        new Transform({position: new Vector2(8, 0)}),
        new SpriteRenderer({image: "images/sword.png"}),
        new Weapon({damage: 10}),
      ],
    },
    {
      components: [
        new Transform({position: new Vector2(-8, 0)}),
        new SpriteRenderer({image: "images/shield.png"}),
        new Shield({defense: 5}),
      ],
    },
    {
      components: [
        new Transform({position: new Vector2(8, 0)}),
        new SpriteRenderer({image: "images/staf.png"}),
        new Staff({mana: 5}),
      ],
      enabled: false,
    }
  ]
});
Copy

Creates an Entity based on a collection of Component instances and ComponentTypes

Example

const entity = entityManager.createEntity([
  new Transform({position: new Vector2(100, 100)}),
  SpriteRenderer
]);
Copy

Disables a component instance

Example

entityManager.disableComponent(spriteRenderer);
Copy

Disables a component by its entity and type

Example

entityManager.disableComponent(entity, SpriteRenderer);
Copy

Disable all Entities that have a component of the given type

Example

entityManager.disableEntitiesByComponent(SpriteRenderer);
Copy

Disables an entity.
The entity's components will not be included in the search results
and therefore will not be processed by their respective systems
(the engine built-in systems use the search method to retrieve the entities). If the entity has children, they will also be disabled.

Example

entityManager.disableEntity(entity);
Copy

Enables a component instance

Example

entityManager.enableComponent(spriteRenderer);
Copy

Enables a component by its entity and type

Example

entityManager.enableComponent(entity, SpriteRenderer);
Copy

Enable all Entities that have a component of the given type

Example

entityManager.enableEntitiesByComponent(SpriteRenderer);
Copy

Enables an Entity.
The entity's components will be included in the search results
and therefore will be processed by their respective systems
(the engine built-in systems use the search method to retrieve the entities). If the entity has children, they will also be enabled, except for those that have been manually disabled.

Example

entityManager.enableEntity(entity);
Copy

Returns all child entities of the parent entity

Example

const children = entityManager.getChildren(parent);
Copy

Returns the component of the given type belonging to the entity

Example

const spriteRenderer = entityManager.getComponent(entity, SpriteRenderer);
Copy

Returns the component of a parent entity, if it exists.

Example

const spriteRenderer = entityManager.getComponentFromParent(parent, SpriteRenderer);
Copy

Returns all the component belonging to the entity

Example

const components = entityManager.getComponents(entity);
Copy

Searches for and returns an entity for the component instance

Example

const entity = entityManager.getEntityForComponent(spriteRenderer);
Copy

Returns the parent entity of the child entity

Example

const parent = entityManager.getParent(child);
Copy

Returns TRUE if the Entity has a component of the given type, otherwise it returns FALSE.

Example

const hasSpriteRenderer = entityManager.hasComponent(entity, SpriteRenderer);
Copy

Returns TRUE if the component is enabled, otherwise it returns FALSE

Example

entityManager.isComponentEnabled(spriteRenderer)
Copy

Returns TRUE if the component is enabled, otherwise it returns FALSE

Example

entityManager.isComponentEnabled(entity, SpriteRenderer)
Copy

If the Entity exists, returns TRUE, otherwise it returns FALSE

Example

const isEntity = entityManager.isEntity(entity);
Copy

If the Entity is enabled, returns TRUE, otherwise it returns FALSE

Example

const entityEnabled = entityManager.isEntityEnabled(entity);
Copy

Removes all Entities and all their Components

Example

entityManager.removeAllEntities();
Copy

Removes a child entity from the parent entity

Example

entityManager.removeChild(parent, child);
Copy

Removes the component instance from its Entity

Example

entityManager.removeComponent(spriteRenderer)
Copy

Removes a component from the entity according to the given type

Example

entityManager.removeComponent(entity, SriteRenderer)
Copy

Removes an Entity and all its Components

Example

entityManager.removeEntity(entity);
Copy

Removes the parent-child relationship between two entities

Example

entityManager.removeParent(child);
Copy

Performs a search for entities given a component type.
This method returns a collection of objects of type SearchResult, which has the entity found, and the instance of the component.
This search can be filtered by passing as a second argument an instance of SearchCriteria, which performs a match between the attributes of the component and the given value.
The third argument determines if disabled entities or components are included in the search result,\its default value is FALSE.

Example

const searchResult = entityManager.search(SpriteRenderer);
searchResult.forEach(({component, entity}) => {
  // do something with the component and entity
})
Copy

Example

const searchResult = entityManager.search(Enemy, {status: "alive"});
searchResult.forEach(({component, entity}) => {
  // do something with the component and entity
})
Copy

Example

const searchResult = entityManager.search(Enemy, {status: "dead"}, true);
searchResult.forEach(({component, entity}) => {
  // do something with the component and entity
})
Copy

Performs a search for entities given a component type.
This method returns a collection of objects of type SearchResult, which has the entity found, and the instance of the component.
The second argument determines if disabled entities or components are included in the search result,\its default value is FALSE.

Example

const searchResult = entityManager.search(SpriteRenderer);
searchResult.forEach(({component, entity}) => {
  // do something with the component and entity
})
Copy

Example

const searchResult = entityManager.search(Enemy, true);
searchResult.forEach(({component, entity}) => {
  // do something with the component and entity
})
Copy

Performs an entity search given a collection of component types.
The entities found must have an instance of all the given component types.
This method returns a collection of Entities.

Example

const entities = entityManager.searchEntitiesByComponents([Transform, SpriteRenderer, Animator]);
Copy

Performs a search for entities that have a component of the given type and are children of the parent entity.
This method returns a collection of objects of type SearchResult, which has the entity found, and the instance of the component.
The third argument determines if disabled entities or components are included in the search result,\its default value is FALSE.

Example

const searchResult = entityManager.searchInChildren(parent, SpriteRenderer);
searchResult.forEach(({component, entity}) => {
 // do something with the component and entity
})
Copy

Example

const searchResult = entityManager.searchInChildren(parent, SpriteRenderer, true);
searchResult.forEach(({component, entity}) => {
// do something with the component and entity
})
Copy

Sets a parent-child relationship between two entities

Example

entityManager.setParent(child, parent);
Copy