Phaser Class: World

new World(game)

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

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 19

Extends

Phaser.Group

Members

<readonly> _definedSize :boolean

True if the World has been given a specifically defined size (i.e. from a Tilemap or direct in code) or false if it's just matched to the Game dimensions.

Source - core/World.js, line 41

_height

Source - core/World.js, line 51

_width

Name	Type	Description
`height`	number	The defined height of the World. Sometimes the bounds needs to grow larger than this (if you resize the game) but this retains the original requested dimension.

Source - core/World.js, line 46

alive :boolean

Name	Type	Description
`width`	number	The defined width of the World. Sometimes the bounds needs to grow larger than this (if you resize the game) but this retains the original requested dimension.

The alive property is useful for Groups that are children of other Groups and need to be included/excluded in checks like forEachAlive.

Inherited From:

Phaser.Group#alive

Default Value:

true

Source - core/Group.js, line 92

alpha :number

The alpha value of the group container.

Inherited From:

Phaser.Group#alpha

Source - core/Group.js, line 2100

angle :number

The angle of rotation of the group container, in degrees.

This adjusts the group itself by modifying its local rotation transform.

This has no impact on the rotation/angle properties of the children, but it will update their worldTransform and on-screen orientation and position.

Inherited From:

Phaser.Group#angle

Source - core/Group.js, line 2032

bounds :Phaser.Rectangle

The World has no fixed size, but it does have a bounds outside of which objects are no longer considered as being "in world" and you should use this to clean-up the display list and purge dead objects. By default we set the Bounds to be from 0,0 to Game.width,Game.height. I.e. it will match the size given to the game constructor with 0,0 representing the top-left of the display. However 0,0 is actually the center of the world, and if you rotate or scale the world all of that will happen from 0,0. So if you want to make a game in which the world itself will rotate you should adjust the bounds so that 0,0 is the center point, i.e. set them to -1000,-1000,2000,2000 for a 2000x2000 sized world centered around 0,0. Bound of this world that objects can not escape from.

Source - core/World.js, line 30

cacheAsBitmap :Boolean

Set if this display object is cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to 'null'

Inherited From:

PIXI.DisplayObject#cacheAsBitmap

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

camera :Phaser.Camera

Camera instance.

Source - core/World.js, line 35

cameraOffset :Phaser.Point

If this object is fixedToCamera then this stores the x/y position offset relative to the top-left of the camera view. If the parent of this Group is also fixedToCamera then the offset here is in addition to that and should typically be disabled.

Inherited From:

Phaser.Group#cameraOffset

Source - core/Group.js, line 186

<readonly> centerX :number

Gets the X position corresponding to the center point of the world.

Source - core/World.js, line 274

<readonly> centerY :number

Gets the Y position corresponding to the center point of the world.

Source - core/World.js, line 287

<readonly> children :Array.<DisplayObject>

[read-only] The array of children of this container.

Type:

Array.<DisplayObject>

Inherited From:

PIXI.DisplayObjectContainer#children

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

classType :object

The type of objects that will be created when using create or createMultiple.

Any object may be used but it should extend either Sprite or Image and accept the same constructor arguments: when a new object is created it is passed the following parameters to its constructor: (game, x, y, key, frame).

Inherited From:

Phaser.Group#classType

Default Value:

Phaser.Sprite

Source - core/Group.js, line 117

cursor :DisplayObject

The current display object that the group cursor is pointing to, if any. (Can be set manually.)

The cursor is a way to iterate through the children in a Group using next and previous.

Inherited From:

Phaser.Group#cursor

Source - core/Group.js, line 132

<readonly> cursorIndex :integer

The current index of the Group cursor. Advance it with Group.next.

Inherited From:

Phaser.Group#cursorIndex

Source - core/Group.js, line 169

enableBody :boolean

If true all Sprites created by, or added to this group, will have a physics body enabled on them.

The default body type is controlled with physicsBodyType.

Inherited From:

Phaser.Group#enableBody

Source - core/Group.js, line 140

enableBodyDebug :boolean

If true when a physics body is created (via enableBody) it will create a physics debug object as well.

This only works for P2 bodies.

Inherited From:

Phaser.Group#enableBodyDebug

Default Value:

false

Source - core/Group.js, line 149

exists :boolean

If exists is true the group is updated, otherwise it is skipped.

Inherited From:

Phaser.Group#exists

Default Value:

true

Source - core/Group.js, line 99

filterArea :Rectangle

The area the filter is applied to like the hitArea this is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Inherited From:

PIXI.DisplayObject#filterArea

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

filters :Array.<Filter>

Sets the filters for the displayObject. IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'

Type:

Array.<Filter>

Inherited From:

PIXI.DisplayObject#filters

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

fixedToCamera :boolean

A Group that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in Group.cameraOffset.

Note that the cameraOffset values are in addition to any parent in the display list. So if this Group was in a Group that has x: 200, then this will be added to the cameraOffset.x

Inherited From:

Phaser.Group#fixedToCamera

Source - core/Group.js, line 179

<internal> game :Phaser.Game

A reference to the currently running Game.

Inherited From:

Phaser.Group#game

Internal:

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

Source - core/Group.js, line 38

height :number

Gets or sets the current height of the game world. The world can never be smaller than the game (canvas) dimensions.

Source - core/World.js, line 249

hitArea :Rectangle|Circle|Ellipse|Polygon

This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)

Type:

Rectangle | Circle | Ellipse | Polygon

Inherited From:

PIXI.DisplayObject#hitArea

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

ignoreDestroy :boolean

A group with ignoreDestroy set to true ignores all calls to its destroy method.

Inherited From:

Phaser.Group#ignoreDestroy

Default Value:

false

Source - core/Group.js, line 106

<readonly> length :integer

Total number of children in this group, regardless of exists/alive status.

Inherited From:

Phaser.Group#length

Source - core/Group.js, line 2015

mask :PIXI.Graphics

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.

Inherited From:

PIXI.DisplayObject#mask

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

name :string

A name for this group. Not used internally but useful for debugging.

Inherited From:

Phaser.Group#name

Source - core/Group.js, line 49

onDestroy :Phaser.Signal

This signal is dispatched when the group is destroyed.

Inherited From:

Phaser.Group#onDestroy

Source - core/Group.js, line 163

<readonly> parent :PIXI.DisplayObjectContainer

[read-only] The display object container that contains this display object.

Inherited From:

PIXI.DisplayObject#parent

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

physicsBodyType :integer

If enableBody is true this is the type of physics body that is created on new Sprites.

The valid values are Phaser.Physics.ARCADE, Phaser.Physics.P2, Phaser.Physics.NINJA, etc.

Inherited From:

Phaser.Group#physicsBodyType

Source - core/Group.js, line 157

<readonly> physicsType :number

The const physics body type of this object.

Inherited From:

Phaser.Group#physicsType

Source - core/Group.js, line 85

pivot :Point

The pivot point of the displayObject that it rotates around

Inherited From:

PIXI.DisplayObject#pivot

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

position :Point

The coordinate of the object relative to the local coordinates of the parent.

Inherited From:

PIXI.DisplayObject#position

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

<readonly> 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 300

<readonly> 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 322

renderable :Boolean

Can this object be rendered

Inherited From:

PIXI.DisplayObject#renderable

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

rotation :number

The angle of rotation of the group container, in radians.

This will adjust the group container itself by modifying its rotation. This will have no impact on the rotation value of its children, but it will update their worldTransform and on-screen position.

Inherited From:

Phaser.Group#rotation

Source - core/Group.js, line 2084

scale :Phaser.Point

The scale of the group container.

Inherited From:

Phaser.Group#scale

Source - core/Group.js, line 124

<readonly> stage :PIXI.Stage

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

Inherited From:

PIXI.DisplayObject#stage

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

<readonly> total :integer

Total number of existing children in the group.

Inherited From:

Phaser.Group#total

Source - core/Group.js, line 1998

transformCallback :function

The transform callback is an optional callback that if set will be called at the end of the updateTransform method and sent two parameters: This Display Objects worldTransform matrix and its parents transform matrix. Both are PIXI.Matrix object types. The matrix are passed by reference and can be modified directly without needing to return them. This ability allows you to check any of the matrix values and perform actions such as clamping scale or limiting rotation, regardless of the parent transforms.

Inherited From:

PIXI.DisplayObject#transformCallback

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

transformCallbackContext :Object

The context under which the transformCallback is invoked.

Inherited From:

PIXI.DisplayObject#transformCallbackContext

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

<internal> type :integer

Internal Phaser Type value.

Inherited From:

Phaser.Group#type

Internal:

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

Source - core/Group.js, line 79

visible :boolean

The visible state of the group. Non-visible Groups and all of their children are not rendered.

Inherited From:

Phaser.Group#visible

Source - core/Group.js, line 2093

width :number

Gets or sets the current width of the game world. The world can never be smaller than the game (canvas) dimensions.

Source - core/World.js, line 224

<readonly> worldAlpha :Number

[read-only] The multiplied alpha of the displayObject

Inherited From:

PIXI.DisplayObject#worldAlpha

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

worldVisible :Boolean

[read-only] Indicates if the sprite is globally visible.

Inherited From:

PIXI.DisplayObject#worldVisible

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

x :number

The x coordinate of the group container.

You can adjust the group container itself by modifying its coordinates. This will have no impact on the x/y coordinates of its children, but it will update their worldTransform and on-screen position.

Inherited From:

Phaser.Group#x

Source - core/Group.js, line 2066

y :number

The y coordinate of the group container.

Inherited From:

Phaser.Group#y

Source - core/Group.js, line 2075

z :integer

The z-depth value of this object within its parent container/Group - the World is a Group as well. This value must be unique for each child in a Group.

Inherited From:

Phaser.Group#z

Source - core/Group.js, line 56

Methods

add(child, silent) → {DisplayObject}

Adds an existing object as the top child in this group.

The child is automatically added to the top of the group and is displayed on top of every previous child.

Use addAt to control where a child is added. Use create to create and add a new child.

Parameters:

Name	Type	Argument	Default	Description
`child`	DisplayObject			The display object to add as a child.
`silent`	boolean	<optional>	false	If true the child will not dispatch the `onAddedToGroup` event.

Returns:

DisplayObject -

The child that was added to the group.

Inherited From:

Phaser.Group#add

Source - core/Group.js, line 242

addAll(property, amount, checkAlive, checkVisible)

Adds the amount to the given property on all children in this group.

Group.addAll('x', 10) will add 10 to the child.x value for each child.

Parameters:

Name	Type	Description
`property`	string	The property to increment, for example 'body.velocity.x' or 'angle'.
`amount`	number	The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.
`checkAlive`	boolean	If true the property will only be changed if the child is alive.
`checkVisible`	boolean	If true the property will only be changed if the child is visible.

Inherited From:

Phaser.Group#addAll

Source - core/Group.js, line 1020

addAt(child, index, silent) → {DisplayObject}

Adds an existing object to this group.

The child is added to the group at the location specified by the index value, this allows you to control child ordering.

Parameters:

Name	Type	Argument	Default	Description
`child`	DisplayObject			The display object to add as a child.
`index`	integer	<optional>	0	The index within the group to insert the child to.
`silent`	boolean	<optional>	false	If true the child will not dispatch the `onAddedToGroup` event.

Returns:

DisplayObject -

The child that was added to the group.

Inherited From:

Phaser.Group#addAt

Source - core/Group.js, line 312

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 92

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 104

addMultiple(children, silent) → {Array.<DisplayObject>}

Adds an array of existing display objects to this group.

The children are automatically added to the top of the group, so render on-top of everything else within the group.

TODO: Add ability to pass the children as parameters rather than having to be an array.

Parameters:

Name	Type	Argument	Default	Description
`children`	Array.<DisplayObject>			An array of display objects to add as children.
`silent`	boolean	<optional>	false	If true the children will not dispatch the `onAddedToGroup` event.

Returns:

Array.<DisplayObject> -

The array of children that were added to the group.

Inherited From:

Phaser.Group#addMultiple

Source - core/Group.js, line 286

<internal> ascendingSortHandler(a, b)

An internal helper function for the sort process.

Parameters:

Name	Type	Description
`a`	object	The first object being sorted.
`b`	object	The second object being sorted.

Inherited From:

Phaser.Group#ascendingSortHandler

Internal:

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

Source - core/Group.js, line 1547

<internal> boot()

Initialises the game world.

Internal:

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

Source - core/World.js, line 58

bringToTop(child) → {any}

Brings the given child to the top of this group so it renders above all other children.

Parameters:

Name	Type	Description
`child`	any	The child to bring to the top of this group.

Returns:

any -

The child that was moved.

Inherited From:

Phaser.Group#bringToTop

Source - core/Group.js, line 568

callAll(method, context, args)

Calls a function, specified by name, on all on children.

The function is called for all children regardless if they are dead or alive (see callAllExists for different options). After the method parameter and context you can add as many extra parameters as you like, which will all be passed to the child.

Parameters:

Name	Type	Argument	Default	Description
`method`	string			Name of the function on the child to call. Deep property lookup is supported.
`context`	string	<optional>	null	A string containing the context under which the method will be executed. Set to null to default to the child.
`args`	any	<repeatable>		Additional parameters that will be passed to the method.

Inherited From:

Phaser.Group#callAll

Source - core/Group.js, line 1175

callAllExists(callback, existsValue, parameter)

Calls a function, specified by name, on all children in the group who exist (or do not exist).

After the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback.

Parameters:

Name	Type	Argument	Description
`callback`	string		Name of the function on the children to call.
`existsValue`	boolean		Only children with exists=existsValue will be called.
`parameter`	any	<repeatable>	Additional parameters that will be passed to the callback.

Inherited From:

Phaser.Group#callAllExists

Source - core/Group.js, line 1088

<internal> callbackFromArray(child, callback, length)

Returns a reference to a function that exists on a child of the group based on the given callback array.

Parameters:

Name	Type	Description
`child`	object	The object to inspect.
`callback`	array	The array of function names.
`length`	integer	The size of the array (pre-calculated in callAll).

Inherited From:

Phaser.Group#callbackFromArray

Internal:

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

Source - core/Group.js, line 1122

checkAll(key, value, checkAlive, checkVisible, force)

Quickly check that the same property across all children of this group is equal to the given value.

This call doesn't descend down children, so if you have a Group inside of this group, the property will be checked on the group but not its children.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The property, as a string, to be set. For example: 'body.velocity.x'
`value`	any			The value that will be checked.
`checkAlive`	boolean	<optional>	false	If set then only children with alive=true will be checked. This includes any Groups that are children.
`checkVisible`	boolean	<optional>	false	If set then only children with visible=true will be checked. This includes any Groups that are children.
`force`	boolean	<optional>	false	If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.

Inherited From:

Phaser.Group#checkAll

Source - core/Group.js, line 987

checkProperty(child, key, value, force) → {boolean}

Checks a property for the given value on the child.

Parameters:

Name	Type	Argument	Default	Description
`child`	any			The child to check the property value on.
`key`	array			An array of strings that make up the property that will be set.
`value`	any			The value that will be checked.
`force`	boolean	<optional>	false	If `force` is true then the property will be checked on the child regardless if it already exists or not. If true and the property doesn't exist, false will be returned.

Returns:

boolean -

True if the property was was equal to value, false if not.

Inherited From:

Phaser.Group#checkProperty

Source - core/Group.js, line 851

countDead() → {integer}

Get the number of dead children in this group.

Returns:

integer -

The number of children flagged as dead.

Inherited From:

Phaser.Group#countDead

Source - core/Group.js, line 1769

countLiving() → {integer}

Get the number of living children in this group.

Returns:

integer -

The number of children flagged as alive.

Inherited From:

Phaser.Group#countLiving

Source - core/Group.js, line 1757

create(x, y, key, frame, exists) → {DisplayObject}

Creates a new Phaser.Sprite object and adds it to the top of this group.

Use classType to change the type of object creaded.

Parameters:

Name	Type	Argument	Default	Description
`x`	number			The x coordinate to display the newly created Sprite at. The value is in relation to the group.x point.
`y`	number			The y coordinate to display the newly created Sprite at. The value is in relation to the group.y point.
`key`	string			The Game.cache key of the image that this Sprite will use.
`frame`	integer \| string	<optional>		If the Sprite image contains multiple frames you can specify which one to use here.
`exists`	boolean	<optional>	true	The default exists state of the Sprite.

Returns:

DisplayObject -

The child that was created: will be a Phaser.Sprite unless #classType has been changed.

Inherited From:

Phaser.Group#create

Source - core/Group.js, line 375

createMultiple(quantity, key, frame, exists)

Creates multiple Phaser.Sprite objects and adds them to the top of this group.

Useful if you need to quickly generate a pool of identical sprites, such as bullets.

By default the sprites will be set to not exist and will be positioned at 0, 0 (relative to the group.x/y). Use classType to change the type of object creaded.

Parameters:

Name	Type	Argument	Default	Description
`quantity`	integer			The number of Sprites to create.
`key`	string			The Game.cache key of the image that this Sprite will use.
`frame`	integer \| string	<optional>		If the Sprite image contains multiple frames you can specify which one to use here.
`exists`	boolean	<optional>	false	The default exists state of the Sprite.

Inherited From:

Phaser.Group#createMultiple

Source - core/Group.js, line 423

customSort(sortHandler, context)

Sort the children in the group according to custom sort function.

The sortHandler is provided the two parameters: the two children involved in the comparison (a and b). It should return -1 if a > b, 1 if a < b or 0 if a === b.

Parameters:

Name	Type	Argument	Default	Description
`sortHandler`	function			The custom sort function.
`context`	object	<optional>	undefined	The context in which the sortHandler is called.

Inherited From:

Phaser.Group#customSort

Source - core/Group.js, line 1523

<internal> descendingSortHandler(a, b)

An internal helper function for the sort process.

Parameters:

Name	Type	Description
`a`	object	The first object being sorted.
`b`	object	The second object being sorted.

Inherited From:

Phaser.Group#descendingSortHandler

Internal:

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

Source - core/Group.js, line 1579

destroy(destroyChildren, soft)

Destroys this group.

Removes all children, then removes this group from its parent and nulls references.

Parameters:

Name	Type	Argument	Default	Description
`destroyChildren`	boolean	<optional>	true	If true `destroy` will be invoked on each removed child.
`soft`	boolean	<optional>	false	A 'soft destroy' (set to true) doesn't remove this group from its parent or null the game reference. Set to false and it does.

Inherited From:

Phaser.Group#destroy

Source - core/Group.js, line 1962

divideAll(property, amount, checkAlive, checkVisible)

Divides the given property by the amount on all children in this group.

Group.divideAll('x', 2) will half the child.x value for each child.

Parameters:

Name	Type	Description
`property`	string	The property to divide, for example 'body.velocity.x' or 'angle'.
`amount`	number	The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.
`checkAlive`	boolean	If true the property will only be changed if the child is alive.
`checkVisible`	boolean	If true the property will only be changed if the child is visible.

Inherited From:

Phaser.Group#divideAll

Source - core/Group.js, line 1071

filter(predicate, checkExists) → {Phaser.ArraySet}

Find children matching a certain predicate.

For example:

var healthyList = Group.filter(function(child, index, children) {
    return child.health > 10 ? true : false;
}, true);
healthyList.callAll('attack');

Note: Currently this will skip any children which are Groups themselves.

Parameters:

Name	Type	Argument	Default	Description
`predicate`	function			The function that each child will be evaluated against. Each child of the group will be passed to it as its first parameter, the index as the second, and the entire child array as the third
`checkExists`	boolean	<optional>	false	If true, only existing can be selected; otherwise all children can be selected and will be passed to the predicate.

Returns:

Phaser.ArraySet -

Returns an array list containing all the children that the predicate returned true for

Inherited From:

Phaser.Group#filter

Source - core/Group.js, line 1312

forEach(callback, callbackContext, checkExists, args)

Call a function on each child in this group.

Additional arguments for the callback can be specified after the checkExists parameter. For example,

Group.forEach(awardBonusGold, this, true, 100, 500)

would invoke awardBonusGold function with the parameters (child, 100, 500).

Note: This check will skip any children which are Groups themselves.

Parameters:

Name	Type	Argument	Default	Description
`callback`	function			The function that will be called for each applicable child. The child will be passed as the first argument.
`callbackContext`	object			The context in which the function should be called (usually 'this').
`checkExists`	boolean	<optional>	false	If set only children matching for which `exists` is true will be passed to the callback, otherwise all children will be passed.
`args`	any	<optional> <repeatable>	(none)	Additional arguments to pass to the callback function, after the child item.

Inherited From:

Phaser.Group#forEach

Source - core/Group.js, line 1352

forEachAlive(callback, callbackContext, args)

Call a function on each alive child in this group.

See forEach for details.

Parameters:

Name	Type	Argument	Default	Description
`callback`	function			The function that will be called for each applicable child. The child will be passed as the first argument.
`callbackContext`	object			The context in which the function should be called (usually 'this').
`args`	any	<optional> <repeatable>	(none)	Additional arguments to pass to the callback function, after the child item.

Inherited From:

Phaser.Group#forEachAlive

Source - core/Group.js, line 1431

forEachDead(callback, callbackContext, args)

Call a function on each dead child in this group.

See forEach for details.

Parameters:

Name	Type	Argument	Default	Description
`callback`	function			The function that will be called for each applicable child. The child will be passed as the first argument.
`callbackContext`	object			The context in which the function should be called (usually 'this').
`args`	any	<optional> <repeatable>	(none)	Additional arguments to pass to the callback function, after the child item.

Inherited From:

Phaser.Group#forEachDead

Source - core/Group.js, line 1459

forEachExists(callback, callbackContext, args)

Call a function on each existing child in this group.

See forEach for details.

Parameters:

Name	Type	Argument	Default	Description
`callback`	function			The function that will be called for each applicable child. The child will be passed as the first argument.
`callbackContext`	object			The context in which the function should be called (usually 'this').
`args`	any	<optional> <repeatable>	(none)	Additional arguments to pass to the callback function, after the child item.

Inherited From:

Phaser.Group#forEachExists

Source - core/Group.js, line 1403

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 495

getAt(index) → {DisplayObject}

Returns the child found at the given index within this group.

Parameters:

Name	Type	Description
`index`	integer	The index to return the child from.

Returns:

DisplayObject -

The child that was found at the given index, or -1 for an invalid index.

Inherited From:

Phaser.Group#getAt

Source - core/Group.js, line 355

getBottom() → {any}

Returns the child at the bottom of this group.

The bottom child the child being displayed (rendered) below every other child.

Returns:

any -

The child at the bottom of the Group.

Inherited From:

Phaser.Group#getBottom

Source - core/Group.js, line 1740

getBounds() → {Rectangle}

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

Returns:

Rectangle -

The rectangular bounding area

Inherited From:

PIXI.DisplayObjectContainer#getBounds

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

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 195

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 160

getFirstAlive() → {any}

Get the first child that is alive (child.alive === true).

This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.

Returns:

any -

The first alive child, or null if none found.

Inherited From:

Phaser.Group#getFirstAlive

Source - core/Group.js, line 1695

getFirstDead() → {any}

Get the first child that is dead (child.alive === false).

This is handy for checking if everything has been wiped out, or choosing a squad leader, etc.

Returns:

any -

The first dead child, or null if none found.

Inherited From:

Phaser.Group#getFirstDead

Source - core/Group.js, line 1709

getFirstExists(exists) → {any}

Get the first display object that exists, or doesn't exist.

Parameters:

Name	Type	Argument	Default	Description
`exists`	boolean	<optional>	true	If true, find the first existing child; otherwise find the first non-existing child.

Returns:

any -

The first child, or null if none found.

Inherited From:

Phaser.Group#getFirstExists

Source - core/Group.js, line 1677

getIndex(child) → {integer}

Get the index position of the given child in this group, which should match the child's z property.

Parameters:

Name	Type	Description
`child`	any	The child to get the index for.

Returns:

integer -

The index of the child or -1 if it's not a member of this group.

Inherited From:

Phaser.Group#getIndex

Source - core/Group.js, line 690

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 364

getRandom(startIndex, length) → {any}

Returns a random child from the group.

Parameters:

Name	Type	Argument	Default	Description
`startIndex`	integer	<optional>	0	Offset from the front of the front of the group (lowest child).
`length`	integer	<optional>	(to top)	Restriction on the number of values you want to randomly select from.

Returns:

any -

A random child of this Group.

Inherited From:

Phaser.Group#getRandom

Source - core/Group.js, line 1781

getTop() → {any}

Return the child at the top of this group.

The top child is the child displayed (rendered) above every other child.

Returns:

any -

The child at the top of the Group.

Inherited From:

Phaser.Group#getTop

Source - core/Group.js, line 1723

hasProperty(child, key) → {boolean}

Checks if the child has the given property.

Will scan up to 4 levels deep only.

Parameters:

Name	Type	Description
`child`	any	The child to check for the existance of the property on.
`key`	Array.<string>	An array of strings that make up the property.

Returns:

boolean -

True if the child has the property, otherwise false.

Inherited From:

Phaser.Group#hasProperty

Source - core/Group.js, line 738

iterate(key, value, returnType, callback, callbackContext, args) → {any}

Iterates over the children of the group performing one of several actions for matched children.

A child is considered a match when it has a property, named key, whose value is equal to value according to a strict equality comparison.

The result depends on the returnType:

RETURN_TOTAL: The callback, if any, is applied to all matching children. The number of matched children is returned.
RETURN_NONE: The callback, if any, is applied to all matching children. No value is returned.
RETURN_CHILD: The callback, if any, is applied to the first matching child and the first matched child is returned. If there is no matching child then null is returned.

If args is specified it must be an array. The matched child will be assigned to the first element and the entire array will be applied to the callback function.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The child property to check, i.e. 'exists', 'alive', 'health'
`value`	any			A child matches if `child[key] === value` is true.
`returnType`	integer			How to iterate the children and what to return.
`callback`	function	<optional>	null	Optional function that will be called on each matching child. The matched child is supplied as the first argument.
`callbackContext`	object	<optional>		The context in which the function should be called (usually 'this').
`args`	Array.<any>	<optional>	(none)	The arguments supplied to to the callback; the first array index (argument) will be replaced with the matched child.

Returns:

any -

Returns either an integer (for RETURN_TOTAL), the first matched child (for RETURN_CHILD), or null.

Inherited From:

Phaser.Group#iterate

Source - core/Group.js, line 1604

moveDown(child) → {any}

Moves the given child down one place in this group unless it's already at the bottom.

Parameters:

Name	Type	Description
`child`	any	The child to move down in the group.

Returns:

any -

The child that was moved.

Inherited From:

Phaser.Group#moveDown

Source - core/Group.js, line 630

moveUp(child) → {any}

Moves the given child up one place in this group unless it's already at the top.

Parameters:

Name	Type	Description
`child`	any	The child to move up in the group.

Returns:

any -

The child that was moved.

Inherited From:

Phaser.Group#moveUp

Source - core/Group.js, line 606

multiplyAll(property, amount, checkAlive, checkVisible)

Multiplies the given property by the amount on all children in this group.

Group.multiplyAll('x', 2) will x2 the child.x value for each child.

Parameters:

Name	Type	Description
`property`	string	The property to multiply, for example 'body.velocity.x' or 'angle'.
`amount`	number	The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.
`checkAlive`	boolean	If true the property will only be changed if the child is alive.
`checkVisible`	boolean	If true the property will only be changed if the child is visible.

Inherited From:

Phaser.Group#multiplyAll

Source - core/Group.js, line 1054

next() → {any}

Advances the group cursor to the next (higher) object in the group.

If the cursor is at the end of the group (top child) it is moved the start of the group (bottom child).

Returns:

any -

The child the cursor now points to.

Inherited From:

Phaser.Group#next

Source - core/Group.js, line 494

<internal> postUpdate()

The core postUpdate - as called by World.

Inherited From:

Phaser.Group#postUpdate

Internal:

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

Source - core/Group.js, line 1288

<internal> preUpdate()

The core preUpdate - as called by World.

Inherited From:

Phaser.Group#preUpdate

Internal:

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

Source - core/Group.js, line 1248

previous() → {any}

Moves the group cursor to the previous (lower) child in the group.

If the cursor is at the start of the group (bottom child) it is moved to the end (top child).

Returns:

any -

The child the cursor now points to.

Inherited From:

Phaser.Group#previous

Source - core/Group.js, line 523

remove(child, destroy, silent) → {boolean}

Removes the given child from this group.

This will dispatch an onRemovedFromGroup event from the child (if it has one), and optionally destroy the child.

If the group cursor was referring to the removed child it is updated to refer to the next child.

Parameters:

Name	Type	Argument	Default	Description
`child`	any			The child to remove.
`destroy`	boolean	<optional>	false	If true `destroy` will be invoked on the removed child.
`silent`	boolean	<optional>	false	If true the the child will not dispatch the `onRemovedFromGroup` event.

Returns:

boolean -

true if the child was removed from this group, otherwise false.

Inherited From:

Phaser.Group#remove

Source - core/Group.js, line 1803

removeAll(destroy, silent)

Removes all children from this group, but does not remove the group from its parent.

Parameters:

Name	Type	Argument	Default	Description
`destroy`	boolean	<optional>	false	If true `destroy` will be invoked on each removed child.
`silent`	boolean	<optional>	false	If true the children will not dispatch their `onRemovedFromGroup` events.

Inherited From:

Phaser.Group#removeAll

Source - core/Group.js, line 1856

removeBetween(startIndex, endIndex, destroy, silent)

Removes all children from this group whose index falls beteen the given startIndex and endIndex values.

Parameters:

Name	Type	Argument	Default	Description
`startIndex`	integer			The index to start removing children from.
`endIndex`	integer	<optional>		The index to stop removing children at. Must be higher than startIndex. If undefined this method will remove all children between startIndex and the end of the group.
`destroy`	boolean	<optional>	false	If true `destroy` will be invoked on each removed child.
`silent`	boolean	<optional>	false	If true the children will not dispatch their `onRemovedFromGroup` events.

Inherited From:

Phaser.Group#removeBetween

Source - core/Group.js, line 1902

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 212

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 227

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 245

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 404

replace(oldChild, newChild) → {any}

Replaces a child of this group with the given newChild. The newChild cannot be a member of this group.

Parameters:

Name	Type	Description
`oldChild`	any	The child in this group that will be replaced.
`newChild`	any	The child to be inserted into this group.

Returns:

any -

Returns the oldChild that was replaced within this group.

Inherited From:

Phaser.Group#replace

Source - core/Group.js, line 703

resetCursor(index) → {any}

Sets the group cursor to the first child in the group.

If the optional index parameter is given it sets the cursor to the object at that index instead.

Parameters:

Name	Type	Argument	Default	Description
`index`	integer	<optional>	0	Set the cursor to point to a specific index.

Returns:

any -

The child the cursor now points to.

Inherited From:

Phaser.Group#resetCursor

Source - core/Group.js, line 467

resize(width, height)

Updates the size of this world. Note that this doesn't modify the world x/y coordinates, just the width and height.

Parameters:

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

Source - core/World.js, line 109

reverse()

Reverses all children in this group.

This operaation applies only to immediate children and does not propagate to subgroups.

Inherited From:

Phaser.Group#reverse

Source - core/Group.js, line 676

sendToBack(child) → {any}

Sends the given child to the bottom of this group so it renders below all other children.

Parameters:

Name	Type	Description
`child`	any	The child to send to the bottom of this group.

Returns:

any -

The child that was moved.

Inherited From:

Phaser.Group#sendToBack

Source - core/Group.js, line 587

set(child, key, value, checkAlive, checkVisible, operation, force) → {boolean}

Quickly set a property on a single child of this group to a new value.

The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.

Parameters:

Name	Type	Argument	Default	Description
`child`	Phaser.Sprite			The child to set the property on.
`key`	string			The property, as a string, to be set. For example: 'body.velocity.x'
`value`	any			The value that will be set.
`checkAlive`	boolean	<optional>	false	If set then the child will only be updated if alive=true.
`checkVisible`	boolean	<optional>	false	If set then the child will only be updated if visible=true.
`operation`	integer	<optional>	0	Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.
`force`	boolean	<optional>	false	If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.

Returns:

boolean -

True if the property was set, false if not.

Inherited From:

Phaser.Group#set

Source - core/Group.js, line 880

setAll(key, value, checkAlive, checkVisible, operation, force)

Quickly set the same property across all children of this group to a new value.

This call doesn't descend down children, so if you have a Group inside of this group, the property will be set on the group but not its children. If you need that ability please see Group.setAllChildren.

The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The property, as a string, to be set. For example: 'body.velocity.x'
`value`	any			The value that will be set.
`checkAlive`	boolean	<optional>	false	If set then only children with alive=true will be updated. This includes any Groups that are children.
`checkVisible`	boolean	<optional>	false	If set then only children with visible=true will be updated. This includes any Groups that are children.
`operation`	integer	<optional>	0	Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.
`force`	boolean	<optional>	false	If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.

Inherited From:

Phaser.Group#setAll

Source - core/Group.js, line 911

setAllChildren(key, value, checkAlive, checkVisible, operation, force)

Quickly set the same property across all children of this group, and any child Groups, to a new value.

If this group contains other Groups then the same property is set across their children as well, iterating down until it reaches the bottom. Unlike with setAll the property is NOT set on child Groups itself.

The operation parameter controls how the new value is assigned to the property, from simple replacement to addition and multiplication.

Parameters:

Name	Type	Argument	Default	Description
`key`	string			The property, as a string, to be set. For example: 'body.velocity.x'
`value`	any			The value that will be set.
`checkAlive`	boolean	<optional>	false	If set then only children with alive=true will be updated. This includes any Groups that are children.
`checkVisible`	boolean	<optional>	false	If set then only children with visible=true will be updated. This includes any Groups that are children.
`operation`	integer	<optional>	0	Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.
`force`	boolean	<optional>	false	If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.

Inherited From:

Phaser.Group#setAllChildren

Source - core/Group.js, line 946

setBounds(x, y, width, height)

Updates the size of this world and sets World.x/y to the given values The Camera bounds and Physics bounds (if set) are also updated to match the new World bounds.

Parameters:

Name	Type	Description
`x`	number	Top left most corner of the world.
`y`	number	Top left most corner of the world.
`width`	number	New width of the game world in pixels.
`height`	number	New height of the game world in pixels.

Source - core/World.js, line 78

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 177

setProperty(child, key, value, operation, force) → {boolean}

Sets a property to the given value on the child. The operation parameter controls how the value is set.

The operations are:

0: set the existing value to the given value; if force is true a new property will be created if needed
1: will add the given value to the value already present.
2: will subtract the given value from the value already present.
3: will multiply the value already present by the given value.
4: will divide the value already present by the given value.

Parameters:

Name	Type	Argument	Default	Description
`child`	any			The child to set the property value on.
`key`	array			An array of strings that make up the property that will be set.
`value`	any			The value that will be set.
`operation`	integer	<optional>	0	Controls how the value is assigned. A value of 0 replaces the value with the new one. A value of 1 adds it, 2 subtracts it, 3 multiplies it and 4 divides it.
`force`	boolean	<optional>	false	If `force` is true then the property will be set on the child regardless if it already exists or not. If false and the property doesn't exist, nothing will be set.

Returns:

boolean -

True if the property was set, false if not.

Inherited From:

Phaser.Group#setProperty

Source - core/Group.js, line 773

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`	PIXI.Stage	the stage that the container will have as its current stage reference

Inherited From:

PIXI.DisplayObjectContainer#setStageReference

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

shutdown()

Destroyer of worlds.

Source - core/World.js, line 142

sort(key, order)

Sort the children in the group according to a particular key and ordering.

Call this function to sort the group according to a particular key value and order. For example to depth sort Sprites for Zelda-style game you might call group.sort('y', Phaser.Group.SORT_ASCENDING) at the bottom of your State.update().

Parameters:

Name	Type	Argument	Default	Description
`key`	string	<optional>	'z'	The name of the property to sort on. Defaults to the objects z-depth value.
`order`	integer	<optional>	Phaser.Group.SORT_ASCENDING	Order ascending (SORT_ASCENDING) or descending (SORT_DESCENDING).

Inherited From:

Phaser.Group#sort

Source - core/Group.js, line 1487

subAll(property, amount, checkAlive, checkVisible)

Subtracts the amount from the given property on all children in this group.

Group.subAll('x', 10) will minus 10 from the child.x value for each child.

Parameters:

Name	Type	Description
`property`	string	The property to decrement, for example 'body.velocity.x' or 'angle'.
`amount`	number	The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.
`checkAlive`	boolean	If true the property will only be changed if the child is alive.
`checkVisible`	boolean	If true the property will only be changed if the child is visible.

Inherited From:

Phaser.Group#subAll

Source - core/Group.js, line 1037

swap(child1, child2)

Swaps the position of two children in this group.

Both children must be in this group, a child cannot be swapped with itself, and unparented children cannot be swapped.

Parameters:

Name	Type	Description
`child1`	any	The first child to swap.
`child2`	any	The second child to swap.

Inherited From:

Phaser.Group#swap

Source - core/Group.js, line 552

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 135

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 529

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 543

<internal> update()

The core update - as called by World.

Inherited From:

Phaser.Group#update

Internal:

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

Source - core/Group.js, line 1272

updateCache()

Generates and updates the cached sprite for this object.

Inherited From:

PIXI.DisplayObject#updateCache

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

<internal> updateZ()

Internal method that re-applies all of the childrens Z values.

This must be called whenever children ordering is altered so that their z indices are correctly updated.

Inherited From:

Phaser.Group#updateZ

Internal:

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

Source - core/Group.js, line 448

wrap(sprite, padding, useBounds, horizontal, vertical)

This will take the given game object and check if its x/y coordinates fall outside of the world bounds. If they do it will reposition the object to the opposite side of the world, creating a wrap-around effect. If sprite has a P2 body then the body (sprite.body) should be passed as first parameter to the function.

Parameters:

Name	Type	Argument	Default	Description
`sprite`	Phaser.Sprite \| Phaser.Image \| Phaser.TileSprite \| Phaser.Text			The object you wish to wrap around the world bounds.
`padding`	number	<optional>	0	Extra padding added equally to the sprite.x and y coordinates before checking if within the world bounds. Ignored if useBounds is true.
`useBounds`	boolean	<optional>	false	If useBounds is false wrap checks the object.x/y coordinates. If true it does a more accurate bounds check, which is more expensive.
`horizontal`	boolean	<optional>	true	If horizontal is false, wrap will not wrap the object.x coordinates horizontally.
`vertical`	boolean	<optional>	true	If vertical is false, wrap will not wrap the object.y coordinates vertically.

Source - core/World.js, line 154

xy(index, x, y)

Positions the child found at the given index within this group to the given x and y coordinates.

Parameters:

Name	Type	Description
`index`	integer	The index of the child in the group to set the position of.
`x`	number	The new x position of the child.
`y`	number	The new y position of the child.

Inherited From:

Phaser.Group#xy

Source - core/Group.js, line 654

new World(game)

Parameters:

Extends

Members

<readonly> _definedSize :boolean

_height

Properties:

_width

Properties:

alive :boolean

alpha :number

angle :number

bounds :Phaser.Rectangle

cacheAsBitmap :Boolean

camera :Phaser.Camera

cameraOffset :Phaser.Point

<readonly> centerX :number

<readonly> centerY :number

<readonly> children :Array.<DisplayObject>

Type:

classType :object

cursor :DisplayObject

<readonly> cursorIndex :integer

enableBody :boolean

enableBodyDebug :boolean

exists :boolean

filterArea :Rectangle

filters :Array.<Filter>

Type:

fixedToCamera :boolean

<internal> game :Phaser.Game

height :number

hitArea :Rectangle|Circle|Ellipse|Polygon

Type:

ignoreDestroy :boolean

<readonly> length :integer

mask :PIXI.Graphics

name :string

onDestroy :Phaser.Signal

<readonly> parent :PIXI.DisplayObjectContainer

physicsBodyType :integer

<readonly> physicsType :number

pivot :Point

position :Point

<readonly> randomX :number

<readonly> randomY :number

renderable :Boolean

rotation :number

scale :Phaser.Point

<readonly> stage :PIXI.Stage

<readonly> total :integer

transformCallback :function

transformCallbackContext :Object

<internal> type :integer

visible :boolean

width :number

<readonly> worldAlpha :Number

worldVisible :Boolean

x :number

y :number

z :integer

Methods

add(child, silent) → {DisplayObject}

Parameters:

Returns:

addAll(property, amount, checkAlive, checkVisible)

Parameters:

addAt(child, index, silent) → {DisplayObject}

Parameters:

Returns:

addChild(child) → {PIXI.DisplayObject}

Parameters:

Returns:

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

Parameters:

Returns:

addMultiple(children, silent) → {Array.<DisplayObject>}

Parameters:

Returns:

<internal> ascendingSortHandler(a, b)