UEnum::GetMetaData

Return the metadata value associated with the specified key.

Windows
MacOS
Linux

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h

Include

#include "UObject/Class.h"

Source

/Engine/Source/Runtime/CoreUObject/Private/UObject/Enum.cpp

Syntax

FString GetMetaData
(
    const TCHAR * Key,
    int32 NameIndex,
    bool bAllowRemap
) const

Remarks

Return the metadata value associated with the specified key.

Returns

the value for the key specified, or an empty string if the key wasn't found or had no value.

Parameters

Parameter

Description

Key

the metadata tag to find the value for

NameIndex

if specified, will search the metadata linked for that enum value; otherwise, searches the metadata for the enum itself

bAllowRemap

if true, the returned value may be remapped from a .ini if the value starts with ini: Pass false when you need the exact string, including any ini:

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