API Docs for: 2.2.1
Show:

Text Class

Extends Sprite
Defined in: pixi/text/Text.hx:9

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

Constructor

Text

(
  • text
  • [style]
)

Defined in pixi/text/Text.hx:9

Parameters:

  • text String

    The copy that you would like the text to display

  • [style] TextStyle optional

    The style parameters

    • [font] String optional

      default 'bold 20px Arial' The style and size of the font

    • [fill='black'] String optional

      A canvas fillstyle that will be used on the text e.g '#00FF00'

    • [align='left'] String optional

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

    • [stroke] String optional

      A canvas fillstyle that will be used on the text stroke e.g ''#FCFF00'

    • [strokeThickness=0] Float optional

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

    • [wordWrap=false] Bool optional

      Indicates if word wrap should be used

    • [wordWrapWidth=100] Float optional

      The width at which text will wrap, it needs wordWrap to be set to true

    • [dropShadow=false] Bool optional

      Set a drop shadow for the text

    • [dropShadowColor='#000000'] String optional

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

    • [dropShadowAngle=Math.PI/4] Number optional

      Set a angle of the drop shadow

    • [dropShadowDistance=5] Number optional

      Set a distance of the drop shadow

Methods

addChild

(
  • child
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:43

Adds a child to the container.

Parameters:

addChildAt

(
  • child
  • index
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:51

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Parameters:

  • child DisplayObject

    The child to add

  • index Int

    The index to place the child in

click

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:279

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

Parameters:

destroy

(
  • [destroyBaseTexture]
)

Defined in pixi/text/Text.hx:60

Destroys this text object

Parameters:

  • [destroyBaseTexture] Bool optional

    whether to destroy the base texture as well

generateTexture

(
  • resolution
  • scaleMode
  • [renderer]
)
Texture

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:23

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:

  • resolution Float

    The resolution of the texture being generated

  • scaleMode Int

    Should be one of the PIXI.scaleMode consts

  • [renderer] CanvasRenderer | WebGLRenderer optional

    The renderer used to generate the texture.

Returns:

Texture:

a texture of the graphics object

getBounds

(
  • [matrix]
)
Rectangle

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:36

Retrieves the bounds of the displayObject as a rectangle object

Parameters:

Returns:

Rectangle:

the rectangular bounding area

getChildAt

(
  • index
)
DisplayObject

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:69

Returns the child at the specified index

Parameters:

  • index Int

    The index to get the child from

Returns:

DisplayObject:

getChildIndex

(
  • child
)
Int

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:112

Returns the index position of a child DisplayObject instance

Parameters:

Returns:

Int:

The index position of the child display object to identify

getLocalBounds

() Rectangle

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:45

Retrieves the local bounds of the displayObject as a rectangle object

Returns:

Rectangle:

the rectangular bounding area

mousedown

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:286

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

Parameters:

mousemove

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:301

Is called when mouse is moved across the renderer element

Parameters:

mouseout

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:272

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

Parameters:

mouseover

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:265

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

Parameters:

mouseup

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:293

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:

mouseupoutside

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:308

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:

removeChild

(
  • child
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:78

Removes a child from the container.

Parameters:

removeChildAt

(
  • index
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:86

Removes a child from the specified index position in the child list of the container.

Parameters:

  • index Int

    The index to get the child from

removeChildren

(
  • beginIndex
  • [endIndex]
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:94

Removes all child instances from the child list of the container.

Parameters:

  • beginIndex Int

    The beginning position. Predefined value is 0.

  • [endIndex] Int optional

    The ending position. Predefined value is children's array length.

removeStageReference

()

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:121

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

rightclick

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:316

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

Parameters:

rightdown

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:323

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

Parameters:

rightup

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:330

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:

rightupoutside

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:338

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:

setChildIndex

(
  • child
  • index
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:103

Changes the position of an existing child in the display object container

Parameters:

  • child DisplayObject

    The child DisplayObject instance for which you want to change the index number

  • index Int

    The resulting index number for the child display object

setStageReference

(
  • stage
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:53

Sets the object's stage reference, the stage this object is connected to

Parameters:

  • stage Stage

    the stage that the object will have as its current stage reference

setStyle

(
  • style
)

Defined in pixi/text/Text.hx:33

Set the style of the text

Parameters:

  • style TextStyle

    The style parameters

    • [font] String optional

      default 'bold 20px Arial' The style and size of the font

    • [fill='black'] String optional

      A canvas fillstyle that will be used on the text e.g '#00FF00'

    • [align='left'] String optional

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

    • [stroke] String optional

      A canvas fillstyle that will be used on the text stroke e.g ''#FCFF00'

    • [strokeThickness=0] Float optional

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

    • [wordWrap=false] Bool optional

      Indicates if word wrap should be used

    • [wordWrapWidth=100] Float optional

      The width at which text will wrap, it needs wordWrap to be set to true

    • [dropShadow=false] Bool optional

      Set a drop shadow for the text

    • [dropShadowColor='#000000'] String optional

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

    • [dropShadowAngle=Math.PI/4] Number optional

      Set a angle of the drop shadow

    • [dropShadowDistance=5] Number optional

      Set a distance of the drop shadow

setText

(
  • text
)

Defined in pixi/text/Text.hx:52

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

Parameters:

  • text String

    The copy that you would like the text to display

setTexture

(
  • texture
)

Inherited from Sprite: pixi/display/Sprite.hx:73

Sets the texture of the sprite

Parameters:

  • texture Texture

    The PIXI texture that is displayed by the sprite

swapChildren

(
  • child1
  • child2
)

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:60

Swaps the position of 2 Display Objects within this container.

Parameters:

tap

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:346

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

Parameters:

toGlobal

(
  • position
)
Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:61

Calculates the global position of the display object

Parameters:

  • position Point

    The world origin to calculate from

Returns:

Point:

A point object representing the position of this object

toLocal

(
  • position
  • [frm]
)
Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:70

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

Parameters:

  • position Point

    The world origin to calculate from

  • [frm] DisplayObject optional

    The DisplayObject to calculate the global position from

Returns:

Point:

A point object representing the position of this object

touchend

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:361

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

Parameters:

touchendoutside

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:368

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:

touchmove

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:376

Is called when a touch is moved across the renderer element

Parameters:

touchstart

(
  • interactionData
)

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:354

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

Parameters:

updateCache

()

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:80

Generates and updates the cached sprite for this object.

Properties

alpha

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:87

The opacity of the object.

anchor

Point

Inherited from Sprite: pixi/display/Sprite.hx:27

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

blendMode

Int

Inherited from Sprite: pixi/display/Sprite.hx:55

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

Default: PIXI.blendModes.NORMAL;

buttonMode

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:95

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

cacheAsBitmap

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:103

Set weather or not a the display objects 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 filters simply set this property to 'null'

canvas

CanvasElement

Defined in pixi/text/Text.hx:74

The canvas element that everything is drawn to

children

Array

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:34

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

context

CanvasRenderingContext2D

Defined in pixi/text/Text.hx:81

The canvas 2d context that everything is drawn with

defaultCursor

String

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:112

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

filterArea

Rectangle

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:120

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

filters

Array An array of filters

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:129

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'

height

Float

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:26

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

hitArea

Rectangle | Circle | Ellipse | Polygon

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:138

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)

interactive

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:147

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

Default: false

mask

Graphics

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:156

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.

parent

DisplayObjectContainer

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:166

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

pivot

Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:175

The pivot point of the displayObject that it rotates around

position

Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:183

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

renderable

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:191

Can this object be rendered

rotation

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:199

The rotation of the object in radians.

scale

Point

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:207

The scale factor of the object.

shader

PIXI.AbstractFilter

Inherited from Sprite: pixi/display/Sprite.hx:64

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

Default: null

stage

Stage

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:215

[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.

texture

Texture

Inherited from Sprite: pixi/display/Sprite.hx:38

The texture that the sprite is using

tint

Int

Inherited from Sprite: pixi/display/Sprite.hx:46

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

Default: 0xFFFFFF

visible

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:224

The visibility of the object.

width

Float

Inherited from DisplayObjectContainer: pixi/display/CoreDisplayObjectContainer.hx:18

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

worldAlpha

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:232

[read-only] The multiplied alpha of the displayObject

worldVisible

Bool

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:241

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

x

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:249

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

y

Float

Inherited from DisplayObject: pixi/display/CoreDisplayObject.hx:257

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