UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FActorIteratorState Class Reference

#include <EngineUtils.h>

Public Member Functions

 FActorIteratorState (const UWorld *InWorld, const TSubclassOf< AActor > InClass)
 
 ~FActorIteratorState ()
 
AActorGetActorChecked () const
 

Public Attributes

const UWorldCurrentWorld
 
TArray< AActor * > ActorArray
 
int32 Index
 
bool ReachedEnd
 
int32 ConsideredCount
 
AActorCurrentActor
 
TArray< AActor * > SpawnedActorArray
 
UClassDesiredClass
 
FDelegateHandle ActorSpawnedDelegateHandle
 

Detailed Description

Abstract base class for actor iteration. Implements all operators and relies on IsActorSuitable to be overridden by derived class. Note that when Playing In Editor, this will find actors only in CurrentWorld.

Constructor & Destructor Documentation

◆ FActorIteratorState()

FActorIteratorState::FActorIteratorState ( const UWorld InWorld,
const TSubclassOf< AActor InClass 
)
inline

Default ctor, inits everything

◆ ~FActorIteratorState()

FActorIteratorState::~FActorIteratorState ( )
inline

Member Function Documentation

◆ GetActorChecked()

AActor * FActorIteratorState::GetActorChecked ( ) const
inline

Returns the current suitable actor pointed at by the Iterator

Returns
Current suitable actor

Member Data Documentation

◆ ActorArray

TArray<AActor*> FActorIteratorState::ActorArray

Results from the GetObjectsOfClass query

◆ ActorSpawnedDelegateHandle

FDelegateHandle FActorIteratorState::ActorSpawnedDelegateHandle

Handle to the registered OnActorSpawned delegate

◆ ConsideredCount

int32 FActorIteratorState::ConsideredCount

Number of actors that have been considered thus far

◆ CurrentActor

AActor* FActorIteratorState::CurrentActor

Current actor pointed to by actor iterator

◆ CurrentWorld

const UWorld* FActorIteratorState::CurrentWorld

Current world we are iterating upon

◆ DesiredClass

UClass* FActorIteratorState::DesiredClass

The class type we are iterating, kept for filtering

◆ Index

int32 FActorIteratorState::Index

index of the current element in the object array

◆ ReachedEnd

bool FActorIteratorState::ReachedEnd

Whether we already reached the end

◆ SpawnedActorArray

TArray<AActor*> FActorIteratorState::SpawnedActorArray

Contains any actors spawned during iteration


The documentation for this class was generated from the following file: