Version: 2017.1 (switch to 2017.2b)
LanguageEnglish
  • C#
  • JS

Script language

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

EditorGUI.BeginDisabledGroup

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function BeginDisabledGroup(disabled: bool): void;
public static void BeginDisabledGroup(bool disabled);

Parameters

disabled Boolean specifying if the controls inside the group should be disabled.

Description

Create a group of controls that can be disabled.

If disabled is true, the controls inside the group will be disabled. If false, the enabled/disabled state will not be changed.

Note: The use of EditorGUI.DisabledScope is usually preferred over EditorGUI.BeginDisabledGroup()/EditorGUI.EndDisabledGroup(), as it provides a safer, scoped mechanism. Please refer to the EditorGUI.DisabledScope documentation for more information.

canJump = EditorGUILayout.Toggle ("Can Jump", canJump);

// Disable the jumping height control if canJump is false: EditorGUI.BeginDisabledGroup (canJump == false); jumpHeight = EditorGUILayout.FloatField ("Jump Height", jumpHeight); EditorGUI.EndDisabledGroup ();

The group cannot be used to enable controls that would otherwise be disabled to begin with. The groups can be nested and the controls within a child group will be disabled both if that child group is itself disabled or if a parent group is.