Version: 2017.3 (switch to 2018.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

EditorGUILayout.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 method EnumFlagsField(enumValue: Enum, params options: GUILayoutOption[]): Enum;
public static Enum EnumFlagsField(Enum enumValue, params GUILayoutOption[] options);
public static method EnumFlagsField(enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
public static Enum EnumFlagsField(Enum enumValue, GUIStyle style, params GUILayoutOption[] options);
public static method EnumFlagsField(label: string, enumValue: Enum, params options: GUILayoutOption[]): Enum;
public static Enum EnumFlagsField(string label, Enum enumValue, params GUILayoutOption[] options);
public static method EnumFlagsField(label: string, enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
public static Enum EnumFlagsField(string label, Enum enumValue, GUIStyle style, params GUILayoutOption[] options);
public static method EnumFlagsField(label: GUIContent, enumValue: Enum, params options: GUILayoutOption[]): Enum;
public static Enum EnumFlagsField(GUIContent label, Enum enumValue, params GUILayoutOption[] options);
public static method EnumFlagsField(label: GUIContent, enumValue: Enum, style: GUIStyle, params options: GUILayoutOption[]): Enum;
public static Enum EnumFlagsField(GUIContent label, Enum enumValue, GUIStyle style, params GUILayoutOption[] options);

Parameters

label Optional label to display in front of the enum flags field.
enumValue Enum flags value.
style Optional GUIStyle.
options An optional list of layout options that specify extra layout 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 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.

#pragma strict
class EnumFlagsFieldExample extends 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
	}
	var m_Flags: ExampleFlagsEnum;
	@MenuItem("Examples/EnumFlagsField Example")
	static function OpenWindow() {
		GetWindow.<EnumFlagsFieldExample>().Show();
	}
	function OnGUI() {
		m_Flags = ExampleFlagsEnumEditorGUILayout.EnumFlagsField(m_Flags);
	}
}
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)EditorGUILayout.EnumFlagsField(m_Flags); } }

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