Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

EditorGUI.MaskField

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

Parameters

positionRectangle on the screen to use for this control.
labelLabel for the field.
maskThe current mask to display.
displayedOptionA string array containing the labels for each flag.
styleOptional GUIStyle.
displayedOptionsA 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);
		}
	}