unreal.EditorTutorial
¶
- class unreal.EditorTutorial(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
Object
An asset used to build a stage-by-stage tutorial in the editor
C++ Source:
Plugin: GuidedTutorials
Module: IntroTutorials
File: EditorTutorial.h
Editor Properties: (see get_editor_property/set_editor_property)
asset_to_use
(SoftObjectPath): [Read-Write] Asset to open & attach the tutorial to. Non-widget-bound content will appear in the asset’s windowcategory
(str): [Read-Write] Category of this tutorial, used to organize tutorials when presented to the userhide_in_browser
(bool): [Read-Write] Hide this tutorial in the tutorials browsericon
(str): [Read-Write] Icon name for this tutorial, used when presented to the user in the tutorial browser. This is a name for the icon in the Slate editor style. Only used if there isn’t a valid texture to use.is_standalone
(bool): [Read-Write] A standalone tutorial displays no navigation buttons and each content widget has a close buttonnext_tutorial
(SoftClassPath): [Read-Write] Tutorial to optionally chain onto after this tutorial completesprevious_tutorial
(SoftClassPath): [Read-Write] Tutorial to optionally chain back to if the “back” button is clicked on the first stagesearch_tags
(Text): [Read-Write] Comma seperated list of tags the search will use to help find this tutorialsort_order
(int32): [Read-Write] Sorting priority, used by the tutorial browserstages
(Array[TutorialStage]): [Read-Write] The various stages of this tutorialsummary_content
(TutorialContent): [Read-Write] Content to be displayed for this tutorial when presented to the user in summarytexture
(Texture2D): [Read-Write] Texture for this tutorial, used when presented to the user in the tutorial browser.title
(Text): [Read-Write] Title of this tutorial, used when presented to the user
- classmethod begin_tutorial(tutorial_to_start, restart) None ¶
Begin a tutorial. Note that this will end the current tutorial that is in progress, if any
- Parameters:
tutorial_to_start (EditorTutorial) –
restart (bool) –
- get_actor_reference(path_to_actor) Actor ¶
Attempts to find the actor specified by PathToActor in the current editor world
- classmethod get_engine_folder_visibilty() bool ¶
Returns the visibility of the engine folder in the content browser
- Return type:
- on_tutorial_stage_ended(stage_name) None ¶
Event fired when a tutorial stage ends
- Parameters:
stage_name (Name) –
- on_tutorial_stage_started(stage_name) None ¶
Event fired when a tutorial stage begins
- Parameters:
stage_name (Name) –
- classmethod open_asset(asset) None ¶
Open an asset for use by a tutorial
- Parameters:
asset (Object) – The asset to open