TActorIteratorBase

Template class used to filter actors by certain characteristics

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/EngineUtils.h

Include

#include "EngineUtils.h"

Syntax

template<typename Derived>
class TActorIteratorBase

Remarks

Template class used to filter actors by certain characteristics

Constructors

Name Description

Protected function

TActorIteratorBase

(
    EActorIteratorType
)

Hide the constructors as construction on this class should only be done by subclasses

Protected function

TActorIteratorBase

(
    UWorld* InWorld,
    TSubclassOf< AActor > InClass,
    EActorIteratorFlags InFlags
)

Functions

Name Description

Protected function Const

bool

 

CanIterateLevel

(
    ULevel* Level
)

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.

Public function

void

 

ClearCurrent()

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

Public function Const

int32

 

GetProgressNumerator()

Returns the number of actors considered thus far.

Protected function Const

bool

 

IsActorSuitable

(
    AActor* Actor
)

Determines whether this is a valid actor or not.

Operators

Name Description

Public function Const

 

operator bool()

Returns whether the iterator has reached the end and no longer points to a suitable actor.

Public function Const

AActor *

 

operator*()

Returns the current suitable actor pointed at by the Iterator

Public function

void

 

operator++()

Iterates to next suitable actor.

Public function Const

AActor *

 

operator->()

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