Button
Make a single press button.
Read time 7 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.IMGUIModule
Button(Texture, GUILayoutOption[])
Make a single press button.
public static bool Button(Texture image, params GUILayoutOption[] options)
Parameters
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the .
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
styleGUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
Returns
Type | Description |
|---|---|
| bool | true when the users clicks the button. |
Remarks
Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected value. If the mouse is moved off the button it is not clicked.
true
Buttons in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight
Examples
using UnityEngine;public class ExampleScript : MonoBehaviour{ // Draws a button with an image and a button with text Texture tex; void OnGUI() { if (!tex) { Debug.LogError("No texture found, please assign a texture on the inspector"); } if (GUILayout.Button(tex)) { Debug.Log("Clicked the image"); } if (GUILayout.Button("I am a regular Automatic Layout Button")) { Debug.Log("Clicked Button"); } }}
Button(string, GUILayoutOption[])
Make a single press button.
public static bool Button(string text, params GUILayoutOption[] options)
Parameters
Text to display on the button.
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the .
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
styleGUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
Returns
Type | Description |
|---|---|
| bool | true when the users clicks the button. |
Remarks
Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected value. If the mouse is moved off the button it is not clicked.
trueButtons in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight
Examples
using UnityEngine;public class ExampleScript : MonoBehaviour{ // Draws a button with an image and a button with text Texture tex; void OnGUI() { if (!tex) { Debug.LogError("No texture found, please assign a texture on the inspector"); } if (GUILayout.Button(tex)) { Debug.Log("Clicked the image"); } if (GUILayout.Button("I am a regular Automatic Layout Button")) { Debug.Log("Clicked Button"); } }}
Button(GUIContent, GUILayoutOption[])
Make a single press button.
public static bool Button(GUIContent content, params GUILayoutOption[] options)
Parameters
Text, image and tooltip for this button.
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the .
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
styleGUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
Returns
Type | Description |
|---|---|
| bool | true when the users clicks the button. |
Remarks
Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected value. If the mouse is moved off the button it is not clicked.
trueButtons in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight
Examples
using UnityEngine;public class ExampleScript : MonoBehaviour{ // Draws a button with an image and a button with text Texture tex; void OnGUI() { if (!tex) { Debug.LogError("No texture found, please assign a texture on the inspector"); } if (GUILayout.Button(tex)) { Debug.Log("Clicked the image"); } if (GUILayout.Button("I am a regular Automatic Layout Button")) { Debug.Log("Clicked Button"); } }}
Button(Texture, GUIStyle, GUILayoutOption[])
Make a single press button.
public static bool Button(Texture image, GUIStyle style, params GUILayoutOption[] options)
Parameters
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the .
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
styleGUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
Returns
Type | Description |
|---|---|
| bool | true when the users clicks the button. |
Remarks
Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected value. If the mouse is moved off the button it is not clicked.
trueButtons in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight
Examples
using UnityEngine;public class ExampleScript : MonoBehaviour{ // Draws a button with an image and a button with text Texture tex; void OnGUI() { if (!tex) { Debug.LogError("No texture found, please assign a texture on the inspector"); } if (GUILayout.Button(tex)) { Debug.Log("Clicked the image"); } if (GUILayout.Button("I am a regular Automatic Layout Button")) { Debug.Log("Clicked Button"); } }}
Button(string, GUIStyle, GUILayoutOption[])
Make a single press button.
public static bool Button(string text, GUIStyle style, params GUILayoutOption[] options)
Parameters
Text to display on the button.
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the .
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
styleGUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
Returns
Type | Description |
|---|---|
| bool | true when the users clicks the button. |
Remarks
Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected value. If the mouse is moved off the button it is not clicked.
trueButtons in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight
Examples
using UnityEngine;public class ExampleScript : MonoBehaviour{ // Draws a button with an image and a button with text Texture tex; void OnGUI() { if (!tex) { Debug.LogError("No texture found, please assign a texture on the inspector"); } if (GUILayout.Button(tex)) { Debug.Log("Clicked the image"); } if (GUILayout.Button("I am a regular Automatic Layout Button")) { Debug.Log("Clicked Button"); } }}
Button(GUIContent, GUIStyle, GUILayoutOption[])
Make a single press button.
public static bool Button(GUIContent content, GUIStyle style, params GUILayoutOption[] options)
Parameters
Text, image and tooltip for this button.
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the .
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
styleGUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight
Returns
Type | Description |
|---|---|
| bool | true when the users clicks the button. |
Remarks
Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected value. If the mouse is moved off the button it is not clicked.
trueButtons in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight
Examples
using UnityEngine;public class ExampleScript : MonoBehaviour{ // Draws a button with an image and a button with text Texture tex; void OnGUI() { if (!tex) { Debug.LogError("No texture found, please assign a texture on the inspector"); } if (GUILayout.Button(tex)) { Debug.Log("Clicked the image"); } if (GUILayout.Button("I am a regular Automatic Layout Button")) { Debug.Log("Clicked Button"); } }}