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

Script language

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

EditorGUILayout.MaskField

Other Versions
Leave feedback
public static int MaskField(GUIContent label, int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
public static int MaskField(string label, int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
public static int MaskField(GUIContent label, int mask, string[] displayedOptions, params GUILayoutOption[] options);
public static int MaskField(string label, int mask, string[] displayedOptions, params GUILayoutOption[] options);
public static int MaskField(int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
public static int MaskField(int mask, string[] displayedOptions, params GUILayoutOption[] options);

Parameters

labelPrefix label of the field.
maskThe current mask to display.
displayedOptionA string array containing the labels for each flag.
optionsAn 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

int The value modified by the user.

Description

Make a field for masks.


Simple window that shows the mask field.

using UnityEngine;
using UnityEditor;

public class MaskFieldExample : EditorWindow
{
    static int flags = 0;
    static string[] options = new string[] {"CanJump", "CanShoot", "CanSwim"};

    [MenuItem("Examples/Mask Field usage")]
    static void Init()
    {
        MaskFieldExample window = (MaskFieldExample)GetWindow(typeof(MaskFieldExample));
        window.Show();
    }

    void OnGUI()
    {
        flags = EditorGUILayout.MaskField("Player Flags", flags, options);
    }
}

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 © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
    TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information