FLocMetadataObject

A LocMetadata Object is a structure holding an unordered set of name/value pairs.

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Internationalization/InternationalizationMetadata.h

Include

#include "Internationalization/InternationalizationMetadata.h"

Syntax

class FLocMetadataObject

Remarks

A LocMetadata Object is a structure holding an unordered set of name/value pairs.

Variables

Name Description

Public variable

TMap< FString, ...

 

Values

Stores the name/value pairs for the metadata object

Constructors

Name Description

Public function

FLocMetadataObject()

Public function

FLocMetadataObject

(
    const FLocMetadataObject& Other
)

Copy ctor

Functions

Name Description

Public function

TArray< TSha...

 

GetArrayField

(
    const FString& FieldName
)

Get the field named FieldName as an array.

Public function

bool

 

GetBoolField

(
    const FString& FieldName
)

Get the field named FieldName as a boolean.

Public function

TSharedPtr< ...

 

GetField

(
    const FString& FieldName
)

Public function

TSharedPtr< ...

 

GetObjectField

(
    const FString& FieldName
)

Get the field named FieldName as a LocMetadata object.

Public function

FString

 

GetStringField

(
    const FString& FieldName
)

Get the field named FieldName as a string.

Public function

bool

 

HasField

(
    const FString& FieldName
)

Checks to see if the FieldName exists in the object.

Public function

bool

 

HasTypedField

(
    const FString& FieldName
)

Checks to see if the FieldName exists in the object, and has the specified type.

Public function Const

bool

 

IsExactMatch

(
    const FLocMetadataObject& Other
)

Similar functionality to == operator but ensures everything matches(ignores COMPARISON_MODIFIER_PREFIX).

Public function Static

bool

 

IsMetadataExactMatch

(
    const FLocMetadataObject*const...,
    const FLocMetadataObject*const...
)

Public function

void

 

RemoveField

(
    const FString& FieldName
)

Public function

void

 

SetArrayField

(
    const FString& FieldName,
    const TArray< TSharedPtr< FLocMetad...
)

Set an array field named FieldName and value of Array

Public function

void

 

SetBoolField

(
    const FString& FieldName,
    bool InValue
)

Set a boolean field named FieldName and value of InValue

Public function

void

 

SetField

(
    const FString& FieldName,
    const TSharedPtr< FLocMetadataValue...
)

Public function

void

 

SetObjectField

(
    const FString& FieldName,
    const TSharedPtr< FLocMetadataObjec...
)

Set an ObjectField named FieldName and value of LocMetadataObject

Public function

void

 

SetStringField

(
    const FString& FieldName,
    const FString& StringValue
)

Add a field named FieldName with value of StringValue

Public function Const

FString

 

ToString()

Operators

Name Description

Public function Const

bool

 

operator<

(
    const FLocMetadataObject& Other
)

Public function

FLocMetadata...

 

operator=

(
    const FLocMetadataObject& Other
)

Public function Const

bool

 

operator==

(
    const FLocMetadataObject& Other
)

Constants

Name

Description

COMPARISON_MODIFIER_PREFIX

Special reserved character.

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