docs.unity3d.com
    Show / Hide Table of Contents

    Class TutorialModalWindow

    A modal/utility window that can display TutorialWelcomePage as its content. Optionally utilizes masking for modality.

    Inheritance
    Object
    Object
    ScriptableObject
    EditorWindow
    TutorialModalWindow
    Inherited Members
    EditorWindow.BeginWindows()
    EditorWindow.EndWindows()
    EditorWindow.ShowNotification(GUIContent)
    EditorWindow.ShowNotification(GUIContent, Double)
    EditorWindow.RemoveNotification()
    UnityEditor.EditorWindow.ShowTab()
    EditorWindow.Focus()
    EditorWindow.ShowUtility()
    EditorWindow.ShowPopup()
    EditorWindow.ShowModalUtility()
    EditorWindow.ShowAsDropDown(Rect, Vector2)
    EditorWindow.Show()
    EditorWindow.Show(Boolean)
    EditorWindow.ShowAuxWindow()
    EditorWindow.ShowModal()
    EditorWindow.GetWindow(Type, Boolean, String, Boolean)
    EditorWindow.GetWindow(Type, Boolean, String)
    EditorWindow.GetWindow(Type, Boolean)
    EditorWindow.GetWindow(Type)
    EditorWindow.GetWindowWithRect(Type, Rect, Boolean, String)
    EditorWindow.GetWindowWithRect(Type, Rect, Boolean)
    EditorWindow.GetWindowWithRect(Type, Rect)
    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>()
    EditorWindow.FocusWindowIfItsOpen(Type)
    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)
    EditorWindow.Close()
    EditorWindow.Repaint()
    EditorWindow.SendEvent(Event)
    EditorWindow.GetExtraPaneTypes()
    EditorWindow.rootVisualElement
    EditorWindow.wantsMouseMove
    EditorWindow.wantsMouseEnterLeaveWindow
    EditorWindow.autoRepaintOnSceneChange
    EditorWindow.maximized
    EditorWindow.focusedWindow
    EditorWindow.mouseOverWindow
    EditorWindow.minSize
    EditorWindow.maxSize
    EditorWindow.title
    EditorWindow.titleContent
    UnityEditor.EditorWindow.depthBufferBits
    UnityEditor.EditorWindow.antiAlias
    EditorWindow.position
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(String)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Tutorials.Core.Editor
    Syntax
    public class TutorialModalWindow : EditorWindow

    Properties

    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
    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

    Extension Methods

    EditorWindowUtils.DockWindow(EditorWindow, EditorWindow, EditorWindowUtils.DockPosition)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023