Class: BitmapText

Extends

• PIXI.BitmapText

Members

align :string

Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.

Source - gameobjects/BitmapText.js, line 265

alpha :Number

The opacity of the object.

Inherited From:

• PIXI.DisplayObject#alpha

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

angle :number

Indicates the rotation of the Text, 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 use the property Sprite.rotation instead. Gets or sets the angle of rotation in degrees.

Source - gameobjects/BitmapText.js, line 309

buttonMode :Boolean

This is used to indicate if the displayObject should display a mouse hand cursor on rollover

Inherited From:

• PIXI.DisplayObject#buttonMode

Source - 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:

• PIXI.DisplayObject#cacheAsBitmap

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

cameraOffset :Phaser.Point

If this object is fixedToCamera then this stores the x/y offset that its drawn at, from the top-left of the camera view.

Source - gameobjects/BitmapText.js, line 108

<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

defaultCursor :String

This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true

Inherited From:

• PIXI.DisplayObject#defaultCursor

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

destroyPhase :boolean

True if this object is currently being destroyed.

Source - gameobjects/BitmapText.js, line 471

dirty :Boolean

The dirty state of this object.

Inherited From:

• PIXI.BitmapText#dirty

Source - pixi/text/BitmapText.js, line 54

events :Phaser.Events

The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.

Source - gameobjects/BitmapText.js, line 98

exists :boolean

If exists = false then the Sprite isn't updated by the core game loop or physics subsystem at all.

Default Value:

• true

Source - gameobjects/BitmapText.js, line 41

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:

• PIXI.DisplayObject#filterArea

Source - 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:

• PIXI.DisplayObject#filters

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

fixedToCamera :boolean

An BitmapText that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in BitmapText.cameraOffset. Note that the cameraOffset values are in addition to any parent in the display list. So if this BitmapText was in a Group that has x: 200, then this will be added to the cameraOffset.x Set to true to fix this BitmapText to the Camera at its current world coordinates.

Source - gameobjects/BitmapText.js, line 440

font :string

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

Source - gameobjects/BitmapText.js, line 328

fontSize :number

The size of the font in pixels.

Source - gameobjects/BitmapText.js, line 351

game :Phaser.Game

A reference to the currently running Game.

Source - gameobjects/BitmapText.js, line 35

height :Number

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

Inherited From:

• PIXI.DisplayObjectContainer#height

Source - 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:

• PIXI.Rectangle | PIXI.Circle | PIXI.Ellipse | PIXI.Polygon

Inherited From:

• PIXI.DisplayObject#hitArea

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

input :Phaser.InputHandler|null

The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.

Type:

• Phaser.InputHandler | null

Source - gameobjects/BitmapText.js, line 103

inputEnabled :boolean

By default a Text object won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is activated for this object and it will then start to process click/touch events and more. Set to true to allow this object to receive input events.

Source - gameobjects/BitmapText.js, line 399

interactive :Boolean

Indicates if the sprite will have touch and mouse interactivity. It is false by default

Inherited From:

• PIXI.DisplayObject#interactive

Default Value:

• false

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

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 380

name :string

The user defined name given to this BitmapText.

Source - gameobjects/BitmapText.js, line 47

<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 106

pivot :PIXI.Point

The pivot point of the displayObject that it rotates around

Inherited From:

• PIXI.DisplayObject#pivot

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

position :PIXI.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

renderable :Boolean

Can this object be rendered

Inherited From:

• PIXI.DisplayObject#renderable

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

rotation :Number

The rotation of the object in radians.

Inherited From:

• PIXI.DisplayObject#rotation

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

scale :PIXI.Point

The scale factor of the object.

Inherited From:

• PIXI.DisplayObject#scale

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

smoothed

Properties:

Name	Type	Description
text	string	Set this value to update the text in this sprite. Carriage returns are automatically stripped out if multiLine is false. Text is converted to upper case if autoUpperCase is true.

Source - gameobjects/RetroFont.js, line 598

<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 115

text :string

The text string to be displayed by this Text object, taking into account the style settings.

Source - gameobjects/BitmapText.js, line 376

text :string

Set this value to update the text in this sprite. Carriage returns are automatically stripped out if multiLine is false. Text is converted to upper case if autoUpperCase is true.

Source - gameobjects/RetroFont.js, line 560

<readonly> textHeight :Number

[read-only] The height of the overall text, different from fontSize, which is defined in the style object

Inherited From:

• PIXI.BitmapText#textHeight

Source - pixi/text/BitmapText.js, line 33

<readonly> textWidth :Number

[read-only] The width of the overall text, different from fontSize, which is defined in the style object

Inherited From:

• PIXI.BitmapText#textWidth

Source - pixi/text/BitmapText.js, line 23

tint :number

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

Source - gameobjects/BitmapText.js, line 287

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

<readonly> type :number

The const type of this object.

Source - gameobjects/BitmapText.js, line 53

visible :Boolean

The visibility of the object.

Inherited From:

• PIXI.DisplayObject#visible

Source - 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:

• PIXI.DisplayObjectContainer#width

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

world :Phaser.Point

The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.

Source - gameobjects/BitmapText.js, line 63

<readonly> worldAlpha :Number

[read-only] The multiplied alpha of the displayObject

Inherited From:

• PIXI.DisplayObject#worldAlpha

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

worldVisible :Boolean

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

Inherited From:

• PIXI.DisplayObject#worldVisible

Source - 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:

• PIXI.DisplayObject#x

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

y :Number

The position of the displayObject on the y axis relative to the local coordinates of the parent.

Inherited From:

• PIXI.DisplayObject#y

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

z :number

The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.

Source - gameobjects/BitmapText.js, line 58

Methods

addChild(child) → {PIXI.DisplayObject}

Adds a child to the container.

Parameters:

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

Returns:

PIXI.DisplayObject -

The child that was added.

Inherited From:

• PIXI.DisplayObjectContainer#addChild

Source - pixi/display/DisplayObjectContainer.js, line 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:

PIXI.DisplayObject -

The child that was added.

Inherited From:

• PIXI.DisplayObjectContainer#addChildAt

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

click(interactionData)

A callback that is used when the users clicks on the displayObject with their mouse's left button

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#click

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

destroy(destroyChildren)

Destroy this BitmapText instance. This will remove any filters and un-parent any children.

Parameters:

Name	Type	Argument	Default	Description
destroyChildren	boolean	<optional>	true	Should every child of this object have its destroy method called?

Source - gameobjects/BitmapText.js, line 205

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 583

getBounds() → {PIXI.Rectangle}

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

Returns:

PIXI.Rectangle -

The rectangular bounding area

Inherited From:

• PIXI.DisplayObjectContainer#getBounds

Source - 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:

PIXI.DisplayObject -

The child at the given index, if any.

Inherited From:

• PIXI.DisplayObjectContainer#getChildAt

Source - 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:

• PIXI.DisplayObjectContainer#getChildIndex

Source - 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:

PIXI.Rectangle -

The rectangular bounding area

Inherited From:

• PIXI.DisplayObjectContainer#getLocalBounds

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

mousedown(interactionData)

A callback that is used when the user clicks the mouse's left button down over the sprite

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#mousedown

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

mouseout(interactionData)

A callback that is used when the users mouse leaves the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#mouseout

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

mouseover(interactionData)

A callback that is used when the users mouse rolls over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#mouseover

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

mouseup(interactionData)

A callback that is used when the user releases the mouse's left button that was over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#mouseup

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

mouseupoutside(interactionData)

A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's left button must have been pressed down over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#mouseupoutside

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

postUpdate()

Automatically called by World.postUpdate.

Source - gameobjects/BitmapText.js, line 190

preUpdate()

Automatically called by World.preUpdate.

Source - gameobjects/BitmapText.js, line 148

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 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:

PIXI.DisplayObject -

The child that was removed.

Inherited From:

• PIXI.DisplayObjectContainer#removeChildAt

Source - 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:

• PIXI.DisplayObjectContainer#removeChildren

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

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

rightclick(interactionData)

A callback that is used when the users clicks on the displayObject with their mouse's right button

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#rightclick

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

rightdown(interactionData)

A callback that is used when the user clicks the mouse's right button down over the sprite

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#rightdown

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

rightup(interactionData)

A callback that is used when the user releases the mouse's right button that was over the displayObject for this callback to be fired the mouse's right button must have been pressed down over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#rightup

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

rightupoutside(interactionData)

A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject for this callback to be fired, the mouse's right button must have been pressed down over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#rightupoutside

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

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 175

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 386

setText(text)

Set the text string to be rendered.

Parameters:

Name	Type	Description
text	String	The text that you would like displayed

Inherited From:

• PIXI.BitmapText#setText

Source - pixi/text/BitmapText.js, line 66

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 133

tap(interactionData)

A callback that is used when the users taps on the sprite with their finger basically a touch version of click

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#tap

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

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:

PIXI.Point -

A point object representing the position of this object

Inherited From:

• PIXI.DisplayObject#toGlobal

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

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:

PIXI.Point -

A point object representing the position of this object

Inherited From:

• PIXI.DisplayObject#toLocal

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

touchend(interactionData)

A callback that is used when the user releases a touch over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#touchend

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

touchendoutside(interactionData)

A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#touchendoutside

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

touchstart(interactionData)

A callback that is used when the user touches over the displayObject

Parameters:

Name	Type	Description
interactionData	PIXI.InteractionData	-

Inherited From:

• PIXI.DisplayObject#touchstart

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

update()

Override and use this function in your own custom objects to handle any update requirements you may have.

Source - gameobjects/BitmapText.js, line 181

updateCache()

Generates and updates the cached sprite for this object.

Inherited From:

• PIXI.DisplayObject#updateCache

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