AActor::ActorGetDistanceToCollision

Returns Distance to closest Body Instance surface.

Windows
MacOS
Linux

References

Module

Engine

Header

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

Include

#include "GameFramework/Actor.h"

Source

/Engine/Source/Runtime/Engine/Private/Actor.cpp

Syntax

float ActorGetDistanceToCollision
(
    const FVector & Point,
    ECollisionChannel TraceChannel,
    FVector & ClosestPointOnCollision,
    UPrimitiveComponent ** OutPrimitiveComponent
) const

Remarks

Returns Distance to closest Body Instance surface. Checks against all components of this Actor having valid collision and blocking TraceChannel.

Returns

Success if returns > 0.f, if returns 0.f, it is either not convex or inside of the point If returns < 0.f, this Actor does not have any primitive with collision

Parameters

Parameter

Description

Point

World 3D vector

TraceChannel

The 'channel' used to determine which components to consider.

ClosestPointOnCollision

Point on the surface of collision closest to Point

OutPrimitiveComponent

PrimitiveComponent ClosestPointOnCollision is on.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback