1. Epic GamesDeveloper
  3. UMetaData

UMetaData

An object that holds a map of key/value pairs.

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/MetaData.h
Include #include "UObject/MetaData.h"

Syntax

class UMetaData : public UObject

Remarks

An object that holds a map of key/value pairs.

Variables

  Type Name Description
Public variable TMap< FWeakObjectPtr, TMap< FName, FString > > ObjectMetaDataMap Mapping between an object, and its key->value meta-data pairs.
Public variable TMap< FName, FString > RootMetaDataMap Root-level (not associated with a particular object) key->value meta-data pairs.

Constructors

  Type Name Description
Public function  

UMetaData ( const FObjectInitializer& ObjectInitializer
)

  
Public function COREUOBJECT_API

UMetaData ( FVTableHelper& Helper
)

 DO NOT USE. This constructor is for internal usage only for hot-reload purposes.

Functions

  Type Name Description
Public function Static void  
Public function Static UObject *  
Public function Static void

CopyMetadata ( UObject* SourceObject,
UObject* DestObject
)

 Copy all metadata from the source object to the destination object.
Public function const FString *

FindValue ( const UObject* Object,
const TCHAR* Key
)

 Returns the value for a the given key if it exists, null otherwise
Public function const FString *

FindValue ( const UObject* Object,
FName Key
)

 Returns the value for a the given key if it exists, null otherwise
Public function Static TMap< FName, FString > *

GetMapForObject ( const UObject* Object
)

 Find the name/value map for metadata for a specific object
Public function Static FName Returns the remapped key name, or NAME_None was not remapped.
Public function const FString &

GetValue ( const UObject* Object,
FName Key
)

 Return the value for the given key in the given property
Public function const FString &

GetValue ( const UObject* Object,
const TCHAR* Key
)

 Return the value for the given key in the given property
Public function bool

HasObjectValues ( const UObject* Object
)

 Is there any metadata for this property? Is there any metadata for this property?
Public function bool

HasValue ( const UObject* Object,
FName Key
)

 Return whether or not the Key is in the meta data
Public function bool

HasValue ( const UObject* Object,
const TCHAR* Key
)

 Return whether or not the Key is in the meta data
Public function void Removes any metadata entries that are to objects not inside the same package as this UMetaData object.
Public function void

RemoveValue ( const UObject* Object,
const TCHAR* Key
)

 Remove any entry with the supplied Key form the Property's metadata
Public function void

RemoveValue ( const UObject* Object,
FName Key
)

 Remove any entry with the supplied Key form the Property's metadata
Public function void

SetObjectValues ( const UObject* Object,
const TMap< FName, FString >& Values
)

 Set the key/value pair in the Property's metadata
Public function void

SetObjectValues ( const UObject* Object,
TMap< FName, FString >&& Values
)

 Set the key/value pair in the Property's metadata
Public function void

SetValue ( const UObject* Object,
FName Key,
const TCHAR* Value
)

 Set the key/value pair in the Property's metadata
Public function void

SetValue ( const UObject* Object,
const TCHAR* Key,
const TCHAR* Value
)

 Set the key/value pair in the Object's metadata
Public function Static UClass * Returns a UClass object representing this class at runtime
Public function Static EClassCastFlags Returns the static cast flags for this class
Public function Static const TCHAR * Returns the package this class belongs in
Public function Static void  

Overridden from UObject

  Type Name Description
Public function Virtual Const bool

IsAsset ()

 Returns true if this object is considered an asset.
Public function Virtual Const bool Called during saving to include this object in client/servers running in editor builds, even if they wouldn't normally be.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.
Public function Virtual void  

Operators

  Type Name Description
Public function void

operator delete ( void* InMem
)

 Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy.
Public function void *

operator new ( const size_t InSize,
EInternal InInternalOnly,
UObject* InOuter,
FName InName,
EObjectFlags InSetFlags
)

 For internal use only; use StaticConstructObject() to create new objects.
Public function void *

operator new ( const size_t InSize,
EInternal* InMem
)

 For internal use only; use StaticConstructObject() to create new objects.

Typedefs

Name Description
Super Typedef for the base class (UObject)
ThisClass Typedef for UMetaData.

Constants

Name Description
KeyRedirectMap Redirect map from deprecated keys to current key names.
StaticClassFlags Bitwise union of EClassFlags pertaining to this class.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page