new BitmapText(game, x, y, font, text, size)
Creates a new BitmapText object.
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:
Members
-
align
-
- Source:
Properties:
Name Type Description alignstring Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.
-
angle
-
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.
- Source:
Properties:
Name Type Description anglenumber Gets or sets the angle of rotation in degrees.
-
cameraOffset
-
- Source:
Properties:
Name Type Description cameraOffsetPhaser.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.
-
destroyPhase
-
- Source:
Properties:
Name Type Description destroyPhaseboolean True if this object is currently being destroyed.
-
events
-
- Source:
Properties:
Name Type Description eventsPhaser.Events The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.
-
exists
-
- Default Value:
- true
- Source:
Properties:
Name Type Description existsboolean If exists = false then the Sprite isn't updated by the core game loop or physics subsystem at all.
-
fixedToCamera
-
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
- Source:
Properties:
Name Type Description fixedToCameraboolean Set to true to fix this BitmapText to the Camera at its current world coordinates.
-
font
-
- Source:
Properties:
Name Type Description fontstring The font the text will be rendered in, i.e. 'Arial'. Must be loaded in the browser before use.
-
fontSize
-
- Source:
Properties:
Name Type Description fontSizenumber The size of the font in pixels.
-
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running Game.
-
input
-
- Source:
Properties:
Name Type Description inputPhaser.InputHandler | null The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.
-
inputEnabled
-
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.
- Source:
Properties:
Name Type Description inputEnabledboolean Set to true to allow this object to receive input events.
-
name
-
- Source:
Properties:
Name Type Description namestring The user defined name given to this BitmapText.
-
smoothed
-
- Source:
Properties:
Name Type Description textstring 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.
-
text
-
The text string to be displayed by this Text object, taking into account the style settings.
- Source:
Properties:
Name Type Description textstring The text string to be displayed by this Text object, taking into account the style settings.
-
text
-
- Source:
Properties:
Name Type Description textstring 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.
-
tint
-
- Source:
Properties:
Name Type Description tintnumber The tint applied to the BitmapText. This is a hex value. Set to white to disable (0xFFFFFF)
-
<readonly> type
-
- Source:
Properties:
Name Type Description typenumber The const type of this object.
-
world
-
- Source:
Properties:
Name Type Description worldPhaser.Point The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.
-
z
-
- Source:
Properties:
Name Type Description znumber 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.
Methods
-
destroy(destroyChildren)
-
Destroy this BitmapText instance. This will remove any filters and un-parent any children.
Parameters:
Name Type Argument Default Description destroyChildrenboolean <optional>
true Should every child of this object have its destroy method called?
- Source:
-
postUpdate()
-
Automatically called by World.postUpdate.
- Source:
-
preUpdate()
-
Automatically called by World.preUpdate.
- Source:
-
update()
-
Override and use this function in your own custom objects to handle any update requirements you may have.
- Source: