You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
304d700746
Tutorial contexts for IOS/Android/Whatever are now hooked up (console setup ones are still missing). Analytics added for tutorial usage in various places. Added ability to reset tutorial state with -ResetTutorials command-line flag. Cleaned up some unused code (still a lot more to come here!). [CL 2302314 by Thomas Sarkanen in Main branch]
117 lines
4.3 KiB
C++
117 lines
4.3 KiB
C++
// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
/** Query delegate to see if we are in picking mode */
|
|
DECLARE_DELEGATE_RetVal_OneParam(bool, FOnIsPicking, FName& /* OutWidgetNameToHighlight */);
|
|
|
|
class UEditorTutorial;
|
|
struct FTutorialContent;
|
|
class STutorialRoot;
|
|
|
|
class FIntroTutorials : public IIntroTutorials
|
|
{
|
|
public:
|
|
// ctor
|
|
FIntroTutorials();
|
|
|
|
/** Get the delegate used to check for whether we are picking widgets */
|
|
FOnIsPicking& OnIsPicking();
|
|
|
|
void GoToPreviousStage();
|
|
|
|
void GoToNextStage(TWeakPtr<SWindow> InNavigationWindow);
|
|
|
|
float GetIntroCurveValue(float InTime);
|
|
|
|
void SummonTutorialBrowser(TSharedRef<SWindow> InWindow, const FString& InFilter = TEXT(""));
|
|
|
|
static FString AnalyticsEventNameFromTutorial(const FString& BaseEventName, UEditorTutorial* Tutorial);
|
|
|
|
private:
|
|
|
|
/** IModuleInterface implementation */
|
|
virtual void StartupModule() override;
|
|
virtual void ShutdownModule() override;
|
|
|
|
/** Add the menu extension for summoning the tutorial */
|
|
void AddSummonTutorialsMenuExtension(FMenuBuilder& MenuBuilder);
|
|
|
|
/** Add a menu extender to summon context-sensitive Blueprints page */
|
|
TSharedRef<FExtender> AddSummonBlueprintTutorialsMenuExtender(const TSharedRef<FUICommandList> CommandList, const TArray<UObject*> EditingObjects) const;
|
|
|
|
/** Add a menu entry to summon context-sensitive Blueprints page */
|
|
void AddSummonBlueprintTutorialsMenuExtension(FMenuBuilder& MenuBuilder, UObject* PrimaryObject);
|
|
|
|
/** Event to be called when the main frame is loaded */
|
|
void MainFrameLoad(TSharedPtr<SWindow> InRootWindow, bool bIsNewProjectWindow);
|
|
|
|
/** Summon tutorial home page to front */
|
|
void SummonTutorialHome();
|
|
|
|
/** Summon blueprint tutorial home page to front */
|
|
void SummonBlueprintTutorialHome(UObject* Asset, bool bForceWelcome);
|
|
|
|
/** Event to be called when Tutorial window is closed. */
|
|
void OnTutorialWindowClosed(const TSharedRef<SWindow>& Window);
|
|
|
|
/** Called when tutorial is dismissed, either when finished or aborted. */
|
|
void OnTutorialDismissed() const;
|
|
|
|
/** Event to be called when any asset editor is opened */
|
|
void OnAssetEditorOpened(UObject* Asset);
|
|
|
|
/** Events to call when editor changes state in various ways */
|
|
void OnAddCodeToProjectDialogOpened();
|
|
void OnNewProjectDialogOpened();
|
|
|
|
/** Events to call when opening the compiler fails */
|
|
void HandleCompilerNotFound();
|
|
|
|
/** Events to call when SDK isn't installed */
|
|
void HandleSDKNotInstalled(const FString& PlatformName, const FString& InTutorialAsset);
|
|
|
|
bool MaybeOpenWelcomeTutorial();
|
|
void ResetWelcomeTutorials() const;
|
|
|
|
/** Delegate for home button visibility */
|
|
EVisibility GetHomeButtonVisibility() const;
|
|
|
|
/** Internal helper to launch a tutorial from a path */
|
|
void LaunchTutorial(const FString& InAssetPath, bool bRestart = true, TWeakPtr<SWindow> InNavigationWindow = nullptr, FSimpleDelegate OnTutorialClosed = FSimpleDelegate(), FSimpleDelegate OnTutorialExited = FSimpleDelegate());
|
|
|
|
public:
|
|
|
|
// IIntroTutorials interface
|
|
virtual void LaunchTutorial(UEditorTutorial* Tutorial, bool bRestart = true, TWeakPtr<SWindow> InNavigationWindow = nullptr, FSimpleDelegate OnTutorialClosed = FSimpleDelegate(), FSimpleDelegate OnTutorialExited = FSimpleDelegate()) override;
|
|
virtual void CloseAllTutorialContent() override;
|
|
virtual TSharedRef<SWidget> CreateTutorialsWidget(FName InContext, TWeakPtr<SWindow> InContextWindow) const override;
|
|
// End of IIntroTutorials interface
|
|
private:
|
|
/** The tab id of the tutorial tab */
|
|
static const FName IntroTutorialTabName;
|
|
|
|
/** The extender to pass to the level editor to extend it's window menu */
|
|
TSharedPtr<FExtender> MainMenuExtender;
|
|
|
|
/** The extender to pass to the blueprint editor to extend it's window menu */
|
|
TSharedPtr<FExtender> BlueprintEditorExtender;
|
|
|
|
/** Whether tutorials are disabled altogether */
|
|
bool bDisableTutorials;
|
|
|
|
/** The current object we are using as a basis for displaying a tutorial */
|
|
UClass* CurrentObjectClass;
|
|
|
|
/** should we be clearing the 'have seen this tutorial' flag? (controlled by -tutorials on the command line) */
|
|
bool bDesireResettingTutorialSeenFlagOnLoad;
|
|
|
|
/** Delegate used to determine whether we are in picking mode */
|
|
FOnIsPicking OnIsPickingDelegate;
|
|
|
|
/** Root widget for tutorial overlay system */
|
|
TSharedPtr<STutorialRoot> TutorialRoot;
|
|
|
|
/** Curve asset for intros */
|
|
UCurveFloat* ContentIntroCurve;
|
|
}; |