UCharacterMovementComponent::FloorSweepTest

Sweep against the world and return the first blocking hit.

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 bool FloorSweepTest
(
    struct FHitResult & OutHit,
    const FVector & Start,
    const FVector & End,
    ECollisionChannel TraceChannel,
    const struct FCollisionShape & CollisionShape,
    const struct FCollisionQueryParams & Params,
    const struct FCollisionResponseParams & ResponseParam
) const

Remarks

Sweep against the world and return the first blocking hit. Intended for tests against the floor, because it may change the result of impacts on the lower area of the test (especially if bUseFlatBaseForFloorChecks is true).

Returns

True if OutHit contains a blocking hit entry.

Parameters

Parameter

Description

OutHit

First blocking hit found.

Start

Start location of the capsule.

End

End location of the capsule.

TraceChannel

The 'channel' that this trace is in, used to determine which components to hit.

CollisionShape

Capsule collision shape.

Params

Additional parameters used for the trace.

ResponseParam

ResponseContainer to be used for this trace.