FRepHandleIterator

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

Windows
MacOS
Linux

References

Module

Engine

Header

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

Include

#include "Net/RepLayout.h"

Syntax

class FRepHandleIterator

Remarks

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

Variables

Name Description

Public variable

const int32

 

ArrayElementSize

Only used for Dynamic Arrays.

Public variable

int32

 

ArrayIndex

The index of the current element in a dynamic array.

Public variable

int32

 

ArrayOffset

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

Public variable

FChangelistIter...

 

ChangelistIterator

Used to track current state of the iteration.

Public variable

int32

 

CmdIndex

The current Property Command index.

Public variable

const TArray< F...

 

Cmds

List of all available Layout Commands.

Public variable

int32

 

Handle

The current Relative Property Command handle.

Public variable

const TArray< F...

 

HandleToCmdIndex

Used to map Relative Handles to absolute Property Command Indices.

Public variable

const int32

 

MaxArrayIndex

Number of elements in a Dynamic array.

Public variable

const int32

 

MaxCmdIndex

Highest index in Cmds where the iterator can go.

Public variable

const int32

 

MinCmdIndex

Lowest index in Cmds where the iterator can go.

Public variable

const int32

 

NumHandlesPerElement

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

Public variable

UStruct const &...

 

Owner

Constructors

Name Description

Public function

FRepHandleIterator

(
    UStruct const*const InOwner,
    FChangelistIterator& InChangelistI...,
    const TArray< FRepLayoutCmd >& InC...,
    const TArray< FHandleToCmdIndex >&...,
    const int32 InElementSize,
    const int32 InMaxArrayIndex,
    const int32 InMinCmdIndex,
    const int32 InMaxCmdIndex
)

Functions

Name Description

Public function

bool

 

JumpOverArray()

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

Public function

bool

 

NextHandle()

Moves the iterator to the next available handle.

Public function Const

int32

 

PeekNextHandle()

Gets the handle at the iterators current position without advancing it.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss