File size: 3,589 Bytes
7fd553e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | // Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "Components/GameStateComponent.h"
#include "LoadingProcessInterface.h"
#include "LyraExperienceManagerComponent.generated.h"
#define UE_API LYRAGAME_API
namespace UE::GameFeatures { struct FResult; }
class ULyraExperienceDefinition;
DECLARE_MULTICAST_DELEGATE_OneParam(FOnLyraExperienceLoaded, const ULyraExperienceDefinition* /*Experience*/);
enum class ELyraExperienceLoadState
{
Unloaded,
Loading,
LoadingGameFeatures,
LoadingChaosTestingDelay,
ExecutingActions,
Loaded,
Deactivating
};
UCLASS(MinimalAPI)
class ULyraExperienceManagerComponent final : public UGameStateComponent, public ILoadingProcessInterface
{
GENERATED_BODY()
public:
UE_API ULyraExperienceManagerComponent(const FObjectInitializer& ObjectInitializer = FObjectInitializer::Get());
//~UActorComponent interface
UE_API virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
//~End of UActorComponent interface
//~ILoadingProcessInterface interface
UE_API virtual bool ShouldShowLoadingScreen(FString& OutReason) const override;
//~End of ILoadingProcessInterface
// Tries to set the current experience, either a UI or gameplay one
UE_API void SetCurrentExperience(FPrimaryAssetId ExperienceId);
// Ensures the delegate is called once the experience has been loaded,
// before others are called.
// However, if the experience has already loaded, calls the delegate immediately.
UE_API void CallOrRegister_OnExperienceLoaded_HighPriority(FOnLyraExperienceLoaded::FDelegate&& Delegate);
// Ensures the delegate is called once the experience has been loaded
// If the experience has already loaded, calls the delegate immediately
UE_API void CallOrRegister_OnExperienceLoaded(FOnLyraExperienceLoaded::FDelegate&& Delegate);
// Ensures the delegate is called once the experience has been loaded
// If the experience has already loaded, calls the delegate immediately
UE_API void CallOrRegister_OnExperienceLoaded_LowPriority(FOnLyraExperienceLoaded::FDelegate&& Delegate);
// This returns the current experience if it is fully loaded, asserting otherwise
// (i.e., if you called it too soon)
UE_API const ULyraExperienceDefinition* GetCurrentExperienceChecked() const;
// Returns true if the experience is fully loaded
UE_API bool IsExperienceLoaded() const;
private:
UFUNCTION()
void OnRep_CurrentExperience();
void StartExperienceLoad();
void OnExperienceLoadComplete();
void OnGameFeaturePluginLoadComplete(const UE::GameFeatures::FResult& Result);
void OnExperienceFullLoadCompleted();
void OnActionDeactivationCompleted();
void OnAllActionsDeactivated();
private:
UPROPERTY(ReplicatedUsing=OnRep_CurrentExperience)
TObjectPtr<const ULyraExperienceDefinition> CurrentExperience;
ELyraExperienceLoadState LoadState = ELyraExperienceLoadState::Unloaded;
int32 NumGameFeaturePluginsLoading = 0;
TArray<FString> GameFeaturePluginURLs;
int32 NumObservedPausers = 0;
int32 NumExpectedPausers = 0;
/**
* Delegate called when the experience has finished loading just before others
* (e.g., subsystems that set up for regular gameplay)
*/
FOnLyraExperienceLoaded OnExperienceLoaded_HighPriority;
/** Delegate called when the experience has finished loading */
FOnLyraExperienceLoaded OnExperienceLoaded;
/** Delegate called when the experience has finished loading */
FOnLyraExperienceLoaded OnExperienceLoaded_LowPriority;
};
#undef UE_API
|