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

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Blueprintable, HideCategories&61;&40;Object&41;, EditInlineNew&41;  
class UEditorTutorial : public UObject

Remarks

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

Variables

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

Constructors

  Type Name Description
Public function  

UEditorTutorial ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Static UFunction BlueprintCallable, Category void

BeginTutorial ( UEditorTutorial* TutorialToStart,
bool bRestart
)

 Begin a tutorial. Note that this will end the current tutorial that is in progress, if any
Public function UFunction BlueprintPure, Category AActor *

GetActorReference ( FString PathToActor
)

 Attempts to find the actor specified by PathToActor in the current editor world
Protected function Static UFunction BlueprintCallable, Category bool Returns the visibility of the engine folder in the content browser
Public function Virtual Const UWorld * UObject implementation
Protected function Static UFunction BlueprintCallable, Category void Advance to the next stage of a tutorial
Protected function Static UFunction BlueprintCallable, Category void Advance to the previous stage of a tutorial
Public function void Called each tick so the Blueprint can optionally complete or skip stages
Public function void Called when a tutorial is closed
Public function void Called when a tutorial is launched
Public function void Called when a tutorial stage ends
Public function void Called when a tutorial stage is started
Protected function UFunction Category, BlueprintImplementableEvent void Event fired when a tutorial is closed
Protected function UFunction Category, BlueprintImplementableEvent void Event fired when a tutorial is launched
Protected function UFunction Category, BlueprintImplementableEvent void

OnTutorialStageEnded ( FName StageName
)

 Event fired when a tutorial stage ends
Protected function UFunction Category, BlueprintImplementableEvent void Event fired when a tutorial stage begins
Protected function Static UFunction BlueprintCallable, Category void

OpenAsset ( UObject* Asset
)

 Open an asset for use by a tutorial
Protected function Static UFunction BlueprintCallable, Category void

SetEngineFolderVisibilty ( bool bNewVisibility
)

 Sets the visibility of the engine folder in the content browser

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page