Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

EditorGUI.MaskField

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function MaskField(position: Rect, label: GUIContent, mask: int, displayedOptions: string[], style: GUIStyle = EditorStyles.popup): int;
public static int MaskField(Rect position, GUIContent label, int mask, string[] displayedOptions, GUIStyle style = EditorStyles.popup);
public static function MaskField(position: Rect, label: string, mask: int, displayedOptions: string[], style: GUIStyle = EditorStyles.popup): int;
public static int MaskField(Rect position, string label, int mask, string[] displayedOptions, GUIStyle style = EditorStyles.popup);
public static function MaskField(position: Rect, mask: int, displayedOptions: string[], style: GUIStyle = EditorStyles.popup): int;
public static int MaskField(Rect position, int mask, string[] displayedOptions, GUIStyle style = EditorStyles.popup);

Parameters

position Rectangle on the screen to use for this control.
label Label for the field.
mask The current mask to display.
displayedOption A string array containing the labels for each flag.
style Optional GUIStyle.
displayedOptions A string array containing the labels for each flag.

Returns

int The value modified by the user.

Description

Make a field for masks.


Simple window that shows the mask field.

class SimpleMaskUsage extends EditorWindow {
    @MenuItem("Examples/Mask Field Usage")
    static function Init() {
        var window = GetWindow(SimpleMaskUsage);
        window.Show();
    }

var flags : int = 0; var options : String[] = ["CanJump", "CanShoot", "CanSwim"]; function OnGUI() { flags = EditorGUI.MaskField (new Rect (0, 0, 300, 20), "Player Flags", flags, options, false); } }