GUI.Toggle

static function Toggle (position : Rect, value : boolean, text : String) : boolean

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

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

static function Toggle (position : Rect, value : boolean, text : String, style : GUIStyle) : boolean

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

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

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

boolean - The new value of the button.

Description

Make an on/off toggle button.

JavaScript
// 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);
}