Class TutorialWindowUtils
Wrapper class for TutorialWindow public APIs
Inherited Members
Namespace: Unity.Tutorials.Core.Editor
Syntax
public static class TutorialWindowUtilsProperties
CurrentTutorial
The currently active tutorial, if any.
Declaration
public static Tutorial CurrentTutorial { get; }Property Value
| Type | Description |
|---|---|
| Tutorial |
IsLoadingLayout
Are we currently loading a window layout.
Declaration
public static bool IsLoadingLayout { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Remarks
A window layout load typically happens when the project is started for the first time and the project's startup settings specify a window layout for the project, or when entering or exiting a tutorial with a window layout specified.
IsTransitioningBetweenTutorials
Are we currently (during this frame) transitioning from one tutorial to another?
Declaration
public static bool IsTransitioningBetweenTutorials { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Remarks
This transition typically happens when using a Switch Tutorial button on a tutorial page.
Methods
ClearLocalizationCache()
Clear localization table cache
Declaration
public static void ClearLocalizationCache()StartTutorial(Tutorial)
Starts a tutorial.
Declaration
public static void StartTutorial(Tutorial tutorial)Parameters
| Type | Name | Description |
|---|---|---|
| Tutorial | tutorial | The tutorial to be started. |
Remarks
The caller of the funtion is responsible for positioning the TutorialWindow for the tutorials. If no TutorialWindow is visible, it is created and shown as a free-floating window. If the currently active scene has unsaved changes, the user is asked to save them. If we are in Play Mode, it is exited. Note that currently there is no explicit way to quit a tutorial. Instead, a tutorial should be quit either by user interaction or by closing the TutorialWindow programmatically.