Phaser API

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 - pixi/text/Text.js, line 6

Extends

Members

alpha :Number

The opacity of the object.

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

anchor :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 - 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 - pixi/display/Sprite.js, line 68

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 - pixi/display/DisplayObject.js, line 336

canvas :HTMLCanvasElement

The canvas element that everything is drawn to

Source - pixi/text/Text.js, line 29

<readonly> children :Array.<DisplayObject>

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

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

context :HTMLCanvasElement

The canvas 2d context that everything is drawn with

Source - pixi/text/Text.js, line 37

filterArea :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 - pixi/display/DisplayObject.js, line 153

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 - pixi/display/DisplayObject.js, line 298

height :Number

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

Source - pixi/text/Text.js, line 86

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

<readonly> parent :PIXI.DisplayObjectContainer

[read-only] The display object container that contains this display object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 98

pivot :Point

The pivot point of the displayObject that it rotates around

Inherited From:
Source - pixi/display/DisplayObject.js, line 49

position :Point

The coordinate of the object relative to the local coordinates of the parent.

Inherited From:
Source - pixi/display/DisplayObject.js, line 14

renderable :Boolean

Can this object be rendered

Inherited From:
Source - pixi/display/DisplayObject.js, line 90

resolution :Number

The resolution of the canvas.

Source - pixi/text/Text.js, line 44

rotation :Number

The rotation of the object in radians.

Inherited From:
Source - pixi/display/DisplayObject.js, line 57

scale :Point

The scale factor of the object.

Inherited From:
Source - 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 - 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 - pixi/display/DisplayObject.js, line 107

texture :PIXI.Texture

The texture that the sprite is using

Inherited From:
Source - 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 - 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 - pixi/display/DisplayObject.js, line 30

transformCallbackContext :Object

The context under which the transformCallback is invoked.

Inherited From:
Source - pixi/display/DisplayObject.js, line 41

visible :Boolean

The visibility of the object.

Inherited From:
Source - 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 - pixi/text/Text.js, line 62

<readonly> worldAlpha :Number

[read-only] The multiplied alpha of the displayObject

Inherited From:
Source - pixi/display/DisplayObject.js, line 116

worldVisible :Boolean

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 249

x :Number

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 672

y :Number

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

Inherited From:
Source - pixi/display/DisplayObject.js, line 690

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

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

destroy(destroyBaseTexture)

Destroys this text object.

Parameters:
Name Type Description
destroyBaseTexture Boolean

whether to destroy the base texture as well
Source - 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:
PIXI.Texture -

a texture of the graphics object

Inherited From:
Source - pixi/display/DisplayObject.js, line 495

getBounds(matrix) → {Rectangle}

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

Parameters:
Name Type Description
matrix Matrix

the transformation matrix of the Text
Returns:
Rectangle -

the framing rectangle

Source - 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:
PIXI.DisplayObject -

The child at the given index, if any.

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 195

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

getLocalBounds() → {Rectangle}

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

Returns:
Rectangle -

The rectangular bounding area

Inherited From:
Source - pixi/display/DisplayObjectContainer.js, line 364

preUpdate()

Empty, to be overridden by classes that require it.

Inherited From:
Source - pixi/display/DisplayObject.js, line 486

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

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

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

removeStageReference()

Removes the current stage reference from the container and all of its children.

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

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

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 - 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 - 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 - pixi/display/Sprite.js, line 137

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

toGlobal(position) → {Point}

Calculates the global position of the display object

Parameters:
Name Type Description
position Point

The world origin to calculate from
Returns:
Point -

A point object representing the position of this object

Inherited From:
Source - pixi/display/DisplayObject.js, line 529

toLocal(position, from) → {Point}

Calculates the local position of the display object relative to another point

Parameters:
Name Type Argument Description
position Point

The world origin to calculate from
from PIXI.DisplayObject <optional>

The DisplayObject to calculate the global position from
Returns:
Point -

A point object representing the position of this object

Inherited From:
Source - pixi/display/DisplayObject.js, line 543

updateCache()

Generates and updates the cached sprite for this object.

Inherited From:
Source - pixi/display/DisplayObject.js, line 519
Phaser Copyright © 2012-2015 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.0-alpha10 on Thu Mar 26 2015 02:54:00 GMT+0000 (GMT Standard Time) using the DocStrap template.