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

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