Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

CharFXTransform

Hérite de : RefCounted < Object

Contrôle le rendu d'un caractère individuel dans un RichTextEffect.

Description

En réglant les diverses propriétés de cet objet, il est possible de contrôler le rendu de caractères individuels dans un RichTextEffect.

Tutoriels

Propriétés

Color

color

Color(0, 0, 0, 1)

float

elapsed_time

0.0

Dictionary

env

{}

RID

font

RID()

int

glyph_count

0

int

glyph_flags

0

int

glyph_index

0

Vector2

offset

Vector2(0, 0)

bool

outline

false

Vector2i

range

Vector2i(0, 0)

int

relative_index

0

Transform2D

transform

Transform2D(1, 0, 0, 1, 0, 0)

bool

visible

true

Descriptions des propriétés

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

La couleur utilisée pour afficher le caractère.

float elapsed_time = 0.0 🔗

  • void set_elapsed_time(value: float)

  • float get_elapsed_time()

Le temps écoulé depuis que le RichTextLabel ait été ajouté à l'arborescence de scène (en secondes). Le temps s’arrête lorsque le RichTextLabel est en pause (voir Node.process_mode). Réinitialisé lorsque le texte du RichTextLabel est modifié.

Note : Le temps continue de s'écouler même lorsque le RichTextLabel est caché.

Dictionary env = {} 🔗

Contient les arguments passés à la balise BBCode d'ouverture. Par défaut, les arguments sont des chaînes de caractères ; si leur contenu correspond à un type tel que bool, int ou float, ils sont automatiquement convertis. Les codes couleur de la forme #rrvvbb ou #rvb sont convertis en une couleur (Color) opaque. Les arguments ne doivent pas contenir d'espaces, même s'ils sont entre guillemets. Si il y en a, les guillemets seront également présents dans la chaîne de caractères finale.

Par exemple, la balise BBCode d'ouverture [exemple foo=bonjour bar=true baz=42 color=#ffffff] va correspondre au dictionnaire (Dictionary) suivant :

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

RID font = RID() 🔗

  • void set_font(value: RID)

  • RID get_font()

RID du TextServer de la police de caractère utilisée pour rendre le glyphe, cette valeur peut être utilisée avec les méthodes de TextServer.font_* pour récupérer les informations de police de caractère.

Remarque : Lecture seule. Définir cette propriété n'affectera pas le dessin.

int glyph_count = 0 🔗

  • void set_glyph_count(value: int)

  • int get_glyph_count()

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 🔗

  • void set_glyph_flags(value: int)

  • int get_glyph_flags()

Options des glyphes. Voir GraphemeFlag pour plus d'informations.

Remarque : Lecture seule. Définir cette propriété n'affectera pas le dessin.

int glyph_index = 0 🔗

  • void set_glyph_index(value: int)

  • int get_glyph_index()

Index de glyphes spécifiques à font. Si vous souhaitez remplacer ce glyphe, utilisez TextServer.font_get_glyph_index() avec font pour recevoir un nouvel index de glyphe pour un caractère unique.

Vector2 offset = Vector2(0, 0) 🔗

Le décalage dans la position avec laquelle le caractère va être affiché (en pixels).

bool outline = false 🔗

  • void set_outline(value: bool)

  • bool is_outline()

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 🔗

  • void set_relative_index(value: int)

  • int get_relative_index()

Le décalage de caractère du glyphe, relatif au bloc personnalisé RichTextEffect actuel.

Note : En lecture seule. Définir cette propriété n'affectera pas le dessin.

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

La transformation actuelle du glyphe actuel. Elle peut être redéfinie (par exemple, en dirigeant la position et la rotation à partir d'une courbe). Vous pouvez également modifier la valeur existante pour appliquer des transformations par dessus d'autres effets.

bool visible = true 🔗

  • void set_visibility(value: bool)

  • bool is_visible()

Si true, le caractère sera affiché. Si false, le caractère sera caché. Les caractères autour des caractères cachés seront réorganisés pour prendre leur place. Si ce n'est pas ce qui est voulu, réglez leur couleur (color) sur Color(1, 1, 1, 0) à la place.