Version: 2019.2
LanguageEnglish
  • C#

EditorGUI.EnumFlagsField

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

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static Enum EnumFlagsField(Rect position, Enum enumValue);
public static Enum EnumFlagsField(Rect position, Enum enumValue, GUIStyle style);
public static Enum EnumFlagsField(Rect position, string label, Enum enumValue);
public static Enum EnumFlagsField(Rect position, string label, Enum enumValue, GUIStyle style);
public static Enum EnumFlagsField(Rect position, GUIContent label, Enum enumValue);
public static Enum EnumFlagsField(Rect position, GUIContent label, Enum enumValue, GUIStyle style);
public static Enum EnumFlagsField(Rect position, GUIContent label, Enum enumValue, bool includeObsolete = false, GUIStyle style = null);

Parameters

positionRectangle on the screen to use for the enum flags field.
labelOptional label to display in front of the enum flags field.
enumValueEnum flags value (Only supports enum values for enum types with int as the underlying type).
styleOptional GUIStyle.
includeObsoleteSet to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute.

Returns

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).

Description

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.

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. ~0 in an unchecked context or the MaxValue constant for the type).


Simple editor window that shows the enum flags field.

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); } }

Did you find this page useful? Please give it a rating: