Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Internationalization > FText > Format > FText::Format

Light Theme

Dark Theme

FText::Format

Format the given map of key->value pairs as named arguments within the given format pattern

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Internationalization/Text.h
Include	#include "Internationalization/Text.h"
Source	/Engine/Source/Runtime/Core/Private/Internationalization/Text.cpp

Syntax

static FText Format
(
FTextFormat Fmt,
const FFormatNamedArguments & InArguments
)

Remarks

Format the given map of key->value pairs as named arguments within the given format pattern

You may want to pre-compile your FText pattern into a FTextFormat prior to performing formats within a loop or on a critical path, as this can save CPU cycles, memory, and mutex resources vs re-compiling the pattern for each format call. See FTextFormat for more info.

Returns

The formatted FText

Parameters

Parameter	Description
Fmt	The format pattern to use
InArguments	The map of key->value pairs to inject into the format pattern

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

Take our survey

Cancel