Script language:

  • JS
  • C#
  • Boo
Script language

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

Suggest a change

GUILayout.Toggle

static function Toggle(value: bool, image: Texture, params options: GUILayoutOption[]): bool;
static bool Toggle(bool value, Texture image, params GUILayoutOption[] options);
static def Toggle(value as bool, image as Texture, *options as GUILayoutOption[]) as bool
static function Toggle(value: bool, text: string, params options: GUILayoutOption[]): bool;
static bool Toggle(bool value, string text, params GUILayoutOption[] options);
static def Toggle(value as bool, text as string, *options as GUILayoutOption[]) as bool
static function Toggle(value: bool, content: GUIContent, params options: GUILayoutOption[]): bool;
static bool Toggle(bool value, GUIContent content, params GUILayoutOption[] options);
static def Toggle(value as bool, content as GUIContent, *options as GUILayoutOption[]) as bool
static function Toggle(value: bool, image: Texture, style: GUIStyle, params options: GUILayoutOption[]): bool;
static bool Toggle(bool value, Texture image, GUIStyle style, params GUILayoutOption[] options);
static def Toggle(value as bool, image as Texture, style as GUIStyle, *options as GUILayoutOption[]) as bool
static function Toggle(value: bool, text: string, style: GUIStyle, params options: GUILayoutOption[]): bool;
static bool Toggle(bool value, string text, GUIStyle style, params GUILayoutOption[] options);
static def Toggle(value as bool, text as string, style as GUIStyle, *options as GUILayoutOption[]) as bool
static function Toggle(value: bool, content: GUIContent, style: GUIStyle, params options: GUILayoutOption[]): bool;
static bool Toggle(bool value, GUIContent content, GUIStyle style, params GUILayoutOption[] options);
static def Toggle(value as bool, content as GUIContent, style as GUIStyle, *options as GUILayoutOption[]) as bool

Parameters

valueIs the 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 button style from the current GUISkin is used.
optionsAn 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);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public aTexture as Texture

	private toggleTxt as bool = false

	private toggleImg as bool = false

	def OnGUI() as void:
		if not aTexture:
			Debug.LogError('Please assign a texture in the inspector.')
			return
		toggleTxt = GUILayout.Toggle(toggleTxt, 'A Toggle text')
		toggleImg = GUILayout.Toggle(toggleImg, aTexture)

Your name (optional):
Your email (optional):
Please write your suggestion here: