Extends

• EvenetEmitter

Members

---

desiredFPS

Desired FPS this scene should run

Properties:

Name	Type	Description
desiredFPS	Number

Default Value:

• 60

Source:

• Game.js, line 25

---

entities :Array.<Entity>

List of entities in the game world.

Type:

• Array.<Entity>

Source:

• Game.js, line 44

---

namedEntities :Object

Holding all the named entities(has name been set).

Type:

• Object

Source:

• Game.js, line 49

---

systemOrder

List of system updating order.
Note: systemOrder should only be modified after systems added!

Properties:

Name	Type	Description
systemOrder	Array.<String>

Source:

• Game.js, line 38

---

systems

Map of added systems

Properties:

Name	Type	Description
systems	Object

Source:

• Game.js, line 31

---

taggedEntities :Object

Holding all the tagged entities(has tag been set).

Type:

• Object

Source:

• Game.js, line 54

Methods

---

addSystem(sys)

Add a system instance to this game.

Parameters:

Name	Type	Description
sys	System	System instance to add

Source:

• Game.js, line 229

Returns:

Self for chaining

Type

Game

---

awake()

Awake is called when this scene is activated.

Source:

• Game.js, line 131

---

fixedUpdate(delta, deltaSec)

Fixed update is called in a constant frenquence decided by desiredFPS.

Parameters:

Name	Type	Description
delta	Number	Delta time in millisecond
deltaSec	Number	Delta time in second

Source:

• Game.js, line 180

---

freeze()

Freeze is called when this scene is deactivated(switched to another one)

Source:

• Game.js, line 214

---

pause()

System pause callback.

Source:

• Game.js, line 255

---

resize(w, h)

Resize callback.

Parameters:

Name	Type	Description
w	Number	New window width
h	Number	New window height

Source:

• Game.js, line 429

---

resume()

System resume callback.

Source:

• Game.js, line 269

---

<protected> run(timestamp)

Called each single frame by engine core, support both idle and fixed update.
Using a modified fixed update implementation from Phaser by @photonstorm

Parameters:

Name	Type	Description
timestamp	Number	Timestamp at this invoking

Source:

• Game.js, line 79

---

spawnEntity(type, x, y, layer, settings)

Spawn an Entity into game world.

Parameters:

Name	Type	Description
type	Class	Entity class
x	Number	X coordinate
y	Number	Y coordinate
layer	String	Name of the layer to added to
settings	Object	Instance settings

Source:

• Game.js, line 284

Returns:

Entity instance

Type

Entity

---

update(delta, deltaSec)

Update is called every single frame.

Parameters:

Name	Type	Description
delta	Number	Delta time in millisecond
deltaSec	Number	Delta time in second

Source:

• Game.js, line 146

Members

---

desiredFPS

Desired FPS this scene should run

Properties:

Name	Type	Description
desiredFPS	Number

Default Value:

• 60

Source:

• Game.js, line 25

---

entities :Array.<Entity>

List of entities in the game world.

Type:

• Array.<Entity>

Source:

• Game.js, line 44

---

namedEntities :Object

Holding all the named entities(has name been set).

Type:

• Object

Source:

• Game.js, line 49

---

systemOrder

List of system updating order.
Note: systemOrder should only be modified after systems added!

Properties:

Name	Type	Description
systemOrder	Array.<String>

Source:

• Game.js, line 38

---

systems

Map of added systems

Properties:

Name	Type	Description
systems	Object

Source:

• Game.js, line 31

---

taggedEntities :Object

Holding all the tagged entities(has tag been set).

Type:

• Object

Source:

• Game.js, line 54

Methods

---

addSystem(sys)

Add a system instance to this game.

Parameters:

Name	Type	Description
sys	System	System instance to add

Source:

• Game.js, line 229

Returns:

Self for chaining

Type

Game

---

awake()

Awake is called when this scene is activated.

Source:

• Game.js, line 131

---

fixedUpdate(delta, deltaSec)

Fixed update is called in a constant frenquence decided by desiredFPS.

Parameters:

Name	Type	Description
delta	Number	Delta time in millisecond
deltaSec	Number	Delta time in second

Source:

• Game.js, line 180

---

freeze()

Freeze is called when this scene is deactivated(switched to another one)

Source:

• Game.js, line 214

---

pause()

System pause callback.

Source:

• Game.js, line 255

---

resize(w, h)

Resize callback.

Parameters:

Name	Type	Description
w	Number	New window width
h	Number	New window height

Source:

• Game.js, line 429

---

resume()

System resume callback.

Source:

• Game.js, line 269

---

<protected> run(timestamp)

Called each single frame by engine core, support both idle and fixed update.
Using a modified fixed update implementation from Phaser by @photonstorm

Parameters:

Name	Type	Description
timestamp	Number	Timestamp at this invoking

Source:

• Game.js, line 79

---

spawnEntity(type, x, y, layer, settings)

Spawn an Entity into game world.

Parameters:

Name	Type	Description
type	Class	Entity class
x	Number	X coordinate
y	Number	Y coordinate
layer	String	Name of the layer to added to
settings	Object	Instance settings

Source:

• Game.js, line 284

Returns:

Entity instance

Type

Entity

---

update(delta, deltaSec)

Update is called every single frame.

Parameters:

Name	Type	Description
delta	Number	Delta time in millisecond
deltaSec	Number	Delta time in second

Source:

• Game.js, line 146