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.

EditorGUI.Toggle

static function Toggle(position: Rect, value: bool): bool;
static function Toggle(position: Rect, label: string, value: bool): bool;
static function Toggle(position: Rect, value: bool, style: GUIStyle): bool;
static function Toggle(position: Rect, label: string, value: bool, style: GUIStyle): bool;
static function Toggle(position: Rect, label: GUIContent, value: bool): bool;
static function Toggle(position: Rect, label: GUIContent, value: bool, style: GUIStyle): bool;

Parameters

positionRectangle on the screen to use for the toggle.
labelOptional label in front of the toggle.
valueThe shown state of the toggle.
styleOptional GUIStyle.

Returns

bool The selected state of the toggle.

Description

Make a toggle.


Toggle control in an Editor Window.

	// Use a toggle button to show/hide a button that can close the window.
	
	class EditorGUIToggle extends EditorWindow {
	
		var showClose : boolean = true;
	
		@MenuItem("Examples/EditorGUI Toggle usage")
		static function Init() {
			var window = GetWindow(EditorGUIToggle);
			window.Show();
		}
		
		function OnGUI() {
			showClose = EditorGUI.Toggle(Rect(0,5,position.width,20),
						"Show Close Button",
						showClose);
			if(showClose)
				if(GUI.Button(Rect(0, 25, position.width, 100),"Close Window!"))
					this.Close();
		}
	}