GUI.Toggle Manual     Reference     Scripting  
Scripting > Runtime Classes > GUI
GUI.Toggle

static function Toggle (position : Rect, value : bool, text : string) : bool

static function Toggle (position : Rect, value : bool, image : Texture) : bool

static function Toggle (position : Rect, value : bool, content : GUIContent) : bool

static function Toggle (position : Rect, value : bool, text : string, style : GUIStyle) : bool

static function Toggle (position : Rect, value : bool, image : Texture, style : GUIStyle) : bool

static function Toggle (position : Rect, value : bool, content : GUIContent, style : GUIStyle) : bool

Parameters

NameDescription
position Rectangle on the screen to use for the button.
value Is this 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 toggle style from the current GUISkin is used.

Returns

bool - The new value of the button.

Description

Make an on/off toggle button.

JavaScripts
// 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 = GUI.Toggle(Rect(10, 10, 100, 30), toggleTxt, "A Toggle text");
toggleImg = GUI.Toggle(Rect(10, 50, 50, 50), toggleImg, aTexture);
}

using UnityEngine;
using System.Collections;

public class example : 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);
}
}

import UnityEngine
import System.Collections

class example(MonoBehaviour):

public aTexture as Texture

private toggleTxt as bool = false

private toggleImg as bool = false

def OnGUI():
if not aTexture:
Debug.LogError('Please assign a texture in the inspector.')
return
toggleTxt = GUI.Toggle(Rect(10, 10, 100, 30), toggleTxt, 'A Toggle text')
toggleImg = GUI.Toggle(Rect(10, 50, 50, 50), toggleImg, aTexture)