Class reference

CharFXTransform

Inherits RefCounted

Controls how an individual character will be displayed in a RichTextEffect.

Description

By setting various properties on this object, you can control how individual characters will be displayed in a RichTextEffect.

Properties

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

The color the character will be drawn with.

Dictionary env = {}

Contains the arguments passed in the opening BBCode tag. By default, arguments are strings; if their contents match a type such as bool, int or float, they will be converted automatically. Color codes in the form #rrggbb or #rgb will be converted to an opaque 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 Dictionary:

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

RID font = RID()

TextServer RID of the font used to render glyph, this value can be used with TextServer.font_* methods to retrieve font information. Note: Read-only. Setting this property won't affect drawing.

int glyph_count = 0

Number of glyphs in the grapheme cluster. This value is set in the first glyph of a cluster. Note: Read-only. Setting this property won't affect drawing.

int glyph_flags = 0

Glyph flags. See TextServer.GraphemeFlag for more info. Note: Read-only. Setting this property won't affect drawing.

Vector2 offset = Vector2(0, 0)

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

bool outline = false

If true, FX transform is called for outline drawing. Note: Read-only. Setting this property won't affect drawing.

Vector2i range = Vector2i(0, 0)

Absolute character range in the string, corresponding to the glyph. Note: Read-only. Setting this property won't affect drawing.

int relative_index = 0

The character offset of the glyph, relative to the current RichTextEffect custom block. Note: Read-only. Setting this property won't affect drawing.

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

The current transform of the current glyph. It can be overridden (for example, by driving the position and rotation from a curve). You can also alter the existing value to apply transforms on top of other effects.

bool visible = true

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 color to Color(1, 1, 1, 0) instead.

Tutorials

Source revision 4f5b14abade2
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.