UCharacterMovementComponent::K2_ComputeFloorDist

Compute distance to the floor from bottom sphere of capsule and store the result in FloorResult.

Choose your operating system:

Windows

macOS

Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/CharacterMovementComponent.h

Include

#include "GameFramework/CharacterMovementComponent.h"

Source

/Engine/Source/Runtime/Engine/Private/Components/CharacterMovementComponent.cpp

Syntax

virtual void K2_ComputeFloorDist
(
    FVector CapsuleLocation,
    float LineDistance,
    float SweepDistance,
    float SweepRadius,
    FFindFloorResult & FloorResult
) const

Remarks

Compute distance to the floor from bottom sphere of capsule and store the result in FloorResult. This distance is the swept distance of the capsule to the first point impacted by the lower hemisphere, or distance from the bottom of the capsule in the case of a line trace. This function does not care if collision is disabled on the capsule (unlike FindFloor).

Parameters

Parameter

Description

CapsuleLocation

Location where the capsule sweep should originate

LineDistance

If non-zero, max distance to test for a simple line check from the capsule base. Used only if the sweep test fails to find a walkable floor, and only returns a valid result if the impact normal is a walkable normal.

SweepDistance

If non-zero, max distance to use when sweeping a capsule downwards for the test. MUST be greater than or equal to the line distance.

SweepRadius

The radius to use for sweep tests. Should be <= capsule radius.

FloorResult

Result of the floor check