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.ToggleLeft

static function ToggleLeft(position: Rect, label: string, value: bool, labelStyle: GUIStyle = EditorStyles.label): bool;
static function ToggleLeft(position: Rect, label: GUIContent, value: bool, labelStyle: GUIStyle = EditorStyles.label): bool;

Parameters

positionRectangle on the screen to use for the toggle.
labelLabel to display next to the toggle.
valueThe value to edit.
labelStyleOptional GUIStyle to use for the label.

Returns

bool The value set by the user.

Description

Make a toggle field where the toggle is to the left and the label immediately to the right of it.

EditorGUI.ToggleLeft is similar to GUI.Toggle but respects the EditorGUI.showMixedValue property and handles keyboard focus consistent with other Editor controls.