godot-d ~releases (2022-04-02T06:37:10.8312204)

RichTextEffect

godot richtexteffect

A custom effect for use with RichTextLabel.

Note: For a RichTextEffect to be usable, a BBCode tag must be defined as a member variable called bbcode in the script.

More...
@GodotBaseClass
struct RichTextEffect {
package
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(RichTextEffect other);
typeof(null) opAssign(typeof(null) n);
bool opEquals(typeof(null) n);
size_t toHash();
mixin baseCasts ;
static RichTextEffect _new();
bool _processCustomFx(CharFXTransform char_fx);
}

Members

Aliases

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

Functions

_processCustomFx
bool _processCustomFx(CharFXTransform char_fx)

Override this method to modify properties in char_fx. The method must return true if the character could be transformed successfully. If the method returns false, it will skip transformation to avoid displaying broken text.

opAssign
typeof(null) opAssign(typeof(null) n)
opEquals
bool opEquals(RichTextEffect other)
opEquals
bool opEquals(typeof(null) n)
toHash
size_t toHash()

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Static functions

_new
RichTextEffect _new()

Construct a new instance of RichTextEffect. Note: use memnew!RichTextEffect 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.

Detailed Description

# The RichTextEffect will be usable like this: $(D example)Some text$(D /example) var bbcode = "example"

Note: As soon as a RichTextLabel contains at least one RichTextEffect, it will continuously process the effect unless the project is paused. This may impact battery life negatively.

Meta

Source

See Implementation

godot richtexteffect structs

Page generated by adrdox