1. Epic GamesDeveloper
  3. UEditorTutorial

UEditorTutorial

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

API > API/Plugins > API/Plugins/IntroTutorials

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

   
Name UEditorTutorial
Type class
Header File /Engine/Plugins/Editor/GuidedTutorials/Source/IntroTutorials/Public/EditorTutorial.h
Include Path #include "EditorTutorial.h"

Syntax

UCLASS (Blueprintable, HideCategories=(Object), EditInlineNew)  
class UEditorTutorial : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorTutorial ( const FObjectInitializer& ObjectInitializer
)

   EditorTutorial.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetToUse FSoftObjectPath Asset to open & attach the tutorial to. Non-widget-bound content will appear in the asset's window EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
bHideInBrowser bool Hide this tutorial in the tutorials browser EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
bIsStandalone bool A standalone tutorial displays no navigation buttons and each content widget has a close button EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
Category FString Category of this tutorial, used to organize tutorials when presented to the user EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
Icon FString Icon name for this tutorial, used when presented to the user in the tutorial browser. EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
ImportPath FString The path this tutorial was imported from, if any. EditorTutorial.h  
NextTutorial FSoftClassPath Tutorial to optionally chain onto after this tutorial completes EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
  • Meta=(MetaClass="/Script/IntroTutorials.EditorTutorial")
PreviousTutorial FSoftClassPath Tutorial to optionally chain back to if the "back" button is clicked on the first stage EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
  • Meta=(MetaClass="/Script/IntroTutorials.EditorTutorial")
SearchTags FText Comma seperated list of tags the search will use to help find this tutorial EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
  • AssetRegistrySearchable
SortOrder int32 Sorting priority, used by the tutorial browser EditorTutorial.h
  • BlueprintReadOnly
  • EditDefaultsOnly
  • Category="Tutorial"
Stages TArray< FTutorialStage > The various stages of this tutorial EditorTutorial.h
  • EditAnywhere
  • Category="Stages"
SummaryContent FTutorialContent Content to be displayed for this tutorial when presented to the user in summary EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
Texture TObjectPtr< UTexture2D > Texture for this tutorial, used when presented to the user in the tutorial browser. EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
Title FText Title of this tutorial, used when presented to the user EditorTutorial.h
  • EditAnywhere
  • Category="Tutorial"
  • AssetRegistrySearchable

Functions

Public

Name Remarks Include Path Unreal Specifiers

AActor * GetActorReference ( FString PathToActor
)

 Attempts to find the actor specified by PathToActor in the current editor world EditorTutorial.h
  • BlueprintPure
  • Category="Tutorial"

virtual UWorld * GetWorld()

 UObject implementation EditorTutorial.h  

void HandleTickCurrentStage ( FName StageName
)

 Called each tick so the Blueprint can optionally complete or skip stages EditorTutorial.h  

void HandleTutorialClosed()

 Called when a tutorial is closed EditorTutorial.h  

void HandleTutorialLaunched()

 Called when a tutorial is launched EditorTutorial.h  

void HandleTutorialStageEnded ( FName StageName
)

 Called when a tutorial stage ends EditorTutorial.h  

void HandleTutorialStageStarted ( FName StageName
)

 Called when a tutorial stage is started EditorTutorial.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnTutorialClosed()

 Event fired when a tutorial is closed EditorTutorial.h
  • BlueprintImplementableEvent
  • Category="Tutorial"

void OnTutorialLaunched()

 Event fired when a tutorial is launched EditorTutorial.h
  • BlueprintImplementableEvent
  • Category="Tutorial"

void OnTutorialStageEnded ( FName StageName
)

 Event fired when a tutorial stage ends EditorTutorial.h
  • BlueprintImplementableEvent
  • Category="Tutorial"

void OnTutorialStageStarted ( FName StageName
)

 Event fired when a tutorial stage begins EditorTutorial.h
  • BlueprintImplementableEvent
  • Category="Tutorial"

Static

Name Remarks Include Path Unreal Specifiers

static void BeginTutorial ( UEditorTutorial* TutorialToStart,
bool bRestart
)

 Begin a tutorial. Note that this will end the current tutorial that is in progress, if any EditorTutorial.h
  • BlueprintCallable
  • Category="Tutorial"

static bool GetEngineFolderVisibilty()

 Returns the visibility of the engine folder in the content browser EditorTutorial.h
  • BlueprintCallable
  • Category="Tutorial"

static void GoToNextTutorialStage()

 Advance to the next stage of a tutorial EditorTutorial.h
  • BlueprintCallable
  • Category="Tutorial"

static void GoToPreviousTutorialStage()

 Advance to the previous stage of a tutorial EditorTutorial.h
  • BlueprintCallable
  • Category="Tutorial"

static void OpenAsset ( UObject* Asset
)

 Open an asset for use by a tutorial EditorTutorial.h
  • BlueprintCallable
  • Category="Tutorial"

static void SetEngineFolderVisibilty ( bool bNewVisibility
)

 Sets the visibility of the engine folder in the content browser EditorTutorial.h
  • BlueprintCallable
  • Category="Tutorial"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page