UKismetSystemLibrary::SphereOverlapComponents

Returns an array of components that overlap the given sphere.

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 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.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss