API Docs for:
Show:

EntityManager Class

Module: ArtemiJS

The entity manager class.

Methods

added

(
  • entity
)

Set entity as added for future process

Parameters:

checkIn

(
  • id
)

Add new id in ids {Bag}

Parameters:

  • id Number

checkOut

() Number

Check an available id

Returns:

Number: next available id

createEntityInstance

() Entity

Create new entity instance

Returns:

deleted

(
  • entity
)

Set entity as deleted for future process

Parameters:

disabled

(
  • entity
)

Set entity as disabled for future process

Parameters:

enabled

(
  • entity
)

Set entity as enabled for future process

Parameters:

getActiveEntityCount

() Number

Get how many entities are active in this world.

Returns:

Number: how many entities are currently active.

getTotalAdded

() Number

Get how many entities have been added to the world since start.

Returns:

Number: how many entities have been added.

getTotalCreated

() Number

Get how many entities have been created in the world since start. Note: A created entity may not have been added to the world, thus created count is always equal or larger than added count.

Returns:

Number: how many entities have been created since start.

getTotalDeleted

() Number

Get how many entities have been deleted from the world since start.

Returns:

Number: how many entities have been deleted since start.

initialize

()

Initialize

isActive

(
  • entityId
)
Boolean

Check if this entity is active. Active means the entity is being actively processed.

Parameters:

  • entityId Number

Returns:

Boolean: true if active, false if not

isEnabled

(
  • entityId
)
Boolean

Check if the specified entityId is enabled.

Parameters:

  • entityId Number

Returns:

Boolean: true if enabled, false if it is disabled

Properties

active

Number private

added

Number private

created

Number private

deleted

Number private

disabled

Utils.BitSet private

entities

Utils.Bag private

identifierPool

IdentifierPool private

nextAvailableId

Number