UMoverSimulation

WIP Base class for a Mover simulation.

API > API/Plugins > API/Plugins/Mover

WIP Base class for a Mover simulation. The simulation is intended to be the thing that updates the Mover state and should be safe to run on an async thread

   
Name UMoverSimulation
Type class
Header File /Engine/Plugins/Experimental/Mover/Source/Mover/Public/MoverSimulation.h
Include Path #include "MoverSimulation.h"

Syntax

UCLASS (Abstract, MinimalAPI, BlueprintType)  
class UMoverSimulation : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMoverSimulation()

   MoverSimulation.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
QueuedInstantMovementEffects TArray< FScheduledInstantMovementEffect > Instant movement effects staged by the GT, consumed by the FSM or ChaosMover backend each tick. MoverSimulation.h  
QueuedLayeredMoveInstances TArray< TSharedPtr< FLayeredMoveInstance > > Instanced layered moves staged by the GT (via MakeAndQueueLayeredMove), consumed each tick. MoverSimulation.h  
QueuedLayeredMoves TArray< FScheduledLayeredMove > Struct-based layered moves staged by the GT, consumed by the FSM or ChaosMover backend each tick. MoverSimulation.h  
SimQueueLock FTransactionallySafeRWLock Protects the three simulation-level staging queues below. MoverSimulation.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TArray< FScheduledInstantMovementEffect > ConsumeQueuedInstantMovementEffects()

 Consume all queued instant movement effects. Empties the queue under a write lock. MoverSimulation.h  

TArray< TSharedPtr< FLayeredMoveInstance > > ConsumeQueuedLayeredMoveInstances()

 Consume all queued instanced layered moves. Empties the queue under a write lock. MoverSimulation.h  

TArray< FScheduledLayeredMove > ConsumeQueuedLayeredMoves()

 Consume all queued struct-based layered moves. Empties the queue under a write lock. MoverSimulation.h  

const UMoverBlackboard * GetBlackboard()

 Warning: the regular blackboard will be fully replaced by the rollback blackboard in the future. MoverSimulation.h
  • BlueprintPure
  • Category=Mover

UMoverBlackboard * GetBlackboard_Mutable()

 Warning: the regular blackboard will be fully replaced by the rollback blackboard in the future. MoverSimulation.h
  • BlueprintPure
  • Category=Mover

FRollbackBlackboardSimWrapper GetRollbackBlackboardPredictionWrapper()

 Get accessor for the blackboard to be used predictively. You can read from it, but any writes will be temporary and thrown away once prediction is finished. MoverSimulation.h
  • BlueprintPure
  • Category=Mover

FRollbackBlackboardSimWrapper GetRollbackBlackboardSimWrapper()

   MoverSimulation.h
  • BlueprintPure
  • Category=Mover

void QueueInstantMovementEffect ( const FScheduledInstantMovementEffect& Effect
)

 Queue a scheduled instant movement effect (GT staging, write-locked). MoverSimulation.h  
Thread-safe simulation-level staging queues. MoverSimulation.h  

void QueueLayeredMoveInstance ( TSharedPtr< FLayeredMoveInstance > MoveInstance
)

 Queue an instanced layered move (GT staging, write-locked). MoverSimulation.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void AttemptTeleport ( const FMoverTimeStep& TimeStep,
const FTransform& TargetTransform,
bool bUseActorRotation,
FMoverSyncState& OutputState
)

 Attempt to teleport to TargetTransform. MoverSimulation.h
  • BlueprintCallable
  • Category=Mover

virtual void CancelFeaturesWithTag ( FGameplayTag TagToCancel,
bool bRequireExactMatch
)

   MoverSimulation.h  

virtual void CancelModifierFromHandle ( FMovementModifierHandle ModifierHandle
)

   MoverSimulation.h  

virtual const FMovementModifierBase * FindQueuedModifier ( FMovementModifierHandle ModifierHandle
) const

 Modifier management functions. MoverSimulation.h  

virtual const FMovementModifierBase * FindQueuedModifierByType ( const UScriptStruct* ModifierType
) const

   MoverSimulation.h  

virtual FName GetNextModeName()

 Gets the anticipated next mode, either the next queued one or the current mode. MoverSimulation.h
  • BlueprintPure
  • Category=Mover
  • Meta=(BlueprintThreadSafe)

virtual bool HasFeaturesWithTag ( FGameplayTag TagToMatch,
bool bRequireExactMatch
) const

   MoverSimulation.h  

virtual FMovementModifierHandle QueueMovementModifier ( TSharedPtr< FMovementModifierBase > Modifier
)

   MoverSimulation.h  

virtual void QueueNextMode ( FModeChangeParams ModeChangeParams
)

 Queues a mode change for the next opportunity. This function is intended to be threadsafe and can be called from inside or outside of the simulation. MoverSimulation.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(BlueprintThreadSafe)

virtual void RegisterMovementMode ( FModeRegistrationParams ModeRegisterParams
)

 Registers a new movement mode for use in the simulation. MoverSimulation.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(BlueprintThreadSafe)

virtual void UnregisterMovementMode ( FModeRegistrationParams ModeRegisterParams
)

 Unregisters a movement mode from the simulation. MoverSimulation.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(BlueprintThreadSafe)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page