TextureButton

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

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

    The “normal” state must contain a texture (texture_normal); other textures are optional.

    enum StretchMode:

    • STRETCH_TILE = 1 —- Tile inside the node’s bounding rectangle.
    • STRETCH_KEEP = 2 —- The texture keeps its original size and stays in the bounding rectangle’s top-left corner.
    • STRETCH_KEEP_CENTERED = 3 —- The texture keeps its original size and stays centered in the node’s bounding rectangle.
    • STRETCH_KEEP_ASPECT = 4 —- Scale the texture to fit the node’s bounding rectangle, but maintain the texture’s aspect ratio.
    • STRETCH_KEEP_ASPECT_CENTERED = 5 —- Scale the texture to fit the node’s bounding rectangle, center it, and maintain its aspect ratio.
    • STRETCH_KEEP_ASPECT_COVERED = 6 —- Scale the texture so that the shorter side fits the bounding rectangle. The other side clips to the node’s limits.
    Defaultfalse
    Setterset_expand(value)
    Getterget_expand()

    If , the texture stretches to the edges of the node’s bounding rectangle using the stretch_mode. If false, the texture will not scale with the node.


    • stretch_mode
    Default
    Setterset_stretch_mode(value)
    Getterget_stretch_mode()

    Controls the texture’s behavior when you resize the node’s bounding rectangle, only if expand is true. Set it to one of the constants. See the constants to learn more.



    • texture_disabled
    Setterset_disabled_texture(value)
    Getterget_disabled_texture()

    Texture to display when the node is disabled. See BaseButton.disabled.


    • texture_focused
    Setterset_focused_texture(value)
    Getterget_focused_texture()

    Texture to display when the node has mouse or keyboard focus.


    Texture to display when the mouse hovers the node.


    • texture_normal
    Setterset_normal_texture(value)
    Getterget_normal_texture()

    Setterset_pressed_texture(value)
    Getterget_pressed_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.shortcut key.