BitmapText

.GameObjects. BitmapText

Type Definitions

BitmapFontCharacterData

Since:
  • 3.0.0
Properties:
Name Type Description
x number 字符的x位置.
y number 字符的y位置.
width number 字符的宽度.
height number 人物的身高.
centerX number 字符的x中心位置.
centerY number 字符的中心y位置.
xOffset number 字符的x偏移量.
yOffset number 字符的y偏移量.
u0 number WebGL texture u0.
v0 number WebGL texture v0.
u1 number WebGL texture u1.
v1 number WebGL texture v1.
data object 角色的额外数据.
kerning Object.<number> 由字符代码键入的字距调整值.
位图字体中单个字符的字体数据. 描述字符的位置,大小,偏移量和字距调整. 从3.50版本开始,它还包括WebGL纹理紫外线数据.
Type:
  • object

BitmapFontData

Since:
  • 3.0.0
Properties:
Name Type Description
font string 字体的名称.
size number 字体的大小.
lineHeight number 字体的行高.
retroFont boolean 此字体是否为复古字体(等宽).
chars Object.<number, Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData> 字体的字符数据,由字符代码键入.每个字符数据包括位置,大小,偏移量等.
位图文本游戏对象可以使用的位图字体数据.
Type:
  • object

BitmapTextCharacter

Since:
  • 3.50.0
Properties:
Name Type Description
i number 位图文本字符串中该字符的索引.
char string 角色.
code number 字符的字符代码.
x number 位图文本中字符的x位置.
y number 位图文本中字符的y位置.
w number 字符的宽度.
h number 人物的身高.
t number 该字符所在行的顶部.
r number 这个角色最右边的点,包括xAdvance.
b number 该字符所在行的底部.
line number 字符出现的行号.
glyph Phaser.Types.GameObjects.BitmapText.BitmapFontCharacterData 对该字符使用的字形对象的引用.
`BitmapTextSize` 字符数组中的单个条目. 位置和尺寸会考虑字体大小, 但是没有被转换到游戏对象本身的本地空间中.
Type:
  • object

BitmapTextConfig

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
font string <optional>
'' 位图字体缓存中要使用的字体的键.
text string <optional>
'' 要设置为此位图文本内容的字符串或字符串数组.
size number | false <optional>
false 要设置的字体大小.
Type:
  • object

BitmapTextLines

Since:
  • 3.50.0
Properties:
Name Type Description
shortest number 最短文本行的宽度.
longest number 最长文本行的宽度.
height number 一行文本的高度.
lengths Array.<number> 一个数组,其中每个条目包含该行文本的长度.
`BitmapTextSize` 对象中的行数据的详细信息.
Type:
  • object

BitmapTextSize

Since:
  • 3.0.0
Properties:
Name Type Description
global Phaser.Types.GameObjects.BitmapText.GlobalBitmapTextSize 位图文本的位置和大小,考虑游戏对象的位置和比例.
local Phaser.Types.GameObjects.BitmapText.LocalBitmapTextSize 位图文本的位置和大小,仅考虑字体大小.
lines Phaser.Types.GameObjects.BitmapText.BitmapTextLines 位图文本中文本行的相关数据.
characters Array.<Phaser.Types.GameObjects.BitmapText.BitmapTextCharacter> 包含每字符数据的数组.仅当 `getTextBounds` 调用中的 `includeChars` 为 `true` 时才填充.
words Array.<Phaser.Types.GameObjects.BitmapText.BitmapTextWord> 包含位图文本中单词数据的数组.
scale number 正在呈现的位图文本字体的比例与.文本数据中的字体大小.
scaleX number 位图文本的比例X值.
scaleY number 位图文本的Y比例值.
wrappedText string 如果启用并要求换行,则为换行文本.
Type:
  • object

BitmapTextWord

Since:
  • 3.50.0
Properties:
Name Type Description
x number 该单词在位图文本中的x位置.
y number 位图文本中单词的y位置.
w number 单词的宽度.
h number 单词的高度.
i number 行内单词的索引.
word string 这个词.
`BitmapTextSize` 对象单词数组中单个世界条目的详细信息.
Type:
  • object

DisplayCallback(display) → {Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig}

Parameters:
Name Type Description
display Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig Settings of the character that is 即将呈现.
Returns:
Altered position, scale and rotation values for the character that is 即将呈现.
Type
Phaser.Types.GameObjects.BitmapText.DisplayCallbackConfig

DisplayCallbackConfig

Since:
  • 3.0.0
Properties:
Name Type Description
parent Phaser.GameObjects.DynamicBitmapText 拥有被渲染字符的动态位图文本对象.
tint Phaser.Types.GameObjects.BitmapText.TintConfig 被渲染的角色的色调.画布中始终为零.
index number 正在呈现的字符的索引.
charCode number 正在呈现的字符的字符代码.
x number 正在呈现的字符的x位置.
y number 正在渲染的字符的y位置.
scale number 正在渲染的角色的比例.
rotation number 正在渲染的角色的旋转.
data any 与正在呈现的字符一起存储的自定义数据.
Type:
  • object

GlobalBitmapTextSize

Since:
  • 3.0.0
Properties:
Name Type Description
x number 位图文本的x位置,考虑游戏对象的x位置和比例.
y number 位图文本的y位置,考虑游戏对象的y位置和比例.
width number 位图文本的宽度,考虑游戏对象的x比例.
height number 位图文本的高度,考虑游戏对象的y比例.
位图文本在全局空间中的位置和大小,考虑游戏对象的比例和世界位置.
Type:
  • object

JSONBitmapText

Since:
  • 3.0.0
Properties:
Name Type Description
font string 字体的名称.
text string 该位图文本显示的文本.
fontSize number 字体的大小.
letterSpacing number 添加/删除字符间距.
align number 多行位图文本对象中文本的对齐方式.
Type:
  • object

LocalBitmapTextSize

Since:
  • 3.0.0
Properties:
Name Type Description
x number 位图文本的x位置.
y number 位图文本的y位置.
width number 位图文本的宽度.
height number 位图文本的高度.
仅考虑字体大小,位图文本在本地空间中的位置和大小.
Type:
  • object

RetroFontConfig

Since:
  • 3.6.0
Properties:
Name Type Description
image string 包含字体的图像的键.
offset.x number 如果字体集不是从给定图像的左上角开始,请在此指定X坐标偏移量.
offset.y number 如果字体集没有从给定图像的左上角开始,请在此指定Y坐标偏移量.
width number 字体集中每个字符的宽度.
height number 字体集中每个字符的高度.
chars string 字体集中使用的字符,按显示顺序排列.您可以将TEXT_SET常量用于常见的字体集排列.
charsPerRow number 字体集中每行的字符数.如果没有给定字符宽度,将为图像宽度/字符宽度.
spacing.x number 如果字体集中的字符之间有水平间距,请在此设定所需的数量.
spacing.y number 如果字体集中的字符之间有垂直间距,请在此设定所需的数量.
lineSpacing number 要添加到字体行高中的垂直空间量.
Type:
  • object

TintConfig

Since:
  • 3.0.0
Properties:
Name Type Description
topLeft number 左上角的色调值.画布上总是零.
topRight number 右上角的色调值.画布上总是零.
bottomLeft number 左下角的色调值.画布上总是零.
bottomRight number 右下角的色调值.画布上总是零.
Type:
  • object