Navigation
API > API/Plugins > API/Plugins/Mover
Accounting record of a move as it is processed. Moves are composed of substeps, and these can be marked to indicate how they influence the final collapsed move. Relevancy means the substep (or part thereof) is contributing to the reflected movement state. Example: a character moves forward across a slightly irregular sidewalk, and then is adjusted downward to keep it sticking closely to the sidewalk. The forward move is a relevant substep, while the vertical heigh adjustment is not.
| Name | FMovementRecord |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Mover/Source/Mover/Public/MoveLibrary/MovementRecord.h |
| Include Path | #include "MoveLibrary/MovementRecord.h" |
Syntax
USTRUCT (BlueprintType )
struct FMovementRecord
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsRelevancyLocked | bool | MoveLibrary/MovementRecord.h | ||
| bRelevancyLockValue | bool | MoveLibrary/MovementRecord.h | ||
| RelevantMoveDelta | FVector | MoveLibrary/MovementRecord.h | ||
| Substeps | TArray< FMovementSubstep > | TODO: Perf, need to reserve a reasonable number or possibly refactor this to be some kind of pool. | MoveLibrary/MovementRecord.h | |
| TotalDeltaSeconds | float | MoveLibrary/MovementRecord.h | ||
| TotalMoveDelta | FVector | MoveLibrary/MovementRecord.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Append
(
FMovementSubstep Substep |
MoveLibrary/MovementRecord.h | ||
const FVector & GetRelevantMoveDelta() |
MoveLibrary/MovementRecord.h | ||
FVector GetRelevantVelocity() |
MoveLibrary/MovementRecord.h | ||
const TArray< FMovementSubstep > & GetSubsteps() |
MoveLibrary/MovementRecord.h | ||
const FVector & GetTotalMoveDelta() |
MoveLibrary/MovementRecord.h | ||
void LockRelevancy
(
bool bLockValue |
TODO: consider changing this to only allow locking as irrelevant TODO: this relevancy locking is hacky, could be replaced by a scoping-style mechanism to allow higher-level functions to override a lower-level function's default relevancy | MoveLibrary/MovementRecord.h | |
void Reset() |
MoveLibrary/MovementRecord.h | ||
void SetDeltaSeconds
(
float DeltaSeconds |
MoveLibrary/MovementRecord.h | ||
FString ToString() |
MoveLibrary/MovementRecord.h | ||
void UnlockRelevancy() |
MoveLibrary/MovementRecord.h |