CharFXTransform

继承: RefCounted < Object

控制单个字符在RichTextEffect中的显示方式。

描述

通过在此对象上设置各种属性,您可以控制单个字符在RichTextEffect中的显示方式。

属性

Color

color

Color(0, 0, 0, 1)

float

elapsed_time

0.0

Dictionary

env

{}

RID

font

RID()

int

glyph_count

0

int

glyph_flags

0

int

glyph_index

0

Vector2

offset

Vector2(0, 0)

bool

outline

false

Vector2i

range

Vector2i(0, 0)

int

relative_index

0

Transform2D

transform

Transform2D(1, 0, 0, 1, 0, 0)

bool

visible

true


属性说明

Color color = Color(0, 0, 0, 1) 🔗

将绘制角色的颜色。


float elapsed_time = 0.0 🔗

  • void set_elapsed_time(value: float)

  • float get_elapsed_time()

RichTextLabel添加到场景树以来经过的时间(以秒为单位)。当RichTextLabel暂停时时间停止(参见Item.process_mode)。当RichTextLabel中的文本更改时重置。

注意:RichTextLabel被隐藏时,时间仍然会过去。


Dictionary env = {} 🔗

包含在开头BBCode标记中传递的参数。默认情况下,参数是字符串;如果它们的内容与boolintfloat等类型匹配,则会自动进行转换。#rrggbb#rgb形式的颜色代码将被转换为不透明的Color。字符串参数不能包含空格,即使它们被引用也是如此。如果存在,引号也会出现在最终的字符串中。

例如,开头BBCode标记[example foo=hello bar=true baz=42 color=#ffffff]将映射到以下Dictionary

{"foo": "hello", "bar": true, "baz": 42, "color": Color(1, 1, 1, 1)}

RID font = RID() 🔗

  • void set_font(value: RID)

  • RID get_font()

TextServer用于渲染字形的字体的RID,该值可以与TextServer一起使用。font_*方法来检索字体信息。

注意:只读。设置此属性不会影响绘图。


int glyph_count = 0 🔗

  • void set_glyph_count(value: int)

  • int get_glyph_count()

字位簇中的字形数。此值在簇的第一个字形中设置。

注意:只读。设置此属性不会影响绘图。


int glyph_flags = 0 🔗

  • void set_glyph_flags(value: int)

  • int get_glyph_flags()

字形标志。有关详细信息,请参阅GraphemeFlag

注意:只读。设置此属性不会影响绘图。


int glyph_index = 0 🔗

  • void set_glyph_index(value: int)

  • int get_glyph_index()

特定于font的字形索引。如果要替换此字形,请使用TextServer.font_get_glyph_index()font来获取单个字符的新字形索引。


Vector2 offset = Vector2(0, 0) 🔗

将使用(以像素为单位)绘制字符的位置偏移量。


bool outline = false 🔗

  • void set_outline(value: bool)

  • bool is_outline()

如果true,则调用FX变换进行轮廓绘制。

注意:只读。设置此属性不会影响绘图。


Vector2i range = Vector2i(0, 0) 🔗

字符串中的绝对字符范围,对应于字形。

注意:只读。设置此属性不会影响绘图。


int relative_index = 0 🔗

  • void set_relative_index(value: int)

  • int get_relative_index()

字形的字符偏移量,相对于当前RichTextEffect自定义块。

注意:只读。设置此属性不会影响绘图。


Transform2D transform = Transform2D(1, 0, 0, 1, 0, 0) 🔗

  • void set_transform(value: Transform2D)

  • Transform2D get_transform()

当前字形的当前变换。它可以被覆盖(例如,通过从曲线驱动位置和旋转)。您还可以更改现有值以在其他效果之上应用变换。


bool visible = true 🔗

  • void set_visibility(value: bool)

  • bool is_visible()

如果true,则绘制该字符。如果false,则隐藏该字符。隐藏字符周围的字符将回流以占用隐藏字符的空间。如果不需要,请将其color设置为Color(1,1,1,0)