ChaosMover

API > API/Plugins

   
Name ChaosMover
Type Plugin
Part of Plugins Chaos Mover
Location /Engine/Plugins/Experimental/ChaosMover/Source/ChaosMover/
Module Build Rules ChaosMover.Build.cs

Classes

Name Remarks
FChaosMover_OnJumped Fired after the actor jumps. First param is the starting jump height.
FChaosMover_OnLanded Fired after the actor lands on a valid surface.
FChaosMover_OnPathedMovementBounced Fired on the game thread when it has received notification that the pathed movement has bounced (reached the end of one leg in a round trip)
FChaosMover_OnPathedMovementLoopingPlaybackChanged Fired on the game thread when looping playback has changed.
FChaosMover_OnPathedMovementOneWayPlaybackChanged Fired on the game thread when one way playback has changed.
FChaosMover_OnPathedMovementReversePlaybackChanged Fired on the game thread when reverse playback has changed.
FChaosMover_OnPathedMovementStarted Fired on the game thread when it has received notification that the pathed movement has started.
FChaosMover_OnPathedMovementStopped Fired on the game thread when it has received notification that the pathed movement has stopped.
FMoverStateMachine  
UChaosCharacterAirExecutor UChaosCharacterAirExecutor: a concrete UChaosMoveExecutorBase that applies air physics to the character's sync state each simulation tick.
UChaosCharacterConstraintMovementModeInterface Interface for mover modes moving on ground like characters, using a character ground constraint.
UChaosCharacterCrouchCheck  
UChaosCharacterFallingCheck  
UChaosCharacterJumpCheck  
UChaosCharacterLandingCheck  
UChaosCharacterLaunchCheck Transition that handles launching based on input for a physics-based character
UChaosCharacterMovementMode Base class for all Chaos character movement modes
UChaosCharacterMovementModeInterface  
UChaosCharacterMoverComponent  
UChaosCharacterWalkingExecutor UChaosCharacterWalkingExecutor: a concrete UChaosMoveExecutorBase that applies walking physics to the Chaos character ground constraint simulation.
UChaosCharacterWaterCheck  
UChaosCompositeMovementMode UChaosCompositeMovementMode: a ChaosMover movement mode that composes a UChaosMoverSourceBase (what velocity to produce) with a UChaosMoveExecutorBase (how to apply it to the physics simulation).
UChaosEllipticalMovementPathPattern  
UChaosFallingMode Chaos character falling mode
UChaosFlyingMode Chaos character flying mode
UChaosGroundMovementUtils  
UChaosLayeredMoveSource UChaosLayeredMoveSource: a UChaosMoverSourceBase that drives move generation from a single FLayeredMoveBase instance stored as an instanced struct property.
UChaosMoveExecutorBase Abstract base class for move executors in ChaosMover.
UChaosMovementActuationInterface Interface for mover modes which can move the controlled component with a physical constraint or kinematically
UChaosMovementMode Base class for all Chaos movement modes
UChaosMovementModeTransition Base class for all Chaos movement mode transitions
UChaosMoverBackendComponent  
UChaosMoverBlueprintLibrary  
UChaosMoverSimulation  
UChaosMoverSourceBase Abstract base class for move sources.
UChaosPathedMovementControllerComponent This controller component gives control over pathed movement of an actor with a mover component and an active pathed movement mode.
UChaosPathedMovementDebugDrawComponent  
UChaosPathedMovementDebugDrawInterface  
UChaosPathedMovementMode Base for any movement mode that proceeds along a defined path within a specified amount of time
UChaosPathedMovementModeInterface Interface for mover modes which target transform is parameterized by an overall path progression, a value in [0, 1] 0 being at the beginning of the progression, 1 being at the end of that progression.
UChaosPathedMovementPatternBase  
UChaosPathedMovementReachedEndTransition Transition checking if an ongiong pathed movement mode has reached the end of the path.
UChaosPointMovementPathPattern Movement pattern that moves between explicitly defined points
UChaosPostSimulationTickInterface  
UChaosPreSimulationTickInterface  
UChaosSimpleWalkingMode Chaos walking mode variant that mirrors Mover's USimpleWalkingMode pattern:
UChaosSmoothWalkingMode A Chaos walking mode that ports Mover's USmoothWalkingMode spring/smoothing model.
UChaosSplineMovementPathPattern  
UChaosSwimmingMode Chaos character swimming mode
UChaosWalkingMode Chaos character walking mode
USharedChaosCharacterMovementSettings SharedChaosCharacterMovementSettings: collection of settings that are shared between the chaos character movement modes

Structs

Name Remarks
FAsyncLocalOnlyInstantMovementEffect This instant movement effect is ChaosMover only and executes AsyncFunction on the issuing end point only Being local only, this instant movement effect does not serialize anything, doesn't override NetSerialize
FCapsuleOverlapTestParams  
FChaosCharacterApplyVelocityEffect Applies a velocity or impulse for a single tick
FChaosMovementBasis Movement basis state, for any movement that is relative to a basis transform given in world coordinates.
FChaosMovementSettingsOverrides Add this struct to the character inputs to override the max speed and acceleration
FChaosMovementSettingsOverridesRemover Add this struct to the character inputs to cancel any max speed and acceleration for the input mode
FChaosMoverCrouchInputs Add this struct to toggle crouch on the character
FChaosMoverGroundSimState Mover ground state, holds movement properties relative to the ground.
FChaosMoverInstantMovementEffectAction Scheduled action that delivers any FInstantMovementEffect to the ChaosMover simulation via UNetworkPhysicsComponent::EnqueueScheduledAction_External.
FChaosMoverLaunchInputs Add this struct to the character inputs to launch the character
FChaosMoverLayeredMoveAction Scheduled action that delivers any FLayeredMoveBase subtype to the ChaosMover simulation via UNetworkPhysicsComponent::EnqueueScheduledAction_External.
FChaosMoverLayeredMoveInstanceAction Scheduled action that activates a FLayeredMoveInstance (ULayeredMoveLogic + FLayeredMoveInstancedData) on the ChaosMover simulation via UNetworkPhysicsComponent::EnqueueScheduledAction_External.
FChaosMoverPostSimContext Context passed by mutable reference to all IChaosPostSimulationTickInterface implementations during OnPostSimulationTick.
FChaosMoverPredictedTrajectoryData Predicted trajectory deltas generated during simulation tick.
FChaosMoverPredictionStateBackup  
FChaosMoverPreSimContext Context passed by mutable reference to all IChaosPreSimulationTickInterface implementations during OnPreSimulationTick.
FChaosMoverRequestedMoveInputs Add this struct to the character inputs to apply a requested move the character
FChaosMoverSimulationDefaultInputs Data block containing all default inputs required by the Chaos Mover simulation.
FChaosMoverSimulationEventsDebugData CVD-only debug wrapper for simulation events emitted during a substep.
FChaosMoverSimulationInterfaceCache Holds pre- and post-simulation interface pointers for the active movement mode, populated by UChaosMovementMode::CollectSimulationInterfaces each tick.
FChaosMoverTimeStepDebugData This will be replaced eventually by the Chaos Visual Debugger supporting the display of this information.
FChaosMoverTrajectoryPredictionInputs Local-only inputs that control how ChaosMover generates predicted trajectory samples.
FChaosMutablePathedMovementProperties Properties that can change during game-time and affect path movement calculations.
FChaosNetInstantMovementEffect Version of a FScheduledInstantMovementEffect with networkable instanced struct instead.
FChaosNetInstantMovementEffectsQueue  
FChaosNetLayeredMove  
FChaosNetLayeredMoveInstance Per-move entry in the networked FLayeredMoveInstance queue.
FChaosNetLayeredMoveInstancesQueue Networked queue of FLayeredMoveInstance moves, mirroring FChaosNetLayeredMovesQueue for the newer ULayeredMoveLogic / FLayeredMoveInstance layered move system.
FChaosNetLayeredMovesQueue  
FChaosPathedMovementInputs Frame inputs for all pathed movement Any property that can change during game time must be delivered in this way, only immutable properties can be safely referenced directly on the object they come from (usually the movement mode)
FChaosPathedMovementModeDebugData  
FChaosPathedMovementState State of a pathed movement that persists from frame to frame
FChaosPointMovementPathPoint  
FChaosScheduledInstantMovementEffect Version of a FScheduledInstantMovementEffect bShouldRollBack flag.
FChaosScheduledLayeredMove Version of a FScheduledLayeredMove with bShouldRollBack flag.
FChaosScheduledLayeredMoveInstance SM-internal queue entry for a GT-issued FLayeredMoveInstance move.
FChaosSplinePathPatternPointData This isn't formal "spline metadata" because that requires a custom spline and component - we want to add info to vanilla splines
FChaosStanceModifier  
FChaosWaterResultData  
FDebugTeleportToInstantMovementEffect This instant movement effect is ChaosMover only and teleport to a location without any checks whatsoever, this is meant for debugging only.
FFloorSweepParams  
FGroundDynamicsInfo  
FMovementModeChangeEvent Mode change event structure, used to postpone callbacks to gameplay code when a mode has changed
FNetworkPhysicsDebugData Structure for tracing some network physics info to CVD.
FPathedMovementBouncedEventData  
FPathedMovementInReverseChangedEventData  
FPathedMovementLoopingChangedEventData  
FPathedMovementOneWayChangedEventData  
FPathedMovementStartedEventData  
FPathedMovementStoppedEventData  
FRequestedMoveParams Input parameters for controlled ground movement function.
FSimulationInputData  
FStanceModifiedEventData  
FSwimmingSettings Controls for the Swimming Movement.

Interfaces

Name Remarks
IChaosCharacterConstraintMovementModeInterface  
IChaosCharacterMovementModeInterface  
IChaosMovementActuationInterface  
IChaosPathedMovementDebugDrawInterface ChaosPathedMovementDebugDrawInterface: Controls the debug draws of pathed movement modes, showing a preview mesh at a given overall progression on the path
IChaosPathedMovementModeInterface  
IChaosPostSimulationTickInterface Interface for post-simulation tick implementations.
IChaosPreSimulationTickInterface Interface for pre-simulation tick implementations.

Typedefs

Name Type Remarks Include Path
FSimulationOutputData ::UE::Mover::FSimulationOutputData   ChaosMover/ChaosMoverSimulationTypes.h

Enums

Public

Name Remarks
EChaosMoverIgnoredCollisionMode  
EChaosMoverVelocityEffectMode  
EChaosPathedMovementExecutionType Execution type for pathed movement modifications, i.e. whether the modification is executed on the authority only or predicted on the client
EChaosPatternAxisMaskFlags  
EChaosPointMovementLocationBasis  
ECharacterMoverFrictionOverrideMode  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TargetRelativeTransform const FName   ChaosMover/PathedMovement/ChaosPathedMovementTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool operator! ( EChaosPatternAxisMaskFlags E
)

   ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h  
  ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h  
  ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h  
  ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h  
  ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h  
  ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h  
  ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h  
  ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h  

FMoverDataCollection & UE::ChaosMover::GetDebugSimData ( UChaosMoverSimulation* Simulation
)

 Util function to be able to get the debug sim data collection from a UChaosMoverSimulation from another plugin, without including ChaosMoverSimulation.h ChaosMover/ChaosMoverSimulationTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page