Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Toggle

Make an on/off toggle button.
Read time 6 minutesLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.IMGUIModule

Toggle(bool, Texture, GUILayoutOption[])

Make an on/off toggle button.
public static bool Toggle(bool value, Texture image, params GUILayoutOption[] options)

Parameters

value

bool
Is the button on or off?

image

Texture
Texture to display on the button.

options

GUILayoutOption[]
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the 
style
.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

Type

Description

boolThe new value of the button.

Remarks

GUILayoutToggle (Toggle)
Toggle button in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

Examples

using UnityEngine;public class ExampleScript : MonoBehaviour{    // Draws 2 toggle controls, one with a text, the other with an image.    Texture aTexture;    bool toggleTxt = false;    bool toggleImg = false;    void OnGUI()    {        if (!aTexture)        {            Debug.LogError("Please assign a texture in the inspector.");            return;        }        toggleTxt = GUILayout.Toggle(toggleTxt, "A Toggle text");        toggleImg = GUILayout.Toggle(toggleImg, aTexture);    }}

Toggle(bool, string, GUILayoutOption[])

Make an on/off toggle button.
public static bool Toggle(bool value, string text, params GUILayoutOption[] options)

Parameters

value

bool
Is the button on or off?

text

string
Text to display on the button.

options

GUILayoutOption[]
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the 
style
.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

Type

Description

boolThe new value of the button.

Remarks

GUILayoutToggle (Toggle)
Toggle button in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

Examples

using UnityEngine;public class ExampleScript : MonoBehaviour{    // Draws 2 toggle controls, one with a text, the other with an image.    Texture aTexture;    bool toggleTxt = false;    bool toggleImg = false;    void OnGUI()    {        if (!aTexture)        {            Debug.LogError("Please assign a texture in the inspector.");            return;        }        toggleTxt = GUILayout.Toggle(toggleTxt, "A Toggle text");        toggleImg = GUILayout.Toggle(toggleImg, aTexture);    }}

Toggle(bool, GUIContent, GUILayoutOption[])

Make an on/off toggle button.
public static bool Toggle(bool value, GUIContent content, params GUILayoutOption[] options)

Parameters

value

bool
Is the button on or off?

content

GUIContent
Text, image and tooltip for this button.

options

GUILayoutOption[]
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the 
style
.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

Type

Description

boolThe new value of the button.

Remarks

GUILayoutToggle (Toggle)
Toggle button in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

Examples

using UnityEngine;public class ExampleScript : MonoBehaviour{    // Draws 2 toggle controls, one with a text, the other with an image.    Texture aTexture;    bool toggleTxt = false;    bool toggleImg = false;    void OnGUI()    {        if (!aTexture)        {            Debug.LogError("Please assign a texture in the inspector.");            return;        }        toggleTxt = GUILayout.Toggle(toggleTxt, "A Toggle text");        toggleImg = GUILayout.Toggle(toggleImg, aTexture);    }}

Toggle(bool, Texture, GUIStyle, GUILayoutOption[])

Make an on/off toggle button.
public static bool Toggle(bool value, Texture image, GUIStyle style, params GUILayoutOption[] options)

Parameters

value

bool
Is the button on or off?

image

Texture
Texture to display on the button.

style

GUIStyle
The style to use. If left out, the 
button
style from the current GUISkin is used.

options

GUILayoutOption[]
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the 
style
.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

Type

Description

boolThe new value of the button.

Remarks

GUILayoutToggle (Toggle)
Toggle button in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

Examples

using UnityEngine;public class ExampleScript : MonoBehaviour{    // Draws 2 toggle controls, one with a text, the other with an image.    Texture aTexture;    bool toggleTxt = false;    bool toggleImg = false;    void OnGUI()    {        if (!aTexture)        {            Debug.LogError("Please assign a texture in the inspector.");            return;        }        toggleTxt = GUILayout.Toggle(toggleTxt, "A Toggle text");        toggleImg = GUILayout.Toggle(toggleImg, aTexture);    }}

Toggle(bool, string, GUIStyle, GUILayoutOption[])

Make an on/off toggle button.
public static bool Toggle(bool value, string text, GUIStyle style, params GUILayoutOption[] options)

Parameters

value

bool
Is the button on or off?

text

string
Text to display on the button.

style

GUIStyle
The style to use. If left out, the 
button
style from the current GUISkin is used.

options

GUILayoutOption[]
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the 
style
.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

Type

Description

boolThe new value of the button.

Remarks

GUILayoutToggle (Toggle)
Toggle button in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

Examples

using UnityEngine;public class ExampleScript : MonoBehaviour{    // Draws 2 toggle controls, one with a text, the other with an image.    Texture aTexture;    bool toggleTxt = false;    bool toggleImg = false;    void OnGUI()    {        if (!aTexture)        {            Debug.LogError("Please assign a texture in the inspector.");            return;        }        toggleTxt = GUILayout.Toggle(toggleTxt, "A Toggle text");        toggleImg = GUILayout.Toggle(toggleImg, aTexture);    }}

Toggle(bool, GUIContent, GUIStyle, GUILayoutOption[])

Make an on/off toggle button.
public static bool Toggle(bool value, GUIContent content, GUIStyle style, params GUILayoutOption[] options)

Parameters

value

bool
Is the button on or off?

content

GUIContent
Text, image and tooltip for this button.

style

GUIStyle
The style to use. If left out, the 
button
style from the current GUISkin is used.

options

GUILayoutOption[]
An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the 
style
.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

Type

Description

boolThe new value of the button.

Remarks

GUILayoutToggle (Toggle)
Toggle button in the Game View.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

Examples

using UnityEngine;public class ExampleScript : MonoBehaviour{    // Draws 2 toggle controls, one with a text, the other with an image.    Texture aTexture;    bool toggleTxt = false;    bool toggleImg = false;    void OnGUI()    {        if (!aTexture)        {            Debug.LogError("Please assign a texture in the inspector.");            return;        }        toggleTxt = GUILayout.Toggle(toggleTxt, "A Toggle text");        toggleImg = GUILayout.Toggle(toggleImg, aTexture);    }}