Navigation
API > API/Plugins > API/Plugins/Mover
This is the core rollback blackboard, with API for external access and admin use. See @FRollbackBlackboardSimWrapper for in-simulation use.
| Name | URollbackBlackboard |
| Type | class |
| Header File | /Engine/Plugins/Experimental/Mover/Source/Mover/Public/MoveLibrary/RollbackBlackboard.h |
| Include Path | #include "MoveLibrary/RollbackBlackboard.h" |
Syntax
UCLASS (MinimalAPI)
class URollbackBlackboard : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → URollbackBlackboard
Structs
| Name | Remarks |
|---|---|
| BlackboardEntry | |
| BlackboardEntryBase | Untyped base, so we can use entries of multiple types in a single-typed container |
| EntrySettings | |
| EntryTimeStamp |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsPredictionInProgress | bool | MoveLibrary/RollbackBlackboard.h | ||
| bIsResimulating | bool | MoveLibrary/RollbackBlackboard.h | ||
| bIsRollbackInProgress | bool | MoveLibrary/RollbackBlackboard.h | ||
| bIsSimulationInProgress | bool | MoveLibrary/RollbackBlackboard.h | ||
| BufferFlags | ERollbackBufferFlags | MoveLibrary/RollbackBlackboard.h | ||
| CurrentSimTimeStamp | EntryTimeStamp | MoveLibrary/RollbackBlackboard.h | ||
| EntryMap | TMap< FName, TUniquePtr< BlackboardEntryBase > > | MoveLibrary/RollbackBlackboard.h | ||
| InPredictionThreadId | uint32 | MoveLibrary/RollbackBlackboard.h | ||
| InProgressSimFrameThreadId | uint32 | MoveLibrary/RollbackBlackboard.h | ||
| InProgressSimTimeStamp | EntryTimeStamp | MoveLibrary/RollbackBlackboard.h | ||
| InRollbackThreadId | uint32 | MoveLibrary/RollbackBlackboard.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginPredictionFrame
(
const FMoverTimeStep& PendingTimeStep |
BeginPredictionFrame/EndPrediction: this is for predictive simulation that is temporary and can't rollback. Note there may be multiple calls to BeginPredictionFrame before a single call to EndPrediction. | MoveLibrary/RollbackBlackboard.h | |
void BeginRollback
(
const FMoverTimeStep& NewBaseTimeStep |
Begin/EndRollback: reverts the blackboard back to an older state. EndRollback will be called before any simulation frames are started (resim or not). | MoveLibrary/RollbackBlackboard.h | |
void BeginSimulationFrame
(
const FMoverTimeStep& PendingTimeStep |
Begin/EndSimulationFrames: advances true simulation flow, regardless of whether this is resimulation or not. Calls will bookend a simulation frame. | MoveLibrary/RollbackBlackboard.h | |
bool CreateEntry
(
FName EntryName, |
MoveLibrary/RollbackBlackboard.h | ||
void EndPrediction() |
MoveLibrary/RollbackBlackboard.h | ||
void EndRollback() |
MoveLibrary/RollbackBlackboard.h | ||
void EndSimulationFrame() |
MoveLibrary/RollbackBlackboard.h | ||
bool HasEntry
(
FName EntryName |
MoveLibrary/RollbackBlackboard.h |