UPropertyBag | Unreal Engine 5.8 Documentation

API > API/Runtime > API/Runtime/CoreUObject

A script struct that is used to store the value of the property bag instance. References to UPropertyBag cannot be serialized, instead the array of the properties is serialized and new class is create on load based on the composition of the properties.

Note: Should not be used directly.


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

Syntax

UCLASS (Transient, MinimalAPI)  
class UPropertyBag : public UScriptStruct

Inheritance Hierarchy

FStructBaseChain → UStruct → UScriptStruct → UPropertyBag
UObjectBase → UObjectBaseUtility → UObject → UField → UStruct → UScriptStruct → UPropertyBag

Functions

Public

Name	Remarks	Include Path
bool ContainsUserDefinedStruct ( const UUserDefinedStruct* UserDefinedStruct ) const		StructUtils/PropertyBag.h
const FPropertyBagPropertyDesc * FindPropertyDescByID ( const FGuid ID ) const		StructUtils/PropertyBag.h
const FPropertyBagPropertyDesc * FindPropertyDescByIndex ( int32 Index ) const		StructUtils/PropertyBag.h
const FPropertyBagPropertyDesc * FindPropertyDescByName ( const FName Name ) const		StructUtils/PropertyBag.h
const FPropertyBagPropertyDesc * FindPropertyDescByProperty ( const FProperty* Property ) const		StructUtils/PropertyBag.h
const FPropertyBagPropertyDesc * FindPropertyDescByPropertyName ( const FName PropertyName ) const		StructUtils/PropertyBag.h
TConstArrayView< FPropertyBagPropertyDesc > GetPropertyDescs()	Returns property descriptions that specify this struct.	StructUtils/PropertyBag.h
bool OwnsPropertyDesc ( const FPropertyBagPropertyDesc& Desc ) const		StructUtils/PropertyBag.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
void DecrementRefCount()		StructUtils/PropertyBag.h
void IncrementRefCount()		StructUtils/PropertyBag.h

Protected Virtual

Overridden from UStruct

Name	Remarks	Include Path
virtual bool ArePropertyGuidsAvailable()	Returns if we have access to property guids	StructUtils/PropertyBag.h
virtual void DestroyStruct ( void* Dest, int32 ArrayDim ) const	Destroy a struct in memory.	StructUtils/PropertyBag.h
virtual FGuid FindPropertyGuidFromName ( const FName InName ) const	Find property guid	StructUtils/PropertyBag.h
virtual FName FindPropertyNameFromGuid ( const FGuid& PropertyGuid ) const	Returns the property name from the guid	StructUtils/PropertyBag.h
virtual void InitializeStruct ( void* Dest, int32 ArrayDim ) const	Initialize a struct over uninitialized memory.	StructUtils/PropertyBag.h
virtual void Link ( FArchive& Ar, bool bRelinkExistingProperties )	Creates the field/property links and gets structure ready for use at runtime	StructUtils/PropertyBag.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void FinishDestroy ()	Called to finish destroying the object.	StructUtils/PropertyBag.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static const UPropertyBag * GetOrCreateFromDescs ( const TConstArrayView< FPropertyBagPropertyDesc > InPropertyDescs, const TCHAR* PrefixName )	Returns UPropertyBag struct based on the property descriptions passed in.	StructUtils/PropertyBag.h
static TArray< FPropertyBagPropertyDesc > SanitizePropertyDescs ( const TArrayView< const FPropertyBagPropertyDesc > PropertyDescs )	Fix property descriptions that are not properly formed.	StructUtils/PropertyBag.h

Navigation