IIntroTutorials

Inheritance Hierarchy

IModuleInterface

IIntroTutorials

Syntax

class IIntroTutorials : public IModuleInterface

Remarks

The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin.

Functions

Name Description

Public function

void

 

CloseAllTutorialContent()

Close all tutorial content, including the browser.

Public function

TSharedPtr < ...

 

CreateTutorialsLoadingWidget

(
    TWeakPtr < SWindow > InContextWindow
)

Create a widget that shows a "loading" visual while waiting for tutorials to load.

Public function

TSharedRef < ...

 

CreateTutorialsWidget

(
    FName InContext,
    TWeakPtr < SWindow > InContextWindow
)

Create a widget that allows access to the tutorial for the current context.

Public function Static

IIntroTutori ...

 

Get()

Singleton-like access to this module's interface.

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function

void

 

LaunchTutorial

(
    const FString & TutorialAssetName,
    TSharedPtr < SWindow > InNavigationW...
)

Launch a tutorial with the specified asset.

Public function

void

 

LaunchTutorial

(
    UEditorTutorial * Tutorial,
    IIntroTutorials::ETutorialStartType ...,
    TWeakPtr < SWindow > InNavigationWin...,
    FSimpleDelegate OnTutorialClosed,
    FSimpleDelegate OnTutorialExited
)

Launch a tutorial immediately, bypassing the tutorial browser.

Enums

Name

Description

Public enum

ETutorialStartType

Parameter for LaunchTutorial function.

References

Module

IntroTutorials

Header

Editor/IntroTutorials/Public/IIntroTutorials.h