Class TutorialModalWindow
A modal/utility window that can display TutorialWelcomePage as its content. Optionally utilizes masking for modality.
Inherited Members
UnityEditor.EditorWindow.ShowTab()
UnityEditor.EditorWindow.GetWindow<T>()
UnityEditor.EditorWindow.GetWindow<T>(System.Boolean)
UnityEditor.EditorWindow.GetWindow<T>(System.Boolean, System.String)
UnityEditor.EditorWindow.GetWindow<T>(System.String)
UnityEditor.EditorWindow.GetWindow<T>(System.String, System.Boolean)
UnityEditor.EditorWindow.GetWindow<T>(System.Boolean, System.String, System.Boolean)
UnityEditor.EditorWindow.GetWindow<T>(System.Type[])
UnityEditor.EditorWindow.GetWindow<T>(System.String, System.Type[])
UnityEditor.EditorWindow.GetWindow<T>(System.String, System.Boolean, System.Type[])
UnityEditor.EditorWindow.CreateWindow<T>(System.Type[])
UnityEditor.EditorWindow.CreateWindow<T>(System.String, System.Type[])
UnityEditor.EditorWindow.HasOpenInstances<T>()
UnityEditor.EditorWindow.FocusWindowIfItsOpen<T>()
UnityEditor.EditorWindow.GetWindowWithRect<T>(UnityEngine.Rect)
UnityEditor.EditorWindow.GetWindowWithRect<T>(UnityEngine.Rect, System.Boolean)
UnityEditor.EditorWindow.GetWindowWithRect<T>(UnityEngine.Rect, System.Boolean, System.String)
UnityEditor.EditorWindow.GetWindowWithRect<T>(UnityEngine.Rect, System.Boolean, System.String, System.Boolean)
UnityEditor.EditorWindow.depthBufferBits
UnityEditor.EditorWindow.antiAlias
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
Namespace: Unity.Tutorials.Core.Editor
Syntax
public class TutorialModalWindow : EditorWindow
Properties
Instance
The current instance of this window
Declaration
public static TutorialModalWindow Instance { get; set; }
Property Value
Type | Description |
---|---|
TutorialModalWindow |
MaskingEnabled
Does the window utilize masking for modality effect.
Declaration
public static bool MaskingEnabled { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Remarks
Remember to set prior to calling TryToShow().
Visible
Is the window currently visible.
Declaration
[Obsolete("Will be removed in v4. Check the status of 'Instance' instead")]
public static bool Visible { get; }
Property Value
Type | Description |
---|---|
Boolean |
WelcomePage
In order to set the welcome page, use the Show() function instead.
Declaration
public TutorialWelcomePage WelcomePage { get; }
Property Value
Type | Description |
---|---|
TutorialWelcomePage |
Methods
Hide()
Closes the window if it's open
Declaration
public static void Hide()
Show(TutorialWelcomePage, Action)
Shows the window using the provided content.
Declaration
public static void Show(TutorialWelcomePage welcomePage, Action onClose = null)
Parameters
Type | Name | Description |
---|---|---|
TutorialWelcomePage | welcomePage | Content to be shown. |
Action | onClose | Optional callback to be called when the window is closed. |
Remarks
Shown as a utility window, https://docs.unity3d.com/ScriptReference/EditorWindow.ShowUtility.html