UKismetSystemLibrary::SphereOverlapComponents

Returns an array of components that overlap the given sphere.

Windows
MacOS
Linux

Syntax

static bool SphereOverlapComponents
(
    UObject * WorldContextObject,
    const FVector SpherePos,
    float SphereRadius,
    const TArray< TEnumAsByte< EObjectTypeQuery > > & ObjectTypes,
    UClass * ComponentClassFilter,
    const TArray< AActor * > & ActorsToIgnore,
    TArray< class UPrimitiveComponent * > & OutComponents
)

Remarks

Returns an array of components that overlap the given sphere.

Returns

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

Parameters

Parameter

Description

WorldContext

World context

SpherePos

Center of sphere.

SphereRadius

Size of sphere.

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.

References

Module

Engine

Header

Runtime/Engine/Classes/Kismet/KismetSystemLibrary.h

Source

Runtime/Engine/Private/KismetSystemLibrary.cpp

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