#include <RepLayout.h>

Public Member Functions
	FRepHandleIterator (UStruct const *const InOwner, FChangelistIterator &InChangelistIterator, const TArray< FRepLayoutCmd > &InCmds, const TArray< FHandleToCmdIndex > &InHandleToCmdIndex, const int32 InElementSize, const int32 InMaxArrayIndex, const int32 InMinCmdIndex, const int32 InMaxCmdIndex)

bool	NextHandle ()

bool	JumpOverArray ()

int32	PeekNextHandle () const

Public Attributes
FChangelistIterator &	ChangelistIterator

const TArray< FRepLayoutCmd > &	Cmds

const TArray< FHandleToCmdIndex > &	HandleToCmdIndex

const int32	NumHandlesPerElement

const int32	ArrayElementSize

const int32	MaxArrayIndex

const int32	MinCmdIndex

const int32	MaxCmdIndex

int32	Handle

int32	CmdIndex

int32	ArrayIndex

int32	ArrayOffset

UStruct const *const	Owner

Detailed Description

Iterates over a changelist, taking each handle, and mapping to rep layout index, array index, etc.

Constructor & Destructor Documentation

◆ FRepHandleIterator()

FRepHandleIterator::FRepHandleIterator	(	UStruct const *const	InOwner,
		FChangelistIterator &	InChangelistIterator,
		const TArray< FRepLayoutCmd > &	InCmds,
		const TArray< FHandleToCmdIndex > &	InHandleToCmdIndex,
		const int32	InElementSize,
		const int32	InMaxArrayIndex,
		const int32	InMinCmdIndex,
		const int32	InMaxCmdIndex
	)

inline

Member Function Documentation

◆ JumpOverArray()

bool FRepHandleIterator::JumpOverArray ( )

Skips all the handles associated with a dynamic array at the iterators current position.

Returns: True if the move was successful, false otherwise (this will return True even if the next handle is the end).

◆ NextHandle()

bool FRepHandleIterator::NextHandle ( )

Moves the iterator to the next available handle.

Returns: True if the move was successful, false otherwise (e.g., end of the iteration range was reached).

◆ PeekNextHandle()

int32 FRepHandleIterator::PeekNextHandle ( ) const

Gets the handle at the iterators current position without advancing it.

Returns: The next Property Command handle.

Member Data Documentation

◆ ArrayElementSize

const int32 FRepHandleIterator::ArrayElementSize

Only used for Dynamic Arrays.

See also: FRepLayout ElementSize.

◆ ArrayIndex

int32 FRepHandleIterator::ArrayIndex

The index of the current element in a dynamic array.

◆ ArrayOffset

int32 FRepHandleIterator::ArrayOffset

The Byte offset of Serialized Property data for a dynamic array to the current element.

◆ ChangelistIterator

FChangelistIterator& FRepHandleIterator::ChangelistIterator

Used to track current state of the iteration.

◆ CmdIndex

int32 FRepHandleIterator::CmdIndex

The current Property Command index.

◆ Cmds

const TArray<FRepLayoutCmd>& FRepHandleIterator::Cmds

List of all available Layout Commands.

◆ Handle

int32 FRepHandleIterator::Handle

The current Relative Property Command handle.

◆ HandleToCmdIndex

const TArray<FHandleToCmdIndex>& FRepHandleIterator::HandleToCmdIndex

Used to map Relative Handles to absolute Property Command Indices.

◆ MaxArrayIndex

const int32 FRepHandleIterator::MaxArrayIndex

Number of elements in a Dynamic array. Should be 1 when iterating Top Level Properties or non-array properties.

◆ MaxCmdIndex

const int32 FRepHandleIterator::MaxCmdIndex

Highest index in Cmds where the iterator can go.

◆ MinCmdIndex

const int32 FRepHandleIterator::MinCmdIndex

Lowest index in Cmds where the iterator can go.

◆ NumHandlesPerElement

const int32 FRepHandleIterator::NumHandlesPerElement

The number of handles per Command. This should always be 1, except for Arrays.

◆ Owner

UStruct const* const FRepHandleIterator::Owner

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

Engine/Source/Runtime/Engine/Public/Net/RepLayout.h
Engine/Source/Runtime/Engine/Private/RepLayout.cpp

Public Member Functions

Public Attributes