Class: Group

Members

countnumber

Count the number of entities in this group

matcherentitas.IMatcher

Get the Matcher for this group

onEntityAddedentitas.utils.ISignal

Subscribe to Entity Addded events

onEntityRemovedentitas.utils.ISignal

Subscribe to Entity Removed events

onEntityUpdatedentitas.utils.ISignal

Subscribe to Entity Updated events

Methods

addEntity(entity, index, component)

Group.js, line 126

Add entity and raise events

Name	Type	Description
entity
index
component

addEntitySilently(entity)

Group.js, line 112

Add entity without raising events

Name	Type	Description
entity

containsEntity(entity)

Group.js, line 172

Check if group has this entity

Name	Type	Description
entity

Returns:

boolean

createObserver(eventType)

Group.js, line 57

Create an Observer for the event type on this group

Name	Type	Description
eventType

getEntities()

Group.js, line 180

Get a list of the entities in this group

Returns:

Array

getSingleEntity()

Group.js, line 198

Gets an entity singleton.
If a group has more than 1 entity, this is an error condition.

Returns:

entitas.Entity

handleEntity(entity, index, component)

Group.js, line 80

Handle adding and removing component from the entity and raisieevents

Name	Type	Description
entity
index
component

handleEntitySilently(entity)

Group.js, line 66

Handle adding and removing component from the entity without raising events

Name	Type	Description
entity

removeEntity(entity, index, component)

Group.js, line 155

Remove entity and raise events

Name	Type	Description
entity
index
component

removeEntitySilently(entity)

Group.js, line 141

Remove entity without raising events

Name	Type	Description
entity

toString()

Group.js, line 221

Create a string representation for this group:

ex: 'Group(Position)'

Returns:

string

updateEntity(entity, index, previousComponent, newComponent)

Group.js, line 95

Update entity and raise events

Name	Type	Description
entity
index
previousComponent
newComponent