Phaser.GameObjects.TextStyle - Phaser 3 API Documentation (beta)

name	type	description
text	Phaser.GameObjects.Text	The Text object that this TextStyle is styling.
style	Phaser.Types.GameObjects.Text.TextStyle	The style settings to set.

align: string

Description:

The text alignment.

Type:

string

Default: 'left'

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 202)

backgroundColor: string

Description:

The background color.

Type:

string

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 103)

baselineX: number

Description:

The amount of horizontal padding added to the width of the text when calculating the font metrics.

Type:

number

Default: 1.2

Since: 3.3.0

Source: src/gameobjects/text/TextStyle.js (Line 277)

baselineY: number

Description:

The amount of vertical padding added to the height of the text when calculating the font metrics.

Type:

number

Default: 1.4

Since: 3.3.0

Source: src/gameobjects/text/TextStyle.js (Line 287)

color: string

Description:

The text fill color.

Type:

string

Default: '#fff'

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 112)

fixedHeight: number

Description:

The fixed height of the text.

0 means no fixed height.

Type:

number

Default: 0

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 234)

fixedWidth: number

Description:

The fixed width of the text.

0 means no fixed with.

Type:

number

Default: 0

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 222)

fontFamily: string

Description:

The font family.

Type:

string

Default: 'Courier'

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 74)

fontSize: string | number

Description:

The font size.

Type:

string | number

Default: '16px'

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 84)

fontStyle: string

Description:

The font style.

Type:

string

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 94)

maxLines: number

Description:

The maximum number of lines to draw.

Type:

number

Default: 0

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 212)

parent: Phaser.GameObjects.Text

Description:

The Text object that this TextStyle is styling.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 65)

resolution: number

Description:

The resolution the text is rendered to its internal canvas at. The default is 0, which means it will use the resolution set in the Game Config.

Type:

number

Default: 0

Since: 3.12.0

Source: src/gameobjects/text/TextStyle.js (Line 246)

rtl: boolean

Description:

Whether the text should render right to left.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 257)

shadowBlur: number

Description:

The shadow blur radius.

Type:

number

Default: 0

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 172)

shadowColor: string

Description:

The shadow color.

Type:

string

Default: '#000'

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 162)

shadowFill: boolean

Description:

Whether shadow fill is enabled or not.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 192)

shadowOffsetX: number

Description:

The horizontal shadow offset.

Type:

number

Default: 0

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 142)

shadowOffsetY: number

Description:

The vertical shadow offset.

Type:

number

Default: 0

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 152)

shadowStroke: boolean

Description:

Whether shadow stroke is enabled or not.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 182)

stroke: string

Description:

The text stroke color.

Type:

string

Default: '#fff'

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 122)

strokeThickness: number

Description:

The text stroke thickness.

Type:

number

Default: 0

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 132)

testString: string

Description:

The test string to use when measuring the font.

Type:

string

Default: '|MÉqgy'

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 267)

wordWrapCallback: TextStyleWordWrapCallback | null

Description:

A custom function that will be responsible for wrapping the text. It will receive two arguments: text (the string to wrap), textObject (this Text instance). It should return the wrapped lines either as an array of lines or as a string with newline characters in place to indicate where breaks should happen. Setting this directly will not re-run the word wrapping algorithm. To change the callback and re-wrap, use Phaser.GameObjects.TextStyle#setWordWrapCallback.

Type:

TextStyleWordWrapCallback | null

Default: null

Since: 3.24.0

Source: src/gameobjects/text/TextStyle.js (Line 309)

wordWrapCallbackScope: object | null

Description:

The scope that will be applied when the wordWrapCallback is invoked. Setting this directly will not re-run the word wrapping algorithm. To change the callback and re-wrap, use Phaser.GameObjects.TextStyle#setWordWrapCallback.

Type:

object | null

Default: null

Since: 3.24.0

Source: src/gameobjects/text/TextStyle.js (Line 324)

wordWrapUseAdvanced: boolean

Description:

Whether or not to use the advanced wrapping algorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false, spaces and whitespace are left as is. Setting this property directly will not re-run the word wrapping algorithm. To change the advanced setting and re-wrap, use Phaser.GameObjects.TextStyle#setWordWrapWidth.

Type:

boolean

Default: false

Since: 3.24.0

Source: src/gameobjects/text/TextStyle.js (Line 336)

wordWrapWidth: number | null

Description:

The maximum width of a line of text in pixels. Null means no line wrapping. Setting this property directly will not re-run the word wrapping algorithm. To change the width and re-wrap, use Phaser.GameObjects.TextStyle#setWordWrapWidth.

Type:

number | null

Default: null

Since: 3.24.0

Source: src/gameobjects/text/TextStyle.js (Line 297)

destroy()

Description:

Destroy this Text Style.

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 1087)

getTextMetrics()

Description:

Get the current text metrics.

Returns:

Description:

The text metrics.

Type:

Phaser.Types.GameObjects.Text.TextMetrics

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 1046)

setAlign([align])

Description:

Set the alignment of the text in this Text object.

The argument can be one of: left, right, center or justify.

Alignment only works if the Text object has more than one line of text.

Parameters:

name	type	arguments	Default	description
align	string	<optional>	'left'	The text alignment for multi-line text.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 1004)

setBackgroundColor(color)

Description:

Set the background color.

Parameters:

name	type	description
color	string	The background color.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 715)

setColor(color)

Description:

Set the text fill color.

Parameters:

name	type	description
color	string	The text fill color.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 749)

setFill(color)

Description:

Set the text fill color.

Parameters:

name	type	description
color	string	The text fill color.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 732)

setFixedSize(width, height)

Description:

Set a fixed width and height for the text.

Pass in 0 for either of these parameters to disable fixed width or height respectively.

Parameters:

name	type	description
width	number	The fixed width to set.
height	number	The fixed height to set.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 684)

setFont(font, [updateText])

Description:

Set the font.

If a string is given, the font family is set.

If an object is given, the fontFamily, fontSize and fontStyle properties of that object are set.

Parameters:

name	type	arguments	Default	description
font	string \| object			The font family or font settings to set.
updateText	boolean	<optional>	true	Whether to update the text immediately.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 540)

setFontFamily(family)

Description:

Set the font family.

Parameters:

name	type	description
family	string	The font family.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 596)

setFontSize(size)

Description:

Set the font size. Can be a string with a valid CSS unit, i.e. 16px, or a number.

Parameters:

name	type	description
size	number \| string	The font size.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 640)

setFontStyle(style)

Description:

Set the font style.

Parameters:

name	type	description
style	string	The font style.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 618)

setMaxLines([max])

Description:

Set the maximum number of lines to draw.

Parameters:

name	type	arguments	description
max	number	<optional>	The maximum number of lines to draw.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 1027)

setResolution(value)

Description:

Set the resolution used by the Text object.

By default it will be set to match the resolution set in the Game Config, but you can override it via this method. It allows for much clearer text on High DPI devices, at the cost of memory because it uses larger internal Canvas textures for the Text.

Please use with caution, as the more high res Text you have, the more memory it uses up.

Parameters:

name	type	description
value	number	The resolution for this Text object to use.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.12.0

Source: src/gameobjects/text/TextStyle.js (Line 766)

setShadow([x], [y], [color], [blur], [shadowStroke], [shadowFill])

Description:

Set the shadow settings.

Calling this method always re-measures the parent Text object, so only call it when you actually change the shadow settings.

Parameters:

name	type	arguments	Default	description
x	number	<optional>	0	The horizontal shadow offset.
y	number	<optional>	0	The vertical shadow offset.
color	string	<optional>	'#000'	The shadow color.
blur	number	<optional>	0	The shadow blur radius.
shadowStroke	boolean	<optional>	false	Whether to stroke the shadow.
shadowFill	boolean	<optional>	true	Whether to fill the shadow.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 822)

setShadowBlur([blur])

Description:

Set the shadow blur radius.

Parameters:

name	type	arguments	description
blur	number	<optional>	The shadow blur radius.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 900)

setShadowColor([color])

Description:

Set the shadow color.

Parameters:

name	type	arguments	Default	description
color	string	<optional>	'#000'	The shadow color.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 881)

setShadowFill(enabled)

Description:

Enable or disable shadow fill.

Parameters:

name	type	description
enabled	boolean	Whether shadow fill is enabled or not.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 936)

setShadowOffset([x], [y])

Description:

Set the shadow offset.

Parameters:

name	type	arguments	description
x	number	<optional>	The horizontal shadow offset.
y	number	<optional>	The vertical shadow offset.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 859)

setShadowStroke(enabled)

Description:

Enable or disable shadow stroke.

Parameters:

name	type	description
enabled	boolean	Whether shadow stroke is enabled or not.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 919)

setStroke(color, thickness)

Description:

Set the stroke settings.

Parameters:

name	type	description
color	string	The stroke color.
thickness	number	The stroke thickness.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 789)

setStyle(style, [updateText], [setDefaults])

Description:

Set the text style.

Parameters:

name	type	arguments	Default	description
style	Phaser.Types.GameObjects.Text.TextStyle			The style settings to set.
updateText	boolean	<optional>	true	Whether to update the text immediately.
setDefaults	boolean	<optional>	false	Use the default values is not set, or the local values.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Examples:

text.setStyle({
    fontSize: '64px',
    fontFamily: 'Arial',
    color: '#ffffff',
    align: 'center',
    backgroundColor: '#ff00ff'
});

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 363)

setTestString(string)

Description:

Set the test string to use when measuring the font.

Parameters:

name	type	description
string	string	The test string to use when measuring the font.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 667)

setWordWrapCallback(callback, [scope])

Description:

Set a custom callback for wrapping lines.

Pass in null to remove wrapping by callback.

Parameters:

name	type	arguments	Default	description
callback	TextStyleWordWrapCallback			A custom function that will be responsible for wrapping the text. It will receive two arguments: text (the string to wrap), textObject (this Text instance). It should return the wrapped lines either as an array of lines or as a string with newline characters in place to indicate where breaks should happen.
scope	object	<optional>	null	The scope that will be applied when the callback is invoked.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 978)

setWordWrapWidth(width, [useAdvancedWrap])

Description:

Set the width (in pixels) to use for wrapping lines.

Pass in null to remove wrapping by width.

Parameters:

name	type	arguments	Default	description
width	number			The maximum width of a line in pixels. Set to null to remove wrapping.
useAdvancedWrap	boolean	<optional>	false	Whether or not to use the advanced wrapping algorithm. If true, spaces are collapsed and whitespace is trimmed from lines. If false, spaces and whitespace are left as is.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 953)

syncFont(canvas, context)

Description:

Synchronize the font settings to the given Canvas Rendering Context.

Parameters:

name	type	description
canvas	HTMLCanvasElement	The Canvas Element.
context	CanvasRenderingContext2D	The Canvas Rendering Context.

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 456)

syncShadow(context, enabled)

Description:

Synchronize the shadow settings to the given Canvas Rendering Context.

Parameters:

name	type	description
context	CanvasRenderingContext2D	The Canvas Rendering Context.
enabled	boolean	Whether shadows are enabled or not.

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 491)

syncStyle(canvas, context)

Description:

Synchronize the text style settings to the given Canvas Rendering Context.

Parameters:

name	type	description
canvas	HTMLCanvasElement	The Canvas Element.
context	CanvasRenderingContext2D	The Canvas Rendering Context.

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 470)

toJSON()

Description:

Build a JSON representation of this Text Style.

Returns:

Description:

A JSON representation of this Text Style.

Type:

object

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 1065)

update(recalculateMetrics)

Description:

Update the style settings for the parent Text object.

Parameters:

name	type	description
recalculateMetrics	boolean	Whether to recalculate font and text metrics.

Returns:

Description:

The parent Text object.

Type:

Phaser.GameObjects.Text

Since: 3.0.0

Source: src/gameobjects/text/TextStyle.js (Line 518)

Filter

Phaser . GameObjects . TextStyle

Phaser . GameObjects . TextStyle

Constructor:

Parameters:

Members

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Description:

Type:

Methods

Description:

Description:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters:

Returns:

Description:

Type:

Description:

Parameters: