Phaser Class: World

new World(game)

"This world is but a canvas to our imagination." - Henry David Thoreau

<p> A game has only one world. The world is an abstract place in which all game objects live. It is not bound by stage limits and can be any size. You look into the world via cameras. All game objects live within the world at world-based coordinates. By default a world is created the same size as your Stage.

Parameters:

Name	Type	Description
`game`	Phaser.Game	Reference to the current game instance.

Source:

core/World.js, line 18

Members

bounds

Properties:

Name	Type	Description
`bounds`	Phaser.Rectangle	Bound of this world that objects can not escape from.

Source:

core/World.js, line 28

camera

Properties:

Name	Type	Description
`camera`	Phaser.Camera	Camera instance.

Source:

core/World.js, line 33

<readonly> centerX

Properties:

Name	Type	Description
`centerX`	number	Gets the X position corresponding to the center point of the world.

Source:

core/World.js, line 192

<readonly> centerY

Properties:

Name	Type	Description
`centerY`	number	Gets the Y position corresponding to the center point of the world.

Source:

core/World.js, line 205

currentRenderOrderID

Properties:

Name	Type	Description
`currentRenderOrderID`	number	Reset each frame, keeps a count of the total number of objects updated.

Source:

core/World.js, line 38

game

Properties:

Name	Type	Description
`game`	Phaser.Game	A reference to the currently running Game.

Source:

core/World.js, line 23

group

Properties:

Name	Type	Description
`group`	Phaser.Group	Object container stores every object created with `create*` methods.

Source:

core/World.js, line 43

height

Properties:

Name	Type	Description
`height`	number	Gets or sets the current height of the game world.

Source:

core/World.js, line 176

<readonly> randomX

Properties:

Name	Type	Description
`randomX`	number	Gets a random integer which is lesser than or equal to the current width of the game world.

Source:

core/World.js, line 218

<readonly> randomY

Properties:

Name	Type	Description
`randomY`	number	Gets a random integer which is lesser than or equal to the current height of the game world.

Source:

core/World.js, line 231

width

Properties:

Name	Type	Description
`width`	number	Gets or sets the current width of the game world.

Source:

core/World.js, line 160

Methods

<protected> boot()

Initialises the game world.

Source:

core/World.js, line 49

destroy()

Destroyer of worlds.

Source:

core/World.js, line 143

postUpdate()

This is called automatically every frame, and is where main logic happens.

Source:

core/World.js, line 99

setSize(width, height)

Updates the size of this world.

Parameters:

Name	Type	Description
`width`	number	New width of the world.
`height`	number	New height of the world.

Source:

core/World.js, line 123

update()

This is called automatically every frame, and is where main logic happens.

Source:

core/World.js, line 65