Navigation
API > API/Runtime > API/Runtime/CoreUObject
| Name | FInstancedPropertyBag |
| Type | struct |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/StructUtils/PropertyBag.h |
| Include Path | #include "StructUtils/PropertyBag.h" |
Syntax
USTRUCT ()
struct FInstancedPropertyBag
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInstancedPropertyBag
(
FInstancedPropertyBag&& Other |
StructUtils/PropertyBag.h | ||
FInstancedPropertyBag
(
const FInstancedPropertyBag& Other |
StructUtils/PropertyBag.h | ||
| StructUtils/PropertyBag.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EPropertyBagAlterationResult AddContainerProperty
(
const FName InName, |
Adds a new container property to the bag. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult AddContainerProperty
(
const FName InName, |
Adds a new container property to the bag. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult AddProperties
(
const TConstArrayView< FPropertyBagPropertyDesc > Descs, |
Adds properties to the bag. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult AddProperty
(
const FName InName, |
Adds a new property to the bag. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult AddProperty
(
const FName InName, |
Adds a new property to the bag. | StructUtils/PropertyBag.h | |
void AddStructReferencedObjects
(
FReferenceCollector& Collector |
StructUtils/PropertyBag.h | ||
void CopyMatchingValuesByID
(
const FInstancedPropertyBag& Other, |
Copies matching property values from another bag of potentially mismatching layout. | StructUtils/PropertyBag.h | |
void CopyMatchingValuesByName
(
const FInstancedPropertyBag& Other, |
Copies matching property values from another bag of potentially mismatching layout. | StructUtils/PropertyBag.h | |
| Return Internal instanced struct to be able to take ownership on the internal memory of this instanced property bag. | StructUtils/PropertyBag.h | ||
EPropertyBagAlterationResult DuplicateProperty
(
FName InName, |
Duplicates the given property in the bag if it exists. | StructUtils/PropertyBag.h | |
const FPropertyBagPropertyDesc * FindPropertyDescByID
(
const FGuid ID |
Returns property descriptor by specified name. | StructUtils/PropertyBag.h | |
const FPropertyBagPropertyDesc * FindPropertyDescByName
(
const FName Name |
Returns property descriptor by specified ID. | StructUtils/PropertyBag.h | |
TValueOrError< const FPropertyBagArrayRef, EPropertyBagResult > GetArrayRef
(
const FName Name |
Returns helper class to access an array property. | StructUtils/PropertyBag.h | |
TValueOrError< const FPropertyBagArrayRef, EPropertyBagResult > GetArrayRef
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< FPropertyBagArrayRef, EPropertyBagResult > GetMutableArrayRef
(
const FName Name |
Returns helper class to modify and access an array property. | StructUtils/PropertyBag.h | |
TValueOrError< FPropertyBagArrayRef, EPropertyBagResult > GetMutableArrayRef
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< FPropertyBagSetRef, EPropertyBagResult > GetMutableSetRef
(
const FName Name |
Returns helper class to modify and access a set property. | StructUtils/PropertyBag.h | |
TValueOrError< FPropertyBagSetRef, EPropertyBagResult > GetMutableSetRef
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
FStructView GetMutableValue() |
StructUtils/PropertyBag.h | ||
int32 GetNumPropertiesInBag() |
Returns number of the Properties in this Property Bag | StructUtils/PropertyBag.h | |
| StructUtils/PropertyBag.h | |||
const UPropertyBag * GetPropertyBagStruct() |
StructUtils/PropertyBag.h | ||
TValueOrError< const FPropertyBagSetRef, EPropertyBagResult > GetSetRef
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< const FPropertyBagSetRef, EPropertyBagResult > GetSetRef
(
const FName Name |
Returns helper class to access a set property. | StructUtils/PropertyBag.h | |
FConstStructView GetValue() |
StructUtils/PropertyBag.h | ||
TValueOrError< bool, EPropertyBagResult > GetValueBool
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< bool, EPropertyBagResult > GetValueBool
(
const FName Name |
Getters Numeric types (bool, (u)int32, (u)int64, float, double) support type conversion. | StructUtils/PropertyBag.h | |
TValueOrError< uint8, EPropertyBagResult > GetValueByte
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< uint8, EPropertyBagResult > GetValueByte
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< UClass *, EPropertyBagResult > GetValueClass
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< UClass *, EPropertyBagResult > GetValueClass
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< double, EPropertyBagResult > GetValueDouble
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< double, EPropertyBagResult > GetValueDouble
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< uint8, EPropertyBagResult > GetValueEnum
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
TValueOrError< T, EPropertyBagResult > GetValueEnum
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< uint8, EPropertyBagResult > GetValueEnum
(
const FName Name, |
StructUtils/PropertyBag.h | ||
TValueOrError< T, EPropertyBagResult > GetValueEnum
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< float, EPropertyBagResult > GetValueFloat
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< float, EPropertyBagResult > GetValueFloat
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< int32, EPropertyBagResult > GetValueInt32
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< int32, EPropertyBagResult > GetValueInt32
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< int64, EPropertyBagResult > GetValueInt64
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< int64, EPropertyBagResult > GetValueInt64
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< FName, EPropertyBagResult > GetValueName
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< FName, EPropertyBagResult > GetValueName
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< UObject *, EPropertyBagResult > GetValueObject
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
TValueOrError< T *, EPropertyBagResult > GetValueObject
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< UObject *, EPropertyBagResult > GetValueObject
(
const FName Name, |
StructUtils/PropertyBag.h | ||
TValueOrError< T *, EPropertyBagResult > GetValueObject
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< FString, EPropertyBagResult > GetValueSerializedString
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< FSoftObjectPath, EPropertyBagResult > GetValueSoftPath
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< FSoftObjectPath, EPropertyBagResult > GetValueSoftPath
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< FString, EPropertyBagResult > GetValueString
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< FString, EPropertyBagResult > GetValueString
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< FStructView, EPropertyBagResult > GetValueStruct
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
TValueOrError< FStructView, EPropertyBagResult > GetValueStruct
(
const FName Name, |
StructUtils/PropertyBag.h | ||
TValueOrError< T *, EPropertyBagResult > GetValueStruct
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< T *, EPropertyBagResult > GetValueStruct
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< FText, EPropertyBagResult > GetValueText
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< FText, EPropertyBagResult > GetValueText
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< uint32, EPropertyBagResult > GetValueUInt32
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< uint32, EPropertyBagResult > GetValueUInt32
(
const FName Name |
StructUtils/PropertyBag.h | ||
TValueOrError< uint64, EPropertyBagResult > GetValueUInt64
(
const FPropertyBagPropertyDesc& Desc |
StructUtils/PropertyBag.h | ||
TValueOrError< uint64, EPropertyBagResult > GetValueUInt64
(
const FName Name |
StructUtils/PropertyBag.h | ||
bool HasSameLayout
(
const FInstancedPropertyBag& Other |
Returns true if our propertybag has the same layout & per property types as another propertybag. | StructUtils/PropertyBag.h | |
bool Identical
(
const FInstancedPropertyBag* Other, |
StructUtils/PropertyBag.h | ||
void InitializeFromBagStruct
(
const UPropertyBag* NewBagStruct |
Initializes the instance from a bag struct. | StructUtils/PropertyBag.h | |
bool IsValid() |
StructUtils/PropertyBag.h | ||
void MigrateToNewBagInstance
(
const FInstancedPropertyBag& InNewBagInstance |
Changes the type of this bag to the InNewBagInstance, and migrates existing values over. | StructUtils/PropertyBag.h | |
void MigrateToNewBagInstanceWithOverrides
(
const FInstancedPropertyBag& InNewBagInstance, |
Changes the type of this bag to the InNewBagInstance, and migrates existing values over if marked as overridden in the OverriddenPropertyIDs. | StructUtils/PropertyBag.h | |
void MigrateToNewBagStruct
(
const UPropertyBag* NewBagStruct |
Changes the type of this bag and migrates existing values. | StructUtils/PropertyBag.h | |
bool OwnsPropertyDesc
(
const FPropertyBagPropertyDesc& Desc |
Returns true if we own the supplied property description, false otherwise. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult RemovePropertiesByName
(
const TConstArrayView< FName > PropertiesToRemove |
Removes properties from the bag by name if they exist. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult RemovePropertyByName
(
const FName PropertyToRemove |
Removes a property from the bag by name if it exists. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult RenameProperty
(
FName PropertyToRename, |
Renames a property in the bag if it exists. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult ReorderProperty
(
int32 SourcePropertyIndex, |
Reorders a property either before or after another target property. | StructUtils/PropertyBag.h | |
EPropertyBagAlterationResult ReorderProperty
(
FName SourcePropertyName, |
Reorders a property either before or after another target property. | StructUtils/PropertyBag.h | |
EPropertyBagResult ReplaceAllPropertiesAndValues
(
const TConstArrayView< FPropertyBagPropertyDesc > InDescs, |
Clears all properties, then adds the supplied properties to the bag and sets their respective values. | StructUtils/PropertyBag.h | |
void Reset() |
Resets the instance to empty. | StructUtils/PropertyBag.h | |
bool Serialize
(
FArchive& Ar |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValue
(
const FName Name, |
Sets property value from given source property and source container address A property must exist in that bag before it can be set. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueBool
(
const FName Name, |
Value Setters. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueBool
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueByte
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueByte
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueClass
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueClass
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueDouble
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueDouble
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueEnum
(
const FName Name, |
Sets enum value specified type. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueEnum
(
const FPropertyBagPropertyDesc& Desc, |
Sets enum value specified type. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueEnum
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueEnum
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueFloat
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueFloat
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueInt32
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueInt32
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueInt64
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueInt64
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueName
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueName
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueObject
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueObject
(
const FName Name, |
Sets object pointer value specified type. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueObject
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueObject
(
const FPropertyBagPropertyDesc& Desc, |
Sets object pointer value specified type. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueSerializedString
(
const FName Name, |
Sets property value from a serialized representation of the value. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueSoftPath
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueSoftPath
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueSoftPath
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueSoftPath
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueString
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueString
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueStruct
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueStruct
(
const FName Name, |
Sets struct value specified type. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueStruct
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueStruct
(
const FPropertyBagPropertyDesc& Desc, |
Sets struct value specified type. | StructUtils/PropertyBag.h | |
EPropertyBagResult SetValueText
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueText
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueUInt32
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueUInt32
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueUInt64
(
const FName Name, |
StructUtils/PropertyBag.h | ||
EPropertyBagResult SetValueUInt64
(
const FPropertyBagPropertyDesc& Desc, |
StructUtils/PropertyBag.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void * GetMutableValueAddress
(
const FPropertyBagPropertyDesc* Desc |
StructUtils/PropertyBag.h | ||
const void * GetValueAddress
(
const FPropertyBagPropertyDesc* Desc |
StructUtils/PropertyBag.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsPropertyNameValid
(
const FName Name |
Checks whether a provided name is a valid property bag name to create a new property bag property. | StructUtils/PropertyBag.h | |
static bool IsPropertyNameValid
(
const FString& Name |
Checks whether a provided name is a valid property bag name to create a new property bag property. | StructUtils/PropertyBag.h | |
static FName SanitizePropertyName
(
FName Name, |
Returns a sanitized version of the provided name without invalid characters. | StructUtils/PropertyBag.h | |
static FName SanitizePropertyName
(
const FString& Name, |
Returns a sanitized version of the provided name without invalid characters. | StructUtils/PropertyBag.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FInstancedPropertyBag & operator=
(
const FInstancedPropertyBag& InOther |
StructUtils/PropertyBag.h | ||
FInstancedPropertyBag & operator=
(
FInstancedPropertyBag&& InOther |
StructUtils/PropertyBag.h |