Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FActorIteratorState

Light Theme

Dark Theme

FActorIteratorState

Abstract base class for actor iteration.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/EngineUtils.h
Include	#include "EngineUtils.h"

Syntax

class FActorIteratorState

Remarks

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.

Variables

	Name	Description
FDelegateHandle	ActorSpawnedDelegateHandle	Handle to the registered OnActorSpawned delegate
int32	ConsideredCount	Number of actors that have been considered thus far
AActor *	CurrentActor	Current actor pointed to by actor iterator
UWorld *	CurrentWorld	Current world we are iterating upon
UClass *	DesiredClass	The class type we are iterating, kept for filtering
int32	Index	Index of the current element in the object array
TArray< UObject...	ObjectArray	Results from the GetObjectsOfClass query
bool	ReachedEnd	Whether we already reached the end
TArray< AActor ...	SpawnedActorArray	Contains any actors spawned during iteration

Constructors

	Name	Description
	FActorIteratorState ( UWorld* InWorld, TSubclassOf< AActor > InClass )	Default ctor, inits everything

Destructors

	Name	Description
	~FActorIteratorState()

Functions

		Name	Description
	AActor *	GetActorChecked()	Returns the current suitable actor pointed at by the Iterator

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss