1. Epic GamesDeveloper
  3. FCharacterMovementComponentAsyncInput

FCharacterMovementComponentAsyncInput

Contains all input and implementation required to run async character movement.

API > API/Runtime > API/Runtime/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/CharacterMovementComponentAsync.h
Include #include "CharacterMovementComponentAsync.h"

Syntax

struct FCharacterMovementComponentAsyncInput : public Chaos::FSimCallbackInput

Remarks

Contains all input and implementation required to run async character movement. Base implementation is from CharacterMovementComponent. Contains 'CharacterInput' and 'UpdatedComponentInput' represent data/impl of Character and our UpdatedComponent. All input is const, non-const data goes in output. 'AsyncSimState' points to non-const sim state.

Variables

  Type Name Description
Public variable float AirControl  
Public variable float AirControlBoostMultiplier  
Public variable float AirControlBoostVelocityThreshold  
Public variable TSharedPtr< FCharacterMovementComponentAsyncOutput, ESPMode::ThreadSafe > AsyncSimState This is the latest simulated state of this movement component.
Public variable bool bAllowPhysicsRotationDuringAnimRootMotion  
Public variable bool bAlwaysCheckFloor  
Public variable bool bApplyGravityWhileJumping  
Public variable bool bCanEverCrouch  
Public variable bool bCanWalkOffLedges  
Public variable bool bCanWalkOffLedgesWhenCrouching  
Public variable bool bConstrainToPlane  
Public variable bool bDeferUpdateMoveComponent  
Public variable bool bForceMaxAccel  
Public variable bool bHasValidData  
Public variable bool bIgnoreBaseRotation  
Public variable bool bInitialized Has this been filled out?
Public variable bool bIsNetModeClient  
Public variable bool bMaintainHorizontalGroundVelocity  
Public variable bool bMovementStateCanJump  
Public variable bool bNavAgentPropsCanJump  
Public variable bool bOrientRotationToMovement  
Public variable float BrakingDecelerationFalling  
Public variable float BrakingDecelerationFlying  
Public variable float BrakingDecelerationSwimming  
Public variable float BrakingDecelerationWalking  
Public variable float BrakingFriction  
Public variable float BrakingFrictionFactor  
Public variable float BrakingSubStepTime  
Public variable bool bRequestedMoveUseAcceleration  
Public variable bool bRunPhysicsWithNoController  
Public variable bool bUseControllerDesiredRotation  
Public variable bool bUseFlatBaseForFloorChecks  
Public variable bool bUseSeparateBrakingFriction  
Public variable bool bWasSimulatingRootMotion  
Public variable FCollisionQueryParams CapsuleParams  
Public variable TUniquePtr< FCharacterAsyncInput > CharacterInput  
Public variable ECollisionChannel CollisionChannel  
Public variable FCollisionResponseParams CollisionResponseParams  
Public variable EMovementMode DefaultLandMovementMode  
Public variable float FallingLateralFriction  
Public variable float GravityZ  
Public variable float GroundFriction  
Public variable FCharacterMovementGTInputs GTInputs  
Public variable FVector InputVector  
Public variable float JumpZVelocity  
Public variable float LedgeCheckThreshold  
Public variable float MaxAcceleration  
Public variable float MaxCustomMovementSpeed  
Public variable float MaxDepenetrationWithGeometry  
Public variable float MaxDepenetrationWithGeometryAsProxy  
Public variable float MaxDepenetrationWithPawn  
Public variable float MaxDepenetrationWithPawnAsProxy  
Public variable float MaxFlySpeed  
Public variable int32 MaxJumpApexAttemptsPerSimulation  
Public variable int32 MaxSimulationIterations  
Public variable float MaxSimulationTimeStep  
Public variable float MaxStepHeight  
Public variable float MaxSwimSpeed  
Public variable float MaxWalkSpeed  
Public variable float MaxWalkSpeedCrouched  
Public variable float MinAnalogWalkSpeed  
Public variable FCachedMovementBaseAsyncData MovementBaseAsyncData  
Public variable ENetworkSmoothingMode NetworkSmoothingMode  
Public variable float PerchAdditionalHeight  
Public variable float PerchRadiusThreshold  
Public variable float PhysicsVolumeTerminalVelocity  
Public variable FVector PlaneConstraintNormal  
Public variable FVector PlaneConstraintOrigin  
Public variable FComponentQueryParams QueryParams Primitive component InitSweepCollisionParams
Public variable FRandomStream RandomStream  
Public variable FRootMotionAsyncData RootMotion  
Public variable FRotator RotationRate  
Public variable TUniquePtr< FUpdatedComponentAsyncInput > UpdatedComponentInput  
Public variable float WalkableFloorZ  
Public variable UWorld * World  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual Const void  
Public function Virtual Const void  
Public function Virtual Const bool

ApplyRequestedMove ( float DeltaTime,
float MaxAccel,
float MaxSpeed,
float Friction,
float BrakingDeceleration,
FVector& OutAcceleration,
float& OutRequestedSpeed,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Const void  
Public function Virtual Const void

ApplyVelocityBraking ( float DeltaTime,
float Friction,
float BrakingDeceleration,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const float

BoostAirControl ( float DeltaTime,
float TickAirControl,
const FVector& FallAcceleration,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Const FVector

CalcAnimRootMotionVelocity ( const FVector& RootMotionDeltaMove,
float DeltaSeconds,
const FVector& CurrentVelocity
)

  
Public function Virtual Const void

CalcVelocity ( float DeltaTime,
float Friction,
bool bFluid,
float BrakingDeceleration,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

CheckFall ( const FFindFloorResult& OldFloor,
const FHitResult& Hit,
const FVector& Delta,
const FVector& OldLocation,
float remainingTime,
float timeTick,
int32 Iterations,
bool bMustJump,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const bool

CheckLedgeDirection ( const FVector& OldLocation,
const FVector& SideStep,
const FVector& GravDir,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void  
Public function Virtual Const float

ComputeAnalogInputModifier ( FVector Acceleration
)

  
Public function Virtual Const void

ComputeFloorDist ( const FVector& CapsuleLocation,
float LineDistance,
float SweepDistance,
FFindFloorResult& OutFloorResult,
float SweepRadius,
FCharacterMovementComponentAsyncOutput& Output,
const FHitResult* DownwardSweepResult
)

  
Public function Virtual Const FVector

ComputeGroundMovementDelta ( const FVector& Delta,
const FHitResult& RampHit,
const bool bHitFromLineTrace,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const FRotator

ComputeOrientToMovementRotation ( const FRotator& CurrentRotation,
float DeltaTime,
FRotator& DeltaRotation,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const bool

ComputePerchResult ( const float TestRadius,
const FHitResult& InHit,
const float InMaxFloorDist,
FFindFloorResult& OutPerchFloorResult,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const FVector

ComputeSlideVector ( const FVector& Delta,
const float Time,
const FVector& Normal,
const FHitResult& Hit,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Const FVector

ConstrainAnimRootMotionVelocity ( const FVector& RootMotionVelocity,
const FVector& CurrentVelocity,
FCharacterMovementComponentAsyncOutput& Output
)

 Root Motion Stuff.
Public function Virtual Const FVector

ConstrainDirectionToPlane ( FVector Direction
)

  
Public function Virtual Const FVector

ConstrainInputAcceleration ( FVector InputAcceleration,
const FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const FVector

ConstrainLocationToPlane ( FVector Location
)

  
Public function Virtual Const FVector

ConstrainNormalToPlane ( FVector Normal
)

  
Public function Virtual Const void

ControlledCharacterMove ( const float DeltaSeconds,
FCharacterMovementComponentAsyncOutput& Output
)

 TODO organize these.
Public function Virtual Const bool

DoJump ( bool bReplayingMoves,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void

FindFloor ( const FVector& CapsuleLocation,
FFindFloorResult& OutFloorResult,
bool bCanUseCachedLocation,
FCharacterMovementComponentAsyncOutput& Output,
const FHitResult* DownwardSweepResult
)

  
Public function Virtual Const bool

FloorSweepTest ( FHitResult& OutHit,
const FVector& Start,
const FVector& End,
ECollisionChannel TraceChannel,
const FCollisionShape& CollisionShape,
const FCollisionQueryParams& Params,
const FCollisionResponseParams& ResponseParam,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const FVector

GetAirControl ( float DeltaTime,
float TickAirControl,
const FVector& FallAcceleration,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const FVector  
Public function Virtual Const FVector

GetLedgeMove ( const FVector& OldLocation,
const FVector& Delta,
const FVector& GravDir,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Const FCollisionShape

GetPawnCapsuleCollisionShape ( const EShrinkCapsuleExtent ShrinkMode,
FCharacterMovementComponentAsyncOutput& Output,
const float CustomShrinkAmount
)

  
Public function Const FVector

GetPawnCapsuleExtent ( const EShrinkCapsuleExtent ShrinkMode,
const float CustomShrinkAmount,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const FVector  
Public function Const float  
Public function Const const FRotator &  
Public function Virtual Const float

GetSimulationTimeStep ( float RemainingTime,
int32 Iterations
)

  
Public function Const ETeleportType  
Public function Virtual Const float  
Public function Virtual Const void

HandleImpact ( const FHitResult& Impact,
FCharacterMovementComponentAsyncOutput& Output,
float TimeSlice,
const FVector& MoveDelta
)

  
Public function Virtual Const FVector

HandleSlopeBoosting ( const FVector& SlideResult,
const FVector& Delta,
const float Time,
const FVector& Normal,
const FHitResult& Hit,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void

HandleWalkingOffLedge ( const FVector& PreviousFloorImpactNormal,
const FVector& PreviousFloorContactNormal,
const FVector& PreviousLocation,
float TimeDelta
)

  
Public function void  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool UNavMovementComponent (super class) impl.
Public function Virtual Const bool  
Public function Virtual Const bool

IsValidLandingSpot ( const FVector& CapsuleLocation,
const FHitResult& Hit,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const bool

IsWalkable ( const FHitResult& Hit
)

  
Public function Virtual Const bool

IsWithinEdgeTolerance ( const FVector& CapsuleLocation,
const FVector& TestImpactPoint,
const float CapsuleRadius
)

  
Public function Virtual Const FVector

LimitAirControl ( float DeltaTime,
const FVector& FallAcceleration,
const FHitResult& HitResult,
bool bCheckForValidLandingSpot,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void  
Public function Virtual Const void  
Public function Virtual Const void

MoveAlongFloor ( const FVector& InVelocity,
float DeltaSeconds,
FStepDownResult* OutStepDownResult,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Const FVector

MoveComponent_ComputeSlideVector ( const FVector& Delta,
const float Time,
const FVector& Normal,
const FHitResult& Hit,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Const FVector More from UMovementComponent, this is not impl ported from CharacterMovementComponent, but super class, so we can call Super:: in CMC impl.
Public function Const float

MoveComponent_SlideAlongSurface ( const FVector& Delta,
float Time,
const FVector& Normal,
FHitResult& Hit,
FCharacterMovementComponentAsyncOutput& Output,
bool bHandleImpact
)

  
Public function Virtual Const bool

MoveUpdatedComponent ( const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
FCharacterMovementComponentAsyncOutput& Output,
FHitResult* OutHitResult,
ETeleportType TeleportType
)

  
Public function Virtual Const FVector

NewFallVelocity ( const FVector& InitialVelocity,
const FVector& Gravity,
float DeltaTime,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void  
Public function Virtual Const void

OnMovementModeChanged ( EMovementMode PreviousMovementMode,
uint8 PreviousCustomMode,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void  
Public function Virtual Const void

PhysFalling ( float deltaTime,
int32 Iterations,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void  
Public function Virtual Const void

PhysWalking ( float deltaTime,
int32 Iterations,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void

ProcessLanded ( const FHitResult& Hit,
float remainingTime,
int32 Iterations,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function void

Reset ()

  
Public function Virtual Const bool

ResolvePenetration ( const FVector& Adjustment,
const FHitResult& Hit,
const FQuat& NewRotation,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Const void  
Public function Const void

RevertMove ( const FVector& OldLocation,
UPrimitiveComponent* OldBase,
const FVector& PreviousBaseLocation,
const FFindFloorResult& OldFloor,
bool bFailMove,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const bool

SafeMoveUpdatedComponent ( const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
FHitResult& OutHit,
FCharacterMovementComponentAsyncOutput& Output,
ETeleportType Teleport
)

  
Public function Virtual Const FVector

ScaleInputAcceleration ( FVector InputAcceleration,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Const void  
Public function Virtual Const void  
Public function Virtual Const void

SetMovementMode ( EMovementMode NewMovementMode,
FCharacterMovementComponentAsyncOutput& Output,
uint8 NewCustomMode
)

  
Public function Virtual Const void  
Public function Virtual Const bool

ShouldCatchAir ( const FFindFloorResult& OldFloor,
const FFindFloorResult& NewFloor
)

  
Public function Virtual Const bool

ShouldCheckForValidLandingSpot ( float DeltaTime,
const FVector& Delta,
const FHitResult& Hit,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const bool  
Public function Virtual Const bool

ShouldComputePerchResult ( const FHitResult& InHit,
FCharacterMovementComponentAsyncOutput& Output,
bool bCheckRadius
)

  
Public function Virtual Const bool

ShouldLimitAirControl ( float DeltaTime,
const FVector& FallAcceleration,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const bool  
Public function Const void

Simulate ( const float DeltaSeconds,
FCharacterMovementComponentAsyncOutput& Output
)

 Entry point of async tick.
Public function Virtual Const float

SlideAlongSurface ( const FVector& Delta,
float Time,
const FVector& InNormal,
FHitResult& Hit,
bool bHandleImpact,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void

StartFalling ( int32 Iterations,
float remainingTime,
float timeTick,
const FVector& Delta,
const FVector& subLoc,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const void

StartNewPhysics ( float deltaTime,
int32 Iterations,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Virtual Const bool

StepUp ( const FVector& GravDir,
const FVector& Delta,
const FHitResult& Hit,
FCharacterMovementComponentAsyncOutput& Output,
FStepDownResult* OutStepDownResult
)

  
Public function Const void

TwoWallAdjust ( FVector& OutDelta,
const FHitResult& Hit,
const FVector& OldHitNormal,
FCharacterMovementComponentAsyncOutput& Output
)

  
Public function Const void  
Public function Virtual Const void  
Public function Virtual Const void  

Typedefs

Name Description
FCharacterInput  
FUpdatedComponentInput  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page