Phaser Global

Methods

bottom() → {number}

The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.

Source:

physics/arcade/Body.js, line 581

Returns:

Type: number

bottom(value)

The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.

Parameters:

Name	Type	Description
`value`	number

Source:

physics/arcade/Body.js, line 590

HEXtoRGB(hex) → {array}

Converts a hex color number to an [R, G, B] array

Parameters:

Name	Type	Description
`hex`	number

Source:

utils/Utils.js, line 243

Returns:

Type: array

render(displayObject, position, clear)

This function will draw the display object to the texture. If the display object is a Group or has children it will draw all children as well.

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	DisplayObject			The display object to render this texture on.
`position`	Phaser.Point	<optional>		Where to draw the display object.
`clear`	boolean	<optional>	false	If true the texture will be cleared before the displayObject is drawn.

Source:

gameobjects/RenderTexture.js, line 71

renderXY(displayObject, x, y, clear)

This function will draw the display object to the texture at the given x/y coordinates. If the display object is a Group or has children it will draw all children as well.

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	DisplayObject			The display object to render this texture on.
`x`	number			The x coordinate to draw the display object at.
`y`	number			The y coordinate to draw the display object at.
`clear`	boolean	<optional>	false	If true the texture will be cleared before the displayObject is drawn.

Source:

gameobjects/RenderTexture.js, line 101

right() → {number}

The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties. However it does affect the width property.

Source:

physics/arcade/Body.js, line 616

Returns:

Type: number

right(value)

The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties. However it does affect the width property.

Parameters:

Name	Type	Description
`value`	number

Source:

physics/arcade/Body.js, line 626