Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

MaskField

Make a field for masks.
Read time 7 minutesLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor.CoreModule

MaskField(GUIContent, int, string[], GUIStyle, GUILayoutOption[])

Make a field for masks.
public static int MaskField(GUIContent label, int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options)

Parameters

label

GUIContent
Prefix label of the field.

mask

int
The current mask to display.

displayedOptions

string[]
A string array containing the labels for each flag.

style

GUIStyle

options

GUILayoutOption[]
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the 
style
.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Type

Description

intThe value modified by the user.

Remarks

MaskField (MaskField)
Simple window that shows the mask field.

Examples

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);        // Display the flags in disabled toggles        GUI.enabled = false;        for (var i = 0; i < options.Length; i++)        {            var value = (flags & (1 << i)) != 0;            EditorGUILayout.Toggle(options[i], value);        }        GUI.enabled = true;    }}

MaskField(string, int, string[], GUIStyle, GUILayoutOption[])

Make a field for masks.
public static int MaskField(string label, int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options)

Parameters

label

string
Prefix label of the field.

mask

int
The current mask to display.

displayedOptions

string[]
A string array containing the labels for each flag.

style

GUIStyle

options

GUILayoutOption[]
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the 
style
.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Type

Description

intThe value modified by the user.

Remarks

MaskField (MaskField)
Simple window that shows the mask field.

Examples

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);        // Display the flags in disabled toggles        GUI.enabled = false;        for (var i = 0; i < options.Length; i++)        {            var value = (flags & (1 << i)) != 0;            EditorGUILayout.Toggle(options[i], value);        }        GUI.enabled = true;    }}

MaskField(GUIContent, int, string[], GUILayoutOption[])

Make a field for masks.
public static int MaskField(GUIContent label, int mask, string[] displayedOptions, params GUILayoutOption[] options)

Parameters

label

GUIContent
Prefix label of the field.

mask

int
The current mask to display.

displayedOptions

string[]
A string array containing the labels for each flag.

options

GUILayoutOption[]
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the 
style
.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Type

Description

intThe value modified by the user.

Remarks

MaskField (MaskField)
Simple window that shows the mask field.

Examples

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);        // Display the flags in disabled toggles        GUI.enabled = false;        for (var i = 0; i < options.Length; i++)        {            var value = (flags & (1 << i)) != 0;            EditorGUILayout.Toggle(options[i], value);        }        GUI.enabled = true;    }}

MaskField(string, int, string[], GUILayoutOption[])

Make a field for masks.
public static int MaskField(string label, int mask, string[] displayedOptions, params GUILayoutOption[] options)

Parameters

label

string
Prefix label of the field.

mask

int
The current mask to display.

displayedOptions

string[]
A string array containing the labels for each flag.

options

GUILayoutOption[]
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the 
style
.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Type

Description

intThe value modified by the user.

Remarks

MaskField (MaskField)
Simple window that shows the mask field.

Examples

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);        // Display the flags in disabled toggles        GUI.enabled = false;        for (var i = 0; i < options.Length; i++)        {            var value = (flags & (1 << i)) != 0;            EditorGUILayout.Toggle(options[i], value);        }        GUI.enabled = true;    }}

MaskField(int, string[], GUIStyle, GUILayoutOption[])

Make a field for masks.
public static int MaskField(int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options)

Parameters

mask

int
The current mask to display.

displayedOptions

string[]
A string array containing the labels for each flag.

style

GUIStyle

options

GUILayoutOption[]
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the 
style
.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Type

Description

intThe value modified by the user.

Remarks

MaskField (MaskField)
Simple window that shows the mask field.

Examples

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);        // Display the flags in disabled toggles        GUI.enabled = false;        for (var i = 0; i < options.Length; i++)        {            var value = (flags & (1 << i)) != 0;            EditorGUILayout.Toggle(options[i], value);        }        GUI.enabled = true;    }}

MaskField(int, string[], GUILayoutOption[])

Make a field for masks.
public static int MaskField(int mask, string[] displayedOptions, params GUILayoutOption[] options)

Parameters

mask

int
The current mask to display.

displayedOptions

string[]
A string array containing the labels for each flag.

options

GUILayoutOption[]
An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the 
style
.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Type

Description

intThe value modified by the user.

Remarks

MaskField (MaskField)
Simple window that shows the mask field.

Examples

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);        // Display the flags in disabled toggles        GUI.enabled = false;        for (var i = 0; i < options.Length; i++)        {            var value = (flags & (1 << i)) != 0;            EditorGUILayout.Toggle(options[i], value);        }        GUI.enabled = true;    }}