EnumFlagsField
Displays a menu with an option for every value of the enum type when clicked. An option for the value 0 with name "Nothing" and an option for the value ~0 (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values 0 and ~0 can be overriden by defining these values in the enum type.
Read time 11 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor
EnumFlagsField(Rect, Enum)
Displays a menu with an option for every value of the enum type when clicked. An option for the value with name "Nothing" and an option for the value (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values and can be overriden by defining these values in the enum type.
0~00~0public static Enum EnumFlagsField(Rect position, Enum enumValue)
Parameters
Returns
Type | Description |
|---|---|
| Enum | The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). |
Remarks
Note: This method only supports enums whose underlying types are supported by Unity's serialization system (sbyte, short, int, byte, ushort, or uint). For enums backed by an unsigned type, the "Everything" option should have the value corresponding to all bits set (i.e. in an unchecked context or the constant for the type).
~0MaxValue
Simple editor window that shows the enum flags field.
Examples
using UnityEditor;using UnityEngine;class EnumFlagsFieldExample : EditorWindow{ enum ExampleFlagsEnum { None = 0, // Custom name for "Nothing" option A = 1 << 0, B = 1 << 1, AB = A | B, // Combination of two flags C = 1 << 2, All = ~0, // Custom name for "Everything" option } ExampleFlagsEnum m_Flags; [MenuItem("Examples/EnumFlagsField Example")] static void OpenWindow() { GetWindow<EnumFlagsFieldExample>().Show(); } void OnGUI() { m_Flags = (ExampleFlagsEnum)EditorGUI.EnumFlagsField(new Rect(5, 5, 300, 20), m_Flags); }}
EnumFlagsField(Rect, Enum, GUIStyle)
Displays a menu with an option for every value of the enum type when clicked. An option for the value with name "Nothing" and an option for the value (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values and can be overriden by defining these values in the enum type.
0~00~0public static Enum EnumFlagsField(Rect position, Enum enumValue, GUIStyle style)
Parameters
Returns
Type | Description |
|---|---|
| Enum | The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). |
Remarks
Note: This method only supports enums whose underlying types are supported by Unity's serialization system (sbyte, short, int, byte, ushort, or uint). For enums backed by an unsigned type, the "Everything" option should have the value corresponding to all bits set (i.e. in an unchecked context or the constant for the type).
~0MaxValueSimple editor window that shows the enum flags field.
Examples
using UnityEditor;using UnityEngine;class EnumFlagsFieldExample : EditorWindow{ enum ExampleFlagsEnum { None = 0, // Custom name for "Nothing" option A = 1 << 0, B = 1 << 1, AB = A | B, // Combination of two flags C = 1 << 2, All = ~0, // Custom name for "Everything" option } ExampleFlagsEnum m_Flags; [MenuItem("Examples/EnumFlagsField Example")] static void OpenWindow() { GetWindow<EnumFlagsFieldExample>().Show(); } void OnGUI() { m_Flags = (ExampleFlagsEnum)EditorGUI.EnumFlagsField(new Rect(5, 5, 300, 20), m_Flags); }}
EnumFlagsField(Rect, string, Enum)
Displays a menu with an option for every value of the enum type when clicked. An option for the value with name "Nothing" and an option for the value (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values and can be overriden by defining these values in the enum type.
0~00~0public static Enum EnumFlagsField(Rect position, string label, Enum enumValue)
Parameters
Returns
Type | Description |
|---|---|
| Enum | The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). |
Remarks
Note: This method only supports enums whose underlying types are supported by Unity's serialization system (sbyte, short, int, byte, ushort, or uint). For enums backed by an unsigned type, the "Everything" option should have the value corresponding to all bits set (i.e. in an unchecked context or the constant for the type).
~0MaxValueSimple editor window that shows the enum flags field.
Examples
using UnityEditor;using UnityEngine;class EnumFlagsFieldExample : EditorWindow{ enum ExampleFlagsEnum { None = 0, // Custom name for "Nothing" option A = 1 << 0, B = 1 << 1, AB = A | B, // Combination of two flags C = 1 << 2, All = ~0, // Custom name for "Everything" option } ExampleFlagsEnum m_Flags; [MenuItem("Examples/EnumFlagsField Example")] static void OpenWindow() { GetWindow<EnumFlagsFieldExample>().Show(); } void OnGUI() { m_Flags = (ExampleFlagsEnum)EditorGUI.EnumFlagsField(new Rect(5, 5, 300, 20), m_Flags); }}
EnumFlagsField(Rect, string, Enum, GUIStyle)
Displays a menu with an option for every value of the enum type when clicked. An option for the value with name "Nothing" and an option for the value (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values and can be overriden by defining these values in the enum type.
0~00~0public static Enum EnumFlagsField(Rect position, string label, Enum enumValue, GUIStyle style)
Parameters
Returns
Type | Description |
|---|---|
| Enum | The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). |
Remarks
Note: This method only supports enums whose underlying types are supported by Unity's serialization system (sbyte, short, int, byte, ushort, or uint). For enums backed by an unsigned type, the "Everything" option should have the value corresponding to all bits set (i.e. in an unchecked context or the constant for the type).
~0MaxValueSimple editor window that shows the enum flags field.
Examples
using UnityEditor;using UnityEngine;class EnumFlagsFieldExample : EditorWindow{ enum ExampleFlagsEnum { None = 0, // Custom name for "Nothing" option A = 1 << 0, B = 1 << 1, AB = A | B, // Combination of two flags C = 1 << 2, All = ~0, // Custom name for "Everything" option } ExampleFlagsEnum m_Flags; [MenuItem("Examples/EnumFlagsField Example")] static void OpenWindow() { GetWindow<EnumFlagsFieldExample>().Show(); } void OnGUI() { m_Flags = (ExampleFlagsEnum)EditorGUI.EnumFlagsField(new Rect(5, 5, 300, 20), m_Flags); }}
EnumFlagsField(Rect, GUIContent, Enum)
Displays a menu with an option for every value of the enum type when clicked. An option for the value with name "Nothing" and an option for the value (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values and can be overriden by defining these values in the enum type.
0~00~0public static Enum EnumFlagsField(Rect position, GUIContent label, Enum enumValue)
Parameters
Rectangle on the screen to use for the enum flags field.
Optional label to display in front of the enum flags field.
Enum flags value (Only supports enum values for enum types with int as the underlying type).
Returns
Type | Description |
|---|---|
| Enum | The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). |
Remarks
Note: This method only supports enums whose underlying types are supported by Unity's serialization system (sbyte, short, int, byte, ushort, or uint). For enums backed by an unsigned type, the "Everything" option should have the value corresponding to all bits set (i.e. in an unchecked context or the constant for the type).
~0MaxValueSimple editor window that shows the enum flags field.
Examples
using UnityEditor;using UnityEngine;class EnumFlagsFieldExample : EditorWindow{ enum ExampleFlagsEnum { None = 0, // Custom name for "Nothing" option A = 1 << 0, B = 1 << 1, AB = A | B, // Combination of two flags C = 1 << 2, All = ~0, // Custom name for "Everything" option } ExampleFlagsEnum m_Flags; [MenuItem("Examples/EnumFlagsField Example")] static void OpenWindow() { GetWindow<EnumFlagsFieldExample>().Show(); } void OnGUI() { m_Flags = (ExampleFlagsEnum)EditorGUI.EnumFlagsField(new Rect(5, 5, 300, 20), m_Flags); }}
EnumFlagsField(Rect, GUIContent, Enum, GUIStyle)
Displays a menu with an option for every value of the enum type when clicked. An option for the value with name "Nothing" and an option for the value (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values and can be overriden by defining these values in the enum type.
0~00~0public static Enum EnumFlagsField(Rect position, GUIContent label, Enum enumValue, GUIStyle style)
Parameters
Rectangle on the screen to use for the enum flags field.
Optional label to display in front of the enum flags field.
Enum flags value (Only supports enum values for enum types with int as the underlying type).
Returns
Type | Description |
|---|---|
| Enum | The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). |
Remarks
Note: This method only supports enums whose underlying types are supported by Unity's serialization system (sbyte, short, int, byte, ushort, or uint). For enums backed by an unsigned type, the "Everything" option should have the value corresponding to all bits set (i.e. in an unchecked context or the constant for the type).
~0MaxValueSimple editor window that shows the enum flags field.
Examples
using UnityEditor;using UnityEngine;class EnumFlagsFieldExample : EditorWindow{ enum ExampleFlagsEnum { None = 0, // Custom name for "Nothing" option A = 1 << 0, B = 1 << 1, AB = A | B, // Combination of two flags C = 1 << 2, All = ~0, // Custom name for "Everything" option } ExampleFlagsEnum m_Flags; [MenuItem("Examples/EnumFlagsField Example")] static void OpenWindow() { GetWindow<EnumFlagsFieldExample>().Show(); } void OnGUI() { m_Flags = (ExampleFlagsEnum)EditorGUI.EnumFlagsField(new Rect(5, 5, 300, 20), m_Flags); }}
EnumFlagsField(Rect, GUIContent, Enum, bool, GUIStyle)
Displays a menu with an option for every value of the enum type when clicked. An option for the value with name "Nothing" and an option for the value (that is, all bits set) with the name "Everything" are always displayed at the top of the menu. The names for the values and can be overriden by defining these values in the enum type.
0~00~0public static Enum EnumFlagsField(Rect position, GUIContent label, Enum enumValue, bool includeObsolete, GUIStyle style = null)
Parameters
Rectangle on the screen to use for the enum flags field.
Optional label to display in front of the enum flags field.
Enum flags value (Only supports enum values for enum types with int as the underlying type).
Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute.
Returns
Type | Description |
|---|---|
| Enum | The enum flags value modified by the user. This is a selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum). |
Remarks
Note: This method only supports enums whose underlying types are supported by Unity's serialization system (sbyte, short, int, byte, ushort, or uint). For enums backed by an unsigned type, the "Everything" option should have the value corresponding to all bits set (i.e. in an unchecked context or the constant for the type).
~0MaxValueSimple editor window that shows the enum flags field.
Examples
using UnityEditor;using UnityEngine;class EnumFlagsFieldExample : EditorWindow{ enum ExampleFlagsEnum { None = 0, // Custom name for "Nothing" option A = 1 << 0, B = 1 << 1, AB = A | B, // Combination of two flags C = 1 << 2, All = ~0, // Custom name for "Everything" option } ExampleFlagsEnum m_Flags; [MenuItem("Examples/EnumFlagsField Example")] static void OpenWindow() { GetWindow<EnumFlagsFieldExample>().Show(); } void OnGUI() { m_Flags = (ExampleFlagsEnum)EditorGUI.EnumFlagsField(new Rect(5, 5, 300, 20), m_Flags); }}