1. Epic GamesDeveloper
  3. FReplayHelper

FReplayHelper

API > API/Runtime > API/Runtime/Engine

   
Name FReplayHelper
Type class
Header File /Engine/Source/Runtime/Engine/Public/ReplayHelper.h
Include Path #include "ReplayHelper.h"

Syntax

class FReplayHelper

Constructors

Name Remarks Include Path Unreal Specifiers
  ReplayHelper.h  
Do not copy or move this helper instance ReplayHelper.h  
  ReplayHelper.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FReplayHelper()

   ReplayHelper.h  

Structs

Name Remarks
FCheckpointSaveStateContext Checkpoint state
FCheckpointStepHelper  
FExternalDataWrapper  
FLevelStatus Helps keeps tabs on what levels are Ready, Have Seen data, Level Name, and Index into the main status list.
FNetGuidCacheItem  
FPendingCheckPointActor When we save a checkpoint, we remember all of the actors that need a checkpoint saved out by adding them to this list

Typedefs

Name Type Remarks Include Path
FOnReplayPlaybackError TBaseDelegate_OneParam< void, const UE::Net::TNetResult< EReplayResult > & >   ReplayHelper.h
FOnReplayRecordError TBaseDelegate_OneParam< void, const UE::Net::TNetResult< EReplayResult > & >   ReplayHelper.h

Constants

Name Type Remarks Include Path
MAX_DEMO_READ_WRITE_BUFFER int32   ReplayHelper.h
MAX_DEMO_STRING_SERIALIZATION_SIZE int32   ReplayHelper.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveReplayName FString   ReplayHelper.h  
AllLevelStatuses TArray< FLevelStatus > Tracks all available level statuses. ReplayHelper.h  
AnalyticsProvider TSharedPtr< IAnalyticsProvider >   ReplayHelper.h  
bHasDeltaCheckpoints bool Checkpoints are delta compressed. ReplayHelper.h  
bHasGameSpecificFrameData bool Allow appending per frame game specific data. ReplayHelper.h  
bHasLevelStreamingFixes bool Whether or not the Streaming Level Fixes are enabled for capture or playback. ReplayHelper.h  
bIsLoadingCheckpoint bool   ReplayHelper.h  
bIsWaitingForStream bool   ReplayHelper.h  
bPauseRecording bool If true, will skip recording, but leaves the replay open so that recording can be resumed again. ReplayHelper.h  
bPendingCheckpointRequest bool   ReplayHelper.h  
bRecording bool   ReplayHelper.h  
bRecordMapChanges bool   ReplayHelper.h  
bWasStartRecordingSuccessful bool   ReplayHelper.h  
CheckpointSaveContext FCheckpointSaveStateContext   ReplayHelper.h  
CheckpointSaveMaxMSPerFrame float   ReplayHelper.h  
CurrentLevelIndex int32 Index of LevelNames that is currently loaded ReplayHelper.h  
DemoCurrentTime float Current record/playback position in seconds ReplayHelper.h  
DemoFrameNum int32 Current record/playback frame number ReplayHelper.h  
DemoTotalTime float Total time of demo in seconds ReplayHelper.h  
DemoURL FURL Cached replay URL. ReplayHelper.h  
ExternalDataMap TMap< TWeakObjectPtr< UObject >, FExternalDataWrapper, FDefaultSetAllocator, TWeakObjectPtrMapKeyFuncs< TWeakObjectPtr< UObject >, FExternalDataWrapper > >   ReplayHelper.h  
ExternalDataToObjectMap TMap< FNetworkGUID, FReplayExternalDataArray > ExternalDataToObjectMap is used to map a FNetworkGUID to the proper FReplayExternalDataArray ReplayHelper.h  
LastCheckpointTime double Last time a checkpoint was saved. ReplayHelper.h  
LatestReadFrameTime float Time of the last frame we've read (in seconds). ReplayHelper.h  
LevelNamesAndTimes TArray< FLevelNameAndTime > List of levels used in the current replay. ReplayHelper.h  
LevelsPendingFastForward TSet< class ULevel * > Levels that are currently pending for fast forward. ReplayHelper.h  
LevelStatusesByName TMap< FString, int32 > Index of level status (in AllLevelStatuses list). ReplayHelper.h  
LevelStatusIndexByLevel TMap< const ULevel *, int32 > Maintain a quick lookup for loaded levels directly to LevelStatus. ReplayHelper.h  
NewStreamingLevelsThisFrame TSet< TWeakObjectPtr< UObject > > During recording, streaming levels waiting to be saved next frame. ReplayHelper.h  
NumLevelsAddedThisFrame uint32 Only used during recording. ReplayHelper.h  
ObjectsWithExternalDataMap TMap< TWeakObjectPtr< UObject >, FNetworkGUID, FDefaultSetAllocator, TWeakObjectPtrMapKeyFuncs< TWeakObjectPtr< UObject >, FNetworkGUID > >   ReplayHelper.h  
OnReplayPlaybackError FOnReplayPlaybackError   ReplayHelper.h  
OnReplayRecordError FOnReplayRecordError   ReplayHelper.h  
PlaybackDeletedNetStartupActors TSet< FString > Net startup actors that need to be destroyed after checkpoints are loaded ReplayHelper.h  
PlaybackDeltaCheckpointData TArray< TUniquePtr< FDeltaCheckpointData > >   ReplayHelper.h  
PlaybackDemoHeader FNetworkDemoHeader This header is valid during playback (so we know what version to pass into serializers, etc) ReplayHelper.h  
PlaybackFrames TMap< float, TMap< FString, TArray< uint8 > > > PlaybackFrames are used to buffer per frame data up when we read a demo frame, which we can then process when the time is right ReplayHelper.h  
QueuedCheckpointPackets TArray< FQueuedDemoPacket >   ReplayHelper.h  
QueuedDemoPackets TArray< FQueuedDemoPacket >   ReplayHelper.h  
RecordingDeletedNetStartupActors TArray< FString > Net startup actors that need to be destroyed after checkpoints are loaded ReplayHelper.h  
RecordingDeltaCheckpointData FDeltaCheckpointData   ReplayHelper.h  
ReplayStreamer TSharedPtr< INetworkReplayStreamer >   ReplayHelper.h  
ResultManager UE::Net::FNetResultManager   ReplayHelper.h  
SeenLevelStatuses TArray< int32 > List of seen level statuses indices (in AllLevelStatuses). ReplayHelper.h  
UniqueStreamingLevels TSet< TWeakObjectPtr< UObject > > During recording, all unique streaming levels since recording started. ReplayHelper.h  
WeakLevelsByName TMap< FName, TWeakObjectPtr< ULevel > > Map of ULevel GetFName to weak object pointer to the level Populated during playback, not using NetworkRemapPath because it is never serialized ReplayHelper.h  
World TWeakObjectPtr< UWorld >   ReplayHelper.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Serialize ( FArchive& Ar
)

 For collection of GC references ReplayHelper.h  

Static

Name Remarks Include Path Unreal Specifiers

static void FlushNetChecked ( UNetConnection& NetConnection
)

   ReplayHelper.h  

static float GetClampedDeltaSeconds ( UWorld* World,
const float DeltaSeconds
)

   ReplayHelper.h  

static FString GetLevelPackageName ( const ULevel& InLevel
)

   ReplayHelper.h  

static const EReadPacketState ReadPacket ( FArchive& Archive,
TArray< uint8 >& OutBuffer,
const EReadPacketMode Mode
)

 Reads a formatted Demo Packet from the given archive (which is expected to be in Demo Frame format). ReplayHelper.h  

static void WritePacket ( FArchive& Ar,
uint8* Data,
int32 Count
)

   ReplayHelper.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ReplayHelper.h  
  ReplayHelper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page