TextStyle

.GameObjects. TextStyle

文本样式类管理文本对象的所有样式设置. 文本游戏对象自动创建一个文本样式实例 通过 `Text.style` 属性访问.你通常不需要 自己实例化一个.

Constructor

new TextStyle(text, style)

Since:
  • 3.0.0
Parameters:
Name Type Description
text Phaser.GameObjects.Text 此文本样式正在设置样式的文本对象.
style Phaser.Types.GameObjects.Text.TextStyle 要设置的样式设置.

Members

align :string

Since:
  • 3.0.0
Default Value:
  • 'left'
文本对齐方式.
Type:
  • string

backgroundColor :string

Since:
  • 3.0.0
背景颜色.
Type:
  • string

baselineX :number

Since:
  • 3.3.0
Default Value:
  • 1.2
计算字体度量时添加到文本宽度的水平填充量.
Type:
  • number

baselineY :number

Since:
  • 3.3.0
Default Value:
  • 1.4
计算字体度量时添加到文本高度的垂直填充量.
Type:
  • number

color :string

Since:
  • 3.0.0
Default Value:
  • '#fff'
文本填充颜色.
Type:
  • string

fixedHeight :number

Since:
  • 3.0.0
Default Value:
  • 0
文本的固定高度. `0` 表示没有固定高度.
Type:
  • number

fixedWidth :number

Since:
  • 3.0.0
Default Value:
  • 0
文本的固定宽度. `0` 表示无固定搭配.
Type:
  • number

fontFamily :string

Since:
  • 3.0.0
Default Value:
  • 'Courier'
字体系列.
Type:
  • string

fontSize :string

Since:
  • 3.0.0
Default Value:
  • '16px'
字体大小.
Type:
  • string

fontStyle :string

Since:
  • 3.0.0
字体样式.
Type:
  • string

maxLines :number

Since:
  • 3.0.0
Default Value:
  • 0
要绘制的最大行数.
Type:
  • number

parent :Phaser.GameObjects.Text

Since:
  • 3.0.0
此文本样式正在设置样式的文本对象.
Type:

resolution :number

Since:
  • 3.12.0
Default Value:
  • 0
文本呈现到其内部画布的分辨率. 默认值为0,这意味着它将使用游戏配置中设置的分辨率.
Type:
  • number

rtl :boolean

Since:
  • 3.0.0
Default Value:
  • false
文本是否应该从右向左呈现.
Type:
  • boolean

shadowBlur :number

Since:
  • 3.0.0
Default Value:
  • 0
阴影模糊半径.
Type:
  • number

shadowColor :string

Since:
  • 3.0.0
Default Value:
  • '#000'
阴影颜色.
Type:
  • string

shadowFill :boolean

Since:
  • 3.0.0
Default Value:
  • false
阴影填充是否启用.
Type:
  • boolean

shadowOffsetX :number

Since:
  • 3.0.0
Default Value:
  • 0
水平阴影偏移量.
Type:
  • number

shadowOffsetY :number

Since:
  • 3.0.0
Default Value:
  • 0
垂直阴影偏移量.
Type:
  • number

shadowStroke :boolean

Since:
  • 3.0.0
Default Value:
  • false
阴影笔划是否启用.
Type:
  • boolean

stroke :string

Since:
  • 3.0.0
Default Value:
  • '#fff'
文本笔画颜色.
Type:
  • string

strokeThickness :number

Since:
  • 3.0.0
Default Value:
  • 0
文本笔画粗细.
Type:
  • number

testString :string

Since:
  • 3.0.0
Default Value:
  • '|MÉqgy'
测量字体时使用的测试字符串.
Type:
  • string

wordWrapCallback :TextStyleWordWrapCallback|null

Since:
  • 3.24.0
Default Value:
  • null
负责包装文本的自定义函数.它将接收两个 参数:文本(要换行的字符串),文本对象(此文本实例).它应该会回来 换行可以是行的数组,也可以是带有换行符的字符串 指示应该发生中断的位置.直接设置此选项不会重新运行 单词换行算法.要更改回调并重新包装,请使用 Phaser.GameObjects.TextStyle#setWordWrapCallback.
Type:

wordWrapCallbackScope :object|null

Since:
  • 3.24.0
Default Value:
  • null
调用wordWrapCallback时将应用的范围.直接设置此选项不会重新运行 单词换行算法.要更改回调并重新包装,请使用 Phaser.GameObjects.TextStyle#setWordWrapCallback.
Type:
  • object | null

wordWrapUseAdvanced :boolean

Since:
  • 3.24.0
Default Value:
  • false
是否使用高级包装算法.如果为真,则空间被折叠 从行中删除空白.如果为false,空格和空白按原样保留.设定 该属性不会直接重新运行换行算法.改变 高级设置和重新包装,使用Phaser.GameObjects.TextStyle#setWordWrapWidth.
Type:
  • boolean

wordWrapWidth :number|null

Since:
  • 3.24.0
Default Value:
  • null
一行文本的最大宽度,以像素为单位.Null表示没有换行.设置这个 属性不会重新运行换行算法.要更改宽度和 重新包装,使用Phaser.GameObjects.TextStyle#setWordWrapWidth.
Type:
  • number | null

Methods

destroy()

Since:
  • 3.0.0
销毁此文本样式.

getTextMetrics() → {Phaser.Types.GameObjects.Text.TextMetrics}

Since:
  • 3.0.0
获取当前文本度量.
Returns:
文本度量.
Type
Phaser.Types.GameObjects.Text.TextMetrics

setAlign(alignopt) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置此文本对象中文本的对齐方式. 参数可以是: `left` , `right` , `center` 或 `justify` 之一. 仅当文本对象有多行文本时,对齐才有效.
Parameters:
Name Type Attributes Default Description
align string <optional>
'left' The text alignment for multi-line text.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setBackgroundColor(color) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置背景颜色.
Parameters:
Name Type Description
color string 背景颜色.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setColor(color) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置文本填充颜色.
Parameters:
Name Type Description
color string 文本填充颜色.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setFill(color) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置文本填充颜色.
Parameters:
Name Type Description
color string 文本填充颜色.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setFixedSize(width, height) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
为文本设置固定的宽度和高度. 为这些参数中的任何一个传入 `0` ,以分别禁用固定宽度或高度.
Parameters:
Name Type Description
width number 要设置的固定宽度.
height number 要设置的固定高度.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setFont(font, updateTextopt) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置字体. 如果给定一个字符串,则设置字体系列. 如果给定了一个对象`fontFamily`, `fontSize` and `fontStyle` 设置该对象的属性.
Parameters:
Name Type Attributes Default Description
font string | object 要设置的字体系列或字体设置.
updateText boolean <optional>
true 是否立即更新文本.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setFontFamily(family) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置字体系列.
Parameters:
Name Type Description
family string 字体系列.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setFontSize(size) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置字体大小.
Parameters:
Name Type Description
size number | string 字体大小.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setFontStyle(style) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置字体样式.
Parameters:
Name Type Description
style string 字体样式.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setMaxLines(maxopt) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置要绘制的最大行数.
Parameters:
Name Type Attributes Default Description
max number <optional>
0 要绘制的最大行数.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setResolution(value) → {Phaser.GameObjects.Text}

Since:
  • 3.12.0
设置文本对象使用的分辨率. 默认情况下,它将被设置为与游戏配置中设置的分辨率相匹配, 但是您可以通过此方法覆盖它.它允许在高DPI设备上显示更清晰的文本, 因为它为文本使用了更大的内部画布纹理. 请谨慎使用,因为分辨率越高,文本占用的内存越多.
Parameters:
Name Type Description
value number 此文本对象要使用的分辨率.
Returns:
父文本对象.
Type
Phaser.GameObjects.Text

setShadow(xopt, yopt, coloropt, bluropt, shadowStrokeopt, shadowFillopt) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
设置阴影设置. 调用此方法总是重新测量父文本对象, 所以只有当你真正改变阴影设置的时候才调用它.
Parameters:
Name Type Attributes Default Description
x number <optional>
0 水平阴影偏移量.
y number <optional>
0 垂直阴影偏移量.
color