Entitas ECS

Class: Entity

Entity

new entitas.Entity(componentsEnum, totalComponents)

Entity.js, line 17

The basic game object. Everything is an entity with components that
are added / removed as needed.

Name Type Description
componentsEnum Object
totalComponents number

Members

creationIndexnumber

A unique sequential index number assigned to each entity at creation

idstring

Entity Id

instanceIndexnumber

Instance index

namestring

Entity name

onComponentAddedentitas.ISignal

Subscribe to Component Added Event

onComponentRemovedentitas.ISignal

Subscribe to Component Removed Event

onComponentReplacedentitas.ISignal

Subscribe to Component Replaced Event

onEntityReleasedentitas.ISignal

Subscribe to Entity Released Event

Methods

addComponent(index, component){entitas.Entity}

Entity.js, line 125

AddComponent

Name Type Description
index number
component entitas.IComponent
Returns:
Type Description
entitas.Entity

addRef(){entitas.Entity}

Entity.js, line 344

AddRef

Returns:
Type Description
entitas.Entity

destroy()

Entity.js, line 311

Destroy

getComponent(index, component)

Entity.js, line 211

GetComponent

Name Type Description
index number
component entitas.IComponent

getComponentIndices(){Array.<number>}

Entity.js, line 242

GetComponentIndices

Returns:
Type Description
Array.<number>

getComponents(){Array.<entitas.IComponent>}

Entity.js, line 223

GetComponents

Returns:
Type Description
Array.<entitas.IComponent>

hasAnyComponent(indices){boolean}

Entity.js, line 285

HasAnyComponent

Name Type Description
indices Array.<number>
Returns:
Type Description
boolean

hasComponent(index){boolean}

Entity.js, line 261

HasComponent

Name Type Description
index number
Returns:
Type Description
boolean

hasComponents(indices){boolean}

Entity.js, line 270

HasComponents

Name Type Description
indices Array.<number>
Returns:
Type Description
boolean

initialize(totalComponents){Array.<entitas.IComponent>}

Entity.js, line 98

Initialize
allocate the entity pool.

Name Type Description
totalComponents number
Returns:
Type Description
Array.<entitas.IComponent>

release()

Entity.js, line 352

Release

removeAllComponents()

Entity.js, line 298

RemoveAllComponents

removeComponent(index){entitas.Entity}

Entity.js, line 148

RemoveComponent

Name Type Description
index number
Returns:
Type Description
entitas.Entity

replaceComponent(index, component){entitas.Entity}

Entity.js, line 166

ReplaceComponent

Name Type Description
index number
component entitas.IComponent
Returns:
Type Description
entitas.Entity

toString(){string}

Entity.js, line 323

ToString

Returns:
Type Description
string