Toggle
Make an on/off toggle button.
Read time 5 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.IMGUIModule
Toggle(Rect, bool, string)
Make an on/off toggle button.
public static bool Toggle(Rect position, bool value, string text)
Parameters
Returns
Type | Description |
|---|---|
| bool | The new value of the button. |
Examples
// Draws 2 toggle controls, one with a text, the other with an image.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture aTexture; private bool toggleTxt = false; private bool toggleImg = false; void OnGUI() { if (!aTexture) { Debug.LogError("Please assign a texture in the inspector."); return; } toggleTxt = GUI.Toggle(new Rect(10, 10, 100, 30), toggleTxt, "A Toggle text"); toggleImg = GUI.Toggle(new Rect(10, 50, 50, 50), toggleImg, aTexture); }}
Toggle(Rect, bool, Texture)
Make an on/off toggle button.
public static bool Toggle(Rect position, bool value, Texture image)
Parameters
Returns
Type | Description |
|---|---|
| bool | The new value of the button. |
Examples
// Draws 2 toggle controls, one with a text, the other with an image.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture aTexture; private bool toggleTxt = false; private bool toggleImg = false; void OnGUI() { if (!aTexture) { Debug.LogError("Please assign a texture in the inspector."); return; } toggleTxt = GUI.Toggle(new Rect(10, 10, 100, 30), toggleTxt, "A Toggle text"); toggleImg = GUI.Toggle(new Rect(10, 50, 50, 50), toggleImg, aTexture); }}
Toggle(Rect, bool, GUIContent)
Make an on/off toggle button.
public static bool Toggle(Rect position, bool value, GUIContent content)
Parameters
Rectangle on the screen to use for the button.
Is this button on or off?
Text, image and tooltip for this button.
Returns
Type | Description |
|---|---|
| bool | The new value of the button. |
Examples
// Draws 2 toggle controls, one with a text, the other with an image.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture aTexture; private bool toggleTxt = false; private bool toggleImg = false; void OnGUI() { if (!aTexture) { Debug.LogError("Please assign a texture in the inspector."); return; } toggleTxt = GUI.Toggle(new Rect(10, 10, 100, 30), toggleTxt, "A Toggle text"); toggleImg = GUI.Toggle(new Rect(10, 50, 50, 50), toggleImg, aTexture); }}
Toggle(Rect, bool, string, GUIStyle)
Make an on/off toggle button.
public static bool Toggle(Rect position, bool value, string text, GUIStyle style)
Parameters
Returns
Type | Description |
|---|---|
| bool | The new value of the button. |
Examples
// Draws 2 toggle controls, one with a text, the other with an image.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture aTexture; private bool toggleTxt = false; private bool toggleImg = false; void OnGUI() { if (!aTexture) { Debug.LogError("Please assign a texture in the inspector."); return; } toggleTxt = GUI.Toggle(new Rect(10, 10, 100, 30), toggleTxt, "A Toggle text"); toggleImg = GUI.Toggle(new Rect(10, 50, 50, 50), toggleImg, aTexture); }}
Toggle(Rect, bool, Texture, GUIStyle)
Make an on/off toggle button.
public static bool Toggle(Rect position, bool value, Texture image, GUIStyle style)
Parameters
Returns
Type | Description |
|---|---|
| bool | The new value of the button. |
Examples
// Draws 2 toggle controls, one with a text, the other with an image.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture aTexture; private bool toggleTxt = false; private bool toggleImg = false; void OnGUI() { if (!aTexture) { Debug.LogError("Please assign a texture in the inspector."); return; } toggleTxt = GUI.Toggle(new Rect(10, 10, 100, 30), toggleTxt, "A Toggle text"); toggleImg = GUI.Toggle(new Rect(10, 50, 50, 50), toggleImg, aTexture); }}
Toggle(Rect, bool, GUIContent, GUIStyle)
Make an on/off toggle button.
public static bool Toggle(Rect position, bool value, GUIContent content, GUIStyle style)
Parameters
Rectangle on the screen to use for the button.
Is this button on or off?
Text, image and tooltip for this button.
Returns
Type | Description |
|---|---|
| bool | The new value of the button. |
Examples
// Draws 2 toggle controls, one with a text, the other with an image.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture aTexture; private bool toggleTxt = false; private bool toggleImg = false; void OnGUI() { if (!aTexture) { Debug.LogError("Please assign a texture in the inspector."); return; } toggleTxt = GUI.Toggle(new Rect(10, 10, 100, 30), toggleTxt, "A Toggle text"); toggleImg = GUI.Toggle(new Rect(10, 50, 50, 50), toggleImg, aTexture); }}
Toggle(Rect, int, bool, GUIContent, GUIStyle)
Make an on/off toggle button.
public static bool Toggle(Rect position, int id, bool value, GUIContent content, GUIStyle style)
Parameters
Returns
Type | Description |
|---|---|
| bool | The new value of the button. |
Examples
// Draws 2 toggle controls, one with a text, the other with an image.using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ public Texture aTexture; private bool toggleTxt = false; private bool toggleImg = false; void OnGUI() { if (!aTexture) { Debug.LogError("Please assign a texture in the inspector."); return; } toggleTxt = GUI.Toggle(new Rect(10, 10, 100, 30), toggleTxt, "A Toggle text"); toggleImg = GUI.Toggle(new Rect(10, 50, 50, 50), toggleImg, aTexture); }}