EditorGUILayout.EnumFlagsField
public static Enum EnumFlagsField
(Enum enumValue,
params GUILayoutOption[] options);
public static Enum EnumFlagsField
(Enum enumValue,
GUIStyle style,
params GUILayoutOption[] options);
public static Enum EnumFlagsField
(string label,
Enum enumValue,
params GUILayoutOption[] options);
public static Enum EnumFlagsField
(string label,
Enum enumValue,
GUIStyle style,
params GUILayoutOption[] options);
public static Enum EnumFlagsField
(GUIContent label,
Enum enumValue,
params GUILayoutOption[] options);
public static Enum EnumFlagsField
(GUIContent label,
Enum enumValue,
GUIStyle style,
params GUILayoutOption[] options);
public static Enum EnumFlagsField
(GUIContent label,
Enum enumValue,
bool includeObsolete,
params GUILayoutOption[] options);
public static Enum EnumFlagsField
(GUIContent label,
Enum enumValue,
bool includeObsolete,
GUIStyle style,
params GUILayoutOption[] options);
Parameters
| label | （可选）显示在枚举标志字段前的标签。 |
| enumValue | 枚举标志值。 |
| style | 可选 GUIStyle。 |
| options | 一个可选的布局选项列表，用于指定额外的布局属性。此处传递的任何值都将覆盖 style 定义的设置。另请参阅：GUILayout.Width、GUILayout.Height、GUILayout.MinWidth、GUILayout.MaxWidth、GUILayout.MinHeight、 GUILayout.MaxHeight、GUILayout.ExpandWidth、GUILayout.ExpandHeight。 |
| includeObsolete | Set to true to include Enum values with ObsoleteAttribute. Set to false to exclude Enum values with ObsoleteAttribute. |
Returns
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)EditorGUILayout.EnumFlagsField(m_Flags); } }