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.

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

    enum StretchMode:

    • STRETCH_SCALE = 0 —- Scale to fit 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.

    • expand

    Default

    false

    Setter

    set_expand(value)

    Getter

    get_expand()

    If true, 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.

    • flip_h

    Default

    Setter

    set_flip_h(value)

    Getter

    is_flipped_h()

    If true, texture is flipped horizontally.

    If true, texture is flipped vertically.

    Default

    Setter

    set_stretch_mode(value)

    get_stretch_mode()

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

    • texture_click_mask

    Setter

    set_click_mask(value)

    Getter

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

    • texture_disabled

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

    • texture_focused

    Setter

    set_focused_texture(value)

    Getter

    get_focused_texture()

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

    Setter

    set_hover_texture(value)

    Getter

    get_hover_texture()

    Texture to display when the mouse hovers the node.

    • texture_normal

    Texture to display by default, when the node is not in the disabled, focused, hover or pressed state.

    Setter

    set_pressed_texture(value)

    Getter

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