1. Epic GamesDeveloper
  3. FBaseRewindHistory

FBaseRewindHistory

Base rewind history used in the rewind data

API > API/Runtime > API/Runtime/Chaos

Inheritance Hierarchy

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/RewindData.h
Include #include "RewindData.h"

Syntax

struct FBaseRewindHistory

Remarks

Base rewind history used in the rewind data

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

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

 Call ApplyData on each frame data within range
Public function Virtual bool

ApplyInputs ( const int32 ApplyFrame,
const bool bResetSolver
)

 Legacy interface to apply inputs
Public function Const TUniquePtr< FBaseRewindHistory >

Clone ()

 Create a polymorphic copy of the history
Public function Virtual bool

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

 Copy all data from local history into into
Public function Virtual bool

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

 Copy data from local history into
Public function 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
Public function Virtual int32

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

 Find how many entries are valid in frame range
Public function Const TUniquePtr< FBaseRewindHistory > Create a new, empty instance with the same concrete type as this object
Public function Virtual void

DebugData ( const FString& DebugText
)

 Print custom string along with values for each entry in history
Public function 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
Public function Virtual void

DebugDatas ( const Chaos::FBaseRewindHistory& NewDatas,
TArray< int32 >& LocalFrames,
TArray< int32 >& ServerFrames,
TArray< int32 >& InputFrames
)

  
Public function Virtual bool

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

 Extract data from the history buffer at a given time
Public function Virtual bool

ExtractDatas ( const int32 ExtractFrame,
const bool bResetSolver,
void* HistoryDatas,
const bool bExactFrame
)

  
Public function Virtual Const const int32 Return the least up to date frame entry in history, returns INT_MAX if no frame was found
Public function Virtual Const const int32 Return the max size of the history
Public function Virtual Const const int32 Return the most up to date frame entry in history, returns INDEX_NONE if no frame was found
Public function Virtual Const const bool Return if history has valid data
Public function Virtual Const bool

HasValidData ( const int32 ValidFrame
)

 Check if the history buffer contains an entry for the given frame
Public function Virtual Const bool

HasValidDatas ( const int32 ValidFrame
)

  
Public function Virtual void Initialize history
Public function Virtual void

MergeData ( const int32 FromFrame,
void* ToData
)

 Iterate over and merge data
Public function Virtual void

NetSerialize ( FArchive& Ar,
UPackageMap* PackageMap
)

 Serialize the data to or from a network archive
Public function Virtual int32

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

 Copy new data (received from the network) into this history, returns frame to resimulate from if
Public function Virtual void

ReceiveNewDatas ( FBaseRewindHistory& NewDatas,
const int32 FrameOffset
)

  
Public function Virtual bool

RecordData ( const int32 RecordFrame,
const void* HistoryData
)

 Record data into the history buffer at a given time
Public function Virtual bool

RecordDatas ( const int32 RecordFrame,
const void* HistoryDatas
)

  
Public function Virtual void Perform a fast reset, marking the data history as reset but not clearing the data or resetting collections
Public function Virtual void

ResizeDataHistory ( const int32 FrameCount,
const EAllowShrinking AllowShrinking
)

 Resize the history
Public function Virtual bool

RewindStates ( const int32 RewindFrame,
const bool bResetSolver
)

 Legacy interface to rewind states
Public function Virtual void

SetImportant ( const bool bImportant,
const int32 Frame
)

 Mark frame important or unimportant
Public function Virtual void

SetPackageMap ( UPackageMap* InPackageMap
)

 Set the package map for serialization
Public function Virtual void

ValidateDataInHistory ( const void* ActorComponent
)

 Validate data in history buffer received from clients on the server

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page