Text

.GameObjects. Text

Type Definitions

GetTextSizeObject

Since:
  • 3.0.0
Properties:
Name Type Description
width number 文本对象中最长线条的宽度.
height number 文本对象的高度.
lines number 文本对象中的行数.
lineWidths Array.<number> 文本对象中每行的行数组.
lineSpacing number 文本对象的行距.
lineHeight number 考虑字体和笔画的线条高度.
对GetTextSize的调用的结果对象.
Type:
  • object

TextConfig

Since:
  • 3.0.0
Properties:
Name Type Attributes Description
text string | Array.<string> <optional>
该文本对象将显示的文本.
style Phaser.Types.GameObjects.Text.TextStyle <optional>
文本样式配置对象.
padding Phaser.Types.GameObjects.Text.TextPadding <optional>
文本填充对象.
Type:
  • object

TextMetrics

Since:
  • 3.0.0
Properties:
Name Type Description
ascent number 字体的上升.
descent number 字体的下降.
fontSize number 字体的大小.
文本样式对象的字体度量.
Type:
  • object

TextPadding

Since:
  • 3.18.0
Properties:
Name Type Attributes Description
x number <optional>
如果设置,该值用于左右填充.
y number <optional>
如果设置,该值用于顶部和底部填充.
left number <optional>
添加到文本对象左侧的填充量.
right number <optional>
添加到文本对象右侧的填充量.
top number <optional>
添加到文本对象顶部的填充量.
bottom number <optional>
添加到文本对象底部的填充量.
文本样式使用的文本填充配置对象.
Type:
  • object

TextShadow

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
offsetX number <optional>
0 阴影的水平偏移量.
offsetY number <optional>
0 阴影的垂直偏移量.
color string <optional>
'#000' 阴影的颜色,以CSS字符串值的形式给出.
blur number <optional>
0 应用于阴影的模糊量.留下一个坚硬的影子.
stroke boolean <optional>
false 将阴影应用于文本对象的笔画效果?
fill boolean <optional>
false 将阴影应用于文本对象的填充效果?
文本样式使用的文本阴影配置对象.
Type:
  • object

TextStyle

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
fontFamily string <optional>
'Courier' 文本对象将呈现的字体.这是一个画布风格的字体字符串.
fontSize string <optional>
'16px' 字体大小,作为CSS大小字符串.
fontStyle string <optional>
任何附加字体样式,如 `strong` .
font string <optional>
要设置的字体系列或字体设置.覆盖其他字体设置.
backgroundColor string <optional>
呈现在文本对象后面的纯色填充.给定为CSS字符串颜色,如 `#ff0` .
color string <optional>
'#fff' 文本的绘制颜色.给定为CSS字符串颜色,如 `#fff` 或 `RGB()`` .
stroke string <optional>
'#fff' 如果属性大于零,用于描边文本的颜色.
strokeThickness number <optional>
0 文本周围笔画的粗细.如果没有笔画,则设置为零.
shadow Phaser.Types.GameObjects.Text.TextShadow <optional>
文本阴影配置对象.
padding Phaser.Types.GameObjects.Text.TextPadding <optional>
文本填充对象.
align string <optional>
'left' 文本的对齐方式.这只会影响多行文本. `left` , `right` , `center` 或 `justify` .
maxLines number <optional>
0 文本对象中显示的最大行数.
fixedWidth number <optional>
0 强制文本对象具有在此属性中指定的精确宽度.保留为0,以便根据内容进行相应的更改.
fixedHeight number <optional>
0 强制文本对象具有此属性中指定的精确高度.保留为0,以便根据内容进行相应的更改.
resolution number <optional>
0 设置文本对象的分辨率(DPI设置).归零,让它使用游戏分辨率.
rtl boolean <optional>
false 如果此文本对象应该从右向左呈现,则设置为 `true` .
testString string <optional>
'|MÉqgy' 这是用于帮助画布计算字体高度的字符串.
baselineX number <optional>
1.2 计算字体度量时添加到文本宽度的水平填充量.
baselineY number <optional>
1.4 计算字体度量时添加到文本高度的垂直填充量.
wordWrap Phaser.Types.GameObjects.Text.TextWordWrap <optional>
文本自动换行配置对象.
metrics Phaser.Types.GameObjects.Text.TextMetrics <optional>
文本度量对象.使用这种方法可以避免在重文本游戏中进行昂贵的字体大小计算.
文本游戏对象使用的文本样式配置对象.
Type:
  • object

TextWordWrap

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
width number <optional>
考虑文字换行的宽度.
callback TextStyleWordWrapCallback <optional>
启用换行时提供自定义回调.
callbackScope any <optional>
调用自动换行回调的上下文.
useAdvancedWrap boolean <optional>
false 用基本的还是高级的换行?
文本样式配置使用的文本自动换行配置对象.
Type:
  • object