Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

EditorGUILayout.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(label: GUIContent, enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
public static Enum EnumMaskField(GUIContent label, Enum enumValue, GUIStyle style, params GUILayoutOption[] options);
public static def EnumMaskField(label as GUIContent, enumValue as Enum, style as GUIStyle, *options as GUILayoutOption[]) as Enum
public static function EnumMaskField(label: string, enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
public static Enum EnumMaskField(string label, Enum enumValue, GUIStyle style, params GUILayoutOption[] options);
public static def EnumMaskField(label as string, enumValue as Enum, style as GUIStyle, *options as GUILayoutOption[]) as Enum
public static function EnumMaskField(label: GUIContent, enumValue: Enum, params options: GUILayoutOption[]): Enum;
public static Enum EnumMaskField(GUIContent label, Enum enumValue, params GUILayoutOption[] options);
public static def EnumMaskField(label as GUIContent, enumValue as Enum, *options as GUILayoutOption[]) as Enum
public static function EnumMaskField(label: string, enumValue: Enum, params options: GUILayoutOption[]): Enum;
public static Enum EnumMaskField(string label, Enum enumValue, params GUILayoutOption[] options);
public static def EnumMaskField(label as string, enumValue as Enum, *options as GUILayoutOption[]) as Enum
public static function EnumMaskField(enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
public static Enum EnumMaskField(Enum enumValue, GUIStyle style, params GUILayoutOption[] options);
public static def EnumMaskField(enumValue as Enum, style as GUIStyle, *options as GUILayoutOption[]) as Enum
public static function EnumMaskField(enumValue: Enum, params options: GUILayoutOption[]): Enum;
public static Enum EnumMaskField(Enum enumValue, params GUILayoutOption[] options);
public static def EnumMaskField(enumValue as Enum, *options as GUILayoutOption[]) as Enum

Parameters

label Prefix label for this field.
enumValue Enum to use for the flags.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

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 = EditorGUILayout.EnumMaskField ( "Static Flags", staticFlagMask );
		}
	}