FBeltIt Struct Reference

The iterator of the belt slots. More...

#include <BeltIt.h>

Public Types
enum	{ InvalidSlotIndex = FBeltSlot::InvalidIndex , InvalidComboIndex = FBeltSlot::InvalidComboIndex }

Public Member Functions
bool	HasLocked ()
	Check if the iterator has locked its belt. More...
	FBeltIt ()
	Construct a new uninitialized iterator. More...
	FBeltIt (FBeltIt &&InIterator)
	Move-construct a belt iterator. More...
FBeltIt &	operator= (FBeltIt &&InIterator)
	Move-assign the iterator. More...
FBeltIt &	operator= (const FBeltIt &InIterator)
	Assign the iterator. More...
	~FBeltIt ()
	Destroy the iterator unlocking the belt if necessary. More...
bool	IsValid () const
	Check if the iterator is valid and not at the end. More...
	operator bool () const
	Check if the iterator is valid and not at the end. More...
int32	GetComboIndex () const
	The current combination within the slot. More...
const struct FFilter &	GetFilter () const
	Get the filter of the current iterating. More...
const struct FBeltSlot &	GetSlot () const
	Get the current slot of the iterator. More...
const struct FSubjectHandle	GetSubject () const
	Get the currently iterated subject. More...
const TScriptInterface< class ISubjective >	GetSubjective () const
	Get the currently iterated subjective. More...
UDetail *	GetDetailAt (const int32 DetailIndex) const
	Get a detail at a certain index. More...
const struct FDetailmark &	GetDetailmark () const
	Get the detailmark of the current iterating. More...
EApparatusStatus	Advance ()
	Advance to the next iteration. More...
FBeltIt &	operator++ ()
	Get the next iterator (prefix version). More...
FBeltIt	operator++ (int)
	Get the next iterator (postfix version). More...
bool	operator== (const FBeltIt &Other) const
bool	operator!= (const FBeltIt &Other) const

Friends
class	UBelt
struct	FBeltChain

Detailed Description

The iterator of the belt slots.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
InvalidSlotIndex	Invalid belt slot index.
InvalidComboIndex	Invalid combination index.

Constructor & Destructor Documentation

FBeltIt() [1/2]

FBeltIt::FBeltIt ( )

inline

Construct a new uninitialized iterator.

FBeltIt() [2/2]

FBeltIt::FBeltIt ( FBeltIt &&  InIterator )

inline

Move-construct a belt iterator.

~FBeltIt()

FBeltIt::~FBeltIt ( )

inline

Destroy the iterator unlocking the belt if necessary.

Member Function Documentation

Advance()

EApparatusStatus FBeltIt::Advance ( )

inline

Advance to the next iteration.

Returns

The status of the operation.

GetComboIndex()

int32 FBeltIt::GetComboIndex ( ) const

inline

The current combination within the slot.

GetDetailAt()

UDetail * FBeltIt::GetDetailAt ( const int32  DetailIndex ) const

inline

Get a detail at a certain index.

GetDetailmark()

const FDetailmark & FBeltIt::GetDetailmark ( ) const

inline

Get the detailmark of the current iterating.

Returns

The detailmark of the iterating.

GetFilter()

const FFilter & FBeltIt::GetFilter ( ) const

inline

Get the filter of the current iterating.

Returns

The filter of the iterating.

GetSlot()

const FBeltSlot & FBeltIt::GetSlot ( ) const

inline

Get the current slot of the iterator.

Returns

The slot of the iterator.

GetSubject()

const struct FSubjectHandle FBeltIt::GetSubject ( ) const

inline

Get the currently iterated subject.

GetSubjective()

const TScriptInterface< class ISubjective > FBeltIt::GetSubjective ( ) const

inline

Get the currently iterated subjective.

HasLocked()

bool FBeltIt::HasLocked ( )

inline

Check if the iterator has locked its belt.

IsValid()

bool FBeltIt::IsValid ( ) const

inline

Check if the iterator is valid and not at the end.

of its belt.

During the iteration process the current state of the iterator may point to some invalid slot after its processing, but that doesn't mean that the iterator is invalid itself, since it can still advance to the next valid slot (if any).

operator bool()

FBeltIt::operator bool ( ) const

inline

Check if the iterator is valid and not at the end.

operator!=()

bool FBeltIt::operator!= ( const FBeltIt &  Other ) const

inline

operator++() [1/2]

FBeltIt& FBeltIt::operator++ ( )

inline

Get the next iterator (prefix version).

operator++() [2/2]

FBeltIt FBeltIt::operator++ ( int  )

inline

Get the next iterator (postfix version).

operator=() [1/2]

FBeltIt & FBeltIt::operator= ( const FBeltIt &  InIterator )

inline

Assign the iterator.

Parameters

InIterator

An iterator to assign from.

operator=() [2/2]

FBeltIt & FBeltIt::operator= ( FBeltIt &&  InIterator )

inline

Move-assign the iterator.

Parameters

InIterator

An iterator to move.

operator==()

bool FBeltIt::operator== ( const FBeltIt &  Other ) const

inline

Friends And Related Function Documentation

FBeltChain

friend struct FBeltChain

friend

UBelt

friend class UBelt

friend

---

The documentation for this struct was generated from the following files:

• D:/ApparatusPlatformer/Plugins/Apparatus/Source/ApparatusRuntime/Public/BeltIt.h
• D:/ApparatusPlatformer/Plugins/Apparatus/Source/ApparatusRuntime/Public/Belt.h