UKismetSystemLibrary::BoxOverlapActors

Returns an array of actors that overlap the given axis-aligned box.

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 BoxOverlapActors
(
    UObject * WorldContextObject,
    const FVector BoxPos,
    FVector BoxExtent,
    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 axis-aligned box.

Returns

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

Parameters

Parameter

Description

WorldContext

World context

BoxPos

Center of box.

BoxExtent

Extents of box.

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