Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

DisabledGroupScope

class in UnityEditor

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

Sumbission failed

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

Close

Cancel

Switch to Manual

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.

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.

#pragma strict
canJump = EditorGUILayout.Toggle("Can Jump", canJump);
var group: var = EditorGUI.BeginDisabledGroup(canJump == false);
{
	jumpHeight = EditorGUILayout.FloatField("Jump Height", jumpHeight);
}
class ExampleClass {
  void Example() {
	canJump = EditorGUILayout.Toggle ("Can Jump", canJump);
	
	// Disable the jumping height control if canJump is false:
	using (var group = EditorGUI.BeginDisabledGroup (canJump == false))
	{
		jumpHeight = EditorGUILayout.FloatField ("Jump Height", jumpHeight);
	}
  }
}

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.

Constructors

EditorGUI.DisabledGroupScopeCreate a new DisabledGroupScope and begin the corresponding group.