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.

EditorGUILayout.EnumMaskField

static function EnumMaskField(label: GUIContent, enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
static Enum EnumMaskField(GUIContent label, Enum enumValue, GUIStyle style, params GUILayoutOption[] options);
static def EnumMaskField(label as GUIContent, enumValue as Enum, style as GUIStyle, *options as GUILayoutOption[]) as Enum
static function EnumMaskField(label: string, enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
static Enum EnumMaskField(string label, Enum enumValue, GUIStyle style, params GUILayoutOption[] options);
static def EnumMaskField(label as string, enumValue as Enum, style as GUIStyle, *options as GUILayoutOption[]) as Enum
static function EnumMaskField(label: GUIContent, enumValue: Enum, params options: GUILayoutOption[]): Enum;
static Enum EnumMaskField(GUIContent label, Enum enumValue, params GUILayoutOption[] options);
static def EnumMaskField(label as GUIContent, enumValue as Enum, *options as GUILayoutOption[]) as Enum
static function EnumMaskField(label: string, enumValue: Enum, params options: GUILayoutOption[]): Enum;
static Enum EnumMaskField(string label, Enum enumValue, params GUILayoutOption[] options);
static def EnumMaskField(label as string, enumValue as Enum, *options as GUILayoutOption[]) as Enum
static function EnumMaskField(enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
static Enum EnumMaskField(Enum enumValue, GUIStyle style, params GUILayoutOption[] options);
static def EnumMaskField(enumValue as Enum, style as GUIStyle, *options as GUILayoutOption[]) as Enum
static function EnumMaskField(enumValue: Enum, params options: GUILayoutOption[]): Enum;
static Enum EnumMaskField(Enum enumValue, params GUILayoutOption[] options);
static def EnumMaskField(enumValue as Enum, *options as GUILayoutOption[]) as Enum

Parameters

labelPrefix label for this field.
enumValueEnum to use for the flags.
optionsAn 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 );
		}
	}