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.

EditorGUI.EnumMaskField

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

Parameters

positionRectangle on the screen to use for this control.
enumValueEnum to use for the flags.
styleOptional GUIStyle.
labelCaption/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 );
		}
	}