1. Epic GamesDeveloper
  3. FPropertyBagArrayRef

FPropertyBagArrayRef

A reference to an array in [FInstancedPropertyBag](API\Runtime\CoreUObject\FInstancedPropertyBag) Allows to modify the array via the [FScriptArrayHelper](API\Runtime\CoreUObject\FScriptArrayHelper) API, and contains helper methods to get and set properties.

API > API/Runtime > API/Runtime/CoreUObject

A reference to an array in FInstancedPropertyBag Allows to modify the array via the FScriptArrayHelper API, and contains helper methods to get and set properties. FInstancedPropertyBag Bag; Bag.AddProperties({ { ArrayName, EPropertyBagContainerType::Array, EPropertyBagPropertyType::Float } });

if (auto FloatArrayRes = Bag.GetArrayRef(ArrayName); FloatArrayRes.IsValid()) { FPropertyBagArrayRef& FloatArray = FloatArrayRes.GetValue(); const int32 NewIndex = FloatArray.AddValue(); FloatArray.SetValueFloat(NewIndex, 123.0f); }

Note: The array reference is not valid after the layout of the referenced property bag has changed!

   
Name FPropertyBagArrayRef
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/StructUtils/PropertyBag.h
Include Path #include "StructUtils/PropertyBag.h"

Syntax

class FPropertyBagArrayRef : public FScriptArrayHelper

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FPropertyBagArrayRef ( const FPropertyBagPropertyDesc& InDesc,
const void* InArray
)

   StructUtils/PropertyBag.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ValueDesc FPropertyBagPropertyDesc   StructUtils/PropertyBag.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Returns helper class to modify and access a nested array (mutable version). StructUtils/PropertyBag.h  
Returns helper class to access a nested array (const version). StructUtils/PropertyBag.h  

TValueOrError< bool, EPropertyBagResult > GetValueBool ( const int32 Index
) const

 Getters Numeric types (bool, (u)int32, (u)int64, float, double) support type conversion. StructUtils/PropertyBag.h  

TValueOrError< uint8, EPropertyBagResult > GetValueByte ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< UClass *, EPropertyBagResult > GetValueClass ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< double, EPropertyBagResult > GetValueDouble ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< uint8, EPropertyBagResult > GetValueEnum ( const int32 Index,
const UEnum* RequestedEnum
) const

   StructUtils/PropertyBag.h  

TValueOrError< T, EPropertyBagResult > GetValueEnum ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< float, EPropertyBagResult > GetValueFloat ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< int32, EPropertyBagResult > GetValueInt32 ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< int64, EPropertyBagResult > GetValueInt64 ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< FName, EPropertyBagResult > GetValueName ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< UObject *, EPropertyBagResult > GetValueObject ( const int32 Index,
const UClass* RequestedClass
) const

   StructUtils/PropertyBag.h  

TValueOrError< T *, EPropertyBagResult > GetValueObject ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< FSoftObjectPath, EPropertyBagResult > GetValueSoftPath ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< FString, EPropertyBagResult > GetValueString ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< FStructView, EPropertyBagResult > GetValueStruct ( const int32 Index,
const UScriptStruct* RequestedStruct
) const

   StructUtils/PropertyBag.h  

TValueOrError< T *, EPropertyBagResult > GetValueStruct ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< FText, EPropertyBagResult > GetValueText ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< uint32, EPropertyBagResult > GetValueUInt32 ( const int32 Index
) const

   StructUtils/PropertyBag.h  

TValueOrError< uint64, EPropertyBagResult > GetValueUInt64 ( const int32 Index
) const

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueBool ( const int32 Index,
const bool bInValue
)

 Value Setters. StructUtils/PropertyBag.h  

EPropertyBagResult SetValueByte ( const int32 Index,
const uint8 InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueClass ( const int32 Index,
UClass* InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueDouble ( const int32 Index,
const double InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueEnum ( const int32 Index,
const T InValue
)

 Sets enum value specified type. StructUtils/PropertyBag.h  

EPropertyBagResult SetValueEnum ( const int32 Index,
const uint8 InValue,
const UEnum* Enum
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueFloat ( const int32 Index,
const float InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueInt32 ( const int32 Index,
const int32 InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueInt64 ( const int32 Index,
const int64 InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueName ( const int32 Index,
const FName InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueObject ( const int32 Index,
UObject* InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueObject ( const int32 Index,
T* InValue
)

 Sets object pointer value specified type. StructUtils/PropertyBag.h  

EPropertyBagResult SetValueSoftPath ( const int32 Index,
const FSoftObjectPath& InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueSoftPath ( const int32 Index,
const UObject* InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueString ( const int32 Index,
const FString& InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueStruct ( const int32 Index,
FConstStructView InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueStruct ( const int32 Index,
const T& InValue
)

 Sets struct value specified type. StructUtils/PropertyBag.h  

EPropertyBagResult SetValueText ( const int32 Index,
const FText& InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueUInt32 ( const int32 Index,
const uint32 InValue
)

   StructUtils/PropertyBag.h  

EPropertyBagResult SetValueUInt64 ( const int32 Index,
const uint64 InValue
)

   StructUtils/PropertyBag.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page