Types.GameObjects.BitmapText

x

number

No

The x position of the character.

y

number

No

The y position of the character.

width

number

No

The width of the character.

height

number

No

The height of the character.

centerX

number

No

The center x position of the character.

centerY

number

No

The center y position of the character.

xOffset

number

No

The x offset of the character.

yOffset

number

No

The y offset of the character.

u0

number

No

WebGL texture u0.

v0

number

No

WebGL texture v0.

u1

number

No

WebGL texture u1.

v1

number

No

WebGL texture v1.

data

object

No

Extra data for the character.

kerning

Object.<number>

No

Kerning values, keyed by character code.

font

string

No

The name of the font.

size

number

No

The size of the font.

lineHeight

number

No

The line height of the font.

retroFont

boolean

No

Whether this font is a retro font (monospace).

chars

Object.<number, Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData>

No

The character data of the font, keyed by character code. Each character datum includes a position, size, offset and more.

i

number

No

The index of this character within the BitmapText wrapped text string.

idx

number

No

The index of this character within the BitmapText text string.

char

string

No

The character.

code

number

No

The character code of the character.

x

number

No

The x position of the character in the BitmapText.

y

number

No

The y position of the character in the BitmapText.

w

number

No

The width of the character.

h

number

No

The height of the character.

t

number

No

The top of the line this character is on.

r

number

No

The right-most point of this character, including xAdvance.

b

number

No

The bottom of the line this character is on.

line

number

No

The line number the character appears on.

glyph

Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData

No

Reference to the glyph object this character is using.

font

string

Yes

"''"

The key of the font to use from the BitmapFont cache.

text

string

Yes

"''"

The string, or array of strings, to be set as the content of this Bitmap Text.

size

number | false

Yes

false

The font size to set.

shortest

number

No

The width of the shortest line of text.

longest

number

No

The width of the longest line of text.

height

number

No

The height of a line of text.

lengths

Array.<number>

No

An array where each entry contains the length of that line of text.

global

Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize

No

The position and size of the BitmapText, taking into account the position and scale of the Game Object.

local

Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize

No

The position and size of the BitmapText, taking just the font size into account.

lines

Phaser.Types.GameObjects.BitmapText.BitmapTextLines

No

Data about the lines of text within the BitmapText.

characters

Array.<Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter>

No

An array containing per-character data. Only populated if includeChars is true in the getTextBounds call.

words

Array.<Phaser.Types.GameObjects.BitmapText.BitmapTextWord>

No

An array containing the word data from the BitmapText.

scale

number

No

The scale of the BitmapText font being rendered vs. font size in the text data.

scaleX

number

No

The scale X value of the BitmapText.

scaleY

number

No

The scale Y value of the BitmapText.

wrappedText

string

No

The wrapped text, if wrapping enabled and required.

x

number

No

The x position of the word in the BitmapText.

y

number

No

The y position of the word in the BitmapText.

w

number

No

The width of the word.

h

number

No

The height of the word.

i

number

No

The index of the first character of this word within the entire string. Note: this index factors in spaces, quotes, carriage-returns, etc.

word

string

No

The word.

parent

Phaser.GameObjects.DynamicBitmapText

No

The Dynamic Bitmap Text object that owns this character being rendered.

tint

Phaser.Types.GameObjects.BitmapText.TintConfig

No

The tint of the character being rendered. Always zero in Canvas.

index

number

No

The index of the character being rendered.

charCode

number

No

The character code of the character being rendered.

x

number

No

The x position of the character being rendered.

y

number

No

The y position of the character being rendered.

scale

number

No

The scale of the character being rendered.

rotation

number

No

The rotation of the character being rendered.

data

any

No

Custom data stored with the character being rendered.

x

number

No

The x position of the BitmapText, taking into account the x position and scale of the Game Object.

y

number

No

The y position of the BitmapText, taking into account the y position and scale of the Game Object.

width

number

No

The width of the BitmapText, taking into account the x scale of the Game Object.

height

number

No

The height of the BitmapText, taking into account the y scale of the Game Object.

font

string

No

The name of the font.

text

string

No

The text that this Bitmap Text displays.

fontSize

number

No

The size of the font.

letterSpacing

number

No

Adds / Removes spacing between characters.

lineSpacing

number

No

Adds / Removes spacing between lines in multi-line text.

align

number

No

The alignment of the text in a multi-line BitmapText object.

x

number

No

The x position of the BitmapText.

y

number

No

The y position of the BitmapText.

width

number

No

The width of the BitmapText.

height

number

No

The height of the BitmapText.

image

string

No

The key of the image containing the font.

offset.x

number

No

If the font set doesn't start at the top left of the given image, specify the X coordinate offset here.

offset.y

number

No

If the font set doesn't start at the top left of the given image, specify the Y coordinate offset here.

width

number

No

The width of each character in the font set.

height

number

No

The height of each character in the font set.

chars

string

No

The characters used in the font set, in display order. You can use the TEXT_SET consts for common font set arrangements.

charsPerRow

number

No

The number of characters per row in the font set. If not given charsPerRow will be the image width / characterWidth.

spacing.x

number

No

If the characters in the font set have horizontal spacing between them set the required amount here.

spacing.y

number

No

If the characters in the font set have vertical spacing between them set the required amount here.

lineSpacing

number

No

The amount of vertical space to add to the line height of the font.

topLeft

number

No

The top left tint value. Always zero in canvas.

topRight

number

No

The top right tint value. Always zero in canvas.

bottomLeft

number

No

The bottom left tint value. Always zero in canvas.

bottomRight

number

No

The bottom right tint value. Always zero in canvas.