Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

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

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