Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UEditorTutorial

An asset used to build a stage-by-stage tutorial in the editor

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEditorTutorial

References

Module	IntroTutorials
Header	/Engine/Source/Editor/IntroTutorials/Public/EditorTutorial.h
Include	#include "EditorTutorial.h"

Syntax

class UEditorTutorial : public UObject

Remarks

An asset used to build a stage-by-stage tutorial in the editor

Variables

	Name	Description
FSoftObjectPath	AssetToUse	Asset to open & attach the tutorial to. Non-widget-bound content will appear in the asset's window
bool	bHideInBrowser	Hide this tutorial in the tutorials browser
bool	bIsStandalone	A standalone tutorial displays no navigation buttons and each content widget has a close button
FString	Category	Category of this tutorial, used to organize tutorials when presented to the user
FString	Icon	Icon name for this tutorial, used when presented to the user in the tutorial browser.
FString	ImportPath	The path this tutorial was imported from, if any.
FSoftClassPath	NextTutorial	Tutorial to optionally chain onto after this tutorial completes
FSoftClassPath	PreviousTutorial	Tutorial to optionally chain back to if the "back" button is clicked on the first stage
FText	SearchTags	Comma seperated list of tags the search will use to help find this tutorial
int32	SortOrder	Sorting priority, used by the tutorial browser
TArray< FTutori...	Stages	The various stages of this tutorial
FTutorialConten...	SummaryContent	Content to be displayed for this tutorial when presented to the user in summary
UTexture2D *...	Texture	Texture for this tutorial, used when presented to the user in the tutorial browser.
FText	Title	Title of this tutorial, used when presented to the user

Constructors

	Name	Description
	UEditorTutorial ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	BeginTutorial ( UEditorTutorial* TutorialToSta..., bool bRestart )	Begin a tutorial. Note that this will end the current tutorial that is in progress, if any
AActor *	GetActorReference ( FString PathToActor )	Attempts to find the actor specified by PathToActor in the current editor world
bool	GetEngineFolderVisibilty()	Returns the visibility of the engine folder in the content browser
UWorld *	GetWorld()	UObject implementation
void	GoToNextTutorialStage()	Advance to the next stage of a tutorial
void	GoToPreviousTutorialStage()	Advance to the previous stage of a tutorial
void	HandleTickCurrentStage ( FName StageName )	Called each tick so the Blueprint can optionally complete or skip stages
void	HandleTutorialClosed()	Called when a tutorial is closed
void	HandleTutorialLaunched()	Called when a tutorial is launched
void	HandleTutorialStageEnded ( FName StageName )	Called when a tutorial stage ends
void	HandleTutorialStageStarted ( FName StageName )	Called when a tutorial stage is started
void	OnTutorialClosed()	Event fired when a tutorial is closed
void	OnTutorialLaunched()	Event fired when a tutorial is launched
void	OnTutorialStageEnded ( FName StageName )	Event fired when a tutorial stage ends
void	OnTutorialStageStarted ( FName StageName )	Event fired when a tutorial stage begins
void	OpenAsset ( UObject* Asset )	Open an asset for use by a tutorial
void	SetEngineFolderVisibilty ( bool bNewVisibility )	Sets the visibility of the engine folder in the content browser

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss