Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > GameFramework > AActor > AActor::ActorGetDistanceToCollision

Light Theme

Dark Theme

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.

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

Take our survey

Dismiss