Struct TextureButton
Texture-based button. Supports Pressed, Hover, Disabled and Focused states.
struct TextureButton
;
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.
The "normal" state must contain a texture (textureNormal); other textures are optional.
Properties
| Name | Type | Description |
|---|---|---|
expand[get, set]
|
bool | If true, the texture stretches to the edges of the node's bounding rectangle using the stretchMode. If false, the texture will not scale with the node.
|
stretchMode[get, set]
|
TextureButton | Controls the texture's behavior when you resize the node's bounding rectangle, only if expand is true. Set it to one of the stretchmode constants. See the constants to learn more.
|
textureClickMask[get, set]
|
BitMap | 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.
|
textureDisabled[get, set]
|
Texture | Texture to display when the node is disabled. See BaseButton.
|
textureFocused[get, set]
|
Texture | Texture to display when the node has mouse or keyboard focus. |
textureHover[get, set]
|
Texture | Texture to display when the mouse hovers the node. |
textureNormal[get, set]
|
Texture | Texture to display by default, when the node is not in the disabled, focused, hover or pressed state. |
texturePressed[get, set]
|
Texture | 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 BaseButton key.
|
Methods
Enums
| Name | Description |
|---|---|
Constants
|
|
StretchMode
|