These archived docs are for Phaser 2.2.2 Phaser 3 docs can be found on newdocs.phaser.io.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

PIXI. Text

new Text(text, style)

A Text Object will create a line or multiple lines of text. To split a line you can use '\n' in your text string, or add a wordWrap property set to true and and wordWrapWidth property with a value in the style object.

Parameters
Name Type Argument Description
text String

The copy that you would like the text to display

style Object <optional>

The style parameters

Source code: pixi/text/Text.js, line 6

Extends

Public Properties

alpha : number

The opacity of the object.

Inherited From
Source code: pixi/display/DisplayObject.js, line 65

anchor : PIXI.Point

The anchor sets the origin point of the texture. The default is 0,0 this means the texture's origin is the top left Setting than anchor to 0.5,0.5 means the textures origin is centered Setting the anchor to 1,1 would mean the textures origin points will be the bottom right corner

Inherited From
Source code: pixi/display/Sprite.js, line 22

blendMode : number

The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.

Inherited From
Default Value
  • PIXI.blendModes.NORMAL;
Source code: pixi/display/Sprite.js, line 68

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

canvas :HTMLCanvasElement

The canvas element that everything is drawn to

Source code: pixi/text/Text.js, line 29

[readonly] children : Array.<DisplayObject>

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

Type
Inherited From
Source code: pixi/display/DisplayObjectContainer.js, line 17

context :HTMLCanvasElement

The canvas 2d context that everything is drawn with

Source code: pixi/text/Text.js, line 37

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

height : number

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

Source code: pixi/text/Text.js, line 86

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

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

[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

resolution : number

The resolution of the canvas.

Source code: pixi/text/Text.js, line 44

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

shader : PIXI.AbstractFilter

The shader that will be used to render the texture to the stage. Set to null to remove a current shader.

Inherited From
Default Value
  • null
Source code: pixi/display/Sprite.js, line 77

[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

texture : PIXI.Texture

The texture that the sprite is using

Inherited From
Source code: pixi/display/Sprite.js, line 33

tint : number

The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

Inherited From
Default Value
  • 0xFFFFFF
Source code: pixi/display/Sprite.js, line 59

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 Text, setting this will actually modify the scale to achieve the value set

Source code: pixi/text/Text.js, line 62

[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

destroy(destroyBaseTexture)

Destroys this text object.

Parameters
Name Type Description
destroyBaseTexture Boolean

whether to destroy the base texture as well

Source code: pixi/text/Text.js, line 516

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(matrix) → {PIXI.Rectangle}

Returns the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.

Parameters
Name Type Description
matrix PIXI.Matrix

the transformation matrix of the Text

Returns

the framing rectangle

Source code: pixi/text/Text.js, line 498

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

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

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

setStyle(style)

Set the style of the text

Parameters
Name Type Argument Description
style Object <optional>

The style parameters

Properties
Name Type Argument Default Description
fill Object <optional>
'black'

A canvas fillstyle that will be used on the text eg 'red', '#00FF00'

align String <optional>
'left'

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

stroke String <optional>
'black'

A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'

strokeThickness Number <optional>
0

A number that represents the thickness of the stroke. Default is 0 (no stroke)

wordWrap Boolean <optional>
false

Indicates if word wrap should be used

wordWrapWidth Number <optional>
100

The width at which text will wrap

dropShadow Boolean <optional>
false

Set a drop shadow for the text

dropShadowColor String <optional>
'#000000'

A fill style to be used on the dropshadow e.g 'red', '#00FF00'

dropShadowAngle Number <optional>
Math.PI/4

Set a angle of the drop shadow

dropShadowDistance Number <optional>
5

Set a distance of the drop shadow

font String <optional>
'bold - 20pt Arial'

The style and size of the font

Source code: pixi/text/Text.js, line 110

setText(text)

Set the copy for the text object. To split a line you can use '\n'.

Parameters
Name Type Description
text String

The copy that you would like the text to display

Source code: pixi/text/Text.js, line 147

setTexture(texture)

Sets the texture of the sprite

Parameters
Name Type Description
texture PIXI.Texture

The PIXI texture that is displayed by the sprite

Inherited From
Source code: pixi/display/Sprite.js, line 135

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

updateCache()

Generates and updates the cached sprite for this object.

Inherited From
Source code: pixi/display/DisplayObject.js, line 606