Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FText
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FText Format
(
FTextFormat Fmt, |
Format the given map of key->value pairs as named arguments within the given format pattern | Internationalization/Text.h | |
static FText Format
(
FTextFormat Fmt, |
Internationalization/Text.h | ||
static FText Format
(
FTextFormat Fmt, |
Format the given list values as ordered arguments within the given format pattern | Internationalization/Text.h | |
static FText Format
(
FTextFormat Fmt, |
Internationalization/Text.h | ||
static FText Format
(
FTextFormat Fmt, |
Format the given list of variadic values as ordered arguments within the given format pattern | Internationalization/Text.h |
Format(FTextFormat, const FFormatNamedArguments &)
Description
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.
| Name | Format |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Internationalization/Text.h |
| Include Path | #include "Internationalization/Text.h" |
| Source | /Engine/Source/Runtime/Core/Private/Internationalization/Text.cpp |
static FText Format
(
FTextFormat Fmt,
const FFormatNamedArguments & InArguments
)
The formatted FText
Parameters
| Name | Remarks |
|---|---|
| Fmt | The format pattern to use |
| InArguments | The map of key->value pairs to inject into the format pattern |
Format(FTextFormat, FFormatNamedArguments &&)
| Name | Format |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Internationalization/Text.h |
| Include Path | #include "Internationalization/Text.h" |
| Source | /Engine/Source/Runtime/Core/Private/Internationalization/Text.cpp |
static FText Format
(
FTextFormat Fmt,
FFormatNamedArguments && InArguments
)
Format(FTextFormat, const FFormatOrderedArguments &)
Description
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.
| Name | Format |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Internationalization/Text.h |
| Include Path | #include "Internationalization/Text.h" |
| Source | /Engine/Source/Runtime/Core/Private/Internationalization/Text.cpp |
static FText Format
(
FTextFormat Fmt,
const FFormatOrderedArguments & InArguments
)
The formatted FText
Parameters
| Name | Remarks |
|---|---|
| Fmt | The format pattern to use |
| InArguments | The list of values to inject into the format pattern |
Format(FTextFormat, FFormatOrderedArguments &&)
| Name | Format |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Internationalization/Text.h |
| Include Path | #include "Internationalization/Text.h" |
| Source | /Engine/Source/Runtime/Core/Private/Internationalization/Text.cpp |
static FText Format
(
FTextFormat Fmt,
FFormatOrderedArguments && InArguments
)
Format(FTextFormat, ArgTypes...)
Description
Format the given list of variadic 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. @usage FText::Format(LOCTEXT("PlayerNameFmt", "{0} is really cool"), FText::FromString(PlayerName));
| Name | Format |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Internationalization/Text.h |
| Include Path | #include "Internationalization/Text.h" |
template<typename... ArgTypes>
static FText Format
(
FTextFormat Fmt,
ArgTypes... Args
)
The formatted FText
Parameters
| Name | Remarks |
|---|---|
| Fmt | The format pattern to use |
| Args | A variadic list of values to inject into the format pattern |