Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

GUI.Toggle

Other Versions
Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static method Toggle(position: Rect, value: bool, text: string): bool;
public static bool Toggle(Rect position, bool value, string text);
public static method Toggle(position: Rect, value: bool, image: Texture): bool;
public static bool Toggle(Rect position, bool value, Texture image);
public static method Toggle(position: Rect, value: bool, content: GUIContent): bool;
public static bool Toggle(Rect position, bool value, GUIContent content);
public static method Toggle(position: Rect, value: bool, text: string, style: GUIStyle): bool;
public static bool Toggle(Rect position, bool value, string text, GUIStyle style);
public static method Toggle(position: Rect, value: bool, image: Texture, style: GUIStyle): bool;
public static bool Toggle(Rect position, bool value, Texture image, GUIStyle style);
public static method Toggle(position: Rect, value: bool, content: GUIContent, style: GUIStyle): bool;
public static bool Toggle(Rect position, bool value, GUIContent content, GUIStyle style);

Parameters

positionRectangle on the screen to use for the button.
valueIs this button on or off?
textText to display on the button.
image Texture to display on the button.
contentText, image and tooltip for this button.
styleThe style to use. If left out, the toggle style from the current GUISkin is used.

Returns

bool The new value of the button.

Description

Make an on/off toggle button.

no example available in JavaScript
// 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);
    }
}

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information