Skip to main content

SUIButton

What is a SUIButton for?​

  • SUIButton is responsible for rendering a virtual button on the screen that can be used to perform a certain action and can be fully modified according to your needs.

⚠️ if you don't know how to create a new interface element, see more about creating an interface element ⚠️

Properties​

When SUIButton is not pressed​

Image​

  • The texture of SUIButton

⚠️ If you don't know how to modify the texture by script, see more about it at how to modify the texture of a SUIButton by script using Java ⚠️

Type​

  • The SUIButton border type

Simple​
  • Simple type of button.

Sliced​
  • Button with customizable borders.

Border​

  • The borders of SUIButton.

⚠️ For SUIButton to have customizable edges it is necessary that the type is mandatorily Sliced ⚠️

⚠️ if you don't know the difference between DIP and PIXEL, see more about difference between dip and pixel ⚠️

Color​

  • The color of SUIButton.

⚠️ if you don't know how to modify the color of a SUIButton by script, see more about how to modify the color of a SUIButton by script using Java ⚠️

Ignore mask​

  • This option will decide whether the SUIButton SUIMask is ignored or not.

⚠️ if you don't know how to enable or disable the SUIButton mask by script, see more about how to enable or disable SUIButton masking by script using Java ⚠️

Event​

  • The SUIButton touch events.

Clickable​

  • Defines whether SUIButton can be clicked or not.

⚠️ if you don't know how to define whether the SUIButton will be clickable or not by script, see more in defining whether the SUIButton will be clickable or not by script using Java ⚠️

Ignre slide from outside inside​

  • Defines whether the outside-in touch of SUIButton will be ignored or not.

Dispatch touch when outside rect​

  • Sets whether to tap outside the SUIButton area or not.

Input mode​

  • SUIButton's touch detection mode.

LayerSystem​
  • Uses the layer hierarchy to detect SUIButton touch.
Ghost​
  • SUIButton can be touched even if it is in a different layer than other SUI components.

Target​

  • The SUIButton touch area.

MySelf​
  • The touch area will be in that same SUIButton.
Parent​
  • The touch area will be the parent object (a SUI component) of that SUIButton.
Other​
  • The SUIButton touch area will be another object (a SUI component) chosen.

⚠️ if you don't know how to modify the SUIButton target by script, see more in how to modify SUIButton target by script using Java ⚠️