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
-
alpha : number
-
The opacity of the object.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 65
-
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
- number | string
- Source code: core/Stage.js, line 343
-
buttonMode : boolean
-
This is used to indicate if the displayObject should display a mouse hand cursor on rollover
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 90
-
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
- Source code: pixi/display/DisplayObject.js, line 436
-
[readonly] children : Array.<DisplayObject>
-
[read-only] The array of children of this container.
Type
- Array.<DisplayObject>
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 17
-
currentRenderOrderID : number
-
Reset each frame, keeps a count of the total number of objects updated.
- Source code: core/Stage.js, line 53
-
destroy
-
Destroys the Stage and removes event listeners.
- Source code: core/Stage.js, line 323
-
disableVisibilityChange : boolean
-
By default if the browser tab loses focus the game will pause. You can stop that behaviour by setting this property to true.
- Default Value
- false
- Source code: core/Stage.js, line 42
-
exists : boolean
-
If exists is true the Stage and all children are updated, otherwise it is skipped.
- Default Value
- true
- Source code: core/Stage.js, line 48
-
filterArea : PIXI.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
- Source code: pixi/display/DisplayObject.js, line 180
-
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
- Source code: pixi/display/DisplayObject.js, line 400
-
game : Phaser.Game
-
A reference to the currently running Game.
- Source code: core/Stage.js, line 21
-
height : number
-
The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 63
-
hitArea : PIXI.Rectangle | PIXI.Circle | PIXI.Ellipse | PIXI.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
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 81
-
interactionManager : PIXI.InteractionManager
-
The interaction manage for this stage, manages all interactive activity on the stage
- Inherited From
- Source code: pixi/display/Stage.js, line 43
-
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
- Source code: pixi/display/DisplayObject.js, line 380
-
name : string
-
The name of this object.
- Default Value
- "_stage_root"
- Source code: core/Stage.js, line 29
-
[readonly] parent : PIXI.DisplayObjectContainer
-
[read-only] The display object container that contains this display object.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 106
-
pivot : PIXI.Point
-
The pivot point of the displayObject that it rotates around
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 49
-
position : PIXI.Point
-
The coordinate of the object relative to the local coordinates of the parent.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 14
-
renderable : boolean
-
Can this object be rendered
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 98
-
rotation : number
-
The rotation of the object in radians.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 57
-
scale : PIXI.Point
-
The scale factor of the object.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 22
-
setBackgroundColor
-
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.
- Source code: core/Stage.js, line 303
-
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)
- Source code: core/Stage.js, line 366
-
[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
- Source code: pixi/display/DisplayObject.js, line 115
-
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
- Source code: pixi/display/DisplayObject.js, line 30
-
transformCallbackContext : Object
-
The context under which the transformCallback is invoked.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 41
-
visible : boolean
-
The visibility of the object.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 73
-
width : number
-
The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 35
-
[readonly] worldAlpha : number
-
[read-only] The multiplied alpha of the displayObject
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 124
-
worldVisible : boolean
-
[read-only] Indicates if the sprite is globally visible.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 359
-
x : number
-
The position of the displayObject on the x axis relative to the local coordinates of the parent.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 761
-
y : number
-
The position of the displayObject on the y axis relative to the local coordinates of the parent.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 776
Public 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
The child that was added.
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 90
-
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
The child that was added.
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 102
-
checkVisibility()
-
Starts a page visibility event listener running, or window.blur/focus if not supported by the browser.
- Source code: core/Stage.js, line 211
-
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
a texture of the graphics object
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 582
-
getBounds() → {PIXI.Rectangle}
-
Retrieves the bounds of the displayObjectContainer as a rectangle. The bounds calculation takes all visible children into consideration.
Returns
The rectangular bounding area
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 302
-
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
The child at the given index, if any.
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 193
-
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
- Source code: pixi/display/DisplayObjectContainer.js, line 158
-
getLocalBounds() → {PIXI.Rectangle}
-
Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.
Returns
The rectangular bounding area
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 362
-
getMousePosition() → {PIXI.Point}
-
This will return the point containing global coordinates of the mouse.
Returns
A point containing the coordinates of the global InteractionData position.
- Inherited From
- Source code: pixi/display/Stage.js, line 126
-
<internal> parseConfig(config)
-
Parses a Game configuration object.
Parameters
Name Type Description config
object The configuration object to parse.
- Internal:
- This member is internal (protected) and may be modified or removed in the future.
- Source code: core/Stage.js, line 77
-
postUpdate()
-
This is called automatically before the renderer runs and after the plugins have updated. In postUpdate this is where all the final physics calculatations and object positioning happens. The objects are processed in the order of the display list. The only exception to this is if the camera is following an object, in which case that is updated first.
- Source code: core/Stage.js, line 154
-
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.
- Source code: core/Stage.js, line 120
-
removeChild(child) → {PIXI.DisplayObject}
-
Removes a child from the container.
Parameters
Name Type Description child
PIXI.DisplayObject The DisplayObject to remove
Returns
The child that was removed.
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 210
-
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
The child that was removed.
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 225
-
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
- Source code: pixi/display/DisplayObjectContainer.js, line 243
-
removeStageReference()
-
Removes the current stage reference from the container and all of its children.
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js, line 404
-
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
- Source code: pixi/display/DisplayObjectContainer.js, line 175
-
setInteractionDelegate(domElement)
-
Sets another DOM element which can receive mouse/touch interactions instead of the default Canvas element. This is useful for when you have other DOM elements on top of the Canvas element.
Parameters
Name Type Description domElement
DOMElement This new domElement which will receive mouse/touch events
- Inherited From
- Source code: pixi/display/Stage.js, line 73
-
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
- Source code: pixi/display/DisplayObjectContainer.js, line 386
-
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
- Source code: pixi/display/DisplayObjectContainer.js, line 133
-
toGlobal(position) → {PIXI.Point}
-
Calculates the global position of the display object
Parameters
Name Type Description position
PIXI.Point The world origin to calculate from
Returns
A point object representing the position of this object
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 616
-
toLocal(position, from) → {PIXI.Point}
-
Calculates the local position of the display object relative to another point
Parameters
Name Type Argument Description position
PIXI.Point The world origin to calculate from
from
PIXI.DisplayObject <optional>
The DisplayObject to calculate the global position from
Returns
A point object representing the position of this object
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 630
-
update()
-
This is called automatically after the State.update, but before particles or plugins update.
- Source code: core/Stage.js, line 138
-
updateCache()
-
Generates and updates the cached sprite for this object.
- Inherited From
- Source code: pixi/display/DisplayObject.js, line 606
-
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.
- Source code: core/Stage.js, line 194
-
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.
- Source code: core/Stage.js, line 265