Navigation
API > API/Runtime > API/Runtime/CoreUObject
For recursively iterating over a UStruct to find nested FProperty pointers and values
| Name | FPropertyValueIterator |
| Type | class |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h |
| Include Path | #include "UObject/UnrealType.h" |
Syntax
class FPropertyValueIterator
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Invalid iterator, start with empty stack | UObject/UnrealType.h | ||
FPropertyValueIterator
(
FFieldClass* InPropertyClass, |
Construct an iterator using a struct and struct value | UObject/UnrealType.h |
Structs
| Name | Remarks |
|---|---|
| FPropertyValueStackEntry |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| BasePairType | TPair< const FProperty *, const void * > | UObject/UnrealType.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bMatchAll | bool | If true, all properties will be matched without checking IsA(PropertyClass) | UObject/UnrealType.h | |
| bSkipRecursionOnce | bool | If true, next iteration will skip recursing into containers/structs | UObject/UnrealType.h | |
| DeprecatedPropertyFlags | const EFieldIteratorFlags::DeprecatedPropertyFlags | Inherits to child field iterator | UObject/UnrealType.h | |
| PropertyClass | FFieldClass * | Property type that is explicitly checked for | UObject/UnrealType.h | |
| PropertyIteratorStack | TArray< FPropertyValueStackEntry, TInlineAllocator< 8 > > | Internal stack, one per continer/struct | UObject/UnrealType.h | |
| RecursionFlags | const EPropertyValueIteratorFlags | Whether to recurse into containers/structs | UObject/UnrealType.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GetPropertyChain
(
TArray< const FProperty* >& PropertyChain |
Returns the full stack of properties for the property currently being iterated. | UObject/UnrealType.h | |
| Returns a string of the property chain in a form that makes reading it easy. | UObject/UnrealType.h | ||
const FProperty * Key() |
Returns Property currently being iterated | UObject/UnrealType.h | |
void SkipRecursiveProperty() |
Call when iterating a recursive property such as Array or Struct to stop it from iterating into that property | UObject/UnrealType.h | |
const void * Value() |
Returns memory address currently being iterated | UObject/UnrealType.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Conversion to "bool" returning true if the iterator is valid | UObject/UnrealType.h | |
bool operator!=
(
const FPropertyValueIterator& Rhs |
UObject/UnrealType.h | ||
const BasePairType & operator*() |
Returns a TPair containing Property/Value currently being iterated | UObject/UnrealType.h | |
void operator++() |
Increments iterator | UObject/UnrealType.h | |
bool operator==
(
const FPropertyValueIterator& Rhs |
UObject/UnrealType.h | ||
const BasePairType * operator->() |
UObject/UnrealType.h |