Class MARSUtils
Namespace: Unity.MARS
Syntax
public static class MARSUtilsProperties
SimulatingDiscovery
Whether MARS is currently simulating the discovery of data over time
Declaration
public static bool SimulatingDiscovery { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
CustomAddTabToHere(Object)
Declaration
public static EditorWindow CustomAddTabToHere(object userData)Parameters
| Type | Name | Description |
|---|---|---|
| Object | userData |
Returns
| Type | Description |
|---|---|
| EditorWindow |
HintBox(Boolean, String, String)
Draw a hint box with a close button/action
Declaration
public static bool HintBox(bool shouldShowHint, string hintMessage, string analyticsLabel)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | shouldShowHint | Whether the hint box should currently be displayed |
| String | hintMessage | The primary message to show in the hint box |
| String | analyticsLabel | Label for this hint to be identified in analytics events |
Returns
| Type | Description |
|---|---|
| Boolean | True, unless the user presses the 'close' button |
HintBox(Boolean, String, String, GUIContent, String, GUIContent, Action)
Draw a hint box, with a 'learn more' button and URL, and a close button/action
Declaration
public static bool HintBox(bool shouldShowHint, string hintMessage, string analyticsLabel, GUIContent learnMoreButton, string learnMoreURL, GUIContent stopShowingHintButton, Action stopShowingHintAction = null)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | shouldShowHint | Whether the hint box should currently be displayed |
| String | hintMessage | The primary message to show in the hint box |
| String | analyticsLabel | Label for this hint to be identified in analytics events |
| GUIContent | learnMoreButton | GUIContent of the 'learn more' button |
| String | learnMoreURL | URL to open when the user clicks the 'learn more' button |
| GUIContent | stopShowingHintButton | GUIContent of the 'close' button |
| Action | stopShowingHintAction | Action to call when the user presses the 'close' button |
Returns
| Type | Description |
|---|---|
| Boolean | True, unless the user presses the 'close' button |
NoActiveSessionHintBox(Boolean, String, MessageType)
Draw a hint box with a button to add a MARS Session
Declaration
public static bool NoActiveSessionHintBox(bool shouldShowHint, string hintMessage, MessageType messageType)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | shouldShowHint | Whether the hint box should currently be displayed |
| String | hintMessage | The primary message to show in the hint box |
| MessageType | messageType | What type of message box to show (info / warning) |
Returns
| Type | Description |
|---|---|
| Boolean | True, unless the user presses the 'close' button |