Unity Script Reference – EditorGUILayout.EnumMaskField

EditorGUILayout.EnumMaskField

static function EnumMaskField (label : GUIContent, enumValue : System.Enum, style : GUIStyle, params options : GUILayoutOption[]) : System.Enum

static function EnumMaskField (label : String, enumValue : System.Enum, style : GUIStyle, params options : GUILayoutOption[]) : System.Enum

static function EnumMaskField (label : GUIContent, enumValue : System.Enum, params options : GUILayoutOption[]) : System.Enum

static function EnumMaskField (label : String, enumValue : System.Enum, params options : GUILayoutOption[]) : System.Enum

static function EnumMaskField (enumValue : System.Enum, style : GUIStyle, params options : GUILayoutOption[]) : System.Enum

static function EnumMaskField (enumValue : System.Enum, params options : GUILayoutOption[]) : System.Enum

Parameters

Name	Description
label	Prefix label for this field.
enumValue	Enum to use for the flags.
options	An optional list of layout options that specify extra layouting 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

System.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 = EditorGUILayout.EnumMaskField ( "Static Flags", staticFlagMask );
    }
}