Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

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

GUILayout.Toggle

Other Versions
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 function Toggle(value: bool, image: Texture, params options: GUILayoutOption[]): bool;
public static bool Toggle(bool value, Texture image, params GUILayoutOption[] options);
public static function Toggle(value: bool, text: string, params options: GUILayoutOption[]): bool;
public static bool Toggle(bool value, string text, params GUILayoutOption[] options);
public static function Toggle(value: bool, content: GUIContent, params options: GUILayoutOption[]): bool;
public static bool Toggle(bool value, GUIContent content, params GUILayoutOption[] options);
public static function Toggle(value: bool, image: Texture, style: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool Toggle(bool value, Texture image, GUIStyle style, params GUILayoutOption[] options);
public static function Toggle(value: bool, text: string, style: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool Toggle(bool value, string text, GUIStyle style, params GUILayoutOption[] options);
public static function Toggle(value: bool, content: GUIContent, style: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool Toggle(bool value, GUIContent content, GUIStyle style, params GUILayoutOption[] options);

Parameters

value Is the button on or off?
text Text to display on the button.
image Texture to display on the button.
content Text, image and tooltip for this button.
style The style to use. If left out, the button style from the current GUISkin is used.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

bool The new value of the button.

Description

Make an on/off toggle button.


Toggle button in the Game View.

	// Draws 2 toggle controls, one with a text, the other with an image.
	var aTexture : Texture;

	private var toggleTxt : boolean = false;
	private var toggleImg : boolean = false;

	function 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);
	}

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 = GUILayout.Toggle(toggleTxt, "A Toggle text");
        toggleImg = GUILayout.Toggle(toggleImg, aTexture);
    }
}
Copyright © 2023 Unity Technologies
优美缔软件（上海）有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961