Navigation
API > API/Runtime > API/Runtime/Engine
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.
| Name | FCharacterMovementComponentAsyncInput |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/CharacterMovementComponentAsync.h |
| Include Path | #include "CharacterMovementComponentAsync.h" |
Syntax
struct FCharacterMovementComponentAsyncInput : public Chaos::FSimCallbackInput
Inheritance Hierarchy
- FSimCallbackInput → FCharacterMovementComponentAsyncInput
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FCharacterMovementComponentAsyncInput() |
CharacterMovementComponentAsync.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCharacterInput | FCharacterAsyncInput | CharacterMovementComponentAsync.h | |
| FUpdatedComponentInput | FUpdatedComponentAsyncInput | CharacterMovementComponentAsync.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AirControl | float | CharacterMovementComponentAsync.h | ||
| AirControlBoostMultiplier | float | CharacterMovementComponentAsync.h | ||
| AirControlBoostVelocityThreshold | float | CharacterMovementComponentAsync.h | ||
| AsyncSimState | TSharedPtr< FCharacterMovementComponentAsyncOutput, ESPMode::ThreadSafe > | This is the latest simulated state of this movement component. | CharacterMovementComponentAsync.h | |
| bAllowPhysicsRotationDuringAnimRootMotion | bool | CharacterMovementComponentAsync.h | ||
| bAlwaysCheckFloor | bool | CharacterMovementComponentAsync.h | ||
| bApplyGravityWhileJumping | bool | CharacterMovementComponentAsync.h | ||
| bCanEverCrouch | bool | CharacterMovementComponentAsync.h | ||
| bCanWalkOffLedges | bool | CharacterMovementComponentAsync.h | ||
| bCanWalkOffLedgesWhenCrouching | bool | CharacterMovementComponentAsync.h | ||
| bConstrainToPlane | bool | CharacterMovementComponentAsync.h | ||
| bDeferUpdateMoveComponent | bool | CharacterMovementComponentAsync.h | ||
| bDontFallBelowJumpZVelocityDuringJump | bool | CharacterMovementComponentAsync.h | ||
| bForceMaxAccel | bool | CharacterMovementComponentAsync.h | ||
| bHasValidData | bool | CharacterMovementComponentAsync.h | ||
| bIgnoreBaseRotation | bool | CharacterMovementComponentAsync.h | ||
| bInitialized | bool | Has this been filled out? | CharacterMovementComponentAsync.h | |
| bIsNetModeClient | bool | CharacterMovementComponentAsync.h | ||
| bMaintainHorizontalGroundVelocity | bool | CharacterMovementComponentAsync.h | ||
| bMovementStateCanJump | bool | CharacterMovementComponentAsync.h | ||
| bNavAgentPropsCanJump | bool | CharacterMovementComponentAsync.h | ||
| bOrientRotationToMovement | bool | CharacterMovementComponentAsync.h | ||
| BrakingDecelerationFalling | float | CharacterMovementComponentAsync.h | ||
| BrakingDecelerationFlying | float | CharacterMovementComponentAsync.h | ||
| BrakingDecelerationSwimming | float | CharacterMovementComponentAsync.h | ||
| BrakingDecelerationWalking | float | CharacterMovementComponentAsync.h | ||
| BrakingFriction | float | CharacterMovementComponentAsync.h | ||
| BrakingFrictionFactor | float | CharacterMovementComponentAsync.h | ||
| BrakingSubStepTime | float | CharacterMovementComponentAsync.h | ||
| bRequestedMoveUseAcceleration | bool | CharacterMovementComponentAsync.h | ||
| bRunPhysicsWithNoController | bool | CharacterMovementComponentAsync.h | ||
| bUseControllerDesiredRotation | bool | CharacterMovementComponentAsync.h | ||
| bUseFlatBaseForFloorChecks | bool | CharacterMovementComponentAsync.h | ||
| bUseSeparateBrakingFriction | bool | CharacterMovementComponentAsync.h | ||
| bWasSimulatingRootMotion | bool | CharacterMovementComponentAsync.h | ||
| CapsuleParams | FCollisionQueryParams | CharacterMovementComponentAsync.h | ||
| CharacterInput | TUniquePtr< FCharacterAsyncInput > | CharacterMovementComponentAsync.h | ||
| CollisionChannel | ECollisionChannel | CharacterMovementComponentAsync.h | ||
| CollisionResponseParams | FCollisionResponseParams | CharacterMovementComponentAsync.h | ||
| DefaultLandMovementMode | EMovementMode | CharacterMovementComponentAsync.h | ||
| FallingLateralFriction | float | CharacterMovementComponentAsync.h | ||
| GravityZ | float | CharacterMovementComponentAsync.h | ||
| GroundFriction | float | CharacterMovementComponentAsync.h | ||
| GTInputs | FCharacterMovementGTInputs | CharacterMovementComponentAsync.h | ||
| InputVector | FVector | CharacterMovementComponentAsync.h | ||
| JumpZVelocity | float | CharacterMovementComponentAsync.h | ||
| LedgeCheckThreshold | float | CharacterMovementComponentAsync.h | ||
| MaxAcceleration | float | CharacterMovementComponentAsync.h | ||
| MaxCustomMovementSpeed | float | CharacterMovementComponentAsync.h | ||
| MaxDepenetrationWithGeometry | float | CharacterMovementComponentAsync.h | ||
| MaxDepenetrationWithGeometryAsProxy | float | CharacterMovementComponentAsync.h | ||
| MaxDepenetrationWithPawn | float | CharacterMovementComponentAsync.h | ||
| MaxDepenetrationWithPawnAsProxy | float | CharacterMovementComponentAsync.h | ||
| MaxFlySpeed | float | CharacterMovementComponentAsync.h | ||
| MaxJumpApexAttemptsPerSimulation | int32 | CharacterMovementComponentAsync.h | ||
| MaxSimulationIterations | int32 | CharacterMovementComponentAsync.h | ||
| MaxSimulationTimeStep | float | CharacterMovementComponentAsync.h | ||
| MaxStepHeight | float | CharacterMovementComponentAsync.h | ||
| MaxSwimSpeed | float | CharacterMovementComponentAsync.h | ||
| MaxWalkSpeed | float | CharacterMovementComponentAsync.h | ||
| MaxWalkSpeedCrouched | float | CharacterMovementComponentAsync.h | ||
| MinAnalogWalkSpeed | float | CharacterMovementComponentAsync.h | ||
| MovementBaseAsyncData | FCachedMovementBaseAsyncData | CharacterMovementComponentAsync.h | ||
| NetworkSmoothingMode | ENetworkSmoothingMode | CharacterMovementComponentAsync.h | ||
| PerchAdditionalHeight | float | CharacterMovementComponentAsync.h | ||
| PerchRadiusThreshold | float | CharacterMovementComponentAsync.h | ||
| PhysicsVolumeTerminalVelocity | float | CharacterMovementComponentAsync.h | ||
| PlaneConstraintNormal | FVector | CharacterMovementComponentAsync.h | ||
| PlaneConstraintOrigin | FVector | CharacterMovementComponentAsync.h | ||
| QueryParams | FComponentQueryParams | Primitive component InitSweepCollisionParams | CharacterMovementComponentAsync.h | |
| RandomStream | FRandomStream | CharacterMovementComponentAsync.h | ||
| RootMotion | FRootMotionAsyncData | CharacterMovementComponentAsync.h | ||
| RotationRate | FRotator | CharacterMovementComponentAsync.h | ||
| UpdatedComponentInput | TUniquePtr< FUpdatedComponentAsyncInput > | CharacterMovementComponentAsync.h | ||
| WalkableFloorZ | float | CharacterMovementComponentAsync.h | ||
| World | UWorld * | CharacterMovementComponentAsync.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AdjustFloorHeight
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual void ApplyAccumulatedForces
(
float DeltaSeconds, |
CharacterMovementComponentAsync.h | ||
virtual bool ApplyRequestedMove
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
void ApplyRootMotionToVelocity
(
float deltaTime, |
CharacterMovementComponentAsync.h | ||
virtual void ApplyVelocityBraking
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
virtual float BoostAirControl
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
FVector CalcAnimRootMotionVelocity
(
const FVector& RootMotionDeltaMove, |
CharacterMovementComponentAsync.h | ||
virtual void CalcVelocity
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
virtual bool CanAttemptJump
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual bool CanCrouchInCurrentState
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual bool CanStepUp
(
const FHitResult& Hit, |
CharacterMovementComponentAsync.h | ||
virtual bool CanWalkOffLedges
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual bool CheckFall
(
const FFindFloorResult& OldFloor, |
CharacterMovementComponentAsync.h | ||
virtual bool CheckLedgeDirection
(
const FVector& OldLocation, |
CharacterMovementComponentAsync.h | ||
virtual void ClearAccumulatedForces
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual float ComputeAnalogInputModifier
(
FVector Acceleration |
CharacterMovementComponentAsync.h | ||
virtual void ComputeFloorDist
(
const FVector& CapsuleLocation, |
CharacterMovementComponentAsync.h | ||
virtual FVector ComputeGroundMovementDelta
(
const FVector& Delta, |
CharacterMovementComponentAsync.h | ||
virtual FRotator ComputeOrientToMovementRotation
(
const FRotator& CurrentRotation, |
CharacterMovementComponentAsync.h | ||
virtual bool ComputePerchResult
(
const float TestRadius, |
CharacterMovementComponentAsync.h | ||
virtual FVector ComputeSlideVector
(
const FVector& Delta, |
CharacterMovementComponentAsync.h | ||
FVector ConstrainAnimRootMotionVelocity
(
const FVector& RootMotionVelocity, |
Root Motion Stuff. | CharacterMovementComponentAsync.h | |
virtual FVector ConstrainDirectionToPlane
(
FVector Direction |
CharacterMovementComponentAsync.h | ||
virtual FVector ConstrainInputAcceleration
(
FVector InputAcceleration, |
CharacterMovementComponentAsync.h | ||
virtual FVector ConstrainLocationToPlane
(
FVector Location |
CharacterMovementComponentAsync.h | ||
virtual FVector ConstrainNormalToPlane
(
FVector Normal |
CharacterMovementComponentAsync.h | ||
virtual void ControlledCharacterMove
(
const float DeltaSeconds, |
TODO organize these. | CharacterMovementComponentAsync.h | |
virtual bool DoJump
(
bool bReplayingMoves, |
CharacterMovementComponentAsync.h | ||
virtual void FindFloor
(
const FVector& CapsuleLocation, |
CharacterMovementComponentAsync.h | ||
virtual bool FloorSweepTest
(
FHitResult& OutHit, |
CharacterMovementComponentAsync.h | ||
virtual FVector GetAirControl
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
virtual FVector GetFallingLateralAcceleration
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
virtual FVector GetLedgeMove
(
const FVector& OldLocation, |
CharacterMovementComponentAsync.h | ||
virtual float GetMaxBrakingDeceleration
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual float GetMaxSpeed
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual float GetMinAnalogSpeed
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
FCollisionShape GetPawnCapsuleCollisionShape
(
const EShrinkCapsuleExtent ShrinkMode, |
CharacterMovementComponentAsync.h | ||
FVector GetPawnCapsuleExtent
(
const EShrinkCapsuleExtent ShrinkMode, |
CharacterMovementComponentAsync.h | ||
virtual FVector GetPenetrationAdjustment
(
FHitResult& HitResult |
CharacterMovementComponentAsync.h | ||
float GetPerchRadiusThreshold() |
CharacterMovementComponentAsync.h | ||
const FRotator & GetRotationRate
(
const FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual float GetSimulationTimeStep
(
float RemainingTime, |
CharacterMovementComponentAsync.h | ||
ETeleportType GetTeleportType
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual float GetValidPerchRadius
(
const FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual void HandleImpact
(
const FHitResult& Impact, |
CharacterMovementComponentAsync.h | ||
virtual FVector HandleSlopeBoosting
(
const FVector& SlideResult, |
CharacterMovementComponentAsync.h | ||
virtual void HandleWalkingOffLedge
(
const FVector& PreviousFloorImpactNormal, |
CharacterMovementComponentAsync.h | ||
void Initialize() |
CharacterMovementComponentAsync.h | ||
virtual bool IsCrouching
(
const FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual bool IsExceedingMaxSpeed
(
float MaxSpeed, |
CharacterMovementComponentAsync.h | ||
virtual bool IsFalling
(
const FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual bool IsFlying
(
const FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
bool IsJumpAllowed() |
UNavMovementComponent (super class) impl. | CharacterMovementComponentAsync.h | |
virtual bool IsMovingOnGround
(
const FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual bool IsValidLandingSpot
(
const FVector& CapsuleLocation, |
CharacterMovementComponentAsync.h | ||
virtual bool IsWalkable
(
const FHitResult& Hit |
CharacterMovementComponentAsync.h | ||
virtual bool IsWithinEdgeTolerance
(
const FVector& CapsuleLocation, |
CharacterMovementComponentAsync.h | ||
virtual FVector LimitAirControl
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
virtual void MaintainHorizontalGroundVelocity
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual void MaybeUpdateBasedMovement
(
float DeltaSeconds, |
CharacterMovementComponentAsync.h | ||
virtual void MoveAlongFloor
(
const FVector& InVelocity, |
CharacterMovementComponentAsync.h | ||
FVector MoveComponent_ComputeSlideVector
(
const FVector& Delta, |
CharacterMovementComponentAsync.h | ||
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. | CharacterMovementComponentAsync.h | |
float MoveComponent_SlideAlongSurface
(
const FVector& Delta, |
CharacterMovementComponentAsync.h | ||
virtual bool MoveUpdatedComponent
(
const FVector& Delta, |
CharacterMovementComponentAsync.h | ||
virtual FVector NewFallVelocity
(
const FVector& InitialVelocity, |
CharacterMovementComponentAsync.h | ||
virtual void OnCharacterStuckInGeometry
(
const FHitResult* Hit, |
CharacterMovementComponentAsync.h | ||
virtual void OnMovementModeChanged
(
EMovementMode PreviousMovementMode, |
CharacterMovementComponentAsync.h | ||
virtual void PerformMovement
(
float DeltaSeconds, |
CharacterMovementComponentAsync.h | ||
virtual void PhysFalling
(
float deltaTime, |
CharacterMovementComponentAsync.h | ||
virtual void PhysicsRotation
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
virtual void PhysWalking
(
float deltaTime, |
CharacterMovementComponentAsync.h | ||
virtual void ProcessLanded
(
const FHitResult& Hit, |
CharacterMovementComponentAsync.h | ||
void Reset() |
CharacterMovementComponentAsync.h | ||
virtual bool ResolvePenetration
(
const FVector& Adjustment, |
CharacterMovementComponentAsync.h | ||
void RestorePreAdditiveRootMotionVelocity
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
void RevertMove
(
const FVector& OldLocation, |
CharacterMovementComponentAsync.h | ||
virtual bool SafeMoveUpdatedComponent
(
const FVector& Delta, |
CharacterMovementComponentAsync.h | ||
virtual FVector ScaleInputAcceleration
(
FVector InputAcceleration, |
CharacterMovementComponentAsync.h | ||
void SetBaseFromFloor
(
const FFindFloorResult& FloorResult, |
CharacterMovementComponentAsync.h | ||
virtual void SetDefaultMovementMode
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
virtual void SetMovementMode
(
EMovementMode NewMovementMode, |
CharacterMovementComponentAsync.h | ||
virtual void SetPostLandedPhysics
(
const FHitResult& Hit, |
CharacterMovementComponentAsync.h | ||
virtual bool ShouldCatchAir
(
const FFindFloorResult& OldFloor, |
CharacterMovementComponentAsync.h | ||
virtual bool ShouldCheckForValidLandingSpot
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
virtual bool ShouldComputeAccelerationToReachRequestedVelocity
(
const float RequestedSpeed, |
CharacterMovementComponentAsync.h | ||
virtual bool ShouldComputePerchResult
(
const FHitResult& InHit, |
CharacterMovementComponentAsync.h | ||
virtual bool ShouldLimitAirControl
(
float DeltaTime, |
CharacterMovementComponentAsync.h | ||
virtual bool ShouldRemainVertical
(
FCharacterMovementComponentAsyncOutput& Output |
CharacterMovementComponentAsync.h | ||
void Simulate
(
const float DeltaSeconds, |
Entry point of async tick. | CharacterMovementComponentAsync.h | |
virtual float SlideAlongSurface
(
const FVector& Delta, |
CharacterMovementComponentAsync.h | ||
virtual void StartFalling
(
int32 Iterations, |
CharacterMovementComponentAsync.h | ||
virtual void StartNewPhysics
(
float deltaTime, |
CharacterMovementComponentAsync.h | ||
virtual bool StepUp
(
const FVector& GravDir, |
CharacterMovementComponentAsync.h | ||
void TwoWallAdjust
(
FVector& OutDelta, |
CharacterMovementComponentAsync.h | ||
void UpdateAsyncStateFromGTInputs_Internal() |
CharacterMovementComponentAsync.h | ||
virtual void UpdateBasedMovement
(
float DeltaSeconds, |
CharacterMovementComponentAsync.h | ||
virtual void UpdateCharacterStateAfterMovement
(
float DeltaSeconds, |
CharacterMovementComponentAsync.h |