API Docs for:
Show:

World Class

Defined in: ../src/World.js:4
Module: ArtemiJS

The primary instance for the framework. It contains all the managers. You must use this to create, delete and retrieve entities. It is also important to set the delta each game loop iteration, and initialize before game loop.

Methods

addEntity

(
  • entity
)

Defined in ../src/World.js:198

Adds a entity to this world.

Parameters:

changedEntity

(
  • entity
)

Defined in ../src/World.js:208

Ensure all systems are notified of changes to this entity. If you're adding a component to an entity after it's been added to the world, then you need to invoke this method.

Parameters:

check

(
  • entities
  • performer
)
private

Defined in ../src/World.js:356

Performs an action on each entity.

Parameters:

createEntity

() Entity

Defined in ../src/World.js:252

Create and return a new or reused entity instance. Will NOT add the entity to the world, use World.addEntity(Entity) for that.

Returns:

Entity: entity

deleteEntity

(
  • entity
)

Defined in ../src/World.js:220

Delete the entity from the world.

Parameters:

deleteManager

(
  • manager
)

Defined in ../src/World.js:168

Deletes the manager from this world.

Parameters:

  • manager Manager

    manager to delete.

deleteSystem

(
  • system
)

Defined in ../src/World.js:315

Removed the specified system from the world.

Parameters:

  • system Object

    to be deleted from world.

disableEntity

(
  • entity
)

Defined in ../src/World.js:241

Disable the entity from being processed. Won't delete it, it will continue to exist but won't get processed.

Parameters:

enableEntity

(
  • entity
)

Defined in ../src/World.js:230

(Re)enable the entity in the world, after it having being disabled. Won't do anything unless it was already disabled.

Parameters:

getComponentManager

() ComponentManager

Defined in ../src/World.js:131

Returns a manager that takes care of all the components in the world.

Returns:

ComponentManager: componentManager

getDelta

() Number

Defined in ../src/World.js:189

Returns:

Number: delta time since last game loop.

getEntity

(
  • entityId
)
Entity

Defined in ../src/World.js:263

Get a entity having the specified id.

Parameters:

  • entityId Number

Returns:

Entity: entity

getEntityManager

() EntityManager

Defined in ../src/World.js:120

Returns a manager that takes care of all the entities in the world. entities of this world

Returns:

EntityManager: entityManager

getMapper

(
  • type
)
ComponentMapper

Defined in ../src/World.js:426

Retrieves a ComponentMapper instance for fast retrieval of components from entities.

Parameters:

  • type Object

    of component to get mapper for.

Returns:

ComponentMapper: mapper for specified component type.

getSystem

(
  • systemType
)
EntitySystem

Defined in ../src/World.js:304

Retrieve a system for specified system type.

Parameters:

  • systemType String

    type of system.

Returns:

EntitySystem: instance of the system in this world.

getSystems

() Mixed

Defined in ../src/World.js:274

Gives you all the systems in this world for possible iteration.

Returns:

Mixed: all entity systems in world, other false

initialize

()

Defined in ../src/World.js:103

Makes sure all managers systems are initialized in the order they were added

notifySystems

(
  • performer
  • entity
)
private

Defined in ../src/World.js:326

Notify all the systems

Parameters:

  • performer Object

    Object with callback perform

  • entity Entity

notifySystems

(
  • performer
  • entity
)
private

Defined in ../src/World.js:341

Notify all the managers

Parameters:

  • performer Object

    Object with callback perform

  • entity Entity

process

()

Defined in ../src/World.js:378

Process all non-passive systems.

setDelta

(
  • d
)

Defined in ../src/World.js:179

You must specify the delta for the game here.

Parameters:

  • d Number

    time since last game loop.

setManager

(
  • manager
)
Manager

Defined in ../src/World.js:141

Add a manager into this world. It can be retrieved later. World will notify this manager of changes to entity.

Parameters:

  • manager Manager

    manager to be added

Returns:

Manager: manager

setSystem

(
  • system
  • [passive]
)
EntitySystem

Defined in ../src/World.js:284

Adds a system to this world that will be processed by World.process()

Parameters:

  • system EntitySystem

    the system to add.

  • [passive] Boolean optional

    wether or not this system will be processed by World.process()

Returns:

EntitySystem: the added system.

Properties

added

Utils.Bag private

Defined in ../src/World.js:58

changed

Utils.Bag private

Defined in ../src/World.js:65

componentManager

ComponentManager private

Defined in ../src/World.js:23

deleted

Utils.Bag private

Defined in ../src/World.js:72

delta

Number private

Defined in ../src/World.js:93

disable

Utils.Bag private

Defined in ../src/World.js:86

enable

Utils.Bag private

Defined in ../src/World.js:79

entityManager

EntityManager private

Defined in ../src/World.js:16

manager

Object private

Defined in ../src/World.js:30

managersBag

Utils.Bag private

Defined in ../src/World.js:37

systems

Object private

Defined in ../src/World.js:44

systemsBag

Utils.Bag private

Defined in ../src/World.js:51