Struct gdnative_bindings_lily::CharFXTransform [−][src]
pub struct CharFXTransform { /* fields omitted */ }
Expand description
core class CharFXTransform
inherits Reference
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
CharFXTransform inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
The index of the current character (starting from 0). Setting this property won’t affect drawing.
Sample code is GDScript unless otherwise noted.
The Unicode codepoint the character will use. This only affects non-whitespace characters. [method @GDScript.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("*")
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 [member Node.pause_mode] is set to [constant Node.PAUSE_MODE_PROCESS]. Note: Time still passes while the RichTextLabel is hidden.
Sample code is GDScript unless otherwise noted.
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)}
The position offset the character will be drawn with (in pixels).
The index of the current character (starting from 0). Setting this property won’t affect drawing.
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 [member color] to Color(1, 1, 1, 0)
instead.
The index of the current character (starting from 0). Setting this property won’t affect drawing.
Sample code is GDScript unless otherwise noted.
The Unicode codepoint the character will use. This only affects non-whitespace characters. [method @GDScript.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("*")
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 [member Node.pause_mode] is set to [constant Node.PAUSE_MODE_PROCESS]. Note: Time still passes while the RichTextLabel is hidden.
Sample code is GDScript unless otherwise noted.
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)}
The position offset the character will be drawn with (in pixels).
The index of the current character (starting from 0). Setting this property won’t affect drawing.
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 [member color] to Color(1, 1, 1, 0)
instead.
Methods from Deref<Target = Reference>
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for CharFXTransform
impl !Send for CharFXTransform
impl !Sync for CharFXTransform
impl Unpin for CharFXTransform
impl UnwindSafe for CharFXTransform