1. Epic GamesDeveloper
  3. FBaseRewindHistory

FBaseRewindHistory

Base rewind history used in the rewind data

API > API/Runtime > API/Runtime/Chaos

Base rewind history used in the rewind data

   
Name FBaseRewindHistory
Type struct
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/RewindData.h
Include Path #include "RewindData.h"

Syntax

struct FBaseRewindHistory

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FBaseRewindHistory()

   RewindData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ApplyDataRange ( const int32 FromFrame,
const int32 ToFrame,
void* ActorComponent,
const bool bOnlyImportant
)

 Call ApplyData on each frame data within range RewindData.h  

virtual bool ApplyInputs ( const int32 ApplyFrame,
const bool bResetSolver
)

 Legacy interface to apply inputs RewindData.h  
Create a polymorphic copy of the history RewindData.h  

virtual bool CopyAllData ( Chaos::FBaseRewindHistory& OutHistory,
bool bIncludeUnimportant,
bool bIncludeImportant
)

 Copy all data from local history into into RewindData.h  

virtual bool CopyAllDataGrowingOrdered ( Chaos::FBaseRewindHistory& OutHistory
)

 Copy all data and record it ordered and growing RewindData.h  

virtual bool CopyAlteredData ( Chaos::FBaseRewindHistory& OutHistory,
bool bIncludeUnimportant,
bool bIncludeImportant
)

 Copy altered data from local history into into RewindData.h  

virtual bool CopyData ( Chaos::FBaseRewindHistory& OutHistory,
const uint32 StartFrame,
const uint32 EndFrame,
bool bIncludeUnimportant,
bool bIncludeImportant
)

 Copy data from local history into RewindData.h  

TUniquePtr< FBaseRewindHistory > CopyFramesWithOffset ( const uint32 StartFrame,
const uint32 EndFrame,
const int32 FrameOffset
)

 Create a polymorphic copy of only a range of frames, applying the frame offset to the copies RewindData.h  

virtual int32 CountAlteredData ( const bool bIncludeUnimportant,
const bool bIncludeImportant
)

 Find how many entries that have been marked as altered, meaning the server has altered the data so that it doesn't match the received data from the client RewindData.h  

virtual int32 CountValidData ( const uint32 StartFrame,
const uint32 EndFrame,
const bool bIncludeUnimportant,
const bool bIncludeImportant
)

 Find how many entries are valid in frame range RewindData.h  
Create a new, empty instance with the same concrete type as this object RewindData.h  

virtual void DebugData ( const Chaos::FBaseRewindHistory& NewData,
TArray< int32 >& LocalFrames,
TArray< int32 >& ServerFrames,
TArray< int32 >& InputFrames
)

 Get arrays of frame values for each entry in the history RewindData.h  

virtual void DebugData ( const FString& DebugText
)

 Print custom string along with values for each entry in history RewindData.h  

virtual bool ExtractData ( const int32 ExtractFrame,
const bool bResetSolver,
void* HistoryData,
const bool bExactFrame
)

 Extract data from the history buffer at a given time RewindData.h  

virtual const int32 GetEarliestFrame()

 Return the least up to date frame entry in history, returns INT_MAX if no frame was found RewindData.h  

virtual const int32 GetHistorySize()

 Return the max size of the history RewindData.h  

virtual const int32 GetLatestFrame()

 Return the most up to date frame entry in history, returns INDEX_NONE if no frame was found RewindData.h  

virtual const bool HasDataInHistory()

 Return if history has valid data RewindData.h  

virtual bool HasValidData ( const int32 ValidFrame
) const

 Check if the history buffer contains an entry for the given frame RewindData.h  

virtual void Initialize()

 Initialize history RewindData.h  

virtual void MergeData ( const int32 FromFrame,
void* ToData
)

 Iterate over and merge data RewindData.h  

virtual void NetSerialize ( FArchive& Ar,
UPackageMap* PackageMap
)

 Serialize the data to or from a network archive RewindData.h  

virtual void NetSerialize ( FArchive& Ar,
UPackageMap* PackageMap,
TUniqueFunction< void(void*Data, const int32 DataIndex)> DataSetupFunction
)

 Serialize the data to or from a network archive RewindData.h  

virtual int32 ReceiveNewData ( FBaseRewindHistory& NewData,
const int32 FrameOffset,
const bool CompareDataForRewind,
const bool bImportant
)

   RewindData.h  

virtual int32 ReceiveNewData ( FBaseRewindHistory& NewData,
const int32 FrameOffset,
const bool CompareDataForRewind,
const bool bImportant,
int32 TryInjectAtFrame
)

 Copy new data (received from the network) into this history Returns frame to resimulate from if RewindData.h  

virtual bool RecordData ( const int32 RecordFrame,
const void* HistoryData
)

 Record data into the history buffer at a given time RewindData.h  

virtual bool RecordDataGrowingOrdered ( const void* HistoryData
)

 Record data in order and allow growing the history RewindData.h  

virtual void ResetFast()

 Perform a fast reset, marking the data history as reset but not clearing the data or resetting collections RewindData.h  

virtual void ResizeDataHistory ( const int32 FrameCount,
const EAllowShrinking AllowShrinking
)

 Resize the history RewindData.h  

virtual bool RewindStates ( const int32 RewindFrame,
const bool bResetSolver
)

 Legacy interface to rewind states RewindData.h  

virtual void SetImportant ( const bool bImportant,
const int32 Frame
)

 Mark frame important or unimportant RewindData.h  

virtual void SetPackageMap ( UPackageMap* InPackageMap
)

 Set the package map for serialization RewindData.h  

virtual void SetRecordDataIncremental ( const bool bInIncremental
)

 Set if this history should only allow overriding of data if it has a higher value than current recorded data RewindData.h  

virtual void ValidateDataInHistory ( const void* ActorComponent
)

 Validate data in history buffer received from clients on the server RewindData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page