LanguageEnglish
  • C#
  • JS

Script language

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

EditorGUI.EnumMaskField

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

public static function EnumMaskField(position: Rect, enumValue: Enum, style: GUIStyle = EditorStyles.popup): Enum;
public static Enum EnumMaskField(Rect position, Enum enumValue, GUIStyle style = EditorStyles.popup);
public static function EnumMaskField(position: Rect, label: string, enumValue: Enum, style: GUIStyle = EditorStyles.popup): Enum;
public static Enum EnumMaskField(Rect position, string label, Enum enumValue, GUIStyle style = EditorStyles.popup);
public static function EnumMaskField(position: Rect, label: GUIContent, enumValue: Enum, style: GUIStyle = EditorStyles.popup): Enum;
public static Enum EnumMaskField(Rect position, GUIContent label, Enum enumValue, GUIStyle style = EditorStyles.popup);
public static function EnumMaskField(position: Rect, enumValue: Enum, style: GUIStyle = EditorStyles.popup): Enum;
public static Enum EnumMaskField(Rect position, Enum enumValue, GUIStyle style = EditorStyles.popup);
public static function EnumMaskField(position: Rect, label: string, enumValue: Enum, style: GUIStyle = EditorStyles.popup): Enum;
public static Enum EnumMaskField(Rect position, string label, Enum enumValue, GUIStyle style = EditorStyles.popup);
public static function EnumMaskField(position: Rect, label: GUIContent, enumValue: Enum, style: GUIStyle = EditorStyles.popup): Enum;
public static Enum EnumMaskField(Rect position, GUIContent label, Enum enumValue, GUIStyle style = EditorStyles.popup);

Parameters

position Rectangle on the screen to use for this control.
enumValue Enum to use for the flags.
style Optional GUIStyle.
label Caption/label for the control.

Returns

Enum The value modified by the user.

Description

Make a field for enum based masks.


Simple window that shows the enum mask field.

	class SimpleEnumMaskUsage extends EditorWindow {
		@MenuItem("Examples/Mask Field Usage")
		static function Init() {
			var window = GetWindow(SimpleEnumMaskUsage);
			window.Show();
		}
		
		var staticFlagMask : StaticEditorFlags = 0;
		function OnGUI() {
			staticFlagMask = EditorGUI.EnumMaskField ( new Rect (0, 0, 300, 20), "Static Flags", staticFlagMask );
		}
	}