Label

描述：

  使用TrueType字体渲染文本的场景节点类。

类对象：Label Class。

继承自：Node。

Label.TextAlign

类型： 枚举。

描述：

  用于文本对齐设置的枚举。

签名：

enum TextAlign
	"Left"
	"Center"
	"Right"
end

alphaRef

类型： 成员变量。

描述：

  Alpha阈值值。Alpha值低于此值的像素将不会被绘制。 仅适用于 label.effect = SpriteEffect("builtin:vs_sprite", "builtin:fs_spritealphatest")。

签名：

alphaRef: number

textWidth

类型： 成员变量。

描述：

  用于文本换行的文本宽度。 设置为 Label.AutomaticWidth 以禁用换行。 默认值为 Label.AutomaticWidth。

签名：

textWidth: number

lineGap

类型： 成员变量。

描述：

  文本行之间的像素间隔。

签名：

lineGap: number

spacing

类型： 成员变量。

描述：

  文本行之间的像素间隔。

签名：

spacing: number

outlineColor

类型： 成员变量。

描述：

  描边颜色，仅适用于SDF标签。

签名：

outlineColor: Color

outlineWidth

类型： 成员变量。

描述：

  描边宽度使用归一化的 SDF 距离单位，并非像素。仅适用于 SDF 标签。常用的清晰描边范围为 0.12 到 0.18；程序会将其限制在受支持的 0 到 0.25 范围内。

签名：

outlineWidth: number

smooth

类型： 成员变量。

描述：

  用于平滑文本边缘的 SDF 下限和上限阈值，仅适用于 SDF 标签。每个分量都会被限制在 0 到 1，并保证下限小于上限。默认使用自动平滑；手动调整时建议使用 0.5 到 0.8 附近的值。

签名：

smooth: Vec2

text

类型： 成员变量。

描述：

  要渲染的文本。

签名：

text: string

blendFunc

类型： 成员变量。

描述：

  用于渲染文本的混合函数。

签名：

blendFunc: BlendFunc

depthWrite

类型： 成员变量。

描述：

  是否启用深度写入。默认为false。

签名：

depthWrite: boolean

batched

类型： 成员变量。

描述：

  标签是否使用批量渲染模式。默认为true。 使用批量渲染可以获得更好的渲染性能，但是label:getCharacter()函数将无法使用。

签名：

batched: boolean

effect

类型： 成员变量。

描述：

  用于渲染文本的图元着色器特效。

签名：

effect: SpriteEffect

alignment

类型： 成员变量。

描述：

  文本对齐设置。

签名：

alignment: TextAlign

characterCount

类型： 只读成员变量。

描述：

  文本中字符的数量。

签名：

const characterCount: integer

getCharacter

类型： 函数。

描述：

  返回指定索引处字符的精灵。

签名：

getCharacter: function(self: Label, index: integer): Sprite | nil

参数：

参数名	类型	描述
index	integer	要检索的字符图元的索引。

返回值：

返回类型	描述
Sprite|nil	字符的图元，如果超出索引范围则返回 nil。