CharFXTransform

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

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

@GodotBaseClass

struct CharFXTransform {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(CharFXTransform other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static CharFXTransform _new();

long getAbsoluteIndex();

long getCharacter();

Color getColor();

double getElapsedTime();

Dictionary getEnvironment();

Vector2 getOffset();

long getRelativeIndex();

bool isVisible();

void setAbsoluteIndex(long index);

void setCharacter(long character);

void setColor(Color color);

void setElapsedTime(double time);

void setEnvironment(Dictionary environment);

void setOffset(Vector2 offset);

void setRelativeIndex(long index);

void setVisibility(bool visibility);

long absoluteIndex [@property getter];

long absoluteIndex [@property setter];

long character [@property getter];

long character [@property setter];

Color color [@property getter];

Color color [@property setter];

double elapsedTime [@property getter];

double elapsedTime [@property setter];

Dictionary env [@property getter];

Dictionary env [@property setter];

Vector2 offset [@property getter];

Vector2 offset [@property setter];

long relativeIndex [@property getter];

long relativeIndex [@property setter];

bool visible [@property getter];

bool visible [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

getAbsoluteIndex long getAbsoluteIndex()
getCharacter long getCharacter()
getColor Color getColor()
getElapsedTime double getElapsedTime()
getEnvironment Dictionary getEnvironment()
getOffset Vector2 getOffset()
getRelativeIndex long getRelativeIndex()
isVisible bool isVisible()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(CharFXTransform other)
opEquals bool opEquals(typeof(null) n)
setAbsoluteIndex void setAbsoluteIndex(long index)
setCharacter void setCharacter(long character)
setColor void setColor(Color color)
setElapsedTime void setElapsedTime(double time)
setEnvironment void setEnvironment(Dictionary environment)
setOffset void setOffset(Vector2 offset)
setRelativeIndex void setRelativeIndex(long index)
setVisibility void setVisibility(bool visibility)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

absoluteIndex long absoluteIndex [@property getter]
long absoluteIndex [@property setter]: The index of the current character (starting from 0). Setting this property won't affect drawing.
character long character [@property getter]
long character [@property setter]: The Unicode codepoint the character will use. This only affects non-whitespace characters. @GDScript.ord can be useful here. For example, the following will replace all characters with asterisks:
color Color color [@property getter]
Color color [@property setter]: The color the character will be drawn with.
elapsedTime double elapsedTime [@property getter]
double elapsedTime [@property setter]: The time elapsed since the RichTextLabel was added to the scene tree (in seconds). Time stops when the project is paused, unless the RichTextLabel's Node.pauseMode is set to constant Node.PAUSE_MODE_PROCESS. Note: Time still passes while the RichTextLabel is hidden.
env Dictionary env [@property getter]
Dictionary env [@property setter]: Contains the arguments passed in the opening BBCode tag. By default, arguments are strings; if their contents match a type such as bool, long or double, 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 $(D example foo=hello bar=true baz=42 color=#ffffff) will map to the following Dictionary:
offset Vector2 offset [@property getter]
Vector2 offset [@property setter]: The position offset the character will be drawn with (in pixels).
relativeIndex long relativeIndex [@property getter]
long relativeIndex [@property setter]: The index of the current character (starting from 0). Setting this property won't affect drawing.
visible bool visible [@property getter]
bool visible [@property setter]: 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.

Static functions

_new CharFXTransform _new(): Construct a new instance of CharFXTransform. Note: use memnew!CharFXTransform instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot charfxtransform structs

CharFXTransform