UMetaData

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

Windows
MacOS
Linux

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

Name Description

Public variable

TMap< FWeakObje...

 

ObjectMetaDataMap

Mapping between an object, and its key->value meta-data pairs.

Public variable

TMap< FName, FS...

 

RootMetaDataMap

Root-level (not associated with a particular object) key->value meta-data pairs.

Constructors

Name Description

Public function

UMetaData

(
    const FObjectInitializer& ObjectIn...
)

Public function

UMetaData

(
    FVTableHelper& Helper
)

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

Functions

Name Description

Public function Static

void

 

__DefaultConstructor

(
    const FObjectInitializer& X
)

Public function Static

UObject *...

 

__VTableCtorCaller

(
    FVTableHelper& Helper
)

Public function Static

void

 

CopyMetadata

(
    UObject* SourceObject,
    UObject* DestObject
)

Copy all metadata from the source object to the destination object.

Public function Static

TMap< FName,...

 

GetMapForObject

(
    const UObject* Object
)

Find the name/value map for metadata for a specific object

Public function Static

FName

 

GetRemappedKeyName

(
    FName OldKey
)

Returns the remapped key name, or NAME_None was not remapped.

Public function

const FStrin...

 

GetValue

(
    const UObject* Object,
    FName Key
)

Return the value for the given key in the given property

Public function

const FStrin...

 

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

 

RemoveMetaDataOutsidePackage()

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 >& Valu...
)

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

void

 

SetValue

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

Set the key/value pair in the Property's metadata

Public function Static

UClass *

 

StaticClass()

Returns a UClass object representing this class at runtime

Public function Static

EClassCastFl...

 

StaticClassCastFlags()

Returns the static cast flags for this class

Public function Static

const TCHAR ...

 

StaticPackage()

Returns the package this class belongs in

Public function Static

void

 

StaticRegisterNativesUMetaData()

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

IsAsset()

Returns true if this object is considered an asset.

Public function Virtual Const

bool

 

NeedsLoadForEditorGame()

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

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Public function Virtual

void

 

Serialize

(
    FStructuredArchive::FRecord Record
)

Handles reading, writing, and reference collecting using FArchive.

Operators

Name Description

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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss