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

Phaser. BitmapText

new BitmapText(game, x, y, font, text, size)

BitmapText objects work by taking a texture file and an XML file that describes the font layout.

On Windows you can use the free app BMFont: http://www.angelcode.com/products/bmfont/ On OS X we recommend Glyph Designer: http://www.71squared.com/en/glyphdesigner For Web there is the great Littera: http://kvazars.com/littera/

Parameters
Name Type Argument Default Description
game Phaser.Game

A reference to the currently running game.

x number

X position of the new bitmapText object.

y number

Y position of the new bitmapText object.

font string

The key of the BitmapFont as stored in Game.Cache.

text string <optional>
''

The actual text that will be rendered. Can be set later via BitmapText.text.

size number <optional>
32

The size the font will be rendered in, in pixels.

Source code: gameobjects/BitmapText.js, line 24

Extends

Public Properties

align : string

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

Source code: gameobjects/BitmapText.js, line 265

alpha : number

The opacity of the object.

Inherited From
Source code: 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 code: 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
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

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 code: gameobjects/BitmapText.js, line 108

[readonly] children : Array.<DisplayObject>

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

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

destroyPhase : boolean

True if this object is currently being destroyed.

Source code: gameobjects/BitmapText.js, line 471

dirty : boolean

The dirty state of this object.

Inherited From
Source code: 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 code: 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 code: 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
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

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 code: 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 code: gameobjects/BitmapText.js, line 328

fontSize : number

The size of the font in pixels.

Source code: gameobjects/BitmapText.js, line 351

game : Phaser.Game

A reference to the currently running Game.

Source code: 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
Source code: 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
Inherited From
Source code: 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
Source code: 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 code: gameobjects/BitmapText.js, line 399

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

name : string

The user defined name given to this BitmapText.

Source code: gameobjects/BitmapText.js, line 47

[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

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

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

[readonly] type : number

The const type of this object.

Source code: gameobjects/BitmapText.js, line 53

visible : boolean

The visibility of the object.

Inherited From
Source code: 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
Source code: 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 code: gameobjects/BitmapText.js, line 63

[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

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 code: gameobjects/BitmapText.js, line 58

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

a texture of the graphics object

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

getBounds() → {PIXI.Rectangle}

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

Returns

The rectangular bounding area

Inherited From
Source code: 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

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

postUpdate()

Automatically called by World.postUpdate.

Source code: gameobjects/BitmapText.js, line 190

preUpdate()

Automatically called by World.preUpdate.

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

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

setText(text)

Set the text string to be rendered.

Parameters
Name Type Description
text String

The text that you would like displayed

Inherited From
Source code: 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
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

update()

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

Source code: gameobjects/BitmapText.js, line 181

updateCache()

Generates and updates the cached sprite for this object.

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