Script language:

  • JS
  • C#
  • Boo
Script language

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

Suggest a change

GUI.Toggle

static function Toggle(position: Rect, value: bool, text: string): bool;
static bool Toggle(Rect position, bool value, string text);
static def Toggle(position as Rect, value as bool, text as string) as bool
static function Toggle(position: Rect, value: bool, image: Texture): bool;
static bool Toggle(Rect position, bool value, Texture image);
static def Toggle(position as Rect, value as bool, image as Texture) as bool
static function Toggle(position: Rect, value: bool, content: GUIContent): bool;
static bool Toggle(Rect position, bool value, GUIContent content);
static def Toggle(position as Rect, value as bool, content as GUIContent) as bool
static function Toggle(position: Rect, value: bool, text: string, style: GUIStyle): bool;
static bool Toggle(Rect position, bool value, string text, GUIStyle style);
static def Toggle(position as Rect, value as bool, text as string, style as GUIStyle) as bool
static function Toggle(position: Rect, value: bool, image: Texture, style: GUIStyle): bool;
static bool Toggle(Rect position, bool value, Texture image, GUIStyle style);
static def Toggle(position as Rect, value as bool, image as Texture, style as GUIStyle) as bool
static function Toggle(position: Rect, value: bool, content: GUIContent, style: GUIStyle): bool;
static bool Toggle(Rect position, bool value, GUIContent content, GUIStyle style);
static def Toggle(position as Rect, value as bool, content as GUIContent, style as GUIStyle) as bool

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.

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

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