1 Star 1 Fork 0

天天编程/godot-docs

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
class_charfxtransform.rst 8.21 KB
一键复制 编辑 原始数据 按行查看 历史
github_url: hide

CharFXTransform

Inherits: :ref:`Reference<class_Reference>` < :ref:`Object<class_Object>`

Controls how an individual character will be displayed in a :ref:`RichTextEffect<class_RichTextEffect>`.

Description

By setting various properties on this object, you can control how individual characters will be displayed in a :ref:`RichTextEffect<class_RichTextEffect>`.

Tutorials

Properties

:ref:`int<class_int>` :ref:`absolute_index<class_CharFXTransform_property_absolute_index>` 0
:ref:`int<class_int>` :ref:`character<class_CharFXTransform_property_character>` 0
:ref:`Color<class_Color>` :ref:`color<class_CharFXTransform_property_color>` Color( 0, 0, 0, 1 )
:ref:`float<class_float>` :ref:`elapsed_time<class_CharFXTransform_property_elapsed_time>` 0.0
:ref:`Dictionary<class_Dictionary>` :ref:`env<class_CharFXTransform_property_env>` {}
:ref:`Vector2<class_Vector2>` :ref:`offset<class_CharFXTransform_property_offset>` Vector2( 0, 0 )
:ref:`int<class_int>` :ref:`relative_index<class_CharFXTransform_property_relative_index>` 0
:ref:`bool<class_bool>` :ref:`visible<class_CharFXTransform_property_visible>` true

Property Descriptions

Default 0
Setter set_absolute_index(value)
Getter get_absolute_index()

The index of the current character (starting from 0). Setting this property won't affect drawing.


Default 0
Setter set_character(value)
Getter get_character()

The Unicode codepoint the character will use. This only affects non-whitespace characters. :ref:`@GDScript.ord<class_@GDScript_method_ord>` can be useful here. For example, the following will replace all characters with asterisks:

# `char_fx` is the CharFXTransform parameter from `_process_custom_fx()`.
# See the RichTextEffect documentation for details.
char_fx.character = ord("*")

Default Color( 0, 0, 0, 1 )
Setter set_color(value)
Getter get_color()

The color the character will be drawn with.


Default 0.0
Setter set_elapsed_time(value)
Getter get_elapsed_time()

The time elapsed since the :ref:`RichTextLabel<class_RichTextLabel>` was added to the scene tree (in seconds). Time stops when the project is paused, unless the :ref:`RichTextLabel<class_RichTextLabel>`'s :ref:`Node.pause_mode<class_Node_property_pause_mode>` is set to :ref:`Node.PAUSE_MODE_PROCESS<class_Node_constant_PAUSE_MODE_PROCESS>`.

Note: Time still passes while the :ref:`RichTextLabel<class_RichTextLabel>` is hidden.


Default {}
Setter set_environment(value)
Getter get_environment()

Contains the arguments passed in the opening BBCode tag. By default, arguments are strings; if their contents match a type such as :ref:`bool<class_bool>`, :ref:`int<class_int>` or :ref:`float<class_float>`, they will be converted automatically. Color codes in the form #rrggbb or #rgb will be converted to an opaque :ref:`Color<class_Color>`. String arguments may not contain spaces, even if they're quoted. If present, quotes will also be present in the final string.

For example, the opening BBCode tag [example foo=hello bar=true baz=42 color=#ffffff] will map to the following :ref:`Dictionary<class_Dictionary>`:

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

Default Vector2( 0, 0 )
Setter set_offset(value)
Getter get_offset()

The position offset the character will be drawn with (in pixels).


Default 0
Setter set_relative_index(value)
Getter get_relative_index()

The index of the current character (starting from 0). Setting this property won't affect drawing.


Default true
Setter set_visibility(value)
Getter is_visible()

If true, the character will be drawn. If false, the character will be hidden. Characters around hidden characters will reflow to take the space of hidden characters. If this is not desired, set their :ref:`color<class_CharFXTransform_property_color>` to Color(1, 1, 1, 0) instead.

Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/ttcode-net/godot-docs.git
git@gitee.com:ttcode-net/godot-docs.git
ttcode-net
godot-docs
godot-docs
master

搜索帮助