UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FFindFloorResult Struct Reference

#include <CharacterMovementComponentAsync.h>

Public Member Functions

 FFindFloorResult ()
 
bool IsWalkableFloor () const
 
void Clear ()
 
float GetDistanceToFloor () const
 
ENGINE_API void SetFromSweep (const FHitResult &InHit, const float InSweepFloorDist, const bool bIsWalkableFloor)
 
ENGINE_API void SetFromLineTrace (const FHitResult &InHit, const float InSweepFloorDist, const float InLineDist, const bool bIsWalkableFloor)
 

Public Attributes

uint32 bBlockingHit: 1
 
uint32 bWalkableFloor: 1
 
uint32 bLineTrace: 1
 
float FloorDist
 
float LineDist
 
FHitResult HitResult
 

Detailed Description

Data about the floor for walking movement, used by CharacterMovementComponent.

Constructor & Destructor Documentation

◆ FFindFloorResult()

FFindFloorResult::FFindFloorResult ( )
inline

Member Function Documentation

◆ Clear()

void FFindFloorResult::Clear ( )
inline

◆ GetDistanceToFloor()

float FFindFloorResult::GetDistanceToFloor ( ) const
inline

Gets the distance to floor, either LineDist or FloorDist.

◆ IsWalkableFloor()

bool FFindFloorResult::IsWalkableFloor ( ) const
inline

Returns true if the floor result hit a walkable surface.

◆ SetFromLineTrace()

void FFindFloorResult::SetFromLineTrace ( const FHitResult InHit,
const float  InSweepFloorDist,
const float  InLineDist,
const bool  bIsWalkableFloor 
)

◆ SetFromSweep()

void FFindFloorResult::SetFromSweep ( const FHitResult InHit,
const float  InSweepFloorDist,
const bool  bIsWalkableFloor 
)

Member Data Documentation

◆ bBlockingHit

uint32 FFindFloorResult::bBlockingHit

True if there was a blocking hit in the floor test that was NOT in initial penetration. The HitResult can give more info about other circumstances.

◆ bLineTrace

uint32 FFindFloorResult::bLineTrace

True if the hit found a valid walkable floor using a line trace (rather than a sweep test, which happens when the sweep test fails to yield a walkable surface).

◆ bWalkableFloor

uint32 FFindFloorResult::bWalkableFloor

True if the hit found a valid walkable floor.

◆ FloorDist

float FFindFloorResult::FloorDist

The distance to the floor, computed from the swept capsule trace.

◆ HitResult

FHitResult FFindFloorResult::HitResult

Hit result of the test that found a floor. Includes more specific data about the point of impact and surface normal at that point.

◆ LineDist

float FFindFloorResult::LineDist

The distance to the floor, computed from the trace. Only valid if bLineTrace is true.


The documentation for this struct was generated from the following files: