Module: engine/core

Requires

• module:engine/polyfill
• module:engine/EventEmitter
• module:engine/Vector
• module:engine/resize
• module:engine/device

Members

---

<static> containerView :HTMLCanvasElement

Div that contains game canvas.

Type:

• HTMLCanvasElement

Source:

• core.js, line 44

---

<static> game :Game

Current activated game.
Note: this may be undefined during switching.
Will be deprecated in future versions.

Type:

• Game

Source:

• core.js, line 86

---

<static> games :object

Map of registered games.

Type:

• object

Source:

• core.js, line 78

---

<static> pauses :object

Map that contains pause state of all kinds of reasons.
See core.pause for more information.

Type:

• object

Source:

• core.js, line 94

---

<static> resizeFunc :function

Current resize function.

Type:

• function

Source:

• core.js, line 71

---

<static> resolution :Number

Canvas resolution properly choosed based on configs.

Type:

• Number

Source:

• core.js, line 51

---

<static> rotatePromptElm :HTMLElement

Rotate prompt element for mobile devices.

Type:

• HTMLElement

Source:

• core.js, line 109

---

<static> rotatePromptVisible :boolean

Whether the rotate prompt is visible.

Type:

• boolean

Source:

• core.js, line 115

---

<static> sayHello :Boolean

Set to false to disable version info console output.

Type:

• Boolean

Source:

• core.js, line 30

---

<static> size :Vector

Size of game content.

Type:

• Vector

Default Value:

• (640, 400)

Source:

• core.js, line 59

---

<static> speed :number

Global time speed, whose value is between 0 and 1.

Type:

• number

Default Value:

• 1

Source:

• core.js, line 102

---

<static> version :string

Version text.

Type:

• string

Source:

• core.js, line 23

---

<static> view :HTMLCanvasElement

Main Canvas element.

Type:

• HTMLCanvasElement

Source:

• core.js, line 37

---

<static> viewSize :Vector

Size of view (devicePixelRatio independent).

Type:

• Vector

Source:

• core.js, line 65

Methods

---

<static> main(gameCtor, loaderCtor)

Main entry.

Parameters:

Name	Type	Description
gameCtor	Game	First game class
loaderCtor	Game	Asset loader class

Source:

• core.js, line 148

---

<static> pause( [reason])

Pause the engine with a reason.

Parameters:

Name	Type	Argument	Default	Description
reason	String	<optional>	'untitled'	The reason to pause, you have to pass the same reason when resume from this pause.

Source:

• core.js, line 170

Example

import core from 'engine/core';
// Pause when ad is playing
core.pause('ad');
// And resume after the ad finished
core.resume('ad');

---

<static> resume( [reason] [, force])

Unpause the engine.

Parameters:

Name	Type	Argument	Default	Description
reason	String	<optional>	'untitled'	Resume from pause tagged with this reason
force	Boolean	<optional>	false	Whether force to resume

Source:

• core.js, line 194

---

<static> setGame(gameCtor [, newInstance] [, param])

Switch to a game.

Parameters:

Name	Type	Argument	Default	Description
gameCtor	Game			Game class to be set
newInstance	Boolean	<optional>	false	Whether create new instance for this game.
param	Object	<optional>	{}	Parameters to pass to the game(to Game#awake)

Source:

• core.js, line 124