Navigation
API > API/Plugins > API/Plugins/IntroTutorials
The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.
| Name | IIntroTutorials |
| Type | class |
| Header File | /Engine/Plugins/Editor/GuidedTutorials/Source/IntroTutorials/Public/IIntroTutorials.h |
| Include Path | #include "IIntroTutorials.h" |
Syntax
class IIntroTutorials : public IModuleInterface
Implements Interfaces
Enums
Public
| Name | Remarks |
|---|---|
| ETutorialStartType | Parameter for LaunchTutorial function. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CloseAllTutorialContent() |
Close all tutorial content, including the browser. | IIntroTutorials.h | |
TSharedPtr< SWidget > CreateTutorialsLoadingWidget
(
TWeakPtr< SWindow > InContextWindow |
Create a widget that shows a "loading" visual while waiting for tutorials to load. | IIntroTutorials.h | |
TSharedRef< SWidget > CreateTutorialsWidget
(
FName InContext, |
Create a widget that allows access to the tutorial for the current context. | IIntroTutorials.h | |
void LaunchTutorial
(
const FString& TutorialAssetName, |
Launch a tutorial with the specified asset. | IIntroTutorials.h | |
void LaunchTutorial
(
UEditorTutorial* Tutorial, |
Launch a tutorial immediately, bypassing the tutorial browser. | IIntroTutorials.h | |
void RegisterCategory
(
FTutorialCategory NewCategory |
Register a new category with the tutorial browser. | IIntroTutorials.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IIntroTutorials & Get () |
Singleton-like access to this module's interface. | IIntroTutorials.h | |
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | IIntroTutorials.h |