UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::FPropertyValueInContainer Struct Reference

#include <PropertyPathFunctions.h>

Public Member Functions

 operator bool () const
 
template<typename ValueType >
ValueType * GetValuePtr () const
 
bool IsDynamicContainerElement () const
 

Public Attributes

const FPropertyProperty = nullptr
 
const UStructStruct = nullptr
 
voidContainer = nullptr
 
int32 ArrayIndex = INDEX_NONE
 

Detailed Description

A reference to a single property value in a container.

An example of accessing the value from a valid reference: void* Data = Value.Property->ContainerPtrToValuePtr<void>(Value.Container, Value.ArrayIndex);

An example of querying initialized property value state from a valid reference: bool bInitialized = !Value.Struct || FInitializedPropertyValueState(Value.Struct, Value.Container).IsSet(Value.Property, Value.ArrayIndex);

Member Function Documentation

◆ GetValuePtr()

template<typename ValueType >
ValueType * UE::FPropertyValueInContainer::GetValuePtr ( ) const
inline

Returns a pointer to the property value that this references.

◆ IsDynamicContainerElement()

bool UE::FPropertyValueInContainer::IsDynamicContainerElement ( ) const
inline

If this value is for an element of a dynamic conatiner (for example an FArrayProperty element) then return true.

◆ operator bool()

UE::FPropertyValueInContainer::operator bool ( ) const
inlineexplicit

Member Data Documentation

◆ ArrayIndex

int32 UE::FPropertyValueInContainer::ArrayIndex = INDEX_NONE

The static array index within the referenced property. Always non-negative in a valid reference.

◆ Container

void* UE::FPropertyValueInContainer::Container = nullptr

The container that contains the referenced property value. If Struct is set, Container is an instance of it.

◆ Property

const FProperty* UE::FPropertyValueInContainer::Property = nullptr

The referenced property. If Struct is set, Property is one of its properties.

◆ Struct

const UStruct* UE::FPropertyValueInContainer::Struct = nullptr

The type of the container that contains the referenced property value. Null for a property in a container.


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