1. Epic GamesDeveloper
  3. FInstancedPropertyBag

FInstancedPropertyBag

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/StructUtils

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/StructUtils/PropertyBag.h
Include #include "StructUtils/PropertyBag.h"

Syntax

USTRUCT ()  
struct FInstancedPropertyBag

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere FInstancedStruct Value  

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Functions

  Type Name Description
Public function void

AddContainerProperty ( const FName InName,
const EPropertyBagContainerType InContainerType,
const EPropertyBagPropertyType InValueType,
const UObject* InValueTypeObject
)

 Adds a new container property to the bag.
Public function void

AddContainerProperty ( const FName InName,
const FPropertyBagContainerTypes InContainerTypes,
const EPropertyBagPropertyType InValueType,
UObject* InValueTypeObject
)

 Adds a new container property to the bag.
Public function void

AddProperties ( const TConstArrayView< FPropertyBagPropertyDesc > Descs
)

 Adds properties to the bag.
Public function void

AddProperty ( const FName InName,
const FProperty* InSourceProperty
)

 Adds a new property to the bag.
Public function void

AddProperty ( const FName InName,
const EPropertyBagPropertyType InValueType,
const UObject* InValueTypeObject
)

 Adds a new property to the bag.
Public function void  
Public function void Copies matching property values from another bag of potentially mismatching layout.
Public function Const const FPropertyBagPropertyDesc * Returns property descriptor by specified name.
Public function Const const FPropertyBagPropertyDesc *

FindPropertyDescByName ( const FName Name
)

 Returns property descriptor by specified ID.
Public function Const TValueOrError< const FPropertyBagArrayRef, EPropertyBagResult >

GetArrayRef ( const FName Name
)

 Returns helper class to access an array property.
Public function TValueOrError< FPropertyBagArrayRef, EPropertyBagResult >

GetMutableArrayRef ( const FName Name
)

 Returns helper class to modify and access an array property.
Public function TValueOrError< FPropertyBagSetRef, EPropertyBagResult >

GetMutableSetRef ( const FName Name
)

 Returns helper class to modify and access a set property.
Public function FStructView  
Protected function void *  
Public function Const int32 Returns number of the Properties in this Property Bag
Public function void  
Public function Const const UPropertyBag *  
Public function Const TValueOrError< const FPropertyBagSetRef, EPropertyBagResult >

GetSetRef ( const FName Name
)

 Returns helper class to access a set property.
Public function Const FConstStructView  
Protected function Const const void *  
Public function Const TValueOrError< bool, EPropertyBagResult >

GetValueBool ( const FName Name
)

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

GetValueByte ( const FName Name
)

  
Public function Const TValueOrError< UClass *, EPropertyBagResult >

GetValueClass ( const FName Name
)

  
Public function Const TValueOrError< double, EPropertyBagResult >

GetValueDouble ( const FName Name
)

  
Public function Const TValueOrError< T, EPropertyBagResult >

GetValueEnum ( const FName Name
)

  
Public function Const TValueOrError< uint8, EPropertyBagResult >

GetValueEnum ( const FName Name,
const UEnum* RequestedEnum
)

  
Public function Const TValueOrError< float, EPropertyBagResult >

GetValueFloat ( const FName Name
)

  
Public function Const TValueOrError< int32, EPropertyBagResult >

GetValueInt32 ( const FName Name
)

  
Public function Const TValueOrError< int64, EPropertyBagResult >

GetValueInt64 ( const FName Name
)

  
Public function Const TValueOrError< FName, EPropertyBagResult >

GetValueName ( const FName Name
)

  
Public function Const TValueOrError< T *, EPropertyBagResult >

GetValueObject ( const FName Name
)

  
Public function Const TValueOrError< UObject *, EPropertyBagResult >

GetValueObject ( const FName Name,
const UClass* RequestedClass
)

  
Public function Const TValueOrError< FString, EPropertyBagResult >  
Public function Const TValueOrError< FSoftObjectPath, EPropertyBagResult >

GetValueSoftPath ( const FName Name
)

  
Public function Const TValueOrError< FString, EPropertyBagResult >

GetValueString ( const FName Name
)

  
Public function Const TValueOrError< FStructView, EPropertyBagResult >

GetValueStruct ( const FName Name,
const UScriptStruct* RequestedStruct
)

  
Public function Const TValueOrError< T *, EPropertyBagResult >

GetValueStruct ( const FName Name
)

  
Public function Const TValueOrError< FText, EPropertyBagResult >

GetValueText ( const FName Name
)

  
Public function Const TValueOrError< uint32, EPropertyBagResult >

GetValueUInt32 ( const FName Name
)

  
Public function Const TValueOrError< uint64, EPropertyBagResult >

GetValueUInt64 ( const FName Name
)

  
Public function Const bool

Identical ( const FInstancedPropertyBag* Other,
uint32 PortFlags
)

  
Public function void

InitializeFromBagStruct ( const UPropertyBag* NewBagStruct
)

 Initializes the instance from a bag struct.
Public function Const bool

IsValid ()

  
Public function void

MigrateToNewBagInstance ( const FInstancedPropertyBag& InNewBagInstance
)

 Changes the type of this bag to the InNewBagInstance, and migrates existing values over.
Public function void

MigrateToNewBagInstanceWithOverrides ( const FInstancedPropertyBag& InNewBagInstance,
TConstArrayView< FGuid > OverriddenPropertyIDs
)

 Changes the type of this bag to the InNewBagInstance, and migrates existing values over if marked as overridden in the OverriddenPropertyIDs.
Public function void

MigrateToNewBagStruct ( const UPropertyBag* NewBagStruct
)

 Changes the type of this bag and migrates existing values.
Public function void

RemovePropertiesByName ( const TConstArrayView< FName > PropertiesToRemove
)

 Removes properties from the bag by name if they exist.
Public function void

RemovePropertyByName ( const FName PropertyToRemove
)

 Removes a property from the bag by name if it exists.
Public function EPropertyBagResult

ReplaceAllPropertiesAndValues ( const TConstArrayView< FPropertyBagPropertyDesc > InDescs,
const TConstArrayView< TConstArrayView< uint8 > > InValues
)

 Clears all properties, then adds the supplied properties to the bag and sets their respective values.
Public function void

Reset ()

 Resets the instance to empty.
Public function bool  
Public function EPropertyBagResult

SetValue ( const FName Name,
const FProperty* InSourceProperty,
const void* InSourceContainerAddress
)

 Sets property value from given source property and source container address A property must exist in that bag before it can be set.
Public function EPropertyBagResult

SetValueBool ( const FName Name,
const bool bInValue
)

 Value Setters.
Public function EPropertyBagResult

SetValueByte ( const FName Name,
const uint8 InValue
)

  
Public function EPropertyBagResult

SetValueClass ( const FName Name,
UClass* InValue
)

  
Public function EPropertyBagResult

SetValueDouble ( const FName Name,
const double InValue
)

  
Public function EPropertyBagResult

SetValueEnum ( const FName Name,
const uint8 InValue,
const UEnum* Enum
)

  
Public function EPropertyBagResult

SetValueEnum ( const FName Name,
const T InValue
)

 Sets enum value specified type.
Public function EPropertyBagResult

SetValueFloat ( const FName Name,
const float InValue
)

  
Public function EPropertyBagResult

SetValueInt32 ( const FName Name,
const int32 InValue
)

  
Public function EPropertyBagResult

SetValueInt64 ( const FName Name,
const int64 InValue
)

  
Public function EPropertyBagResult

SetValueName ( const FName Name,
const FName InValue
)

  
Public function EPropertyBagResult

SetValueObject ( const FName Name,
UObject* InValue
)

  
Public function EPropertyBagResult

SetValueObject ( const FName Name,
T* InValue
)

 Sets object pointer value specified type.
Public function EPropertyBagResult

SetValueSerializedString ( const FName Name,
const FString& InValue
)

 Sets property value from a serialized representation of the value.
Public function EPropertyBagResult

SetValueSoftPath ( const FName Name,
const FSoftObjectPath& InValue
)

  
Public function EPropertyBagResult

SetValueString ( const FName Name,
const FString& InValue
)

  
Public function EPropertyBagResult

SetValueStruct ( const FName Name,
const T& InValue
)

 Sets struct value specified type.
Public function EPropertyBagResult

SetValueStruct ( const FName Name,
FConstStructView InValue
)

  
Public function EPropertyBagResult

SetValueText ( const FName Name,
const FText& InValue
)

  
Public function EPropertyBagResult

SetValueUInt32 ( const FName Name,
const uint32 InValue
)

  
Public function EPropertyBagResult

SetValueUInt64 ( const FName Name,
const uint64 InValue
)

  

Operators

  Type Name Description
Public function FInstancedPropertyBag &  
Public function FInstancedPropertyBag &

operator= ( const FInstancedPropertyBag& InOther
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page