Stage
Class: Phaser.Stage
Constructor
new Stage(game)
The Stage controls root level display objects upon which everything is displayed.
It also handles browser visibility handling and the pausing due to loss of focus.
Parameters
Name | Type | Description |
---|---|---|
game | Phaser.Game | Game reference to the currently running game. |
- Source code: core/Stage.js (Line 16)
Extends
Public Properties
- number | string
- Source code: core/Stage.js (Line 366)
- Array.<DisplayObject>
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 17)
- Source code: core/Stage.js (Line 65)
- Source code: core/Stage.js (Line 40)
- Default Value
- true
- Source code: core/Stage.js (Line 46)
- Source code: core/Stage.js (Line 21)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 600)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 26)
- Default Value
- _stage_root
- Source code: core/Stage.js (Line 29)
- Source code: core/Stage.js (Line 386)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 571)
backgroundColor : number | string
Gets and sets the background color of the stage. The color can be given as a number: 0xff0000 or a hex string: '#ff0000'
Type
[readonly] children : Array.<DisplayObject>
[read-only] The array of children of this container.
Type
currentRenderOrderID : number
Reset each frame, keeps a count of the total number of objects updated.
disableVisibilityChange : boolean
By default if the browser tab loses focus the game will pause.
You can stop that behavior by setting this property to true.
Note that the browser can still elect to pause your game if it wishes to do so,
for example swapping to another browser tab. This will cause the RAF callback to halt,
effectively pausing your game, even though no in-game pause event is triggered if you enable this property.
exists : boolean
If exists is true the Stage and all children are updated, otherwise it is skipped.
game : Phaser.Game
A reference to the currently running Game.
height : number
The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
ignoreChildInput : boolean
If ignoreChildInput
is false
it will allow this objects children to be considered as valid for Input events.
If this property is true
then the children will not be considered as valid for Input events.
Note that this property isn't recursive: only immediate children are influenced, it doesn't scan further down.
name : string
The name of this object.
smoothed : boolean
Enable or disable texture smoothing for all objects on this Stage. Only works for bitmap/image textures. Smoothing is enabled by default. Set to true to smooth all sprites rendered on this Stage, or false to disable smoothing (great for pixel art)
width : number
The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
Public Methods
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 42)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 55)
- Source code: core/Stage.js (Line 221)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 449)
- Source code: core/Stage.js (Line 346)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 280)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 153)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 112)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 437)
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: core/Stage.js (Line 101)
- Source code: core/Stage.js (Line 173)
- Source code: core/Stage.js (Line 138)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 171)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 191)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 213)
- Source code: core/Stage.js (Line 319)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 132)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 85)
- Source code: core/Stage.js (Line 156)
- Source code: core/Stage.js (Line 204)
- Source code: core/Stage.js (Line 281)
addChild(child) → {DisplayObject}
Adds a child to the container.
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | The DisplayObject to add to the container |
Returns
The child that was added.
addChildAt(child, index) → {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 | DisplayObject | The child to add |
index | Number | The index to place the child in |
Returns
The child that was added.
checkVisibility()
Starts a page visibility event listener running, or window.onpagehide/onpageshow if not supported by the browser.
Also listens for window.onblur and window.onfocus.
contains(child) → {Boolean}
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | - |
Returns
destroy()
Destroys the Stage and removes event listeners.
getBounds(targetCoordinateSpace) → {Rectangle}
Retrieves the global bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.
Parameters
Name | Type | Argument | Description |
---|---|---|---|
targetCoordinateSpace | PIXIDisplayObject | PIXIMatrix | <optional> | Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. |
Returns
The rectangular bounding area
getChildAt(index) → {DisplayObject}
Returns the child at the specified index
Parameters
Name | Type | Description |
---|---|---|
index | Number | The index to get the child from |
Returns
The child at the given index, if any.
getChildIndex(child) → {Number}
Returns the index position of a child DisplayObject instance
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | The DisplayObject instance to identify |
Returns
The index position of the child display object to identify
getLocalBounds() → {Rectangle}
Retrieves the non-global local bounds of the displayObjectContainer as a rectangle without any transformations. The calculation takes all visible children into consideration.
Returns
The rectangular bounding area
<internal> parseConfig(config)
Parses a Game configuration object.
Parameters
Name | Type | Description |
---|---|---|
config | object | The configuration object to parse. |
postUpdate()
This is called automatically before the renderer runs and after the plugins have updated.
In postUpdate this is where all the final physics calculations and object positioning happens.
The objects are processed in the order of the display list.
preUpdate()
This is called automatically after the plugins preUpdate and before the State.update.
Most objects have preUpdate methods and it's where initial movement and positioning is done.
removeChild(child) → {DisplayObject}
Removes a child from the container.
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | The DisplayObject to remove |
Returns
The child that was removed.
removeChildAt(index) → {DisplayObject}
Removes a child from the specified index position.
Parameters
Name | Type | Description |
---|---|---|
index | Number | The index to get the child from |
Returns
The child that was removed.
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. |
setBackgroundColor(color)
Sets the background color for the Stage.
The color can be given as a hex string ('#RRGGBB'
), a CSS color string ('rgb(r,g,b)'
), or a numeric value (0xRRGGBB
).
An alpha channel is not supported and will be ignored.
If you've set your game to be transparent then calls to setBackgroundColor are ignored.
Parameters
Name | Type | Description |
---|---|---|
color | number | string | The color of the background. |
setChildIndex(child, index)
Changes the position of an existing child in the display object container
Parameters
Name | Type | Description |
---|---|---|
child | 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 |
swapChildren(child, child2)
Swaps the position of 2 Display Objects within this container.
Parameters
Name | Type | Description |
---|---|---|
child | DisplayObject | - |
child2 | DisplayObject | - |
update()
This is called automatically after the State.update, but before particles or plugins update.
updateTransform()
Updates the transforms for all objects on the display list.
This overrides the Pixi default as we don't need the interactionManager, but do need the game property check.
visibilityChange(event)
This method is called when the document visibility is changed.
Parameters
Name | Type | Description |
---|---|---|
event | Event | Its type will be used to decide whether the game should be paused or not. |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Stage.html