ReplaySubsystem.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Subsystems/GameInstanceSubsystem.h"
#include "Interfaces/IAnalyticsProvider.h"
#include "ReplaySubsystem.generated.h"
 
class UReplayNetConnection;
 
namespace UE::ReplaySubsystem
{
    enum class EStopReplayFlags : uint32
    {
        None = 0x0,
        Flush = 0x1,
    };
 
    ENUM_CLASS_FLAGS(EStopReplayFlags);
};
 
UCLASS(DisplayName = "Replay Subsystem", MinimalAPI)
class UReplaySubsystem : public UGameInstanceSubsystem
{
    GENERATED_BODY()
 
public:
    /* UGameInstanceSubsystem */
    ENGINE_API virtual void Initialize(FSubsystemCollectionBase& Collection) override;
    ENGINE_API virtual void Deinitialize() override;
 
    ENGINE_API void RecordReplay(const FString& Name, const FString& FriendlyName, const TArray<FString>& AdditionalOptions, TSharedPtr<IAnalyticsProvider> AnalyticsProvider);
 
    ENGINE_API bool PlayReplay(const FString& Name, UWorld* WorldOverride, const TArray<FString>& AdditionalOptions);
 
    ENGINE_API void StopReplay();
 
    UFUNCTION(BlueprintCallable, Category=Replay)
    ENGINE_API FString GetActiveReplayName() const;
 
    UFUNCTION(BlueprintCallable, Category = Replay)
    ENGINE_API float GetReplayTotalTime() const;
 
    UFUNCTION(BlueprintCallable, Category=Replay)
    ENGINE_API float GetReplayCurrentTime() const;
 
    ENGINE_API void AddUserToReplay(const FString& UserString);
 
    UFUNCTION(BlueprintCallable, Category=Replay)
    ENGINE_API bool IsRecording() const;
    
    UFUNCTION(BlueprintCallable, Category=Replay)
    ENGINE_API bool IsPlaying() const;
    
    ENGINE_API bool IsSavingCheckpoint() const;
 
    ENGINE_API virtual bool IsReplayDeferred(const FString& ReplayName) const;
 
    ENGINE_API void AddEvent(const FString& Group, const FString& Meta, const TArray<uint8>& Data);
 
    ENGINE_API void AddOrUpdateEvent(const FString& EventName, const FString& Group, const FString& Meta, const TArray<uint8>& Data);
 
    ENGINE_API void SetCheckpointSaveMaxMSPerFrame(const float InCheckpointSaveMaxMSPerFrame);
 
    UFUNCTION(BlueprintCallable, Category=Replay)
    ENGINE_API void RequestCheckpoint();
 
    ENGINE_API void SetExternalDataForObject(UObject* OwningObject, const uint8* Src, const int32 NumBits);
 
    UPROPERTY(EditAnywhere, Category=Replay)
    bool bLoadDefaultMapOnStop = true;
 
private:
    void StopExistingReplays(UWorld* InWorld, UE::ReplaySubsystem::EStopReplayFlags Flags = UE::ReplaySubsystem::EStopReplayFlags::None);
 
    void OnSeamlessTravelStart(UWorld* CurrentWorld, const FString& LevelName);
    void OnSeamlessLevelTransition(UWorld* CurrentWorld);
    void OnCopyWorldData(UWorld* CurrentWorld, UWorld* LoadedWorld);
 
    TWeakObjectPtr<UReplayNetConnection> ReplayConnection;
};