Skip to main content

SuiIconButton

Signals​

down​

  • Signature: none

up​

  • Signature: none

pressed​

  • Signature: none

toggled​

  • Signature: bool toggled_on

Variables​

bool disabled = false​

Makes the button unable to be interacted with.

bool toggle_mode = false​

Makes the button toggleable.

bool button_pressed = false​

Forwarded from the internal Button. Will be overridden with the internal button's value, any changes to this variable will not be reflected.

Texture2D image​

The image you want to display.

Rect2D region_rect = Rect2(0, 0, 0, 0)​

See NinePatchRect.region_rect.

bool draw_center = true​

See NinePatchRect.draw_center.

int ip_left = 0​

Icon padding (left side).

int ip_top = 0​

Icon padding (top side).

int ip_right = 0​

Icon padding (right side).

int ip_bottom = 0​

Icon padding (bottom side).

int pm_left = 0​

See NinePatchRect.patch_margin_left.

int pm_top = 0​

See NinePatchRect.patch_margin_top.

int pm_right = 0​

See NinePatchRect.patch_margin_right.

int pm_bottom = 0​

See NinePatchRect.patch_margin_bottom.

NinePatchRect.AxisStretchMode as_horizontal = 0​

See NinePatchRect.axis_stretch_horizontal.

NinePatchRect.AxisStretchMode as_vertical = 0​

See NinePatchRect.axis_stretch_vertical.

bool editor_process = true​

Determines if the element should be updated automatically while running in the editor.

bool runtime_process = true​

Determines if the element should be updated automatically during your game/application's runtime.

Functions​

void update_element()​

Updates the element.

void update_pressed(bool is_pressed)​

Updates the internal button's value for pressed. Use this method to update pressed.