Extends

• EventEmitter

Members

<private> _engine :Engine

The Engine associated with this object.

Type:

• Engine

Source:

• Entity.js, line 26

componentBits :BitSet

The BitSet holding information about what kind of Component this has.

Type:

• BitSet

Source:

• Entity.js, line 31

componentGroupBits :BitSet

The BitSet holding information about what ComponentGroup this matches.

Type:

• BitSet

Source:

• Entity.js, line 36

components :Object

The key-value storage of Components.

Type:

• Object

Source:

• Entity.js, line 41

id :Number

The ID of this object. This will be given by Engine, and it shouldn't be edited after being added to the Engine. Otherwise, You can edit the value to what you want.

Type:

• Number

Source:

• Entity.js, line 20

Methods

<static> fromJSON(engine, data) → {Entity}

Returns new deserialized Entity object.

Parameters:

Name	Type	Description
engine	Engine	the Engine object
data	Object	serialized Entity object

Source:

• Entity.js, line 159

Returns:

the Entity object

Type

Entity

add(key, component)

Adds the Component to the Entity.

Parameters:

Name	Type	Description
key	String	The key of the Component.
component	Component	The Component to add.

Source:

• Entity.js, line 53

Fires:

• Entity#event:componentAdded

c(key, args)

Executes Component related functions by its arguments.

If only a key is provided, it returns the Component with that ID. Otherwise, it creates the Component with the options.

Parameters:

Name	Type	Description
key	String	The Component's key
args	Object	The options

Source:

• Entity.js, line 88

create(key, args) → {Entity}

Creates new Component with the args and adds to the Entity.

Parameters:

Name	Type	Description
key	String	The key of the Component.
args	Object	A key-value storage to create the Component.

Source:

• Entity.js, line 73

Returns:

the Entity to allow chains.

Type

Entity

emit(event)

Emits the event. This will trigger all the listener with that event type. You can supply listener function's arguments by appending arguments after the 'event' parameter.

Parameters:

Name	Type	Description
event	String	The name of the event.
args...		Arguments to supply to listeners.

Inherited From:

• EventEmitter#emit

Source:

• EventEmitter.js, line 95

get(key) → {Component}

Returns the Component which this Entity has.

Parameters:

Name	Type	Description
key	String	The key of the Component.

Source:

• Entity.js, line 117

Returns:

The component.

Type

Component

has(key) → {Boolean}

Checks whether if this Entity has the Component.

Parameters:

Name	Type	Description
key	String	The key of the Component to check.

Source:

• Entity.js, line 127

Returns:

Whether if this Entity has the Component.

Type

Boolean

listeners(event) → {Array}

Returns the array of listeners with specified event type.

Parameters:

Name	Type	Description
event	String	The name of the event.

Inherited From:

• EventEmitter#listeners

Source:

• EventEmitter.js, line 81

Returns:

An array holding event listeners.

Type

Array

on(event, listener)

Registers a listener.

Parameters:

Name	Type	Description
event	String	The name of the event.
listener	function	The function to be triggered.

Inherited From:

• EventEmitter#on

Source:

• EventEmitter.js, line 17

once(event, listener)

Registers a one-time listener. The listener will be removed after being triggered once.

Parameters:

Name	Type	Description
event	String	The name of the event.
listener	function	The function to be triggered.

Inherited From:

• EventEmitter#once

Source:

• EventEmitter.js, line 37

remove(key)

Removes the Component from the Entity.

Parameters:

Name	Type	Description
key	String	The key of the Component.

Source:

• Entity.js, line 98

Fires:

• Entity#event:componentRemoved

removeAllListeners(event)

Removes all the listener with specified event type. If event parameter is not set, it will remove all the listener of all types.

Parameters:

Name	Type	Argument	Description
event	String	<optional>	The name of the event.

Inherited From:

• EventEmitter#removeAllListeners

Source:

• EventEmitter.js, line 64

removeListener(event, listener)

Removes the listener.

Parameters:

Name	Type	Description
event	String	The name of the event.
listener	function	The function to be removed.

Inherited From:

• EventEmitter#removeListener

Source:

• EventEmitter.js, line 47

toJSON() → {Object}

Serializes the Entity object. Components should be serializable in order to do this.

Source:

• Entity.js, line 137

Returns:

serialized Entity object

Type

Object

Events

componentAdded

This event is fired when a Component is added to the Entity.

Properties:

Name	Type	Description
0	Entity	the Entity.
1	String	the Component key added to Entity.
2	Component	the Component added to Entity.

Source:

• Entity.js, line 57

componentRemoved

This event is fired when a Component is removed from the Entity.

Properties:

Name	Type	Description
0	Entity	the Entity.
1	String	the Component key removed from the Entity.

Source:

• Entity.js, line 103