FFindFloorResult

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

Windows
MacOS
Linux

References

Module

Engine

Header

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

Include

#include "GameFramework/CharacterMovementComponent.h"

Syntax

struct FFindFloorResult

Remarks

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

Variables

Name Description

Public variable

uint32: 1

 

bBlockingHit

True if there was a blocking hit in the floor test that was NOT in initial penetration.

Public variable

uint32: 1

 

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).

Public variable

uint32: 1

 

bWalkableFloor

True if the hit found a valid walkable floor.

Public variable

float

 

FloorDist

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

Public variable

FHitResult

 

HitResult

Hit result of the test that found a floor.

Public variable

float

 

LineDist

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

Constructors

Name Description

Public function

FFindFloorResult()

Functions

Name Description

Public function

void

 

Clear()

Public function Const

float

 

GetDistanceToFloor()

Gets the distance to floor, either LineDist or FloorDist.

Public function Const

bool

 

IsWalkableFloor()

Returns true if the floor result hit a walkable surface.

Public function

void

 

SetFromLineTrace

(
    const FHitResult& InHit,
    const float InSweepFloorDist,
    const float InLineDist,
    const bool bIsWalkableFloor
)

Public function

void

 

SetFromSweep

(
    const FHitResult& InHit,
    const float InSweepFloorDist,
    const bool bIsWalkableFloor
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss