World Event

This is the World Event for the game.

The events that messenger will receive from outside

Basically users don't need to deal with the world events, they work with user events instead.

User Event

This is the User Event for the game.

Users can get outside information through these events.

Tick is triggered every timeInterval. The int attacked to it is

KeyDown, KeyUp records the keyboard events. "KeyDown" event is sent when the key is pressed, "KeyUp" is sent when the key is released.

• Note: if you just want to check if a key is pressed or not, use globalData.pressedKeys instead. check all the keycodes here.

MouseDown, MouseUp records the button code and position when mouse up and down. Mouse code 0 represents the left mouse button, 1 represents middle mouse button and 2 represents right mouse button.

We have provide some key and mouse codes in messenger-extra.

MouseWheel records the wheel event for mouse, positive value means scrolling down while negative value means scrolling up. It can be also used for touchpad.

Prompt name result gives the result user entered in the prompt window.

GlobalData

GlobalData is the data that doesn't change during the game.

It won't be reset if you change the scene.

It is mainly used for display and reading/writing some localstorage data.

• globalStartFrame records the past frames number since the game started
• globalStartTime records the past time since the game started, in milliseconds
• sceneStartFrame records the past frames number since this scene started
• sceneStartTime records the past time since this scene started, in milliseconds
• userdata records the data that users set to save
• extraHTML is used to render extra HTML tags. Be careful to use this
• windowVisibility records whether users stay in this tab/window
• pressedKeys records the keycodes that are be pressed now
• pressedMouseButtons records the mouse buttons that are pressed now
• volume records the volume of the game
• currentScene records the current scene name
• mousePos records the mouse position, in virtual coordinate
• camera records the camera position and zoom level

Internal GlobalData

Basically users do not need to get or modify them.

• browserViewPort records the browser size.
• sprites records all the sprites(images).

Environment

Environment is provided to users almost all the time.

It stores GlobalData and CommonData (Similar to GlobalData but just for one scene), so you can get and modify them through the Env.

The main flags.

Get info from js script.

Learn more about flags here

Remove common data from environment.

Useful when dealing with portable components by yourself.

Most of the time it will not be used since it has been built into prepared update functions.

Add the common data to a Environment without common data.

This type is for user to use when initializing the messenger. It is very useful when dealing with local storage.

Empty InternalData

Turn UserViewGlobalData into GlobalData

Turn GlobalData into UserViewGlobalData