• API Docs for Version:

    • Show:

    ECS

    Module: ecs

    Table of Contents

    Constructor

    ECS ()

    Defined in yagl-ecs\src\ecs.js:16

    Methods

    addEntity
    (
    • entity
    )

    Defined in yagl-ecs\src\ecs.js:69

    Add an entity to the ecs.

    Parameters:

    • entity Entity

      The entity to add.

    addSystem
    (
    • system
    )

    Defined in yagl-ecs\src\ecs.js:133

    Add a system to the ecs.

    Parameters:

    cleanDirtyEntities ()
    private

    Defined in yagl-ecs\src\ecs.js:163

    "Clean" entities flagged as dirty by removing unecessary systems and adding missing systems.

    removeEntity
    (
    • entity
    )
    Entity

    Defined in yagl-ecs\src\ecs.js:79

    Remove an entity from the ecs by reference.

    Parameters:

    • entity Entity

      reference of the entity to remove

    Returns:

    Entity:

    the remove entity if any

    removeEntityById
    (
    • entityId
    )
    Entity

    Defined in yagl-ecs\src\ecs.js:101

    Remove an entity from the ecs by entity id.

    Parameters:

    • entityId Entity

      id of the entity to remove

    Returns:

    Entity:

    removed entity if any

    removeEntityIfDirty
    (
    • entity
    )
    private

    Defined in yagl-ecs\src\ecs.js:119

    Remove an entity from dirty entities by reference.

    Parameters:

    • entity type

      entity to remove

    removeSystem
    (
    • system
    )

    Defined in yagl-ecs\src\ecs.js:149

    Remove a system from the ecs.

    Parameters:

    • system System

      system reference

    update ()

    Defined in yagl-ecs\src\ecs.js:195

    Update the ecs.

    Properties

    entities

    Array

    Defined in yagl-ecs\src\ecs.js:21

    Store all entities of the ECS.

    entitiesSystemsDirty

    Array

    Defined in yagl-ecs\src\ecs.js:29

    Store entities which need to be tested at beginning of next tick.

    systems

    Array

    Defined in yagl-ecs\src\ecs.js:37

    Store all systems of the ECS.

    updateCounter

    Number

    Defined in yagl-ecs\src\ecs.js:45

    Count how many updates have been done.