1. Epic GamesDeveloper
  3. UChaosMoverSimulation

UChaosMoverSimulation

API > API/Plugins > API/Plugins/ChaosMover

   
Name UChaosMoverSimulation
Type class
Header File /Engine/Plugins/Experimental/ChaosMover/Source/ChaosMover/Public/ChaosMover/ChaosMoverSimulation.h
Include Path #include "ChaosMover/ChaosMoverSimulation.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UChaosMoverSimulation : public UMoverSimulation

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UChaosMoverSimulation()

   ChaosMover/ChaosMoverSimulation.h  

Structs

Name Remarks
FInitParams  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bInitialized bool   ChaosMover/ChaosMoverSimulation.h  
bInputCmdOverridden bool   ChaosMover/ChaosMoverSimulation.h  
bSyncStateOverridden bool   ChaosMover/ChaosMoverSimulation.h  
Events TArray< TSharedPtr< FMoverSimulationEventData > >   ChaosMover/ChaosMoverSimulation.h  
InternalServerFrame int32   ChaosMover/ChaosMoverSimulation.h  
NetInputCmd FMoverInputCmdContext   ChaosMover/ChaosMoverSimulation.h  
NetSyncState FMoverSyncState   ChaosMover/ChaosMoverSimulation.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddEvent ( TSharedPtr< FMoverSimulationEventData > Event
)

   ChaosMover/ChaosMoverSimulation.h  

void ApplyNetInputData ( const FMoverInputCmdContext& InNetInputCmd
)

   ChaosMover/ChaosMoverSimulation.h  

void ApplyNetStateData ( const FMoverSyncState& InNetSyncState
)

   ChaosMover/ChaosMoverSimulation.h  

void BuildNetInputData ( FMoverInputCmdContext& OutNetInputCmd
) const

   ChaosMover/ChaosMoverSimulation.h  

void BuildNetStateData ( FMoverSyncState& OutNetSyncState
) const

   ChaosMover/ChaosMoverSimulation.h  

void CancelModifierFromHandle ( FMovementModifierHandle ModifierHandle
)

   ChaosMover/ChaosMoverSimulation.h
  • BlueprintCallable
  • Category=Mover

void Deinit()

   ChaosMover/ChaosMoverSimulation.h  

const UBaseMovementMode * FindMovementModeByName ( const FName& Name
) const

   ChaosMover/ChaosMoverSimulation.h
  • BlueprintPure
  • Category=Mover

UBaseMovementMode * FindMovementModeByName_Mutable ( const FName& Name
)

   ChaosMover/ChaosMoverSimulation.h
  • BlueprintPure
  • Category=Mover

const FMovementModifierBase * FindMovementModifierByType ( const UScriptStruct* DataStructType
) const

 Find movement modifier by type (returns the first modifier it finds). Returns nullptr if the modifier couldn't be found. ChaosMover/ChaosMoverSimulation.h  

const ModifierT * FindMovementModifierByType ()

 Find a movement modifier of a specific type in this components movement modifiers. ChaosMover/ChaosMoverSimulation.h  

const UBaseMovementMode * GetCurrentMovementMode()

   ChaosMover/ChaosMoverSimulation.h
  • BlueprintPure
  • Category=Mover

FMoverDataCollection & GetDebugSimData()

 Collection for holding extra debug data, that will be sent to the Chaos Visual Debugger for debugging. ChaosMover/ChaosMoverSimulation.h
  • BlueprintPure
  • Category=Mover

const FMoverDataCollection & GetLocalSimInput()

 Returns the local simulation input MoverDataCollection, to read local non networked data passed to the simulation by the gameplay thread. ChaosMover/ChaosMoverSimulation.h
  • BlueprintPure
  • Category=Mover

FMoverDataCollection & GetLocalSimInput_Mutable()

 Returns the local simulation input MoverDataCollection, to pass local non networked data to the simulation Only available from the gameplay thread ChaosMover/ChaosMoverSimulation.h
  • BlueprintPure
  • Category=Mover

virtual const FTransform & GetMovementBasisTransform()

 Movement modes can be relative to a basis transform, which can change at runtime Returns the movement basis transform, for movement relative to it ChaosMover/ChaosMoverSimulation.h  

bool HasGameplayTag ( FGameplayTag TagToFind,
bool bExactMatch
) const

   ChaosMover/ChaosMoverSimulation.h
  • BlueprintPure
  • Category=Mover
  • Meta=(Keywords="HasTag")

void Init ( const FInitParams& InitParams
)

   ChaosMover/ChaosMoverSimulation.h  

void K2_QueueInstantMovementEffect ( const int32& EffectAsRawData
)

   ChaosMover/ChaosMoverSimulation.h
  • BlueprintCallable
  • CustomThunk
  • Category=Mover
  • Meta=(CustomStructureParam="EffectAsRawData", AllowAbstract="false", DisplayName="Queue Instant Movement Effect")

FMovementModifierHandle K2_QueueMovementModifier ( const int32& MoveAsRawData
)

   ChaosMover/ChaosMoverSimulation.h
  • BlueprintCallable
  • CustomThunk
  • Category=Mover
  • Meta=(CustomStructureParam="MoveAsRawData", AllowAbstract="false", DisplayName="Queue Movement Modifier")

void ModifyContacts ( const FMoverTimeStep& TimeStep,
const UE::ChaosMover::FSimulationInputData& InputData,
const UE::ChaosMover::FSimulationOutputData& OutputData,
Chaos::FCollisionContactModifier& Modifier
)

   ChaosMover/ChaosMoverSimulation.h  

void ProcessInputs ( int32 PhysicsStep,
const FMoverTimeStep& TimeStep,
const UE::ChaosMover::FSimulationInputData& InputData
)

   ChaosMover/ChaosMoverSimulation.h  

void QueueInstantMovementEffect ( TSharedPtr< FInstantMovementEffect > InstantMovementEffect,
bool bShouldRollBack
)

 Queue an Instant Movement Effect to take place at the end of this frame or start of the next subtick - whichever happens first. ChaosMover/ChaosMoverSimulation.h  

void QueueInstantMovementEffect ( const FScheduledInstantMovementEffect& ScheduledInstantMovementEffect,
bool bShouldRollBack
)

 Queue a scheduled instant movement effect. ChaosMover/ChaosMoverSimulation.h  

FMovementModifierHandle QueueMovementModifier ( TSharedPtr< FMovementModifierBase > Modifier
)

 Queue a Movement Modifier to start during the next simulation frame. ChaosMover/ChaosMoverSimulation.h  

virtual void SetMovementBasisTransform ( const FTransform& InMovementBasisTransform
)

 Sets the movement basis transform, for movement relative to it. ChaosMover/ChaosMoverSimulation.h  

void SimulationTick ( const FMoverTimeStep& TimeStep,
const UE::ChaosMover::FSimulationInputData& InputData,
UE::ChaosMover::FSimulationOutputData& OutputData
)

   ChaosMover/ChaosMoverSimulation.h  

Overridden from UMoverSimulation

Name Remarks Include Path Unreal Specifiers

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

 Teleportation (internal functions) ChaosMover/ChaosMoverSimulation.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool CanTeleport ( const FTransform& TargetTransform,
bool bUseActorRotation,
const FMoverSyncState& SyncState
)

 Whether the teleport can happen (does the movement mode allow it? Do we fit at the target transform?) ChaosMover/ChaosMoverSimulation.h  

void DisableActuationConstraint()

   ChaosMover/ChaosMoverSimulation.h  

void DisableCharacterConstraint()

   ChaosMover/ChaosMoverSimulation.h  

void EnableActuationConstraint()

 General purpose actuation joint constraint. ChaosMover/ChaosMoverSimulation.h  

void EnableCharacterConstraint()

 Character ground constraint. ChaosMover/ChaosMoverSimulation.h  

Chaos::FPBDRigidParticleHandle * GetControlledParticle()

   ChaosMover/ChaosMoverSimulation.h  

bool IsActuationConstraintEnabled()

   ChaosMover/ChaosMoverSimulation.h  

bool IsCharacterConstraintEnabled()

   ChaosMover/ChaosMoverSimulation.h  

bool IsControlledParticleDynamic()

   ChaosMover/ChaosMoverSimulation.h  

bool IsControlledParticleKinematic()

   ChaosMover/ChaosMoverSimulation.h  

virtual void OnDeinit()

   ChaosMover/ChaosMoverSimulation.h  

virtual void OnInit()

   ChaosMover/ChaosMoverSimulation.h  

virtual void OnModifyContacts ( const FMoverTimeStep& TimeStep,
const UE::ChaosMover::FSimulationInputData& InputData,
const UE::ChaosMover::FSimulationOutputData& OutputData,
Chaos::FCollisionContactModifier& Modifier
)

   ChaosMover/ChaosMoverSimulation.h  

virtual void OnMovementModeChanged ( const FMovementModeChangedEventData& ModeChangedData
)

   ChaosMover/ChaosMoverSimulation.h  

virtual void OnPostSimulationTick ( const FMoverTimeStep& TimeStep,
UE::ChaosMover::FSimulationOutputData& OutputData
)

   ChaosMover/ChaosMoverSimulation.h  

virtual void OnPreSimulationTick ( const FMoverTimeStep& TimeStep,
const UE::ChaosMover::FSimulationInputData& InputData
)

   ChaosMover/ChaosMoverSimulation.h  

virtual void OnSimulationRollback ( const FMoverTimeStep& NewTimeStep,
const FMoverSyncState& PrevSyncState
)

   ChaosMover/ChaosMoverSimulation.h  

virtual void OnSimulationTick ( const FMoverTimeStep& TimeStep,
const UE::ChaosMover::FSimulationInputData& InputData,
UE::ChaosMover::FSimulationOutputData& OutputData
)

   ChaosMover/ChaosMoverSimulation.h  

virtual void PostSimulationTickCharacter ( const IChaosCharacterMovementModeInterface& CharacterMode,
const FMoverTimeStep& TimeStep,
UE::ChaosMover::FSimulationOutputData& OutputData
)

   ChaosMover/ChaosMoverSimulation.h  

virtual void PostSimulationTickCharacterConstraint ( const IChaosCharacterConstraintMovementModeInterface& CharacterConstraintMode,
const FMoverTimeStep& TimeStep,
UE::ChaosMover::FSimulationOutputData& OutputData
)

   ChaosMover/ChaosMoverSimulation.h  

virtual void PostSimulationTickMovementActuation ( const IChaosMovementActuationInterface& ConstraintMode,
const FMoverTimeStep& TimeStep,
UE::ChaosMover::FSimulationOutputData& OutputData
)

 Pathed movement sim steps (kinematic or constrained) ChaosMover/ChaosMoverSimulation.h  

virtual void PreSimulationTickCharacter ( const IChaosCharacterMovementModeInterface& CharacterMode,
const FMoverTimeStep& TimeStep,
const UE::ChaosMover::FSimulationInputData& InputData
)

 Character-like movement sim steps. ChaosMover/ChaosMoverSimulation.h  

virtual void ProcessSimulationEvent ( const FMoverSimulationEventData& ModeChangedData
)

   ChaosMover/ChaosMoverSimulation.h  

void SetActuationTargetTransform ( const FTransform& TargetTransform
)

   ChaosMover/ChaosMoverSimulation.h  
Object State. ChaosMover/ChaosMoverSimulation.h  

void SetControlledParticleKinematic()

   ChaosMover/ChaosMoverSimulation.h  

virtual void Teleport ( const FTransform& TargetTransform,
const FMoverTimeStep& TimeStep,
FMoverSyncState& OutputState
)

 Actually perform the teleport. ChaosMover/ChaosMoverSimulation.h  

void TeleportActuationTarget ( const FTransform& TargetTransform,
bool AlsoTeleportControlledParticle
)

   ChaosMover/ChaosMoverSimulation.h  

void TraceMoverData ( const FMoverTimeStep& TimeStep,
const UE::ChaosMover::FSimulationOutputData& OutputData
)

   ChaosMover/ChaosMoverSimulation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page