Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

EditorGUI.EnumMaskField

Other Versions
Leave feedback
public static Enum EnumMaskField(Rect position, Enum enumValue, GUIStyle style = EditorStyles.popup);
public static Enum EnumMaskField(Rect position, string label, Enum enumValue, GUIStyle style = EditorStyles.popup);
public static Enum EnumMaskField(Rect position, GUIContent label, Enum enumValue, GUIStyle style = EditorStyles.popup);

Parameters

position Rectangle on the screen to use for this control.
label Caption/label for the control.
enumValue Enum to use for the flags.
style Optional GUIStyle.

Returns

Enum A selection BitMask where each bit represents an Enum value index. (Note this returned value is not itself an Enum).

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 = EditorGUI.EnumMaskField ( new Rect (0, 0, 300, 20), "Static Flags", staticFlagMask );
}
}

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

  • Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

    Copyright © 2017 Unity Technologies. Publication: 2017.2-001U. Built: 2017-12-08.
    Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information