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...
TextureProgressBar
Hérite de : Range < Control < CanvasItem < Node < Object
Barre de progression avec une texture. Utile pour les écrans de chargement et les barres de vie ou d'endurance.
Description
TextureProgressBar fonctionne comme ProgressBar, mais utilise jusqu'à 3 textures au lieu de la ressource Theme de Godot. Elle peut être utilisée pour créer des barres de progression horizontales, verticales et radiales.
Propriétés
|
||
mouse_filter |
|
|
|
||
|
||
|
||
|
||
BitField[SizeFlags] |
size_flags_vertical |
|
step |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Méthodes
get_stretch_margin(margin: Side) const |
|
void |
set_stretch_margin(margin: Side, value: int) |
Énumérations
enum FillMode: 🔗
FillMode FILL_LEFT_TO_RIGHT = 0
La texture_progress remplis de gauche à droite.
FillMode FILL_RIGHT_TO_LEFT = 1
La texture_progress remplis de droite à gauche.
FillMode FILL_TOP_TO_BOTTOM = 2
La texture_progress remplis de haut en bas.
FillMode FILL_BOTTOM_TO_TOP = 3
La texture_progress remplis de bas en haut.
FillMode FILL_CLOCKWISE = 4
Transforme le nœud en une barre radiale. La texture texture_progress se remplit en sens horaire. Voir radial_center_offset, radial_initial_angle et radial_fill_degrees pour contrôler la façon dont la barre se remplit.
FillMode FILL_COUNTER_CLOCKWISE = 5
Transforme le nœud en une barre radiale. La texture texture_progress se remplit en sens anti-horaire. Voir radial_center_offset, radial_initial_angle et radial_fill_degrees pour contrôler la façon dont la barre se remplit.
FillMode FILL_BILINEAR_LEFT_AND_RIGHT = 6
La texture texture_progress se remplit depuis le centre, s'étendant à la fois vers la gauche et la droite.
FillMode FILL_BILINEAR_TOP_AND_BOTTOM = 7
La texture texture_progress se remplit depuis le centre, s'étendant à la fois vers le haut et le bas.
FillMode FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE = 8
Transforme le nœud en une barre radiale. La texture texture_progress se remplit de manière radiale depuis le centre, s’étendant à la fois dans le sens horaire et anti-horaire . Voir radial_center_offset, radial_initial_angle et radial_fill_degrees pour contrôler la façon dont la barre se remplit.
Descriptions des propriétés
La direction de remplissage. Voir FillMode pour les valeurs possibles.
bool nine_patch_stretch = false 🔗
Si true, Godot traite les textures de la barre comme dans NinePatchRect. Utilisez les propriétés stretch_margin_* comme stretch_margin_bottom pour configurer la grille 3×3 des neuf patchs. Lors de l'utilisation d'un mode de remplissage fill_mode radial, ce paramètre n'activera l'étirement que pour texture_progress, tandis que texture_under et texture_over seront traités comme dans NinePatchRect.
Vector2 radial_center_offset = Vector2(0, 0) 🔗
Décale texture_progress si fill_mode vaut FILL_CLOCKWISE, FILL_COUNTER_CLOCKWISE, ou FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE.
Note : Le centre radial effectif reste toujours dans les limites de texture_progress. Si vous devez le déplacer en dehors des limites de la texture, modifiez texture_progress pour contenir un espace vide supplémentaire où il y en a besoin.
float radial_fill_degrees = 360.0 🔗
Limite supérieure pour le remplissage de texture_progress si fill_mode vaut FILL_CLOCKWISE, FILL_COUNTER_CLOCKWISE, ou FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE. Lorsque la valeur value du nœud est égale à sa valeur maximale max_value, la texture se remplit jusqu'à cet angle.
Voir Range.value, Range.max_value.
float radial_initial_angle = 0.0 🔗
Angle de départ pour le remplissage de texture_progress si fill_mode vaut FILL_CLOCKWISE, FILL_COUNTER_CLOCKWISE, ou FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE. Lorsque la valeur value du nœud est égale à sa valeur minimale min_value, la texture ne s'affiche pas du tout. Lorsque la valeur value augmente, la texture se remplit et tend vers radial_fill_degrees.
Note : radial_initial_angle est enroulé entre 0 et 360 degrés (inclusifs).
int stretch_margin_bottom = 0 🔗
La hauteur de la ligne du bas des 9 patchs. Une marge de 16 signifie que les angles du bas des 9 patchs et les côtés auront une hauteur de 16 pixels. Vous pouvez définir les 4 valeurs de marge individuellement pour créer des panneaux avec des bordures non uniformes. Seulement effectif si nine_patch_stretch vaut true.
La largeur de la colonne de gauche du 9-patchs. Seulement effectif si nine_patch_stretch vaut true.
int stretch_margin_right = 0 🔗
La largeur de la colonne de droite du 9-patchs. Seulement effectif si nine_patch_stretch vaut true.
La hauteur de la ligne du haut du 9-patchs. Seulement effectif si nine_patch_stretch vaut true.
Texture2D qui se dessine sur la barre de progression. Utilisez la pour accentuer des parties ou ajouter un cadre par dessus qui cache une partie de texture_progress.
Texture2D qui se coupe selon la valeur value du nœud et fill_mode. Quand la valeur value augmente, la texture se remplit. Elle est affichée entièrement lorsque value atteint max_value. Elle n'est pas du tout affiché si value est égale à min_value.
La propriété value provient de Range. Voir Range.value, Range.min_value, Range.max_value.
Vector2 texture_progress_offset = Vector2(0, 0) 🔗
Le décalage de texture_progress. Utile pour texture_over et texture_under avec des bordures détaillées, pour éviter des marges transparentes dans votre texture de progression.
Texture2D qui est dessinée sous la barre de progression. L'arrière-plan de la barre.
Color tint_over = Color(1, 1, 1, 1) 🔗
Multiplie la couleur de la texture texture_over de la barre. L'effet est semblable à CanvasItem.modulate, sauf qu'il affecte seulement cette texture spécifique au lieu de l'ensemble du nœud.
Color tint_progress = Color(1, 1, 1, 1) 🔗
Multiplie la couleur de la texture texture_progress de la barre.
Color tint_under = Color(1, 1, 1, 1) 🔗
Multiplie la couleur de la texture texture_under de la barre.
Descriptions des méthodes
int get_stretch_margin(margin: Side) const 🔗
Renvoie la marge d'étirement avec l'index spécifié. Voir stretch_margin_bottom et les propriétés liées.
void set_stretch_margin(margin: Side, value: int) 🔗
Définit la marge d'étirement avec l'index spécifié. Voir stretch_margin_bottom et les propriétés liées.