Methods

addChild (child) → { PIXI.DisplayObject}

Adds a child to the container.

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject to add to the container

Returns:

PIXI.DisplayObject-

The child that was added.

Inherited From:

• PIXI.DisplayObjectContainer#addChild

Source - pixi/display/DisplayObjectContainer.js, line 91

addChildAt (child, index) → { PIXI.DisplayObject}

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	The child to add
index	Number	The index to place the child in

Returns:

PIXI.DisplayObject-

The child that was added.

Inherited From:

• PIXI.DisplayObjectContainer#addChildAt

Source - pixi/display/DisplayObjectContainer.js, line 103

bringToTop () → { PIXI.DisplayObject}

Brings this Game Object to the top of its parents display list. Visually this means it will render over the top of any old child in the same Group.

If this Game Object hasn't been added to a custom Group then this method will bring it to the top of the Game World, because the World is the root Group from which all Game Objects descend.

Returns:

PIXI.DisplayObject-

This instance.

Inherited From:

• Phaser.Component.BringToTop#bringToTop

Source - gameobjects/components/BringToTop.js, line 24

clearFrames ()

Clears all of the frames set on this Button.

Source - gameobjects/Button.js, line 233

crop (rect, copy)

Crop allows you to crop the texture being used to display this Game Object. Setting a crop rectangle modifies the core texture frame. The Game Object width and height properties will be adjusted accordingly.

Cropping takes place from the top-left and can be modified in real-time either by providing an updated rectangle object to this method, or by modifying cropRectproperty directly and then calling updateCrop.

The rectangle object given to this method can be either a Phaser.Rectangleor any other object so long as it has public x, y, width, height, rightand bottomproperties.

A reference to the rectangle is stored in cropRectunless the copyparameter is true, in which case the values are duplicated to a local object.

Parameters:

Name	Type	Argument	Default	Description
rect	Phaser.Rectangle			The Rectangle used during cropping. Pass null or no parameters to clear a previously set crop rectangle.
copy	boolean	<optional>	false	If false cropRectwill be stored as a reference to the given rect. If true it will copy the rect values into a local Phaser Rectangle object stored in cropRect.

Inherited From:

• Phaser.Component.Crop#crop

Source - gameobjects/components/Crop.js, line 49

destroy ()

Destroy this DisplayObject. Removes all references to transformCallbacks, its parent, the stage, filters, bounds, mask and cached Sprites.

Inherited From:

• PIXI.DisplayObject#destroy

Source - pixi/display/DisplayObject.js, line 223

generateTexture (resolution, scaleMode, renderer) → { PIXI.Texture}

Useful function that returns a texture of the displayObject object that can then be used to create sprites This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

Parameters:

Name	Type	Description
resolution	Number	The resolution of the texture being generated
scaleMode	Number	See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values
renderer	PIXI.CanvasRenderer| PIXI.WebGLRenderer	The renderer used to generate the texture.

Returns:

PIXI.Texture-

a texture of the graphics object

Inherited From:

• PIXI.DisplayObject#generateTexture

Source - pixi/display/DisplayObject.js, line 542

getBounds (matrix) → {Rectangle}

Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.

Parameters:

Name	Type	Description
matrix	Matrix	the transformation matrix of the sprite

Returns:

Rectangle-

the framing rectangle

Inherited From:

• PIXI.Sprite#getBounds

Source - pixi/display/Sprite.js, line 193

getChildAt (index) → { PIXI.DisplayObject}

Returns the child at the specified index

Parameters:

Name	Type	Description
index	Number	The index to get the child from

Returns:

PIXI.DisplayObject-

The child at the given index, if any.

Inherited From:

• PIXI.DisplayObjectContainer#getChildAt

Source - pixi/display/DisplayObjectContainer.js, line 194

getChildIndex (child) → {Number}

Returns the index position of a child DisplayObject instance

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject instance to identify

Returns:

Number-

The index position of the child display object to identify

Inherited From:

• PIXI.DisplayObjectContainer#getChildIndex

Source - pixi/display/DisplayObjectContainer.js, line 159

getLocalBounds () → {Rectangle}

Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.

Returns:

Rectangle-

The rectangular bounding area

Inherited From:

• PIXI.DisplayObjectContainer#getLocalBounds

Source - pixi/display/DisplayObjectContainer.js, line 367

kill () → { PIXI.DisplayObject}

Kills a Game Object. A killed Game Object has its alive, existsand visibleproperties all set to false.

It will dispatch the onKilledevent. You can listen to events.onKilledfor the signal.

Note that killing a Game Object is a way for you to quickly recycle it in an object pool, it doesn't destroy the object or free it up from memory.

If you don't need this Game Object any more you should call destroyinstead.

Returns:

PIXI.DisplayObject-

This instance.

Inherited From:

• Phaser.Component.LifeSpan#kill

Source - gameobjects/components/LifeSpan.js, line 113

loadTexture (key, frame, stopAnimation)

Changes the base texture the Game Object is using. The old texture is removed and the new one is referenced or fetched from the Cache.

If your Game Object is using a frame from a texture atlas and you just wish to change to another frame, then see the frameor frameNameproperties instead.

You should only use loadTextureif you want to replace the base texture entirely.

Calling this method causes a WebGL texture update, so use sparingly or in low-intensity portions of your game, or if you know the new texture is already on the GPU.

You can use the new const Phaser.PENDING_ATLASas the texture key for any sprite. Doing this then sets the key to be the frameargument (the frame is set to zero).

This allows you to create sprites using load.imageduring development, and then change them to use a Texture Atlas later in development by simply searching your code for 'PENDING_ATLAS' and swapping it to be the key of the atlas data.

Parameters:

Name	Type	Argument	Default	Description
key	string| Phaser.RenderTexture| Phaser.BitmapData| Phaser.Video| PIXI.Texture			This is the image or texture used by the Sprite during rendering. It can be a string which is a reference to the Cache Image entry, or an instance of a RenderTexture, BitmapData, Video or PIXI.Texture.
frame	string| number	<optional>		If this Sprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
stopAnimation	boolean	<optional>	true	If an animation is already playing on this Sprite you can choose to stop it or let it carry on playing.

Inherited From:

• Phaser.Component.LoadTexture#loadTexture

Source - gameobjects/components/LoadTexture.js, line 49

moveDown () → { PIXI.DisplayObject}

Moves this Game Object down one place in its parents display list. This call has no effect if the Game Object is already at the bottom of the display list.

If this Game Object hasn't been added to a custom Group then this method will move it one object down within the Game World, because the World is the root Group from which all Game Objects descend.

Returns:

PIXI.DisplayObject-

This instance.

Inherited From:

• Phaser.Component.BringToTop#moveDown

Source - gameobjects/components/BringToTop.js, line 87

moveUp () → { PIXI.DisplayObject}

Moves this Game Object up one place in its parents display list. This call has no effect if the Game Object is already at the top of the display list.

If this Game Object hasn't been added to a custom Group then this method will move it one object up within the Game World, because the World is the root Group from which all Game Objects descend.

Returns:

PIXI.DisplayObject-

This instance.

Inherited From:

• Phaser.Component.BringToTop#moveUp

Source - gameobjects/components/BringToTop.js, line 66

<internal>onInputDownHandler (sprite, pointer)

Internal function that handles input events.

Parameters:

Name	Type	Description
sprite	Phaser.Button	The Button that the event occurred on.
pointer	Phaser.Pointer	The Pointer that activated the Button.

Internal:

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

Source - gameobjects/Button.js, line 531

<internal>onInputOutHandler (sprite, pointer)

Internal function that handles input events.

Parameters:

Name	Type	Description
sprite	Phaser.Button	The Button that the event occurred on.
pointer	Phaser.Pointer	The Pointer that activated the Button.

Internal:

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

Source - gameobjects/Button.js, line 511

<internal>onInputOverHandler (sprite, pointer)

Internal function that handles input events.

Parameters:

Name	Type	Description
sprite	Phaser.Button	The Button that the event occurred on.
pointer	Phaser.Pointer	The Pointer that activated the Button.

Internal:

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

Source - gameobjects/Button.js, line 478

<internal>onInputUpHandler (sprite, pointer)

Internal function that handles input events.

Parameters:

Name	Type	Description
sprite	Phaser.Button	The Button that the event occurred on.
pointer	Phaser.Pointer	The Pointer that activated the Button.

Internal:

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

Source - gameobjects/Button.js, line 551

overlap (displayObject) → {boolean}

Checks to see if the bounds of this Game Object overlaps with the bounds of the given Display Object, which can be a Sprite, Image, TileSprite or anything that extends those such as Button or provides a getBoundsmethod and result.

This check ignores the hitAreaproperty if set and runs a getBoundscomparison on both objects to determine the result.

Therefore it's relatively expensive to use in large quantities, i.e. with lots of Sprites at a high frequency. It should be fine for low-volume testing where physics isn't required.

Parameters:

Name	Type	Description
displayObject	Phaser.Sprite| Phaser.Image| Phaser.TileSprite| Phaser.Button| PIXI.DisplayObject	The display object to check against.

Returns:

boolean-

True if the bounds of this Game Object intersects at any point with the bounds of the given display object.

Inherited From:

• Phaser.Component.Overlap#overlap

Source - gameobjects/components/Overlap.js, line 29

play (name, frameRate, loop, killOnComplete) → { Phaser.Animation}

Plays an Animation.

The animation should have previously been created via animations.add.

If the animation is already playing calling this again won't do anything. If you need to reset an already running animation do so directly on the Animation object itself or via AnimationManager.stop.

Parameters:

Name	Type	Argument	Default	Description
name	string			The name of the animation to be played, e.g. "fire", "walk", "jump". Must have been previously created via 'AnimationManager.add'.
frameRate	number	<optional>	null	The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.
loop	boolean	<optional>	false	Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.
killOnComplete	boolean	<optional>	false	If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.

Returns:

Phaser.Animation-

A reference to playing Animation.

Inherited From:

• Phaser.Component.Animation#play

Source - gameobjects/components/Animation.js, line 31

<internal>postUpdate ()

Internal method called by the World postUpdate cycle.

Inherited From:

• Phaser.Component.Core#postUpdate

Internal:

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

Source - gameobjects/components/Core.js, line 331

preUpdate ()

Automatically called by World.preUpdate.

Inherited From:

• Phaser.Image#preUpdate

Source - gameobjects/Image.js, line 77

removeChild (child) → { PIXI.DisplayObject}

Removes a child from the container.

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	The DisplayObject to remove

Returns:

PIXI.DisplayObject-

The child that was removed.

Inherited From:

• PIXI.DisplayObjectContainer#removeChild

Source - pixi/display/DisplayObjectContainer.js, line 211

removeChildAt (index) → { PIXI.DisplayObject}

Removes a child from the specified index position.

Parameters:

Name	Type	Description
index	Number	The index to get the child from

Returns:

PIXI.DisplayObject-

The child that was removed.

Inherited From:

• PIXI.DisplayObjectContainer#removeChildAt

Source - pixi/display/DisplayObjectContainer.js, line 226

removeChildren (beginIndex, endIndex)

Removes all children from this container that are within the begin and end indexes.

Parameters:

Name	Type	Description
beginIndex	Number	The beginning position. Default value is 0.
endIndex	Number	The ending position. Default value is size of the container.

Inherited From:

• PIXI.DisplayObjectContainer#removeChildren

Source - pixi/display/DisplayObjectContainer.js, line 244

<internal>removedFromWorld ()

Called when this Button is removed from the World.

Internal:

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

Source - gameobjects/Button.js, line 244

removeStageReference ()

Removes the current stage reference from the container and all of its children.

Inherited From:

• PIXI.DisplayObjectContainer#removeStageReference

Source - pixi/display/DisplayObjectContainer.js, line 407

reset (x, y, health) → { PIXI.DisplayObject}

Resets the Game Object.

This moves the Game Object to the given x/y world coordinates and sets fresh, exists, visibleand renderableto true.

If this Game Object has the LifeSpan component it will also set aliveto true and healthto the given value.

If this Game Object has a Physics Body it will reset the Body.

Parameters:

Name	Type	Argument	Default	Description
x	number			The x coordinate (in world space) to position the Game Object at.
y	number			The y coordinate (in world space) to position the Game Object at.
health	number	<optional>	1	The health to give the Game Object if it has the Health component.

Returns:

PIXI.DisplayObject-

This instance.

Inherited From:

• Phaser.Component.Reset#reset

Source - gameobjects/components/Reset.js, line 30

resetFrame ()

Resets the texture frame dimensions that the Game Object uses for rendering.

Inherited From:

• Phaser.Component.LoadTexture#resetFrame

Source - gameobjects/components/LoadTexture.js, line 220

resizeFrame (parent, width, height)

Resizes the Frame dimensions that the Game Object uses for rendering.

You shouldn't normally need to ever call this, but in the case of special texture types such as Video or BitmapData it can be useful to adjust the dimensions directly in this way.

Parameters:

Name	Type	Description
parent	object	The parent texture object that caused the resize, i.e. a Phaser.Video object.
width	integer	The new width of the texture.
height	integer	The new height of the texture.

Inherited From:

• Phaser.Component.LoadTexture#resizeFrame

Source - gameobjects/components/LoadTexture.js, line 208

revive ( health) → { PIXI.DisplayObject}

Brings a 'dead' Game Object back to life, optionally resetting its health value in the process.

A resurrected Game Object has its alive, existsand visibleproperties all set to true.

It will dispatch the onRevivedevent. Listen to events.onRevivedfor the signal.

Parameters:

Name	Type	Argument	Default	Description
health	number	<optional>	100	The health to give the Game Object. Only set if the GameObject has the Health component.

Returns:

PIXI.DisplayObject-

This instance.

Inherited From:

• Phaser.Component.LifeSpan#revive

Source - gameobjects/components/LifeSpan.js, line 78

sendToBack () → { PIXI.DisplayObject}

Sends this Game Object to the bottom of its parents display list. Visually this means it will render below all other children in the same Group.

If this Game Object hasn't been added to a custom Group then this method will send it to the bottom of the Game World, because the World is the root Group from which all Game Objects descend.

Returns:

PIXI.DisplayObject-

This instance.

Inherited From:

• Phaser.Component.BringToTop#sendToBack

Source - gameobjects/components/BringToTop.js, line 45

setChildIndex (child, index)

Changes the position of an existing child in the display object container

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	The child DisplayObject instance for which you want to change the index number
index	Number	The resulting index number for the child display object

Inherited From:

• PIXI.DisplayObjectContainer#setChildIndex

Source - pixi/display/DisplayObjectContainer.js, line 176

setDownSound (sound, marker)

The Sound to be played when a Pointer presses down on this Button.

Parameters:

Name	Type	Argument	Description
sound	Phaser.Sound| Phaser.AudioSprite		The Sound that will be played.
marker	string	<optional>	A Sound Marker that will be used in the playback.

Source - gameobjects/Button.js, line 450

setFrame (frame)

Sets the texture frame the Game Object uses for rendering.

This is primarily an internal method used by loadTexture, but is exposed for the use of plugins and custom classes.

Parameters:

Name	Type	Description
frame	Phaser.Frame	The Frame to be used by the texture.

Inherited From:

• Phaser.Component.LoadTexture#setFrame

Source - gameobjects/components/LoadTexture.js, line 143

setFrames ( overFrame, outFrame, downFrame, upFrame)

Used to manually set the frames that will be used for the different states of the Button.

Frames can be specified as either an integer (the frame ID) or a string (the frame name); these are the same values that can be used with a Sprite constructor.

Parameters:

Name	Type	Argument	Description
overFrame	string| integer	<optional>	The frame / frameName when the button is in the Over state.
outFrame	string| integer	<optional>	The frame / frameName when the button is in the Out state.
downFrame	string| integer	<optional>	The frame / frameName when the button is in the Down state.
upFrame	string| integer	<optional>	The frame / frameName when the button is in the Up state.

Source - gameobjects/Button.js, line 320

setOutSound (sound, marker)

The Sound to be played when a Pointer moves out of this Button.

Parameters:

Name	Type	Argument	Description
sound	Phaser.Sound| Phaser.AudioSprite		The Sound that will be played.
marker	string	<optional>	A Sound Marker that will be used in the playback.

Source - gameobjects/Button.js, line 436

setOverSound (sound, marker)

The Sound to be played when a Pointer moves over this Button.

Parameters:

Name	Type	Argument	Description
sound	Phaser.Sound| Phaser.AudioSprite		The Sound that will be played.
marker	string	<optional>	A Sound Marker that will be used in the playback.

Source - gameobjects/Button.js, line 422

setSounds ( overSound, overMarker, downSound, downMarker, outSound, outMarker, upSound, upMarker)

Sets the sounds to be played whenever this Button is interacted with. Sounds can be either full Sound objects, or markers pointing to a section of a Sound object. The most common forms of sounds are 'hover' effects and 'click' effects, which is why the order of the parameters is overSound then downSound.

Call this function with no parameters to reset all sounds on this Button.

Parameters:

Name	Type	Argument	Description
overSound	Phaser.Sound| Phaser.AudioSprite	<optional>	Over Button Sound.
overMarker	string	<optional>	Over Button Sound Marker.
downSound	Phaser.Sound| Phaser.AudioSprite	<optional>	Down Button Sound.
downMarker	string	<optional>	Down Button Sound Marker.
outSound	Phaser.Sound| Phaser.AudioSprite	<optional>	Out Button Sound.
outMarker	string	<optional>	Out Button Sound Marker.
upSound	Phaser.Sound| Phaser.AudioSprite	<optional>	Up Button Sound.
upMarker	string	<optional>	Up Button Sound Marker.

Source - gameobjects/Button.js, line 396

setStageReference (stage)

Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.

Parameters:

Name	Type	Description
stage	Stage	the stage that the container will have as its current stage reference

Inherited From:

• PIXI.DisplayObjectContainer#setStageReference

Source - pixi/display/DisplayObjectContainer.js, line 391

setTexture (texture, destroy)

Sets the texture of the sprite. Be warned that this doesn't remove or destroy the previous texture this Sprite was using.

Parameters:

Name	Type	Argument	Default	Description
texture	PIXI.Texture			The PIXI texture that is displayed by the sprite
destroy	Boolean	<optional>	false	Call Texture.destroy on the current texture before replacing it with the new one?

Inherited From:

• PIXI.Sprite#setTexture

Source - pixi/display/Sprite.js, line 158

setUpSound (sound, marker)

The Sound to be played when a Pointer has pressed down and is released from this Button.

Parameters:

Name	Type	Argument	Description
sound	Phaser.Sound| Phaser.AudioSprite		The Sound that will be played.
marker	string	<optional>	A Sound Marker that will be used in the playback.

Source - gameobjects/Button.js, line 464

swapChildren (child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters:

Name	Type	Description
child	PIXI.DisplayObject	-
child2	PIXI.DisplayObject	-

Inherited From:

• PIXI.DisplayObjectContainer#swapChildren

Source - pixi/display/DisplayObjectContainer.js, line 134

toGlobal (position) → {Point}

Calculates the global position of the display object

Parameters:

Name	Type	Description
position	Point	The world origin to calculate from

Returns:

Point-

A point object representing the position of this object

Inherited From:

• PIXI.DisplayObject#toGlobal

Source - pixi/display/DisplayObject.js, line 576

toLocal (position, from) → {Point}

Calculates the local position of the display object relative to another point

Parameters:

Name	Type	Argument	Description
position	Point		The world origin to calculate from
from	PIXI.DisplayObject	<optional>	The DisplayObject to calculate the global position from

Returns:

Point-

A point object representing the position of this object

Inherited From:

• PIXI.DisplayObject#toLocal

Source - pixi/display/DisplayObject.js, line 590

update ()

Override this method in your own custom objects to handle any update requirements. It is called immediately after preUpdateand before postUpdate. Remember if this Game Object has any children you should call update on those too.

Inherited From:

• Phaser.Component.Core#update

Source - gameobjects/components/Core.js, line 321

updateCache ()

Generates and updates the cached sprite for this object.

Inherited From:

• PIXI.DisplayObject#updateCache

Source - pixi/display/DisplayObject.js, line 566

updateCrop ()

If you have set a crop rectangle on this Game Object via cropand since modified the cropRectproperty, or the rectangle it references, then you need to update the crop frame by calling this method.

Inherited From:

• Phaser.Component.Crop#updateCrop

Source - gameobjects/components/Crop.js, line 86