Global

Members

originalEvent

The original event currently being proxied; the getters will follow suit.

Source - input/Mouse.js, line 618

Methods

clone() → {Phaser.Frame}

Clones this Frame into a new Phaser.Frame object and returns it. Note that all properties are cloned, including the name, index and UUID.

Returns:

Phaser.Frame -

An exact copy of this Frame object.

Source - animation/Frame.js, line 168

clone() → {Phaser.FrameData}

Makes a copy of this FrameData including copies (not references) to all of the Frames it contains.

Returns:

Phaser.FrameData -

A clone of this object, including clones of the Frame objects it contains.

Source - animation/FrameData.js, line 108

createCustomLayer(width, height, children) → {Phaser.FlexLayer}

A custom layer is centered on the game and maintains its aspect ratio as it scales up and down.

Parameters:

Name	Type	Argument	Description
width	number		Width of this layer in pixels.
height	number		Height of this layer in pixels.
children	array	<optional>	An array of children that are used to populate the FlexLayer.

Returns:

Phaser.FlexLayer -

The Layer object.

Source - core/FlexGrid.js, line 104

createFixedLayer(children) → {Phaser.FlexLayer}

A fixed layer is centered on the game and is the size of the required dimensions and is never scaled.

Parameters:

Name	Type	Argument	Description
children	array	<optional>	An array of children that are used to populate the FlexLayer.

Returns:

Phaser.FlexLayer -

The Layer object.

Source - core/FlexGrid.js, line 194

createFluidLayer(children) → {Phaser.FlexLayer}

A fluid layer is centered on the game and maintains its aspect ratio as it scales up and down.

Parameters:

Name	Type	Argument	Description
children	array	<optional>	An array of children that are used to populate the FlexLayer.

Returns:

Phaser.FlexLayer -

The Layer object.

Source - core/FlexGrid.js, line 141

createFullLayer(children) → {Phaser.FlexLayer}

A full layer is placed at 0,0 and extends to the full size of the game. Children are scaled according to the fluid ratios.

Parameters:

Name	Type	Argument	Description
children	array	<optional>	An array of children that are used to populate the FlexLayer.

Returns:

Phaser.FlexLayer -

The Layer object.

Source - core/FlexGrid.js, line 170

debug()

Call in the render function to output the bounds rects.

Source - core/FlexGrid.js, line 293

<internal> destroy()

Destroys the ScaleManager and removes any event listeners. This should probably only be called when the game is destroyed.

Internal:

• This member is internal (protected) and may be modified or removed in the future.

Source - core/ScaleManager.js, line 1874

destroy()

Removes all events.

Source - gameobjects/Events.js, line 127

destroy()

Destroys this object and the associated event listeners.

Source - input/Gamepad.js, line 466

destroy()

Destroys this object and associated callback references.

Source - input/SinglePad.js, line 297

onResize(width, height)

Called when the game container changes dimensions.

Parameters:

Name	Type	Description
width	number	The new width of the game container.
height	number	The new height of the game container.

Source - core/FlexGrid.js, line 240

refresh()

Updates all internal vars such as the bounds and scale values.

Source - core/FlexGrid.js, line 256

reset()

Resets the layer children references

Source - core/FlexGrid.js, line 218

setSize(width, height)

Sets the core game size. This resets the w/h parameters and bounds.

Parameters:

Name	Type	Description
width	number	The new dimensions.
height	number	The new dimensions.

Source - core/FlexGrid.js, line 77