UKismetSystemLibrary::CapsuleOverlapActors

Returns an array of actors that overlap the given capsule.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Kismet/KismetSystemLibrary.h

Include

#include "Kismet/KismetSystemLibrary.h"

Source

/Engine/Source/Runtime/Engine/Private/KismetSystemLibrary.cpp

Syntax

static bool CapsuleOverlapActors
(
    const UObject * WorldContextObject,
    const FVector CapsulePos,
    float Radius,
    float HalfHeight,
    const TArray < TEnumAsByte < EObjectTypeQuery > > & ObjectTypes,
    UClass * ActorClassFilter,
    const TArray < AActor * > & ActorsToIgnore,
    TArray < class AActor * > & OutActors
)

Remarks

Returns an array of actors that overlap the given capsule.

Returns

true if there was an overlap that passed the filters, false otherwise.

Parameters

Parameter

Description

WorldContext

World context

CapsulePos

Center of the capsule.

Radius

Radius of capsule hemispheres and radius of center cylinder portion.

HalfHeight

Half-height of the capsule (from center of capsule to tip of hemisphere.

Filter

Option to restrict results to only static or only dynamic. For efficiency.

ClassFilter

If set, will only return results of this class or subclasses of it.

ActorsToIgnore

Ignore these actors in the list

OutActors

Returned array of actors. Unsorted.

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