1. Epic GamesDeveloper
  3. FTextFormatter

FTextFormatter

A text formatter is responsible for formatting text patterns using a set of named or ordered arguments.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Internationalization

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Internationalization/TextFormatter.h
Include #include "Internationalization/TextFormatter.h"

Syntax

class FTextFormatter

Remarks

A text formatter is responsible for formatting text patterns using a set of named or ordered arguments.

Constructors

No constructors are accessible with public or protected access.

Functions

  Type Name Description
Public function Static void

ArgumentValueToFormattedString ( const FFormatArgumentValue& InValue,
const FPrivateTextFormatArguments& InFormatArgs,
FString& OutResult
)

 Incredibly low-level version of FFormatArgumentValue::ToFormattedString.
Public function Const FCompileTextArgumentModifierFuncPtr  
Public function Static FString

Format ( const FTextFormat& InFmt,
const FPrivateTextFormatArguments& InFormatArgs
)

 Incredibly low-level version of format.
Public function Static FText

Format ( FTextFormat&& InFmt,
FFormatNamedArguments&& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

 Low-level versions of Format.
Public function Static FText

Format ( FTextFormat&& InFmt,
FFormatOrderedArguments&& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

 Low-level versions of Format.
Public function Static FText

Format ( FTextFormat&& InFmt,
TArray< FFormatArgumentData >&& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

 Low-level versions of Format.
Public function Static FString

FormatStr ( const FTextFormat& InFmt,
const FFormatNamedArguments& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

 Low-level version of Format that returns a string.
Public function Static FString

FormatStr ( const FTextFormat& InFmt,
const FFormatOrderedArguments& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

 Low-level version of Format that returns a string.
Public function Static FString

FormatStr ( const FTextFormat& InFmt,
const TArray< FFormatArgumentData >& InArguments,
const bool bInRebuildText,
const bool bInRebuildAsSource
)

 Low-level version of Format that returns a string.
Public function Static FTextFormatter &

Get ()

 Singleton access
Public function void  
Public function void  

Typedefs

Name Description
FCompileTextArgumentModifierFuncPtr Callback function used to compile an argument modifier.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page