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...

TextureButton

Hérite de : BaseButton < Control < CanvasItem < Node < Object

Un bouton affiché avec une Texture. Supporte les états appuyé, survolé, désactivé, et avec le focus.

Description

TextureButton a les même fonctionnalités que Button, sauf qu'il utilise des sprites plutôt que la ressource Theme de Godot. Il est plus rapide à créer, mais ne supporte pas la localisation comme certains Control plus complexes.

Voir aussi BaseButton qui contient les propriétés et méthodes communes associées avec ce nœud.

Note : Il est recommandé de définir une texture pour l'état "normal" (texture_normal). Si texture_normal n'est pas définie, le TextureButton recevra encore des événements d'entrée et sera cliquable, mais l'utilisateur ne pourra pas le voir à moins qu'ils activent un autre de ses états avec une texture assignée (par exemple, le survoler pour afficher texture_hover).

Tutoriels

Démo voxel 3D

Propriétés

bool	flip_h	`false`
bool	flip_v	`false`
bool	ignore_texture_size	`false`
StretchMode	stretch_mode	`2`
BitMap	texture_click_mask
Texture2D	texture_disabled
Texture2D	texture_focused
Texture2D	texture_hover
Texture2D	texture_normal
Texture2D	texture_pressed

Énumérations

enum StretchMode: 🔗

StretchMode STRETCH_SCALE = 0

Change l'échelle pour adapter le rectangle total du nœud.

StretchMode STRETCH_TILE = 1

Répétition à l'intérieur du rectangle délimitant du nœud.

StretchMode STRETCH_KEEP = 2

La texture conserve sa taille d’origine et reste dans le coin supérieur gauche du rectangle délimitant.

StretchMode STRETCH_KEEP_CENTERED = 3

La texture conserve sa taille d’origine et reste centrée dans le rectangle délimitant du nœud.

StretchMode STRETCH_KEEP_ASPECT = 4

Échelonne la texture pour s'adapter au rectangle délimitant du nœud, mais maintient le rapport d'aspect de la texture.

StretchMode STRETCH_KEEP_ASPECT_CENTERED = 5

Échelonne la texture pour s'adapter au rectangle délimitant du nœud, la centre, et maintient son rapport d'aspect.

StretchMode STRETCH_KEEP_ASPECT_COVERED = 6

Échelonne la texture pour que le côté le plus court rentre dans le rectangle délimitant du nœud. L'autre côté est coupé aux limites du nœud.

Descriptions des propriétés

bool flip_h = false 🔗

void set_flip_h(value: bool)
bool is_flipped_h()

Si true, la texture est inversée horizontalement.

bool flip_v = false 🔗

void set_flip_v(value: bool)
bool is_flipped_v()

Si true, la texture est inversée verticalement.

bool ignore_texture_size = false 🔗

void set_ignore_texture_size(value: bool)
bool get_ignore_texture_size()

Si true, la taille de la texture ne sera pas considérée pour le calcul de la taille minimale, de sorte que le TextureButton puisse être rétréci au delà de la taille de la texture.

StretchMode stretch_mode = 2 🔗

void set_stretch_mode(value: StretchMode)
StretchMode get_stretch_mode()

Contrôle le comportement de la texture lorsque vous redimensionnez le rectangle délimitant du nœud. Voir les constantes StretchMode pour les options disponibles.

BitMap texture_click_mask 🔗

void set_click_mask(value: BitMap)
BitMap get_click_mask()

Image BitMap en pur noir et blanc à utiliser pour la détection de clics. Sur le masque, les pixels blancs représentent la zone cliquable du bouton. Utilisez-le pour créer des boutons avec des formes courbes.

Texture2D texture_disabled 🔗

void set_texture_disabled(value: Texture2D)
Texture2D get_texture_disabled()

Texture à afficher lorsque le nœud est désactivé. Voir BaseButton.disabled. Si non assignée, le TextureButton affiche texture_normal à la place.

Texture2D texture_focused 🔗

void set_texture_focused(value: Texture2D)
Texture2D get_texture_focused()

Texture à superposer sur la texture de base lorsque le nœud a le focus de la souris ou du clavier. Comme texture_focused est affiché au-dessus de la texture de base, une texture partiellement transparente devrait être utilisée pour s'assurer que la texture de base reste visible. Une texture qui représente un contour ou une soulignage fonctionne bien à cette fin. Pour désactiver l'effet visuel du focus, assignez une texture entièrement transparente de n'importe quelle taille. Notez que la désactivation de l'effet visuel du focus va nuire à l'utilisabilité de navigation clavier/contrôleur, ce qui n'est donc pas recommandé pour des raisons d'accessibilité.

Texture2D texture_hover 🔗

void set_texture_hover(value: Texture2D)
Texture2D get_texture_hover()

Texture à afficher lorsque la souris survole le nœud. Si non assignée, le TextureButton affiche texture_normal à la place lorsqu'il est survolé.

Texture2D texture_normal 🔗

void set_texture_normal(value: Texture2D)
Texture2D get_texture_normal()

Texture à afficher par défaut, quand le nœud n'est pas dans l'état désactivé, survolé or appuyé. Cette texture sera toujours affichée dans l'état avec le focus, avec texture_focused dessiné par dessus.

Texture2D texture_pressed 🔗

void set_texture_pressed(value: Texture2D)
Texture2D get_texture_pressed()

Texture à afficher quand la souris appuie sur le nœud, si le nœud a le focus du clavier et que l'utilisateur appuie sur la touche Entrée, ou quand l'utilisateur appuie sur la touche BaseButton.shortcut. Si non assignée, le TextureButton affiche texture_hover à la place lors qu’appuyé.