Class: BitmapText

Extends

• PIXI.DisplayObjectContainer
• Phaser.Component.Core
• Phaser.Component.Angle
• Phaser.Component.AutoCull
• Phaser.Component.Bounds
• Phaser.Component.Destroy
• Phaser.Component.FixedToCamera
• Phaser.Component.InputEnabled
• Phaser.Component.InWorld
• Phaser.Component.LifeSpan
• Phaser.Component.PhysicsBody
• Phaser.Component.Reset

Members

align : string

Alignment for multi-line text ('left', 'center' or 'right'), does not affect single lines of text.

Type:

• string

Source:

src/gameobjects/BitmapText.js line 558

alive : boolean

A useful flag to control if the Game Object is alive or dead.

This is set automatically by the Health components damage method should the object run out of health. Or you can toggle it via your game code.

This property is mostly just provided to be used by your game - it doesn't effect rendering or logic updates. However you can use Group.getFirstAlive in conjunction with this property for fast object pooling and recycling.

Type:

• boolean

Inherited From:

• Phaser.Component.LifeSpan#alive

Default Value:

• true

Source:

src/gameobjects/components/LifeSpan.js line 55

alpha : number

The alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent. Please note that an object with an alpha value of 0 is skipped during the render pass.

The value of this property does not reflect any alpha values set further up the display list. To obtain that value please see the worldAlpha property.

Type:

• number

Inherited From:

• PIXI.DisplayObject#alpha

Default Value:

• 1

Source:

src/pixi/display/DisplayObject.js line 73

anchor : Phaser.Point

The anchor value of this BitmapText.

Type:

• Phaser.Point

Source:

src/gameobjects/BitmapText.js line 92

angle : number

The angle property is the rotation of the Game Object in degrees from its original orientation.

Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.

Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.

If you wish to work in radians instead of degrees you can use the property rotation instead. Working in radians is slightly faster as it doesn't have to perform any calculations.

Type:

• number

Inherited From:

• Phaser.Component.Angle#angle

Source:

src/gameobjects/components/Angle.js line 29

animations : Phaser.AnimationManager

If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance. Through it you can create, play, pause and stop animations.

Type:

• Phaser.AnimationManager

Inherited From:

• Phaser.Component.Core#animations

Source:

src/gameobjects/components/Core.js line 186

See:

• Phaser.AnimationManager

autoCull : boolean

A Game Object with autoCull set to true will check its bounds against the World Camera every frame. If it is not intersecting the Camera bounds at any point then it has its renderable property set to false. This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.

This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required, or you have tested performance and find it acceptable.

Type:

• boolean

Inherited From:

• Phaser.Component.AutoCull#autoCull

Source:

src/gameobjects/components/AutoCull.js line 28

body : Phaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null

body is the Game Objects physics body. Once a Game Object is enabled for physics you access all associated properties and methods via it.

By default Game Objects won't add themselves to any physics system and their body property will be null.

To enable this Game Object for physics you need to call game.physics.enable(object, system) where object is this object and system is the Physics system you are using. If none is given it defaults to Phaser.Physics.Arcade.

You can alternatively call game.physics.arcade.enable(object), or add this Game Object to a physics enabled Group.

Important: Enabling a Game Object for P2 or Ninja physics will automatically set its anchor property to 0.5, so the physics body is centered on the Game Object.

If you need a different result then adjust or re-create the Body shape offsets manually or reset the anchor after enabling physics.

Type:

• Phaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null

Inherited From:

• Phaser.Component.PhysicsBody#body

Source:

src/gameobjects/components/PhysicsBody.js line 97

bottom : number

The sum of the y and height properties. This is the same as y + height - offsetY.

Type:

• number

Inherited From:

• Phaser.Component.Bounds#bottom

Source:

src/gameobjects/components/Bounds.js line 156

cacheAsBitmap : boolean

Sets if this DisplayObject should be cached as a bitmap.

When invoked it will take a snapshot of the DisplayObject, as it is at that moment, and store it in a RenderTexture. This is then used whenever this DisplayObject is rendered. It can provide a performance benefit for complex, but static, DisplayObjects. I.e. those with lots of children.

Transparent areas adjoining the edges may be removed (#283).

Cached Bitmaps do not track their parents. If you update a property of this DisplayObject, it will not re-generate the cached bitmap automatically. To do that you need to call DisplayObject.updateCache.

To remove a cached bitmap, set this property to null. Cache this DisplayObject as a Bitmap. Set to null to remove an existing cached bitmap.

Type:

• boolean

Inherited From:

• PIXI.DisplayObject#cacheAsBitmap

Source:

src/pixi/display/DisplayObject.js line 791

cameraOffset : Phaser.Point

The x/y coordinate offset applied to the top-left of the camera that this Game Object will be drawn at if fixedToCamera is true.

The values are relative to the top-left of the camera view and in addition to any parent of the Game Object on the display list.

Type:

• Phaser.Point

Inherited From:

• Phaser.Component.FixedToCamera#cameraOffset

Source:

src/gameobjects/components/FixedToCamera.js line 82

centerX : number

The local center x coordinate of the Game Object. This is the same as (x - offsetX) + (width / 2).

Type:

• number

Inherited From:

• Phaser.Component.Bounds#centerX

Source:

src/gameobjects/components/Bounds.js line 56

centerY : number

The local center y coordinate of the Game Object. This is the same as (y - offsetY) + (height / 2).

Type:

• number

Inherited From:

• Phaser.Component.Bounds#centerY

Source:

src/gameobjects/components/Bounds.js line 76

checkWorldBounds : boolean

If this is set to true the Game Object checks if it is within the World bounds each frame.

When it is no longer intersecting the world bounds it dispatches the onOutOfBounds event.

If it was previously out of bounds but is now intersecting the world bounds again it dispatches the onEnterBounds event.

It also optionally kills the Game Object if outOfBoundsKill is true.

When checkWorldBounds is enabled it forces the Game Object to calculate its full bounds every frame.

This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required, or you have tested performance and find it acceptable.

Type:

• boolean

Inherited From:

• Phaser.Component.InWorld#checkWorldBounds

Source:

src/gameobjects/components/InWorld.js line 103

<readonly> children : Array(DisplayObject)

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

Type:

• Array(DisplayObject)

Inherited From:

• PIXI.DisplayObjectContainer#children

Source:

src/pixi/display/DisplayObjectContainer.js line 24

<protected> components : object

The components this Game Object has installed.

Type:

• object

Inherited From:

• Phaser.Component.Core#components

Source:

src/gameobjects/components/Core.js line 160

data : Object

An empty Object that belongs to this Game Object. This value isn't ever used internally by Phaser, but may be used by your own code, or by Phaser Plugins, to store data that needs to be associated with the Game Object, without polluting the Game Object directly.

Type:

• Object

Inherited From:

• Phaser.Component.Core#data

Default Value:

• {}

Source:

src/gameobjects/components/Core.js line 153

debug : boolean

A debug flag designed for use with Game.enableStep.

Type:

• boolean

Inherited From:

• Phaser.Component.Core#debug

Source:

src/gameobjects/components/Core.js line 211

<readonly> destroyPhase : boolean

As a Game Object runs through its destroy method this flag is set to true, and can be checked in any sub-systems or plugins it is being destroyed from.

Type:

• boolean

Inherited From:

• Phaser.Component.Destroy#destroyPhase

Source:

src/gameobjects/components/Destroy.js line 22

dirty : boolean

The dirty state of this object.

Type:

• boolean

Source:

src/gameobjects/BitmapText.js line 159

events : Phaser.Events

All Phaser Game Objects have an Events class which contains all of the events that are dispatched when certain things happen to this Game Object, or any of its components.

Type:

• Phaser.Events

Inherited From:

• Phaser.Component.Core#events

Source:

src/gameobjects/components/Core.js line 178

See:

• Phaser.Events

exists : boolean

Controls if this Game Object is processed by the core game loop. If this Game Object has a physics body it also controls if its physics body is updated or not. When exists is set to false it will remove its physics body from the physics world if it has one. It also toggles the visible property to false as well.

Setting exists to true will add its physics body back in to the physics world, if it has one. It will also set the visible property to true.

Type:

• boolean

Inherited From:

• Phaser.Component.Core#exists

Source:

src/gameobjects/components/Core.js line 277

filterArea : Rectangle

The rectangular area used by filters when rendering a shader for this DisplayObject.

Type:

• Rectangle

Inherited From:

• PIXI.DisplayObject#filterArea

Source:

src/pixi/display/DisplayObject.js line 205

filters : Array

Sets the filters for this DisplayObject. This is a WebGL only feature, and is ignored by the Canvas Renderer. A filter is a shader applied to this DisplayObject. You can modify the placement of the filter using DisplayObject.filterArea.

To remove filters, set this property to null.

Note: You cannot have a filter set, and a MULTIPLY Blend Mode active, at the same time. Setting a filter will reset this DisplayObjects blend mode to NORMAL. An Array of Phaser.Filter objects, or objects that extend them.

Type:

• Array

Inherited From:

• PIXI.DisplayObject#filters

Source:

src/pixi/display/DisplayObject.js line 740

fixedToCamera : boolean

A Game Object that is "fixed" to the camera is rendered at a given x/y offsets from the top left of the camera. The offsets are stored in the cameraOffset property, which is initialized with the current object coordinates.

The values are adjusted at the rendering stage, overriding the Game Objects actual world position.

The end result is that the Game Object will appear to be 'fixed' to the camera, regardless of where in the game world the camera is viewing. This is useful if for example this Game Object is a UI item that you wish to be visible at all times regardless where in the world the camera is.

Note that the cameraOffset values are in addition to any parent of this Game Object on the display list.

Be careful not to set fixedToCamera on Game Objects which are in Groups that already have fixedToCamera enabled on them.

Type:

• boolean

Inherited From:

• Phaser.Component.FixedToCamera#fixedToCamera

Source:

src/gameobjects/components/FixedToCamera.js line 54

font : string

The font the text will be rendered in, i.e. 'Arial'. Must be loaded in the browser before use.

Type:

• string

Source:

src/gameobjects/BitmapText.js line 602

fontSize : number

The size of the font in pixels.

Type:

• number

Source:

src/gameobjects/BitmapText.js line 625

<readonly> fresh : boolean

A Game Object is considered fresh if it has just been created or reset and is yet to receive a renderer transform update. This property is mostly used internally by the physics systems, but is exposed for the use of plugins.

Type:

• boolean

Inherited From:

• Phaser.Component.Core#fresh

Source:

src/gameobjects/components/Core.js line 241

game : Phaser.Game

A reference to the currently running Game.

Type:

• Phaser.Game

Inherited From:

• Phaser.Component.Core#game

Source:

src/gameobjects/components/Core.js line 135

height : Number

The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

Type:

• Number

Inherited From:

• PIXI.DisplayObjectContainer#height

Source:

src/pixi/display/DisplayObjectContainer.js line 606

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:

src/pixi/display/DisplayObject.js line 99

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.

Type:

• boolean

Inherited From:

• PIXI.DisplayObjectContainer#ignoreChildInput

Source:

src/pixi/display/DisplayObjectContainer.js line 35

<readonly> inCamera : boolean

Checks if the Game Objects bounds intersect with the Game Camera bounds. Returns true if they do, otherwise false if fully outside of the Cameras bounds.

Type:

• boolean

Inherited From:

• Phaser.Component.AutoCull#inCamera

Source:

src/gameobjects/components/AutoCull.js line 37

input : Phaser.InputHandler | null

The Input Handler for this Game Object.

By default it is disabled. If you wish this Game Object to process input events you should enable it with: inputEnabled = true.

After you have done this, this property will be a reference to the Phaser InputHandler.

Type:

• Phaser.InputHandler | null

Inherited From:

• Phaser.Component.InputEnabled#input

Source:

src/gameobjects/components/InputEnabled.js line 24

inputEnabled : boolean

By default a Game Object won't process any input events. By setting inputEnabled to true a Phaser.InputHandler is created for this Game Object and it will then start to process click / touch events and more.

You can then access the Input Handler via this.input.

Note that Input related events are dispatched from this.events, i.e.: events.onInputDown.

If you set this property to false it will stop the Input Handler from processing any more input events.

If you want to temporarily disable input for a Game Object, then it's better to set input.enabled = false, as it won't reset any of the Input Handlers internal properties. You can then toggle this back on as needed.

Type:

• boolean

Inherited From:

• Phaser.Component.InputEnabled#inputEnabled

Source:

src/gameobjects/components/InputEnabled.js line 42

<readonly> inWorld : boolean

Checks if the Game Objects bounds are within, or intersect at any point with the Game World bounds.

Type:

• boolean

Inherited From:

• Phaser.Component.InWorld#inWorld

Source:

src/gameobjects/components/InWorld.js line 134

key : string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture

The key of the image or texture used by this Game Object during rendering. If it is a string it's the string used to retrieve the texture from the Phaser Image Cache. It can also be an instance of a RenderTexture, BitmapData, Video or PIXI.Texture. If a Game Object is created without a key it is automatically assigned the key __default which is a 32x32 transparent PNG stored within the Cache. If a Game Object is given a key which doesn't exist in the Image Cache it is re-assigned the key __missing which is a 32x32 PNG of a green box with a line through it.

Type:

• string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture

Inherited From:

• Phaser.Component.Core#key

Source:

src/gameobjects/components/Core.js line 196

left : number

The left coordinate of the Game Object. This is the same as x - offsetX.

Type:

• number

Inherited From:

• Phaser.Component.Bounds#left

Source:

src/gameobjects/components/Bounds.js line 96

letterSpacing : string

Sets the letter spacing between each character of this Bitmap Text. Can be a positive value to increase the space, or negative to reduce it. Spacing is applied after the kerning values have been set.

Type:

• string

Source:

src/gameobjects/BitmapText.js line 536

lifespan : number

The lifespan allows you to give a Game Object a lifespan in milliseconds.

Once the Game Object is 'born' you can set this to a positive value.

It is automatically decremented by game.time.delta each frame. When it reaches zero it will call the kill method.

Very handy for particles, bullets, collectibles, or any other short-lived entity.

Type:

• number

Inherited From:

• Phaser.Component.LifeSpan#lifespan

Source:

src/gameobjects/components/LifeSpan.js line 70

mask : Phaser.Graphics

Sets a mask for this DisplayObject. A mask is an instance of a Graphics object. When applied it limits the visible area of this DisplayObject to the shape of the mask. Under a Canvas renderer it uses shape clipping. Under a WebGL renderer it uses a Stencil Buffer. To remove a mask, set this property to null. The mask applied to this DisplayObject. Set to null to remove an existing mask.

Type:

• Phaser.Graphics

Inherited From:

• PIXI.DisplayObject#mask

Source:

src/pixi/display/DisplayObject.js line 707

maxWidth : number

The maximum display width of this BitmapText in pixels.

If BitmapText.text is longer than maxWidth then the lines will be automatically wrapped based on the last whitespace character found in the line.

If no whitespace was found then no wrapping will take place and consequently the maxWidth value will not be honored.

Disable maxWidth by setting the value to 0. The maximum width of this BitmapText in pixels.

Type:

• number

Source:

src/gameobjects/BitmapText.js line 671

name : string

A user defined name given to this Game Object. This value isn't ever used internally by Phaser, it is meant as a game level property.

Type:

• string

Inherited From:

• Phaser.Component.Core#name

Source:

src/gameobjects/components/Core.js line 143

<readonly> offsetX : number

The amount the Game Object is visually offset from its x coordinate. This is the same as width * anchor.x. It will only be > 0 if anchor.x is not equal to zero.

Type:

• number

Inherited From:

• Phaser.Component.Bounds#offsetX

Source:

src/gameobjects/components/Bounds.js line 24

<readonly> offsetY : number

The amount the Game Object is visually offset from its y coordinate. This is the same as height * anchor.y. It will only be > 0 if anchor.y is not equal to zero.

Type:

• number

Inherited From:

• Phaser.Component.Bounds#offsetY

Source:

src/gameobjects/components/Bounds.js line 41

outOfBoundsKill : boolean

If this and the checkWorldBounds property are both set to true then the kill method is called as soon as inWorld returns false.

Type:

• boolean

Inherited From:

• Phaser.Component.InWorld#outOfBoundsKill

Source:

src/gameobjects/components/InWorld.js line 111

outOfCameraBoundsKill : boolean

If this and the autoCull property are both set to true, then the kill method is called as soon as the Game Object leaves the camera bounds.

Type:

• boolean

Inherited From:

• Phaser.Component.InWorld#outOfCameraBoundsKill

Source:

src/gameobjects/components/InWorld.js line 120

<readonly> parent : PIXI.DisplayObjectContainer

The parent DisplayObjectContainer that this DisplayObject is a child of. All DisplayObjects must belong to a parent in order to be rendered. The root parent is the Stage object. This property is set automatically when the DisplayObject is added to, or removed from, a DisplayObjectContainer.

Type:

• PIXI.DisplayObjectContainer

Inherited From:

• PIXI.DisplayObject#parent

Source:

src/pixi/display/DisplayObject.js line 120

pendingDestroy : boolean

A Game Object is that is pendingDestroy is flagged to have its destroy method called on the next logic update. You can set it directly to allow you to flag an object to be destroyed on its next update.

This is extremely useful if you wish to destroy an object from within one of its own callbacks such as with Buttons or other Input events.

Type:

• boolean

Inherited From:

• Phaser.Component.Core#pendingDestroy

Source:

src/gameobjects/components/Core.js line 252

<readonly> physicsType : number

The const physics body type of this object.

Type:

• number

Source:

src/gameobjects/BitmapText.js line 75

pivot : PIXI.Point

The pivot point of this DisplayObject that it rotates around. The values are expressed in pixel values.

Type:

• PIXI.Point

Inherited From:

• PIXI.DisplayObject#pivot

Source:

src/pixi/display/DisplayObject.js line 49

position : PIXI.Point

The coordinates, in pixels, of this DisplayObject, relative to its parent container.

The value of this property does not reflect any positioning happening further up the display list. To obtain that value please see the worldPosition property.

Type:

• PIXI.Point

Inherited From:

• PIXI.DisplayObject#position

Source:

src/pixi/display/DisplayObject.js line 29

<readonly> previousPosition : Phaser.Point

The position the Game Object was located in the previous frame.

Type:

• Phaser.Point

Inherited From:

• Phaser.Component.Core#previousPosition

Source:

src/gameobjects/components/Core.js line 218

<readonly> previousRotation : number

The rotation the Game Object was in set to in the previous frame. Value is in radians.

Type:

• number

Inherited From:

• Phaser.Component.Core#previousRotation

Source:

src/gameobjects/components/Core.js line 225

renderable : boolean

Should this DisplayObject be rendered by the renderer? An object with a renderable value of false is skipped during the render pass.

Type:

• boolean

Inherited From:

• PIXI.DisplayObject#renderable

Source:

src/pixi/display/DisplayObject.js line 108

<readonly> renderOrderID : number

The render order ID is used internally by the renderer and Input Manager and should not be modified. This property is mostly used internally by the renderers, but is exposed for the use of plugins.

Type:

• number

Inherited From:

• Phaser.Component.Core#renderOrderID

Source:

src/gameobjects/components/Core.js line 233

right : number

The right coordinate of the Game Object. This is the same as x + width - offsetX.

Type:

• number

Inherited From:

• Phaser.Component.Bounds#right

Source:

src/gameobjects/components/Bounds.js line 116

rotation : number

The rotation of this DisplayObject. The value is given, and expressed, in radians, and is based on a right-handed orientation.

The value of this property does not reflect any rotation happening further up the display list. To obtain that value please see the worldRotation property.

Type:

• number

Inherited From:

• PIXI.DisplayObject#rotation

Source:

src/pixi/display/DisplayObject.js line 61

scale : PIXI.Point

The scale of this DisplayObject. A scale of 1:1 represents the DisplayObject at its default size. A value of 0.5 would scale this DisplayObject by half, and so on.

The value of this property does not reflect any scaling happening further up the display list. To obtain that value please see the worldScale property.

Type:

• PIXI.Point

Inherited From:

• PIXI.DisplayObject#scale

Source:

src/pixi/display/DisplayObject.js line 41

smoothed : boolean

Enable or disable texture smoothing for this BitmapText.

The smoothing is applied to the BaseTexture of this font, which all letters of the text reference.

Smoothing is enabled by default.

Type:

• boolean

Source:

src/gameobjects/BitmapText.js line 702

text : string

The text to be displayed by this BitmapText object.

Type:

• string

Source:

src/gameobjects/BitmapText.js line 649

<readonly> textHeight : number

The height in pixels of the overall text area, taking into consideration multi-line text.

Type:

• number

Source:

src/gameobjects/BitmapText.js line 87

<readonly> textWidth : number

The width in pixels of the overall text area, taking into consideration multi-line text.

Type:

• number

Source:

src/gameobjects/BitmapText.js line 81

tint : number

The tint applied to the BitmapText. This is a hex value. Set to white to disable (0xFFFFFF)

Type:

• number

Source:

src/gameobjects/BitmapText.js line 580

top : number

The y coordinate of the Game Object. This is the same as y - offsetY.

Type:

• number

Inherited From:

• Phaser.Component.Bounds#top

Source:

src/gameobjects/components/Bounds.js line 136

<readonly> type : number

The const type of this object.

Type:

• number

Source:

src/gameobjects/BitmapText.js line 69

visible : boolean

The visibility of this DisplayObject. A value of false makes the object invisible. A value of true makes it visible.

An object with a visible value of false is skipped during the render pass. Equally a DisplayObject with visible false will not render any of its children.

The value of this property does not reflect any visible values set further up the display list. To obtain that value please see the worldVisible property.

Objects that are not worldVisible do not update their worldPosition.

Type:

• boolean

Inherited From:

• PIXI.DisplayObject#visible

Default Value:

• true

Source:

src/pixi/display/DisplayObject.js line 90

width : Number

The width of the displayObjectContainer, setting this will actually modify the scale to achieve the value set

Type:

• Number

Inherited From:

• PIXI.DisplayObjectContainer#width

Source:

src/pixi/display/DisplayObjectContainer.js line 576

world : Phaser.Point

The world coordinates of this Game Object in pixels. Depending on where in the display list this Game Object is placed this value can differ from position, which contains the x/y coordinates relative to the Game Objects parent.

Type:

• Phaser.Point

Inherited From:

• Phaser.Component.Core#world

Source:

src/gameobjects/components/Core.js line 204

<readonly> worldAlpha : number

The multiplied alpha value of this DisplayObject. A value of 1 is fully opaque. A value of 0 is transparent. This value is the calculated total, based on the alpha values of all parents of this DisplayObjects in the display list.

To obtain, and set, the local alpha value, see the alpha property.

Note: This property is only updated at the end of the updateTransform call, once per render. Until that happens this property will contain values based on the previous frame. Be mindful of this if accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Type:

• number

Inherited From:

• PIXI.DisplayObject#worldAlpha

Source:

src/pixi/display/DisplayObject.js line 136

<readonly> worldPosition : PIXI.Point

The coordinates, in pixels, of this DisplayObject within the world.

This property contains the calculated total, based on the positions of all parents of this DisplayObject in the display list.

Note: This property is only updated at the end of the updateTransform call, once per render. Until that happens this property will contain values based on the previous frame. Be mindful of this if accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Type:

• PIXI.Point

Inherited From:

• PIXI.DisplayObject#worldPosition

Source:

src/pixi/display/DisplayObject.js line 166

<readonly> worldRotation : number

The rotation, in radians, of this DisplayObject.

This property contains the calculated total, based on the rotations of all parents of this DisplayObject in the display list.

Note: This property is only updated at the end of the updateTransform call, once per render. Until that happens this property will contain values based on the previous frame. Be mindful of this if accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Type:

• number

Inherited From:

• PIXI.DisplayObject#worldRotation

Source:

src/pixi/display/DisplayObject.js line 196

<readonly> worldScale : PIXI.Point

The global scale of this DisplayObject.

This property contains the calculated total, based on the scales of all parents of this DisplayObject in the display list.

Note: This property is only updated at the end of the updateTransform call, once per render. Until that happens this property will contain values based on the previous frame. Be mindful of this if accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Type:

• PIXI.Point

Inherited From:

• PIXI.DisplayObject#worldScale

Source:

src/pixi/display/DisplayObject.js line 181

<readonly> worldTransform : Phaser.Matrix

The current transform of this DisplayObject.

This property contains the calculated total, based on the transforms of all parents of this DisplayObject in the display list.

Note: This property is only updated at the end of the updateTransform call, once per render. Until that happens this property will contain values based on the previous frame. Be mindful of this if accessing this property outside of the normal game flow, i.e. from an asynchronous event callback.

Type:

• Phaser.Matrix

Inherited From:

• PIXI.DisplayObject#worldTransform

Source:

src/pixi/display/DisplayObject.js line 151

worldVisible : boolean

Indicates if this DisplayObject is visible, based on it, and all of its parents, visible property values.

Type:

• boolean

Inherited From:

• PIXI.DisplayObject#worldVisible

Source:

src/pixi/display/DisplayObject.js line 666

x : number

The horizontal position of the DisplayObject, in pixels, relative to its parent. If you need the world position of the DisplayObject, use DisplayObject.worldPosition instead.

Type:

• number

Inherited From:

• PIXI.DisplayObject#x

Overrides:

• Phaser.Component.PhysicsBody#x

Source:

src/pixi/display/DisplayObject.js line 626

y : number

The vertical position of the DisplayObject, in pixels, relative to its parent. If you need the world position of the DisplayObject, use DisplayObject.worldPosition instead.

Type:

• number

Inherited From:

• PIXI.DisplayObject#y

Overrides:

• Phaser.Component.PhysicsBody#y

Source:

src/pixi/display/DisplayObject.js line 646

<readonly> z : number

The z depth of this Game Object within its parent Group. No two objects in a Group can have the same z value. This value is adjusted automatically whenever the Group hierarchy changes. If you wish to re-order the layering of a Game Object then see methods like Group.moveUp or Group.bringToTop.

Type:

• number

Inherited From:

• Phaser.Component.Core#z

Source:

src/gameobjects/components/Core.js line 170

Methods

addChild(child)

Adds a child to the container.

Parameters:

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

Inherited From:

• PIXI.DisplayObjectContainer#addChild

Source:

src/pixi/display/DisplayObjectContainer.js line 41

Returns:

The child that was added.

Type

DisplayObject

addChildAt(child, index)

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

Inherited From:

• PIXI.DisplayObjectContainer#addChildAt

Source:

src/pixi/display/DisplayObjectContainer.js line 53

Returns:

The child that was added.

Type

DisplayObject

alignIn(container [, position] [, offsetX] [, offsetY])

Aligns this Game Object within another Game Object, or Rectangle, known as the 'container', to one of 9 possible positions.

The container must be a Game Object, or Phaser.Rectangle object. This can include properties such as World.bounds or Camera.view, for aligning Game Objects within the world and camera bounds. Or it can include other Sprites, Images, Text objects, BitmapText, TileSprites or Buttons.

Please note that aligning a Sprite to another Game Object does not make it a child of the container. It simply modifies its position coordinates so it aligns with it.

The position constants you can use are:

Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER and Phaser.BOTTOM_RIGHT.

The Game Objects are placed in such a way that their bounds align with the container, taking into consideration rotation, scale and the anchor property. This allows you to neatly align Game Objects, irrespective of their position value.

The optional offsetX and offsetY arguments allow you to apply extra spacing to the final aligned position of the Game Object. For example:

sprite.alignIn(background, Phaser.BOTTOM_RIGHT, -20, -20)

Would align the sprite to the bottom-right, but moved 20 pixels in from the corner. Think of the offsets as applying an adjustment to the containers bounds before the alignment takes place. So providing a negative offset will 'shrink' the container bounds by that amount, and providing a positive one expands it.

Parameters:

Name	Type	Argument	Default	Description
container	Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite			The Game Object or Rectangle with which to align this Game Object to. Can also include properties such as World.bounds or Camera.view.
position	integer	<optional>		The position constant. One of Phaser.TOP_LEFT (default), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER or Phaser.BOTTOM_RIGHT.
offsetX	integer	<optional>	0	A horizontal adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.
offsetY	integer	<optional>	0	A vertical adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.

Inherited From:

• Phaser.Component.Bounds#alignIn

Source:

src/gameobjects/components/Bounds.js line 209

Returns:

This Game Object.

Type

Object

alignTo(parent [, position] [, offsetX] [, offsetY])

Aligns this Game Object to the side of another Game Object, or Rectangle, known as the 'parent', in one of 11 possible positions.

The parent must be a Game Object, or Phaser.Rectangle object. This can include properties such as World.bounds or Camera.view, for aligning Game Objects within the world and camera bounds. Or it can include other Sprites, Images, Text objects, BitmapText, TileSprites or Buttons.

Please note that aligning a Sprite to another Game Object does not make it a child of the parent. It simply modifies its position coordinates so it aligns with it.

The position constants you can use are:

Phaser.TOP_LEFT (default), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP, Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER, Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER and Phaser.BOTTOM_RIGHT.

The Game Objects are placed in such a way that their bounds align with the parent, taking into consideration rotation, scale and the anchor property. This allows you to neatly align Game Objects, irrespective of their position value.

The optional offsetX and offsetY arguments allow you to apply extra spacing to the final aligned position of the Game Object. For example:

sprite.alignTo(background, Phaser.BOTTOM_RIGHT, -20, -20)

Would align the sprite to the bottom-right, but moved 20 pixels in from the corner. Think of the offsets as applying an adjustment to the parents bounds before the alignment takes place. So providing a negative offset will 'shrink' the parent bounds by that amount, and providing a positive one expands it.

Parameters:

Name	Type	Argument	Default	Description
parent	Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite			The Game Object or Rectangle with which to align this Game Object to. Can also include properties such as World.bounds or Camera.view.
position	integer	<optional>		The position constant. One of Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP, Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER, Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER or Phaser.BOTTOM_RIGHT.
offsetX	integer	<optional>	0	A horizontal adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.
offsetY	integer	<optional>	0	A vertical adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.

Inherited From:

• Phaser.Component.Bounds#alignTo

Source:

src/gameobjects/components/Bounds.js line 306

Returns:

This Game Object.

Type

Object

cleanText(text [, replace])

Given a text string this will scan each character in the string to ensure it exists in the BitmapText font data. If it doesn't the character is removed, or replaced with the replace argument.

If no font data has been loaded at all this returns an empty string, as nothing can be rendered.

Parameters:

Name	Type	Argument	Default	Description
text	string			The text to parse.
replace	string	<optional>	''	The replacement string for any missing characters.

Source:

src/gameobjects/BitmapText.js line 315

Returns:

The cleaned text string.

Type

string

contains(child)

Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.

Parameters:

Name	Type	Description
child	DisplayObject

Inherited From:

• PIXI.DisplayObjectContainer#contains

Source:

src/pixi/display/DisplayObjectContainer.js line 456

Returns:

Type

boolean

destroy()

Destroy this DisplayObject.

Removes any cached sprites, sets renderable flag to false, and nulls filters, bounds and mask.

Also iteratively calls destroy on any children.

Inherited From:

• PIXI.DisplayObject#destroy

Overrides:

• Phaser.Component.Destroy#destroy

Source:

src/pixi/display/DisplayObject.js line 254

generateTexture( [resolution] [, scaleMode], renderer)

Generates a RenderTexture based on this DisplayObject, which can they be used to texture other Sprites. This can be useful if your DisplayObject is static, or complicated, and needs to be reused multiple times.

Please note that no garbage collection takes place on old textures. It is up to you to destroy old textures, and references to them, so they don't linger in memory.

Parameters:

Name	Type	Argument	Default	Description
resolution	number	<optional>	1	The resolution of the texture being generated.
scaleMode	number	<optional>	PIXI.scaleModes.DEFAULT	See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values.
renderer	PIXI.CanvasRenderer | PIXI.WebGLRenderer			The renderer used to generate the texture.

Inherited From:

• PIXI.DisplayObject#generateTexture

Source:

src/pixi/display/DisplayObject.js line 443

Returns:

• A RenderTexture containing an image of this DisplayObject at the time it was invoked.

Type

Phaser.RenderTexture

getBounds( [targetCoordinateSpace])

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	PIXI.DisplayObject | Phaser.Matrix	<optional>	Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.

Inherited From:

• PIXI.DisplayObjectContainer#getBounds

Source:

src/pixi/display/DisplayObjectContainer.js line 289

Returns:

The rectangular bounding area

Type

Rectangle

getChildAt(index)

Returns the child at the specified index

Parameters:

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

Inherited From:

• PIXI.DisplayObjectContainer#getChildAt

Source:

src/pixi/display/DisplayObjectContainer.js line 147

Returns:

The child at the given index, if any.

Type

DisplayObject

getChildIndex(child)

Returns the index position of a child DisplayObject instance

Parameters:

Name	Type	Description
child	DisplayObject	The DisplayObject instance to identify

Inherited From:

• PIXI.DisplayObjectContainer#getChildIndex

Source:

src/pixi/display/DisplayObjectContainer.js line 108

Returns:

The index position of the child display object to identify

Type

Number

getLocalBounds()

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

Inherited From:

• PIXI.DisplayObjectContainer#getLocalBounds

Source:

src/pixi/display/DisplayObjectContainer.js line 445

Returns:

The rectangular bounding area

Type

Rectangle

kill()

Kills a Game Object. A killed Game Object has its alive, exists and visible properties all set to false.

It will dispatch the onKilled event. You can listen to events.onKilled for 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 destroy instead.

Inherited From:

• Phaser.Component.LifeSpan#kill

Source:

src/gameobjects/components/LifeSpan.js line 117

Returns:

This instance.

Type

PIXI.DisplayObject

postUpdate()

Automatically called by World.preUpdate.

Overrides:

• Phaser.Component.Core#postUpdate

Source:

src/gameobjects/BitmapText.js line 202

preUpdate()

Automatically called by World.preUpdate.

Overrides:

• PIXI.DisplayObjectContainer#preUpdate

Source:

src/gameobjects/BitmapText.js line 192

Returns:

True if the BitmapText was rendered, otherwise false.

Type

boolean

<protected> preUpdateChildren()

Internal method called by preUpdate.

Inherited From:

• Phaser.Component.Core#preUpdateChildren

Source:

src/gameobjects/components/Core.js line 318

purgeGlyphs()

If a BitmapText changes from having a large number of characters to having very few characters it will cause lots of Sprites to be retained in the BitmapText._glyphs array. Although they are not attached to the display list they still take up memory while sat in the glyphs pool waiting to be re-used in the future.

If you know that the BitmapText will not grow any larger then you can purge out the excess glyphs from the pool by calling this method.

Calling this doesn't prevent you from increasing the length of the text again in the future.

Source:

src/gameobjects/BitmapText.js line 480

Returns:

The amount of glyphs removed from the pool.

Type

integer

removeChild(child)

Removes a child from the container.

Parameters:

Name	Type	Description
child	DisplayObject	The DisplayObject to remove

Inherited From:

• PIXI.DisplayObjectContainer#removeChild

Source:

src/pixi/display/DisplayObjectContainer.js line 164

Returns:

The child that was removed.

Type

DisplayObject

removeChildAt(index)

Removes a child from the specified index position.

Parameters:

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

Inherited From:

• PIXI.DisplayObjectContainer#removeChildAt

Source:

src/pixi/display/DisplayObjectContainer.js line 183

Returns:

The child that was removed.

Type

DisplayObject

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:

src/pixi/display/DisplayObjectContainer.js line 224

reset(x, y [, health])

Resets the Game Object.

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

If this Game Object has the LifeSpan component it will also set alive to true and health to 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.

Inherited From:

• Phaser.Component.Reset#reset

Source:

src/gameobjects/components/Reset.js line 30

Returns:

This instance.

Type

PIXI.DisplayObject

revive( [health])

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

A resurrected Game Object has its alive, exists and visible properties all set to true.

It will dispatch the onRevived event. Listen to events.onRevived for 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.

Inherited From:

• Phaser.Component.LifeSpan#revive

Source:

src/gameobjects/components/LifeSpan.js line 83

Returns:

This instance.

Type

PIXI.DisplayObject

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

Inherited From:

• PIXI.DisplayObjectContainer#setChildIndex

Source:

src/pixi/display/DisplayObjectContainer.js line 127

setText(text)

The text to be displayed by this BitmapText object.

It's faster to use BitmapText.text = string, but this is kept for backwards compatibility.

Parameters:

Name	Type	Description
text	string	The text to be displayed by this BitmapText object.

Source:

src/gameobjects/BitmapText.js line 220

swapChildren(child, child2)

Swaps the position of 2 Display Objects within this container.

Parameters:

Name	Type	Description
child	DisplayObject
child2	DisplayObject

Inherited From:

• PIXI.DisplayObjectContainer#swapChildren

Source:

src/pixi/display/DisplayObjectContainer.js line 82

toGlobal(position)

Calculates the global position of this DisplayObject, based on the position given.

Parameters:

Name	Type	Description
position	PIXI.Point	The global position to calculate from.

Inherited From:

• PIXI.DisplayObject#toGlobal

Source:

src/pixi/display/DisplayObject.js line 483

Returns:

• A point object representing the position of this DisplayObject based on the global position given.

Type

PIXI.Point

toLocal(position [, from])

Calculates the local position of this DisplayObject, relative to another point.

Parameters:

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

Inherited From:

• PIXI.DisplayObject#toLocal

Source:

src/pixi/display/DisplayObject.js line 497

Returns:

• A point object representing the position of this DisplayObject based on the global position given.

Type

PIXI.Point

update()

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

Inherited From:

• Phaser.Component.Core#update

Source:

src/gameobjects/components/Core.js line 343

updateCache()

If this DisplayObject has a cached Sprite, this method generates and updates it.

Inherited From:

• PIXI.DisplayObject#updateCache

Source:

src/pixi/display/DisplayObject.js line 470

Returns:

• A reference to this DisplayObject.

Type

PIXI.DisplayObject