FText::Format

Format the given list values as ordered 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 FFormatOrderedArguments & InArguments
)

Remarks

Format the given list values as ordered 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 list of values 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