FPropertyValueIterator

For recursively iterating over a [UStruct](API\Runtime\CoreUObject\UObject\UStruct) to find nested [FProperty](API\Runtime\CoreUObject\UObject\FProperty) pointers and values

Windows
MacOS
Linux

Inheritance Hierarchy

FPropertyValueIterator

TPropertyValueIterator

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h

Include

#include "UObject/UnrealType.h"

Syntax

class FPropertyValueIterator

Remarks

For recursively iterating over a UStruct to find nested FProperty pointers and values

Constructors

Name Description

Public function

FPropertyValueIterator()

Invalid iterator, start with empty stack

Public function

FPropertyValueIterator

(
    FFieldClass* InPropertyClass,
    const UStruct* InStruct,
    const void* InStructValue,
    EPropertyValueIteratorFlags InRecur...,
    EFieldIteratorFlags::DeprecatedProp...
)

Construct an iterator using a struct and struct value

Functions

Name Description

Public function Const

void

 

GetPropertyChain

(
    TArray< const FProperty* >& P...
)

Returns the full stack of properties for the property currently being iterated.

Public function Const

const FPrope...

 

Key()

Returns Property currently being iterated

Public function

void

 

SkipRecursiveProperty()

Call when iterating a recursive property such as Array or Struct to stop it from iterating into that property

Public function Const

const void &...

 

Value()

Returns memory address currently being iterated

Operators

Name Description

Public function Const

 

operator bool()

Conversion to "bool" returning true if the iterator is valid

Public function Const

const BasePa...

 

operator*()

Returns a TPair containing Property/Value currently being iterated

Public function

void

 

operator++()

Increments iterator

Public function Const

const BasePa...

 

operator->()

Typedefs

Name

Description

BasePairType

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss