ecstasy Class: TurnEngine

new TurnEngine(isServer)

Represents an turn based game engine. It's like a normal ECS with Action and Turn.

Parameters:

Name	Type	Argument	Default	Description
`isServer`	Boolean	<optional>	false	Whether if it's a server or not

Source:

TurnEngine.js, line 14

See:

Action
Turn

Extends

ActionEngine

Members

isServer :Boolean

A boolean contains whether if it's a server or not.

Type:

Boolean

Inherited From:

ActionEngine#isServer

Source:

ActionEngine.js, line 17

players :Array

An arraying holding all the player Entity in the game.

Type:

Array

Source:

TurnEngine.js, line 27

See:

Entity

systems :Array

Array of all the System in the Engine. You shouldn't edit this array directly, use Engine#addSystem and Engine#removeSystem instead.

Type:

Array

Inherited From:

Engine#systems

Source:

Engine.js, line 36

turns :Array

An array holding all the Turn used in the game.

Type:

Array

Source:

TurnEngine.js, line 21

See:

Turn

Methods

addEntity(entity)

Adds an Entity to the Engine.

Parameters:

Name	Type	Description
`entity`	Entity	An Entity to add

Inherited From:

Engine#addEntity

Source:

Engine.js, line 129

Fires:

addSystem(key, system)

Adds the System to the Engine. The System will be triggered when the Engine#update is called. This will trigger System#add.

Parameters:

Name	Type	Description
`key`	String	The System's string key
`system`	System	The System to add

Inherited From:

Engine#addSystem

Source:

Engine.js, line 354

c(key, constructor)

Registers a Component type to the Engine.

Parameters:

Name	Type	Description
`key`	String	Component's string key.
`constructor`	function	Component's constructor.

Inherited From:

Engine#c

Source:

Engine.js, line 64

createAction(name, entity, player, options) → {Action}

Creates a new Action using registered constructor.

Parameters:

Name	Type	Description
`name`	String	The name of the Action.
`entity`	Entity	The entity associated with the action.
`player`	Entity	The player who requested the action.
`options`	Object	The arguments associated with the action.

Inherited From:

ActionEngine#createAction

Source:

ActionEngine.js, line 76

Returns:

The created Action.

Type: Action

createEntity() → {Entity}

Creates an empty Entity and adds to the Engine.

Inherited From:

Engine#createEntity

Source:

Engine.js, line 158

Fires:

Engine#event:entityAdded

Returns:

an empty Entity.

Type: Entity

createSystem(key) → {SystemBuilder}

Returns a new SystemBuilder associated the Engine.

Parameters:

Name	Type	Description
`key`	String	The System's string key to use.

Inherited From:

Engine#createSystem

Source:

Engine.js, line 374

Returns:

A new SystemBuilder

Type: SystemBuilder

defineAction(name, constructor)

Defines an Action type to the Engine.

Parameters:

Name	Type	Description
`name`	String	The name of the Action.
`constructor`	function	The constructor of the Action.

Inherited From:

ActionEngine#defineAction

Source:

ActionEngine.js, line 53

deserialize(serialized)

Deserializes the Engine object and places on provided engine. The provided Engine object should be clean; it shouldn't contain any Entity object. But it can contain pre-defined Components and Systems. Note that systems won't be included in serialized object, so user should load the systems on their own.

Parameters:

Name	Type	Description
`serialized`	Object	Engine object

Inherited From:

Engine#deserialize

Source:

Engine.js, line 486

e()

Executes Entity related functions by its arguments.

If no argument is provided, it returns new Entity. If a number is provided, it returns a Entity with that ID. If an object is provided, it returns new Entity populated with the template. Otherwise, it returns an array of Entity having provided list components.

Inherited From:

Engine#e

Source:

Engine.js, line 172

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

getActionConstructor(name) → {function}

Returns the Action's construtor with specified name.

Parameters:

Name	Type	Description
`name`	String	The name of the Action.

Inherited From:

ActionEngine#getActionConstructor

Source:

ActionEngine.js, line 64

Returns:

The constructor of the Action.

Type: function

getComponentBit(key)

Returns Component type's unique ID in the Engine. This unique ID is used in BitSet's bit position. This will call Engine#registerComponent if needed.

Parameters:

Name	Type	Description
`key`	String	Component's string key.

Inherited From:

Engine#getComponentBit

Source:

Engine.js, line 82

Returns:

the Component's unique ID.

getComponentConstructor(key)

Returns Component's constructor registered in the Engine/

Parameters:

Name	Type	Description
`key`	String	Component's string key.

Inherited From:

Engine#getComponentConstructor

Source:

Engine.js, line 71

Returns:

the Component's constructor.

getComponentGroup(entities) → {ComponentGroup}

Searches ComponentGroup by its array.

Parameters:

Name	Type	Description
`entities`	Array	An array of ComponentGroup

Inherited From:

Engine#getComponentGroup

Source:

Engine.js, line 343

Returns:

The ComponentGroup linked with the array

Type: ComponentGroup

getComponentName(key)

Returns Component type's key by its unique ID.

Parameters:

Name	Type	Description
`key`	Number	Component's unique ID

Inherited From:

Engine#getComponentName

Source:

Engine.js, line 96

Returns:

the Component's string key.

getComponentsBitSet(components) → {BitSet}

Returns a BitSet holding combination of Components type's unique ID.

Parameters:

Name	Type	Description
`components`	Array	An array holding Component keys.

Inherited From:

Engine#getComponentsBitSet

Source:

Engine.js, line 105

Returns:

A BitSet holding combination of Components.

Type: BitSet

getEntities() → {Array}

Returns an array of Entity. It shouldn't be edited since the Engine uses it directly.

Inherited From:

Engine#getEntities

Source:

Engine.js, line 248

Returns:

An array holding Entity

Type: Array

getEntitiesFor(componentGroup) → {Array}

Returns an array having Entity matching ComponentGroup's criteria. The array will keep updated, so you can call this method only once and check its contents if needed. It's an alias function to Engine#registerComponentGroup

Parameters:

Name	Type	Description
`componentGroup`	ComponentGroup	The ComponentGroup

Inherited From:

Engine#getEntitiesFor

Source:

Engine.js, line 326

See:

Engine#registerComponentGroup

Fires:

ComponentGroup#event:entityAdded

Returns:

An array holding Entity matching its criteria

Type: Array

getEntity(id) → {Entity}

Returns an Entity with given ID. This will return null if it can't be found.

Parameters:

Name	Type	Description
`id`	Number	An ID to find the Entity

Inherited From:

Engine#getEntity

Source:

Engine.js, line 239

Returns:

The entity with given ID

Type: Entity

getSystem(key) → {System}

Returns the System registered to the Engine.

Parameters:

Name	Type	Description
`key`	String	The System's string key

Inherited From:

Engine#getSystem

Source:

Engine.js, line 400

Returns:

The system registered to the Engine

Type: System

getTurn() → {Turn}

Returns current Turn object. It'll call TurnEngine#nextTurn if the game hasn't started yet.

Source:

TurnEngine.js, line 38

Returns:

The current Turn

Type: Turn

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

nextTurn() → {Turn}

Finishes the current Turn and starts next Turn.

Source:

TurnEngine.js, line 53

Fires:

Throws:

If there are no players in the game

Returns:

The current Turn

Type: Turn

obtainEntityId() → {Number}

Returns a new Entity ID to use. This changes its value each time it's called.

Inherited From:

Engine#obtainEntityId

Source:

Engine.js, line 119

See:

Entity

Returns:

An integer that is used for Entity's ID

Type: Number

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

registerComponent(key, constructor)

Registers a Component type to the Engine.

Parameters:

Name	Type	Description
`key`	String	Component's string key.
`constructor`		{Function] - Component's constructor.

Inherited From:

Engine#registerComponent

Source:

Engine.js, line 50

registerComponentGroup(componentGroup) → {Array}

Registers the ComponentGroup to the Engine. Engine will check if an Entity matches ComponentGroup's criteria every time when a Entity is added or removed.

Parameters:

Name	Type	Description
`componentGroup`	ComponentGroup	The ComponentGroup to register

Inherited From:

Engine#registerComponentGroup

Source:

Engine.js, line 289

See:

Entity

Fires:

ComponentGroup#event:entityAdded

Returns:

An array holding Entity matching its criteria

Type: Array

removeAllEntities()

Removes all Entity from the Engine.

Inherited From:

Engine#removeAllEntities

Source:

Engine.js, line 227

Fires:

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

removeEntity(entity)

Removes an Entity from the Engine.

Parameters:

Name	Type	Description
`entity`	Entity	An Entity to remove

Inherited From:

Engine#removeEntity

Source:

Engine.js, line 197

Fires:

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

removeSystem(key)

Removes the System from the Engine. This will trigger System#remove.

Parameters:

Name	Type	Description
`key`	String	The System's string key to remove.

Inherited From:

Engine#removeSystem

Source:

Engine.js, line 409

runAction(action)

Runs the Action. Action shouldn't have run yet if ActionEngine#isServer is true, but it should have run on server and have Action#result if not.

Parameters:

Name	Type	Description
`action`	Action	The Action to run.

Inherited From:

ActionEngine#runAction

Source:

ActionEngine.js, line 92

Fires:

ActionEngine#event:action
ActionEngine#event:preAction

s()

Executes System related functions by its arguments.

If a key is provided and the Engine doesn't have a system with that key, it returns a SystemBuilder. If a key is provided and the Engine has a system with that key, it returns that system. If a key is provided and a system is provided, it registers the system.

Inherited From: