Button component is very similar to the the Button node but there are some differences. The UI Button can be placed much more precisely however it does not have some of the features available in the Button Node such as expanded touch areas.
Name |
Set the name of the Button Component Used to identify Inputs & Outputs in the User Interface Node |
Text | Set text to be displayed in the Button (can be left empty) |
Copy/Paste Style | Copy the current properties to the UI Editor clipboard or paste the properties currently saved in the clipboard to this Button |
Colors | Set the colors to be used by different parts or states of the Button |
Text Size | Set the size of the text displayed in the Button |
Shape | Choose from a variety of preset shapes for the Button |
Roundness | Set the roundness of the corners of the button * this is only visible when the Shape type is set to Round Corners |
Border Width | Set the width of the Button's border |
Image |
Select an image to be used as a texture for the background of your Button The image will stretch to fit the size of the Button |
Text Margin | Define how much space there should be between the text and the edge of the Button |
Inputs and Outputs | Open the Inputs and Outputs menu to select what Inputs and Outputs will be visible in the User Interface Node for this Button |
Auto Alignment | Automatically update the Button's alignment as it is moved around the canvas to the nearest alignment point |
Alignment | Set the screen region to align the Button with |
Width/Height | Set the Width & Height of the Button |
X/Y | Set the X & Y screen position relative to the set alignment point |
Visible | Set the Button's visibility * Note that invisible buttons will not be visible during gameplay will remain visible in the UI Editor canvas |
Transition | Set how the Button should appear/disappear when it is made visible or invisible |
Rotation | Set the rotation of the Button |
Controller Mapping |
Set the input to be used if your game is being played with a keyboard or controller See Keyboard & Controller Actions below for more info |
Use inputs and outputs to send data into or out from your Button.
By default the Button's “On Start” output will be enabled.
Edit which Inputs & Outputs are enabled by tapping the Inputs & Outputs button in the Properties menu.
Type | Keyboard Input | Controller Input |
None | Input is not mapped to controller or keyboard | |
Left | Arrow Left | D-pad Left |
Right | Arrow Right | D-pad Right |
Up | Arrow Up | D-pad Up |
Down | Arrow Down | D-pad Down |
Action 1 | Space or H | A or Left Trigger |
Action 2 | Enter or J | B or Right Trigger or Mouse Left Click |
Action 3 | Shift or K | X or Left Shoulder or Mouse Right Click |
Action 4 | Ctrl or L | Y or Right Shoulder or Mouse Middle Click |
Number 1 | 1 or F1 | No controller Input |
Number 2 | 2 or F2 | No controller Input |
Number 3 | 3 or F3 | No controller Input |
Number 4 | 4 or F4 | No controller Input |
Number 5 | 5 or F5 | No controller Input |
Number 6 | 6 or F6 | No controller Input |
Number 7 | 7 or F7 | No controller Input |
Number 8 | 8 or F8 | No controller Input |
Number 9 | 9 or F9 | No controller Input |
Number 10 | 10 or F10 | No controller Input |
Next | + or M | Controller Forward or Mouse Wheel Up |
Previous | - or N | Controller Back or Mouse Wheel Down |
Note: Keyboard & controller inputs may not be compatible with all devices
Inputs with multiple options might work with any/all or none of the listed input depending on device