FCharacterMovementComponentAsyncInput

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSimCallbackInput

FCharacterMovementComponentAsyncInput

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

	Name	Description
float	AirControl
float	AirControlBoostMultiplier
float	AirControlBoostVelocityThreshold
TSharedPtr< FCh...	AsyncSimState	This is the latest simulated state of this movement component.
bool	bAllowPhysicsRotationDuringAnimRootMotion
bool	bAlwaysCheckFloor
bool	bApplyGravityWhileJumping
bool	bCanEverCrouch
bool	bCanWalkOffLedges
bool	bCanWalkOffLedgesWhenCrouching
bool	bConstrainToPlane
bool	bDeferUpdateMoveComponent
bool	bForceMaxAccel
bool	bHasValidData
bool	bIgnoreBaseRotation
bool	bInitialized	Has this been filled out?
bool	bIsNetModeClient
bool	bMaintainHorizontalGroundVelocity
bool	bMovementStateCanJump
bool	bNavAgentPropsCanJump
bool	bOrientRotationToMovement
float	BrakingDecelerationFalling
float	BrakingDecelerationFlying
float	BrakingDecelerationSwimming
float	BrakingDecelerationWalking
float	BrakingFriction
float	BrakingFrictionFactor
float	BrakingSubStepTime
bool	bRequestedMoveUseAcceleration
bool	bRunPhysicsWithNoController
bool	bUseControllerDesiredRotation
bool	bUseFlatBaseForFloorChecks
bool	bUseSeparateBrakingFriction
bool	bWasSimulatingRootMotion
FCollisionQuery...	CapsuleParams
TUniquePtr< FCh...	CharacterInput
ECollisionChann...	CollisionChannel
FCollisionRespo...	CollisionResponseParams
EMovementMode	DefaultLandMovementMode
float	FallingLateralFriction
float	GravityZ
float	GroundFriction
FCharacterMovem...	GTInputs
FVector	InputVector
float	JumpZVelocity
float	LedgeCheckThreshold
float	MaxAcceleration
float	MaxCustomMovementSpeed
float	MaxDepenetrationWithGeometry
float	MaxDepenetrationWithGeometryAsProxy
float	MaxDepenetrationWithPawn
float	MaxDepenetrationWithPawnAsProxy
float	MaxFlySpeed
int32	MaxJumpApexAttemptsPerSimulation
int32	MaxSimulationIterations
float	MaxSimulationTimeStep
float	MaxStepHeight
float	MaxSwimSpeed
float	MaxWalkSpeed
float	MaxWalkSpeedCrouched
float	MinAnalogWalkSpeed
FCachedMovement...	MovementBaseAsyncData
ENetworkSmoothi...	NetworkSmoothingMode
float	PerchAdditionalHeight
float	PerchRadiusThreshold
float	PhysicsVolumeTerminalVelocity
FVector	PlaneConstraintNormal
FVector	PlaneConstraintOrigin
FComponentQuery...	QueryParams	Primitive component InitSweepCollisionParams
FRandomStream	RandomStream
FRootMotionAsyn...	RootMotion
FRotator	RotationRate
TUniquePtr< FUp...	UpdatedComponentInput
float	WalkableFloorZ
UWorld *	World

Destructors

	Name	Description
	~FCharacterMovementComponentAsyncInput()

Functions

	Name	Description
void	AdjustFloorHeight ( FCharacterMovementComponentAsyncOut... )
void	ApplyAccumulatedForces ( float DeltaSeconds, FCharacterMovementComponentAsyncOut... )
bool	ApplyRequestedMove ( float DeltaTime, float MaxAccel, float MaxSpeed, float Friction, float BrakingDeceleration, FVector& OutAcceleration, float& OutRequestedSpeed, FCharacterMovementComponentAsyncOut... )
void	ApplyRootMotionToVelocity ( float deltaTime, FCharacterMovementComponentAsyncOut... )
void	ApplyVelocityBraking ( float DeltaTime, float Friction, float BrakingDeceleration, FCharacterMovementComponentAsyncOut... )
float	BoostAirControl ( float DeltaTime, float TickAirControl, const FVector& FallAcceleration, FCharacterMovementComponentAsyncOut... )
FVector	CalcAnimRootMotionVelocity ( const FVector& RootMotionDeltaMove, float DeltaSeconds, const FVector& CurrentVelocity )
void	CalcVelocity ( float DeltaTime, float Friction, bool bFluid, float BrakingDeceleration, FCharacterMovementComponentAsyncOut... )
bool	CanAttemptJump ( FCharacterMovementComponentAsyncOut... )
bool	CanCrouchInCurrentState ( FCharacterMovementComponentAsyncOut... )
bool	CanStepUp ( const FHitResult& Hit, FCharacterMovementComponentAsyncOut... )
bool	CanWalkOffLedges ( FCharacterMovementComponentAsyncOut... )
bool	CheckFall ( const FFindFloorResult& OldFloor, const FHitResult& Hit, const FVector& Delta, const FVector& OldLocation, float remainingTime, float timeTick, int32 Iterations, bool bMustJump, FCharacterMovementComponentAsyncOut... )
bool	CheckLedgeDirection ( const FVector& OldLocation, const FVector& SideStep, const FVector& GravDir, FCharacterMovementComponentAsyncOut... )
void	ClearAccumulatedForces ( FCharacterMovementComponentAsyncOut... )
float	ComputeAnalogInputModifier ( FVector Acceleration )
void	ComputeFloorDist ( const FVector& CapsuleLocation, float LineDistance, float SweepDistance, FFindFloorResult& OutFloorResult, float SweepRadius, FCharacterMovementComponentAsyncOut..., const FHitResult* DownwardSwee... )
FVector	ComputeGroundMovementDelta ( const FVector& Delta, const FHitResult& RampHit, const bool bHitFromLineTrace, FCharacterMovementComponentAsyncOut... )
FRotator	ComputeOrientToMovementRotation ( const FRotator& CurrentRotation, float DeltaTime, FRotator& DeltaRotation, FCharacterMovementComponentAsyncOut... )
bool	ComputePerchResult ( const float TestRadius, const FHitResult& InHit, const float InMaxFloorDist, FFindFloorResult& OutPerchFloorRes..., FCharacterMovementComponentAsyncOut... )
FVector	ComputeSlideVector ( const FVector& Delta, const float Time, const FVector& Normal, const FHitResult& Hit, FCharacterMovementComponentAsyncOut... )
FVector	ConstrainAnimRootMotionVelocity ( const FVector& RootMotionVelocity, const FVector& CurrentVelocity, FCharacterMovementComponentAsyncOut... )	Root Motion Stuff.
FVector	ConstrainDirectionToPlane ( FVector Direction )
FVector	ConstrainInputAcceleration ( FVector InputAcceleration, const FCharacterMovementComponentAs... )
FVector	ConstrainLocationToPlane ( FVector Location )
FVector	ConstrainNormalToPlane ( FVector Normal )
void	ControlledCharacterMove ( const float DeltaSeconds, FCharacterMovementComponentAsyncOut... )	TODO organize these.
bool	DoJump ( bool bReplayingMoves, FCharacterMovementComponentAsyncOut... )
void	FindFloor ( const FVector& CapsuleLocation, FFindFloorResult& OutFloorResult, bool bCanUseCachedLocation, FCharacterMovementComponentAsyncOut..., const FHitResult* DownwardSwee... )
bool	FloorSweepTest ( FHitResult& OutHit, const FVector& Start, const FVector& End, ECollisionChannel TraceChannel, const FCollisionShape& CollisionSh..., const FCollisionQueryParams& Param..., const FCollisionResponseParams& Re..., FCharacterMovementComponentAsyncOut... )
FVector	GetAirControl ( float DeltaTime, float TickAirControl, const FVector& FallAcceleration, FCharacterMovementComponentAsyncOut... )
FVector	GetFallingLateralAcceleration ( float DeltaTime, FCharacterMovementComponentAsyncOut... )
FVector	GetLedgeMove ( const FVector& OldLocation, const FVector& Delta, const FVector& GravDir, FCharacterMovementComponentAsyncOut... )
float	GetMaxBrakingDeceleration ( FCharacterMovementComponentAsyncOut... )
float	GetMaxSpeed ( FCharacterMovementComponentAsyncOut... )
float	GetMinAnalogSpeed ( FCharacterMovementComponentAsyncOut... )
FCollisionSh...	GetPawnCapsuleCollisionShape ( const EShrinkCapsuleExtent ShrinkMo..., FCharacterMovementComponentAsyncOut..., const float CustomShrinkAmount )
FVector	GetPawnCapsuleExtent ( const EShrinkCapsuleExtent ShrinkMo..., const float CustomShrinkAmount, FCharacterMovementComponentAsyncOut... )
FVector	GetPenetrationAdjustment ( FHitResult& HitResult )
float	GetPerchRadiusThreshold()
const FRotat...	GetRotationRate ( const FCharacterMovementComponentAs... )
float	GetSimulationTimeStep ( float RemainingTime, int32 Iterations )
ETeleportTyp...	GetTeleportType ( FCharacterMovementComponentAsyncOut... )
float	GetValidPerchRadius ( const FCharacterMovementComponentAs... )
void	HandleImpact ( const FHitResult& Impact, FCharacterMovementComponentAsyncOut..., float TimeSlice, const FVector& MoveDelta )
FVector	HandleSlopeBoosting ( const FVector& SlideResult, const FVector& Delta, const float Time, const FVector& Normal, const FHitResult& Hit, FCharacterMovementComponentAsyncOut... )
void	HandleWalkingOffLedge ( const FVector& PreviousFloorImpact..., const FVector& PreviousFloorContac..., const FVector& PreviousLocation, float TimeDelta )
void	Initialize()
bool	IsCrouching ( const FCharacterMovementComponentAs... )
bool	IsExceedingMaxSpeed ( float MaxSpeed, const FCharacterMovementComponentAs... )
bool	IsFalling ( const FCharacterMovementComponentAs... )
bool	IsFlying ( const FCharacterMovementComponentAs... )
bool	IsJumpAllowed()	UNavMovementComponent (super class) impl.
bool	IsMovingOnGround ( const FCharacterMovementComponentAs... )
bool	IsValidLandingSpot ( const FVector& CapsuleLocation, const FHitResult& Hit, FCharacterMovementComponentAsyncOut... )
bool	IsWalkable ( const FHitResult& Hit )
bool	IsWithinEdgeTolerance ( const FVector& CapsuleLocation, const FVector& TestImpactPoint, const float CapsuleRadius )
FVector	LimitAirControl ( float DeltaTime, const FVector& FallAcceleration, const FHitResult& HitResult, bool bCheckForValidLandingSpot, FCharacterMovementComponentAsyncOut... )
void	MaintainHorizontalGroundVelocity ( FCharacterMovementComponentAsyncOut... )
void	MaybeUpdateBasedMovement ( float DeltaSeconds, FCharacterMovementComponentAsyncOut... )
void	MoveAlongFloor ( const FVector& InVelocity, float DeltaSeconds, FStepDownResult* OutStepDownRe..., FCharacterMovementComponentAsyncOut... )
FVector	MoveComponent_ComputeSlideVector ( const FVector& Delta, const float Time, const FVector& Normal, const FHitResult& Hit, FCharacterMovementComponentAsyncOut... )
FVector	MoveComponent_GetPenetrationAdjustment ( FHitResult& HitResult )	More from UMovementComponent, this is not impl ported from CharacterMovementComponent, but super class, so we can call Super:: in CMC impl.
float	MoveComponent_SlideAlongSurface ( const FVector& Delta, float Time, const FVector& Normal, FHitResult& Hit, FCharacterMovementComponentAsyncOut..., bool bHandleImpact )
bool	MoveUpdatedComponent ( const FVector& Delta, const FQuat& NewRotation, bool bSweep, FCharacterMovementComponentAsyncOut..., FHitResult* OutHitResult, ETeleportType TeleportType )
FVector	NewFallVelocity ( const FVector& InitialVelocity, const FVector& Gravity, float DeltaTime, FCharacterMovementComponentAsyncOut... )
void	OnCharacterStuckInGeometry ( const FHitResult* Hit, FCharacterMovementComponentAsyncOut... )
void	OnMovementModeChanged ( EMovementMode PreviousMovementMode, uint8 PreviousCustomMode, FCharacterMovementComponentAsyncOut... )
void	PerformMovement ( float DeltaSeconds, FCharacterMovementComponentAsyncOut... )
void	PhysFalling ( float deltaTime, int32 Iterations, FCharacterMovementComponentAsyncOut... )
void	PhysicsRotation ( float DeltaTime, FCharacterMovementComponentAsyncOut... )
void	PhysWalking ( float deltaTime, int32 Iterations, FCharacterMovementComponentAsyncOut... )
void	ProcessLanded ( const FHitResult& Hit, float remainingTime, int32 Iterations, FCharacterMovementComponentAsyncOut... )
void	Reset()
bool	ResolvePenetration ( const FVector& Adjustment, const FHitResult& Hit, const FQuat& NewRotation, FCharacterMovementComponentAsyncOut... )
void	RestorePreAdditiveRootMotionVelocity ( FCharacterMovementComponentAsyncOut... )
void	RevertMove ( const FVector& OldLocation, UPrimitiveComponent* OldBase, const FVector& PreviousBaseLocatio..., const FFindFloorResult& OldFloor, bool bFailMove, FCharacterMovementComponentAsyncOut... )
bool	SafeMoveUpdatedComponent ( const FVector& Delta, const FQuat& NewRotation, bool bSweep, FHitResult& OutHit, FCharacterMovementComponentAsyncOut..., ETeleportType Teleport )
FVector	ScaleInputAcceleration ( FVector InputAcceleration, FCharacterMovementComponentAsyncOut... )
void	SetBaseFromFloor ( const FFindFloorResult& FloorResul..., FCharacterMovementComponentAsyncOut... )
void	SetDefaultMovementMode ( FCharacterMovementComponentAsyncOut... )
void	SetMovementMode ( EMovementMode NewMovementMode, FCharacterMovementComponentAsyncOut..., uint8 NewCustomMode )
void	SetPostLandedPhysics ( const FHitResult& Hit, FCharacterMovementComponentAsyncOut... )
bool	ShouldCatchAir ( const FFindFloorResult& OldFloor, const FFindFloorResult& NewFloor )
bool	ShouldCheckForValidLandingSpot ( float DeltaTime, const FVector& Delta, const FHitResult& Hit, FCharacterMovementComponentAsyncOut... )
bool	ShouldComputeAccelerationToReachRequestedVelocity ( const float RequestedSpeed, FCharacterMovementComponentAsyncOut... )
bool	ShouldComputePerchResult ( const FHitResult& InHit, FCharacterMovementComponentAsyncOut..., bool bCheckRadius )
bool	ShouldLimitAirControl ( float DeltaTime, const FVector& FallAcceleration, FCharacterMovementComponentAsyncOut... )
bool	ShouldRemainVertical ( FCharacterMovementComponentAsyncOut... )
void	Simulate ( const float DeltaSeconds, FCharacterMovementComponentAsyncOut... )	Entry point of async tick.
float	SlideAlongSurface ( const FVector& Delta, float Time, const FVector& InNormal, FHitResult& Hit, bool bHandleImpact, FCharacterMovementComponentAsyncOut... )
void	StartFalling ( int32 Iterations, float remainingTime, float timeTick, const FVector& Delta, const FVector& subLoc, FCharacterMovementComponentAsyncOut... )
void	StartNewPhysics ( float deltaTime, int32 Iterations, FCharacterMovementComponentAsyncOut... )
bool	StepUp ( const FVector& GravDir, const FVector& Delta, const FHitResult& Hit, FCharacterMovementComponentAsyncOut..., FStepDownResult* OutStepDownRe... )
void	TwoWallAdjust ( FVector& OutDelta, const FHitResult& Hit, const FVector& OldHitNormal, FCharacterMovementComponentAsyncOut... )
void	UpdateAsyncStateFromGTInputs_Internal()
void	UpdateBasedMovement ( float DeltaSeconds, FCharacterMovementComponentAsyncOut... )
void	UpdateCharacterStateAfterMovement ( float DeltaSeconds, FCharacterMovementComponentAsyncOut... )

Typedefs

Name	Description
FCharacterInput
FUpdatedComponentInput