MaskField
Makes a field for masks.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
MaskField(Rect, GUIContent, int, string[], GUIStyle)
Makes a field for masks.
public static int MaskField(Rect position, GUIContent label, int mask, string[] displayedOptions, GUIStyle style)
Parameters
Returns
Type | Description |
|---|---|
| int | The value modified by the user. |
Remarks
Note: The mask values for the flags associated with each option in the menu will be consecutive powers of 2 starting with 1, i.e. 1, 2, 4, 8, 16, and so on.
Simple window that shows the mask field.
Examples
using UnityEngine;using UnityEditor;class SimpleMaskUsage : EditorWindow{ int flags = 0; string[] options = { "CanJump", "CanShoot", "CanSwim" }; [MenuItem("Examples/Mask Field Usage")] static void Init() { var window = GetWindow<SimpleMaskUsage>(); window.Show(); } void OnGUI() { flags = EditorGUI.MaskField(new Rect(0, 0, 300, 20), "Player Flags", flags, options); }}
MaskField(Rect, string, int, string[], GUIStyle)
Makes a field for masks.
public static int MaskField(Rect position, string label, int mask, string[] displayedOptions, GUIStyle style)
Parameters
Returns
Type | Description |
|---|---|
| int | The value modified by the user. |
Remarks
Note: The mask values for the flags associated with each option in the menu will be consecutive powers of 2 starting with 1, i.e. 1, 2, 4, 8, 16, and so on.
Simple window that shows the mask field.
Examples
using UnityEngine;using UnityEditor;class SimpleMaskUsage : EditorWindow{ int flags = 0; string[] options = { "CanJump", "CanShoot", "CanSwim" }; [MenuItem("Examples/Mask Field Usage")] static void Init() { var window = GetWindow<SimpleMaskUsage>(); window.Show(); } void OnGUI() { flags = EditorGUI.MaskField(new Rect(0, 0, 300, 20), "Player Flags", flags, options); }}
MaskField(Rect, int, string[], GUIStyle)
Makes a field for masks.
public static int MaskField(Rect position, int mask, string[] displayedOptions, GUIStyle style)
Parameters
Returns
Type | Description |
|---|---|
| int | The value modified by the user. |
Remarks
Note: The mask values for the flags associated with each option in the menu will be consecutive powers of 2 starting with 1, i.e. 1, 2, 4, 8, 16, and so on.
Simple window that shows the mask field.
Examples
using UnityEngine;using UnityEditor;class SimpleMaskUsage : EditorWindow{ int flags = 0; string[] options = { "CanJump", "CanShoot", "CanSwim" }; [MenuItem("Examples/Mask Field Usage")] static void Init() { var window = GetWindow<SimpleMaskUsage>(); window.Show(); } void OnGUI() { flags = EditorGUI.MaskField(new Rect(0, 0, 300, 20), "Player Flags", flags, options); }}