33 lines
1.4 KiB
Markdown
33 lines
1.4 KiB
Markdown
|
# Button
|
||
|
|
|
||
|
|
The **Button** control responds to a click from the user and is used to initiate or confirm an action. Familiar examples include the _Submit_ and _Cancel_ buttons used on web forms.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
|**Property:** |**Function:** |
|
||
|
|
|:---|:---|
|
||
|
|
|**Interactable** | Enable **Interactable** if you want this button to accept input. See API documentation on [Interactable](script-Selectable.md) for more details. |
|
||
|
|
|**Transition** | Properties that determine the way the control responds visually to user actions. See [Transition Options](script-SelectableTransition.md). |
|
||
|
|
|**Navigation** | Properties that determine the sequence of controls. See [Navigation Options](script-SelectableNavigation.md).|
|
||
|
|
|
||
|
|
## Events
|
||
|
|
|
||
|
|
|**Property:** |**Function:** |
|
||
|
|
|:---|:---|
|
||
|
|
|**On Click** | A [UnityEvent](https://docs.unity3d.com/Manual/UnityEvents.html) that Unity invokes when a user clicks the button and releases it.|
|
||
|
|
|
||
|
|
|
||
|
|
## Details
|
||
|
|
|
||
|
|
The button is designed to initiate an action when the user clicks and releases it. If the mouse is moved off the button control before the click is released, the action does not take place.
|
||
|
|
|
||
|
|
The button has a single event called _On Click_ that responds when the user completes a click. Typical use cases include:
|
||
|
|
|
||
|
|
* Confirming a decision (eg, starting gameplay or saving a game)
|
||
|
|
* Moving to a sub-menu in a GUI
|
||
|
|
* Cancelling an action in progress (eg, downloading a new scene)
|