UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TextStringificationUtil Namespace Reference

Typedefs

typedef TFunctionRef< void(const FString *, const FFormatArgumentValue &)> FTextFormatArgumentEnumeratorCallback
 

Functions

bool PeekMarker (const TCHAR *Buffer, const TCHAR *InMarker, const int32 InMarkerLen)
 
bool PeekInsensitiveMarker (const TCHAR *Buffer, const TCHAR *InMarker, const int32 InMarkerLen)
 
const TCHARSkipMarker (const TCHAR *Buffer, const TCHAR *InMarker, const int32 InMarkerLen)
 
const TCHARSkipInsensitiveMarker (const TCHAR *Buffer, const TCHAR *InMarker, const int32 InMarkerLen)
 
const TCHARSkipWhitespace (const TCHAR *Buffer)
 
const TCHARSkipWhitespaceToCharacter (const TCHAR *Buffer, const TCHAR InChar)
 
const TCHARSkipWhitespaceAndCharacter (const TCHAR *Buffer, const TCHAR InChar)
 
const TCHARReadNumberFromBuffer (const TCHAR *Buffer, FFormatArgumentValue &OutValue)
 
const TCHARReadAlnumFromBuffer (const TCHAR *Buffer, FString &OutValue)
 
const TCHARReadQuotedStringFromBuffer (const TCHAR *Buffer, FString &OutStr)
 
template<typename T >
void WriteNumberFormattingOptionToBuffer (FString &Buffer, const TCHAR *OptionFunctionName, const T &OptionValue, const T &DefaultOptionValue, TFunctionRef< void(FString &, const T &)> WriteOptionValue)
 
void WriteNumberFormattingOptionsToBuffer (FString &Buffer, const FNumberFormattingOptions &Options)
 
template<typename T >
const TCHARReadNumberFormattingOptionFromBuffer (const TCHAR *Buffer, const FString &OptionFunctionName, T &OutOptionValue, TFunctionRef< const TCHAR *(const TCHAR *, T &)> ReadOptionValue)
 
const TCHARReadNumberFormattingOptionsFromBuffer (const TCHAR *Buffer, FNumberFormattingOptions &OutOptions)
 
void WriteNumberOrPercentToBuffer (FString &Buffer, const TCHAR *TokenMarker, const FFormatArgumentValue &SourceValue, const TOptional< FNumberFormattingOptions > &FormatOptions, FCulturePtr TargetCulture, const bool bStripPackageNamespace)
 
const TCHARReadNumberOrPercentFromBuffer (const TCHAR *Buffer, const FString &TokenMarker, FFormatArgumentValue &OutSourceValue, TOptional< FNumberFormattingOptions > &OutFormatOptions, FCulturePtr &OutTargetCulture)
 
void WriteDateTimeToBuffer (FString &Buffer, const TCHAR *TokenMarker, const FDateTime &DateTime, const EDateTimeStyle::Type *DateStylePtr, const EDateTimeStyle::Type *TimeStylePtr, const FString *CustomPattern, const FString &TimeZone, FCulturePtr TargetCulture, const bool bStripPackageNamespace)
 
const TCHARReadDateTimeFromBuffer (const TCHAR *Buffer, const FString &TokenMarker, FDateTime &OutDateTime, EDateTimeStyle::Type *OutDateStylePtr, EDateTimeStyle::Type *OutTimeStylePtr, FString *OutCustomPattern, FString &OutTimeZone, FCulturePtr &OutTargetCulture)
 
void WriteTextFormatToBuffer (FString &Buffer, const FString &TokenMarker, const FTextFormat &SourceFmt, const bool bStripPackageNamespace, TFunctionRef< void(FTextFormatArgumentEnumeratorCallback)> ArgumentEnumerator)
 
template<typename T >
const TCHARReadScopedEnumFromBuffer (const TCHAR *Buffer, const FString &Scope, T &OutValue)
 
template<typename T >
void WriteScopedEnumToBuffer (FString &Buffer, const TCHAR *Scope, const T Value)
 

Variables

const autoTextMarker = TEXT("TEXT")
 
const autoInvTextMarker = TEXT("INVTEXT")
 
const autoNsLocTextMarker = TEXT("NSLOCTEXT")
 
const autoLocTextMarker = TEXT("LOCTEXT")
 
const autoLocTableMarker = TEXT("LOCTABLE")
 
const autoLocGenNumberMarker = TEXT("LOCGEN_NUMBER")
 
const autoLocGenPercentMarker = TEXT("LOCGEN_PERCENT")
 
const autoLocGenCurrencyMarker = TEXT("LOCGEN_CURRENCY")
 
const autoLocGenDateMarker = TEXT("LOCGEN_DATE")
 
const autoLocGenTimeMarker = TEXT("LOCGEN_TIME")
 
const autoLocGenDateTimeMarker = TEXT("LOCGEN_DATETIME")
 
const autoLocGenToLowerMarker = TEXT("LOCGEN_TOLOWER")
 
const autoLocGenToUpperMarker = TEXT("LOCGEN_TOUPPER")
 
const autoLocGenFormatOrderedMarker = TEXT("LOCGEN_FORMAT_ORDERED")
 
const autoLocGenFormatNamedMarker = TEXT("LOCGEN_FORMAT_NAMED")
 
const autoGroupedSuffix = TEXT("_GROUPED")
 
const autoUngroupedSuffix = TEXT("_UNGROUPED")
 
const autoCustomSuffix = TEXT("_CUSTOM")
 
const autoUtcSuffix = TEXT("_UTC")
 
const autoLocalSuffix = TEXT("_LOCAL")
 

Detailed Description

Utilities for stringifying text

Typedef Documentation

◆ FTextFormatArgumentEnumeratorCallback

Function Documentation

◆ PeekInsensitiveMarker()

bool TextStringificationUtil::PeekInsensitiveMarker ( const TCHAR Buffer,
const TCHAR InMarker,
const int32  InMarkerLen 
)

◆ PeekMarker()

bool TextStringificationUtil::PeekMarker ( const TCHAR Buffer,
const TCHAR InMarker,
const int32  InMarkerLen 
)

◆ ReadAlnumFromBuffer()

const TCHAR * TextStringificationUtil::ReadAlnumFromBuffer ( const TCHAR Buffer,
FString &  OutValue 
)

◆ ReadDateTimeFromBuffer()

const TCHAR * TextStringificationUtil::ReadDateTimeFromBuffer ( const TCHAR Buffer,
const FString &  TokenMarker,
FDateTime OutDateTime,
EDateTimeStyle::Type OutDateStylePtr,
EDateTimeStyle::Type OutTimeStylePtr,
FString *  OutCustomPattern,
FString &  OutTimeZone,
FCulturePtr OutTargetCulture 
)

◆ ReadNumberFormattingOptionFromBuffer()

template<typename T >
const TCHAR * TextStringificationUtil::ReadNumberFormattingOptionFromBuffer ( const TCHAR Buffer,
const FString &  OptionFunctionName,
T &  OutOptionValue,
TFunctionRef< const TCHAR *(const TCHAR *, T &)>  ReadOptionValue 
)

◆ ReadNumberFormattingOptionsFromBuffer()

const TCHAR * TextStringificationUtil::ReadNumberFormattingOptionsFromBuffer ( const TCHAR Buffer,
FNumberFormattingOptions OutOptions 
)

◆ ReadNumberFromBuffer()

const TCHAR * TextStringificationUtil::ReadNumberFromBuffer ( const TCHAR Buffer,
FFormatArgumentValue OutValue 
)

◆ ReadNumberOrPercentFromBuffer()

const TCHAR * TextStringificationUtil::ReadNumberOrPercentFromBuffer ( const TCHAR Buffer,
const FString &  TokenMarker,
FFormatArgumentValue OutSourceValue,
TOptional< FNumberFormattingOptions > &  OutFormatOptions,
FCulturePtr OutTargetCulture 
)

◆ ReadQuotedStringFromBuffer()

const TCHAR * TextStringificationUtil::ReadQuotedStringFromBuffer ( const TCHAR Buffer,
FString &  OutStr 
)

◆ ReadScopedEnumFromBuffer()

template<typename T >
const TCHAR * TextStringificationUtil::ReadScopedEnumFromBuffer ( const TCHAR Buffer,
const FString &  Scope,
T &  OutValue 
)

◆ SkipInsensitiveMarker()

const TCHAR * TextStringificationUtil::SkipInsensitiveMarker ( const TCHAR Buffer,
const TCHAR InMarker,
const int32  InMarkerLen 
)

◆ SkipMarker()

const TCHAR * TextStringificationUtil::SkipMarker ( const TCHAR Buffer,
const TCHAR InMarker,
const int32  InMarkerLen 
)

◆ SkipWhitespace()

const TCHAR * TextStringificationUtil::SkipWhitespace ( const TCHAR Buffer)

◆ SkipWhitespaceAndCharacter()

const TCHAR * TextStringificationUtil::SkipWhitespaceAndCharacter ( const TCHAR Buffer,
const TCHAR  InChar 
)

◆ SkipWhitespaceToCharacter()

const TCHAR * TextStringificationUtil::SkipWhitespaceToCharacter ( const TCHAR Buffer,
const TCHAR  InChar 
)

◆ WriteDateTimeToBuffer()

void TextStringificationUtil::WriteDateTimeToBuffer ( FString &  Buffer,
const TCHAR TokenMarker,
const FDateTime DateTime,
const EDateTimeStyle::Type DateStylePtr,
const EDateTimeStyle::Type TimeStylePtr,
const FString *  CustomPattern,
const FString &  TimeZone,
FCulturePtr  TargetCulture,
const bool  bStripPackageNamespace 
)

◆ WriteNumberFormattingOptionsToBuffer()

void TextStringificationUtil::WriteNumberFormattingOptionsToBuffer ( FString &  Buffer,
const FNumberFormattingOptions Options 
)

◆ WriteNumberFormattingOptionToBuffer()

template<typename T >
void TextStringificationUtil::WriteNumberFormattingOptionToBuffer ( FString &  Buffer,
const TCHAR OptionFunctionName,
const T &  OptionValue,
const T &  DefaultOptionValue,
TFunctionRef< void(FString &, const T &)>  WriteOptionValue 
)

◆ WriteNumberOrPercentToBuffer()

void TextStringificationUtil::WriteNumberOrPercentToBuffer ( FString &  Buffer,
const TCHAR TokenMarker,
const FFormatArgumentValue SourceValue,
const TOptional< FNumberFormattingOptions > &  FormatOptions,
FCulturePtr  TargetCulture,
const bool  bStripPackageNamespace 
)

◆ WriteScopedEnumToBuffer()

template<typename T >
void TextStringificationUtil::WriteScopedEnumToBuffer ( FString &  Buffer,
const TCHAR Scope,
const T  Value 
)

◆ WriteTextFormatToBuffer()

void TextStringificationUtil::WriteTextFormatToBuffer ( FString &  Buffer,
const FString &  TokenMarker,
const FTextFormat SourceFmt,
const bool  bStripPackageNamespace,
TFunctionRef< void(FTextFormatArgumentEnumeratorCallback)>  ArgumentEnumerator 
)

Variable Documentation

◆ CustomSuffix

const auto& TextStringificationUtil::CustomSuffix = TEXT("_CUSTOM")
inline

◆ GroupedSuffix

const auto& TextStringificationUtil::GroupedSuffix = TEXT("_GROUPED")
inline

◆ InvTextMarker

const auto& TextStringificationUtil::InvTextMarker = TEXT("INVTEXT")
inline

◆ LocalSuffix

const auto& TextStringificationUtil::LocalSuffix = TEXT("_LOCAL")
inline

◆ LocGenCurrencyMarker

const auto& TextStringificationUtil::LocGenCurrencyMarker = TEXT("LOCGEN_CURRENCY")
inline

◆ LocGenDateMarker

const auto& TextStringificationUtil::LocGenDateMarker = TEXT("LOCGEN_DATE")
inline

◆ LocGenDateTimeMarker

const auto& TextStringificationUtil::LocGenDateTimeMarker = TEXT("LOCGEN_DATETIME")
inline

◆ LocGenFormatNamedMarker

const auto& TextStringificationUtil::LocGenFormatNamedMarker = TEXT("LOCGEN_FORMAT_NAMED")
inline

◆ LocGenFormatOrderedMarker

const auto& TextStringificationUtil::LocGenFormatOrderedMarker = TEXT("LOCGEN_FORMAT_ORDERED")
inline

◆ LocGenNumberMarker

const auto& TextStringificationUtil::LocGenNumberMarker = TEXT("LOCGEN_NUMBER")
inline

◆ LocGenPercentMarker

const auto& TextStringificationUtil::LocGenPercentMarker = TEXT("LOCGEN_PERCENT")
inline

◆ LocGenTimeMarker

const auto& TextStringificationUtil::LocGenTimeMarker = TEXT("LOCGEN_TIME")
inline

◆ LocGenToLowerMarker

const auto& TextStringificationUtil::LocGenToLowerMarker = TEXT("LOCGEN_TOLOWER")
inline

◆ LocGenToUpperMarker

const auto& TextStringificationUtil::LocGenToUpperMarker = TEXT("LOCGEN_TOUPPER")
inline

◆ LocTableMarker

const auto& TextStringificationUtil::LocTableMarker = TEXT("LOCTABLE")
inline

◆ LocTextMarker

const auto& TextStringificationUtil::LocTextMarker = TEXT("LOCTEXT")
inline

◆ NsLocTextMarker

const auto& TextStringificationUtil::NsLocTextMarker = TEXT("NSLOCTEXT")
inline

◆ TextMarker

const auto& TextStringificationUtil::TextMarker = TEXT("TEXT")
inline

◆ UngroupedSuffix

const auto& TextStringificationUtil::UngroupedSuffix = TEXT("_UNGROUPED")
inline

◆ UtcSuffix

const auto& TextStringificationUtil::UtcSuffix = TEXT("_UTC")
inline