1. Epic GamesDeveloper
  3. FPropertyBagArrayRef

FPropertyBagArrayRef

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

API > API/Plugins > API/Plugins/StructUtils

Inheritance Hierarchy

References

   
Module StructUtils
Header /Engine/Plugins/Experimental/StructUtils/Source/StructUtils/Public/PropertyBag.h
Include #include "PropertyBag.h"

Syntax

class FPropertyBagArrayRef : public FScriptArrayHelper

Remarks

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!

Constructors

  Type Name Description
Public function  

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

  

Functions

  Type Name Description
Public function Const TValueOrError< FPropertyBagArrayRef, EPropertyBagResult >

GetMutableNestedArrayRef ( const int32 Index
)

 Returns helper class to modify and access a nested array (mutable version).
Public function Const TValueOrError< const FPropertyBagArrayRef, EPropertyBagResult >

GetNestedArrayRef ( const int32 Index
)

 Returns helper class to access a nested array (const version).
Public function Const TValueOrError< bool, EPropertyBagResult >

GetValueBool ( const int32 Index
)

 Getters Numeric types (bool, int32, int64, float, double) support type conversion.
Public function Const TValueOrError< uint8, EPropertyBagResult >

GetValueByte ( const int32 Index
)

  
Public function Const TValueOrError< UClass *, EPropertyBagResult >

GetValueClass ( const int32 Index
)

  
Public function Const TValueOrError< double, EPropertyBagResult >

GetValueDouble ( const int32 Index
)

  
Public function Const TValueOrError< uint8, EPropertyBagResult >

GetValueEnum ( const int32 Index,
const UEnum* RequestedEnum
)

  
Public function Const TValueOrError< T, EPropertyBagResult >

GetValueEnum ( const int32 Index
)

  
Public function Const TValueOrError< float, EPropertyBagResult >

GetValueFloat ( const int32 Index
)

  
Public function Const TValueOrError< int32, EPropertyBagResult >

GetValueInt32 ( const int32 Index
)

  
Public function Const TValueOrError< int64, EPropertyBagResult >

GetValueInt64 ( const int32 Index
)

  
Public function Const TValueOrError< FName, EPropertyBagResult >

GetValueName ( const int32 Index
)

  
Public function Const TValueOrError< T *, EPropertyBagResult >

GetValueObject ( const int32 Index
)

  
Public function Const TValueOrError< UObject *, EPropertyBagResult >

GetValueObject ( const int32 Index,
const UClass* RequestedClass
)

  
Public function Const TValueOrError< FSoftObjectPath, EPropertyBagResult >

GetValueSoftPath ( const int32 Index
)

  
Public function Const TValueOrError< FString, EPropertyBagResult >

GetValueString ( const int32 Index
)

  
Public function Const TValueOrError< FStructView, EPropertyBagResult >

GetValueStruct ( const int32 Index,
const UScriptStruct* RequestedStruct
)

  
Public function Const TValueOrError< T *, EPropertyBagResult >

GetValueStruct ( const int32 Index
)

  
Public function Const TValueOrError< FText, EPropertyBagResult >

GetValueText ( const int32 Index
)

  
Public function EPropertyBagResult

SetValueBool ( const int32 Index,
const bool bInValue
)

 Value Setters.
Public function EPropertyBagResult

SetValueByte ( const int32 Index,
const uint8 InValue
)

  
Public function EPropertyBagResult

SetValueClass ( const int32 Index,
UClass* InValue
)

  
Public function EPropertyBagResult

SetValueDouble ( const int32 Index,
const double InValue
)

  
Public function EPropertyBagResult

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

  
Public function EPropertyBagResult

SetValueEnum ( const int32 Index,
const T InValue
)

 Sets enum value specified type.
Public function EPropertyBagResult

SetValueFloat ( const int32 Index,
const float InValue
)

  
Public function EPropertyBagResult

SetValueInt32 ( const int32 Index,
const int32 InValue
)

  
Public function EPropertyBagResult

SetValueInt64 ( const int32 Index,
const int64 InValue
)

  
Public function EPropertyBagResult

SetValueName ( const int32 Index,
const FName InValue
)

  
Public function EPropertyBagResult

SetValueObject ( const int32 Index,
UObject* InValue
)

  
Public function EPropertyBagResult

SetValueObject ( const int32 Index,
T* InValue
)

 Sets object pointer value specified type.
Public function EPropertyBagResult

SetValueSoftPath ( const int32 Index,
const FSoftObjectPath& InValue
)

  
Public function EPropertyBagResult

SetValueString ( const int32 Index,
const FString& InValue
)

  
Public function EPropertyBagResult

SetValueStruct ( const int32 Index,
FConstStructView InValue
)

  
Public function EPropertyBagResult

SetValueStruct ( const int32 Index,
const T& InValue
)

 Sets struct value specified type.
Public function EPropertyBagResult

SetValueText ( const int32 Index,
const FText& InValue
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page