Version: 5.5 (switch to 5.4)
LanguageEnglish
  • C#
  • JS

Script language

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

EditorGUILayout.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(label: GUIContent, mask: int, displayedOptions: string[], style: GUIStyle, params options: GUILayoutOption[]): int;
public static int MaskField(GUIContent label, int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
public static function MaskField(label: string, mask: int, displayedOptions: string[], style: GUIStyle, params options: GUILayoutOption[]): int;
public static int MaskField(string label, int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
public static function MaskField(label: GUIContent, mask: int, displayedOptions: string[], params options: GUILayoutOption[]): int;
public static int MaskField(GUIContent label, int mask, string[] displayedOptions, params GUILayoutOption[] options);
public static function MaskField(label: string, mask: int, displayedOptions: string[], params options: GUILayoutOption[]): int;
public static int MaskField(string label, int mask, string[] displayedOptions, params GUILayoutOption[] options);
public static function MaskField(mask: int, displayedOptions: string[], style: GUIStyle, params options: GUILayoutOption[]): int;
public static int MaskField(int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
public static function MaskField(mask: int, displayedOptions: string[], params options: GUILayoutOption[]): int;
public static int MaskField(int mask, string[] displayedOptions, params GUILayoutOption[] options);

Parameters

label Prefix label of the field.
mask The current mask to display.
displayedOption A string array containing the labels for each flag.
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

int The value modified by the user.

Description

Make a field for masks.


Simple window that shows the mask field.

#pragma strict

class MaskFieldExample extends EditorWindow {

static var flags: int = 0; static var options: String[] = ["CanJump", "CanShoot", "CanSwim"];

@MenuItem("Examples/Mask Field usage") static function Init() { var window = GetWindow(MaskFieldExample); window.Show(); }

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

}
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); } }