Class TextureButton

Texture-based button. Supports Pressed, Hover, Disabled and Focused states.

Inheritance

BaseButton

Control

CanvasItem

Node

Object

TextureButton

Remarks

TextureButton has the same functionality as Button, except it uses sprites instead of Godot's Theme resource. It is faster to create, but it doesn't support localization like more complex Controls.

See also BaseButton which contains common properties and methods associated with this node.

Note: Setting a texture for the "normal" state (texture_normal) is recommended. If texture_normal is not set, the TextureButton will still receive input events and be clickable, but the user will not be able to see it unless they activate another one of its states with a texture assigned (e.g., hover over it to show texture_hover).

See Also

3D Voxel Demo

Properties

flip_h

If true, texture is flipped horizontally.

var flip_h : bool = false

Property Value

bool

Remarks

• void set_flip_h(bool value)
• bool is_flipped_h

flip_v

If true, texture is flipped vertically.

var flip_v : bool = false

Property Value

bool

Remarks

• void set_flip_v(bool value)
• bool is_flipped_v

ignore_texture_size

If true, the size of the texture won't be considered for minimum size calculation, so the TextureButton can be shrunk down past the texture size.

var ignore_texture_size : bool = false

Property Value

bool

Remarks

• void set_ignore_texture_size(bool value)
• bool get_ignore_texture_size

stretch_mode

Controls the texture's behavior when you resize the node's bounding rectangle. See the StretchMode constants for available options.

var stretch_mode : int = 2

Property Value

int

Remarks

• void set_stretch_mode(int value)
• int get_stretch_mode

texture_click_mask

Pure black and white BitMap image to use for click detection. On the mask, white pixels represent the button's clickable area. Use it to create buttons with curved shapes.

var texture_click_mask : BitMap

Property Value

BitMap

Remarks

• void set_click_mask(BitMap value)
• BitMap get_click_mask

texture_disabled

Texture to display when the node is disabled. See disabled. If not assigned, the TextureButton displays texture_normal instead.

var texture_disabled : Texture2D

Property Value

Texture2D

Remarks

• void set_texture_disabled(Texture2D value)
• Texture2D get_texture_disabled

texture_focused

Texture to overlay on the base texture when the node has mouse or keyboard focus. Because texture_focused is displayed on top of the base texture, a partially transparent texture should be used to ensure the base texture remains visible. A texture that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a fully transparent texture of any size. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.

var texture_focused : Texture2D

Property Value

Texture2D

Remarks

• void set_texture_focused(Texture2D value)
• Texture2D get_texture_focused

texture_hover

Texture to display when the mouse hovers over the node. If not assigned, the TextureButton displays texture_normal instead when hovered over.

var texture_hover : Texture2D

Property Value

Texture2D

Remarks

• void set_texture_hover(Texture2D value)
• Texture2D get_texture_hover

texture_normal

Texture to display by default, when the node is not in the disabled, hover or pressed state. This texture is still displayed in the focused state, with texture_focused drawn on top.

var texture_normal : Texture2D

Property Value

Texture2D

Remarks

• void set_texture_normal(Texture2D value)
• Texture2D get_texture_normal

texture_pressed

Texture to display on mouse down over the node, if the node has keyboard focus and the player presses the Enter key or if the player presses the shortcut key. If not assigned, the TextureButton displays texture_hover instead when pressed.

var texture_pressed : Texture2D

Property Value

Texture2D

Remarks

• void set_texture_pressed(Texture2D value)
• Texture2D get_texture_pressed