Language: English
  • C#
  • JS
  • Boo

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

Sumbission failed

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

Close

Cancel

static function MaskField(label: GUIContent, mask: int, displayedOptions: string[], style: GUIStyle, params options: GUILayoutOption[]): int;
static int MaskField(GUIContent label, int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
static def MaskField(label as GUIContent, mask as int, displayedOptions as string[], style as GUIStyle, *options as GUILayoutOption[]) as int
static function MaskField(label: string, mask: int, displayedOptions: string[], style: GUIStyle, params options: GUILayoutOption[]): int;
static int MaskField(string label, int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
static def MaskField(label as string, mask as int, displayedOptions as string[], style as GUIStyle, *options as GUILayoutOption[]) as int
static function MaskField(label: GUIContent, mask: int, displayedOptions: string[], params options: GUILayoutOption[]): int;
static int MaskField(GUIContent label, int mask, string[] displayedOptions, params GUILayoutOption[] options);
static def MaskField(label as GUIContent, mask as int, displayedOptions as string[], *options as GUILayoutOption[]) as int
static function MaskField(label: string, mask: int, displayedOptions: string[], params options: GUILayoutOption[]): int;
static int MaskField(string label, int mask, string[] displayedOptions, params GUILayoutOption[] options);
static def MaskField(label as string, mask as int, displayedOptions as string[], *options as GUILayoutOption[]) as int
static function MaskField(mask: int, displayedOptions: string[], style: GUIStyle, params options: GUILayoutOption[]): int;
static int MaskField(int mask, string[] displayedOptions, GUIStyle style, params GUILayoutOption[] options);
static def MaskField(mask as int, displayedOptions as string[], style as GUIStyle, *options as GUILayoutOption[]) as int
static function MaskField(mask: int, displayedOptions: string[], params options: GUILayoutOption[]): int;
static int MaskField(int mask, string[] displayedOptions, params GUILayoutOption[] options);
static def MaskField(mask as int, displayedOptions as string[], *options as GUILayoutOption[]) as int

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.

	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 = EditorGUILayout.MaskField ("Player Flags", flags, options);
		}
	}