Actor iterator. More...

#include <ActorIterator.h>

Inheritance diagram for Karma::FActorIterator:

Collaboration diagram for Karma::FActorIterator:

Public Member Functions
	FActorIterator (const UWorld *InWorld, const EActorIteratorFlags InFlags=EActorIteratorFlags(OnlyActiveLevels\|SkipPendingKill))
	A Constructor.

	FActorIterator (const UWorld *InWorld, const TSubclassOf< AActor > InClass, const EActorIteratorFlags InFlags=EActorIteratorFlags(OnlyActiveLevels\|SkipPendingKill))
	A Constructor.

Public Member Functions inherited from Karma::TActorIteratorBase< FActorIterator >
void	operator++ ()
	Iterates to next suitable actor.

FORCEINLINE AActor *	operator* () const
	Returns the current suitable actor pointed at by the Iterator.

FORCEINLINE AActor *	operator-> () const
	Returns the current suitable actor pointed at by the Iterator.

FORCEINLINE	operator bool () const
	Returns whether the iterator has reached the end and no longer points to a suitable actor.

void	ClearCurrent ()
	Clears the current Actor in the array (setting it to NULL).

int32	GetProgressNumerator () const
	Returns the number of actors considered thus far. Can be used in combination with GetProgressDenominator to gauge progress iterating over all actors.

FORCEINLINE bool	CanIterateLevel (const ULevel *Level) const
	Used to examine whether this level is valid for iteration or not. This function should be redefined (thus hiding this one) in a derived class if it wants special level filtering.

FORCEINLINE bool	IsActorSuitable (const AActor *Actor) const
	Determines whether this is a valid actor or not. This function should be redefined (thus hiding this one) in a derived class if it wants special actor filtering.

void	operator++ ()
	Iterates to next suitable actor.

FORCEINLINE AActor *	operator* () const
	Returns the current suitable actor pointed at by the Iterator.

FORCEINLINE AActor *	operator-> () const
	Returns the current suitable actor pointed at by the Iterator.

FORCEINLINE	operator bool () const
	Returns whether the iterator has reached the end and no longer points to a suitable actor.

void	ClearCurrent ()
	Clears the current Actor in the array (setting it to NULL).

int32	GetProgressNumerator () const
	Returns the number of actors considered thus far. Can be used in combination with GetProgressDenominator to gauge progress iterating over all actors.

FORCEINLINE bool	CanIterateLevel (const ULevel *Level) const
	Used to examine whether this level is valid for iteration or not. This function should be redefined (thus hiding this one) in a derived class if it wants special level filtering.

FORCEINLINE bool	IsActorSuitable (const AActor *Actor) const
	Determines whether this is a valid actor or not. This function should be redefined (thus hiding this one) in a derived class if it wants special actor filtering.

Friends
class	TActorIteratorBase< FActorIterator >
	Maybe for use in future.

Additional Inherited Members
Protected Member Functions inherited from Karma::TActorIteratorBase< FActorIterator >
	TActorIteratorBase (EActorIteratorType)
	A constructor.

	TActorIteratorBase (const UWorld *InWorld, TSubclassOf< AActor > InClass, const EActorIteratorFlags InFlags)
	Constructor for setting m_State (FActorIteratorState) with the supplied InWorld and InClass.

	TActorIteratorBase (EActorIteratorType)
	A constructor.

	TActorIteratorBase (const UWorld *InWorld, TSubclassOf< AActor > InClass, const EActorIteratorFlags InFlags)
	Constructor for setting m_State (FActorIteratorState) with the supplied InWorld and InClass.

Detailed Description

Actor iterator.

Note: When Playing In Editor, this will find actors only in CurrentWorld; Seems like not in use

Constructor & Destructor Documentation

◆ FActorIterator() [1/2]

Karma::FActorIterator::FActorIterator	(	const UWorld *	InWorld,
		const EActorIteratorFlags	InFlags = EActorIteratorFlags(OnlyActiveLevels \| SkipPendingKill) )

inlineexplicit

A Constructor.

Parameters

InWorld	The world whose actors are to be iterated over.
InFlags	Iteration flags indicating which types of levels and actors should be iterated

Since: Karma 1.0.0

◆ FActorIterator() [2/2]

Karma::FActorIterator::FActorIterator	(	const UWorld *	InWorld,
		const TSubclassOf< AActor >	InClass,
		const EActorIteratorFlags	InFlags = EActorIteratorFlags(OnlyActiveLevels \| SkipPendingKill) )

inlineexplicit

A Constructor.

Parameters

InWorld	The world whose actors are to be iterated over.
InClass	The type of actors to be iterated over.
InFlags	Iteration flags indicating which types of levels and actors should be iterated

Since: Karma 1.0.0

Friends And Related Symbol Documentation

◆ TActorIteratorBase< FActorIterator >

friend class TActorIteratorBase< FActorIterator >

friend

Maybe for use in future.

Since: Karma 1.0.0

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

Karma/src/Karma/GameFramework/ActorIterator.h

Public Member Functions