UKismetTextLibrary

class Engine Blueprint Since unknown

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary › UKismetTextLibrary

#include "Kismet/KismetTextLibrary.h"

Description

Blueprint function library providing FText conversion, formatting, and query utilities. Backs the 'Utilities|Text' category nodes in the Blueprint graph editor, mirroring parts of the C++ FText API for visual scripting.

Caveats & Gotchas

• All functions are static and BlueprintPure, and the class carries BlueprintThreadSafe, so calling them has no side effects and they can safely execute off the game thread.
• The UCLASS meta sets ScriptName="TextLibrary", so Python/scripting API references use 'TextLibrary' rather than 'KismetTextLibrary'.

Functions (52)

String 1 Text 51

String

1 ▼

Access	Type	Name	Description
public	function	UKismetTextLibrary::Conv_TextToString	Converts localizable text to a plain FString.

Text

51 ▼

Access	Type	Name	Description
public	function	UKismetTextLibrary::Conv_BoolToText	Converts a boolean value to formatted text, either 'true' or 'false'.
public	function	UKismetTextLibrary::Conv_ByteToText	Converts a byte value to formatted text.
public	function	UKismetTextLibrary::Conv_IntToText	Converts an integer to formatted, localized text using the given number formatting options.
public	function	UKismetTextLibrary::Conv_StringToText	Converts a string to culture-invariant text.
public	function	UKismetTextLibrary::TextIsEmpty	Returns true if the given text is empty.
public	function	UKismetTextLibrary::TextToLower	Transforms the text to lowercase in a culture-correct way.
public	function	UKismetTextLibrary::TextToUpper	Transforms the text to uppercase in a culture-correct way.
public	function	UKismetTextLibrary::TextTrimPrecedingAndTrailing	Removes whitespace characters from the front and end of the text.
public	function	UKismetTextLibrary::AsCurrencyBase	Formats an integer amount as currency in the current culture.
public	function	UKismetTextLibrary::AsDate_DateTime	Converts a date & time to text formatted as a date only, using an invariant timezone.
public	function	UKismetTextLibrary::AsDateTime_DateTime	Converts a date & time to text combining both the date and time of day, using an invariant timezone with no conversion applied.
public	function	UKismetTextLibrary::AsMemory	Generates localized text that represents a byte count as a human-readable memory size, choosing the appropriate unit (KB/MiB/GB/etc.
public	function	UKismetTextLibrary::AsPercent_Float	Formats a float as percent text, multiplying the value by 100 and appending a localized percent symbol.
public	function	UKismetTextLibrary::AsTime_DateTime	Converts a date & time to text formatted as a time only, using an invariant timezone with no conversion applied.
public	function	UKismetTextLibrary::AsTimeZoneDateTime_DateTime	Converts a date & time to combined date and time text, converting from UTC to the given timezone (or the local timezone if none is specified), accounting for daylight saving time.
public	function	UKismetTextLibrary::AsTimeZoneTime_DateTime	Converts a date & time to text formatted as a time only, converting from UTC to the given timezone (or the local timezone if none is specified), accounting for daylight saving time.
public	function	UKismetTextLibrary::Conv_ColorToText	Converts a linear color to localized, formatted text in the form '(R=,G=,B=,A=)'.
public	function	UKismetTextLibrary::Conv_DoubleToText	Converts a double to formatted, localized text using the given number and rounding options.
public	function	UKismetTextLibrary::Conv_Int64ToText	Converts a 64-bit integer to formatted, localized text using the given number formatting options.
public	function	UKismetTextLibrary::Conv_NameToText	Converts an FName to culture-invariant text.
public	function	UKismetTextLibrary::Conv_NumericPropertyToText	Converts a generic numeric value to localized formatted text using the user's current culture.
public	function	UKismetTextLibrary::Conv_ObjectToText	Converts a UObject reference to culture-invariant text by calling the object's GetName().
public	function	UKismetTextLibrary::Conv_RotatorToText	Converts a rotator to localized, formatted text in the form 'P= Y= R='.
public	function	UKismetTextLibrary::Conv_TransformToText	Converts a transform to localized, formatted text combining translation, rotation, and scale.
public	function	UKismetTextLibrary::Conv_Vector2dToText	Converts a 2D vector to localized, formatted text in the form 'X= Y='.
public	function	UKismetTextLibrary::Conv_VectorToText	Converts a vector to localized, formatted text in the form 'X= Y= Z='.
public	function	UKismetTextLibrary::EqualEqual_IgnoreCase_TextText	Returns true if A and B are linguistically equal, ignoring case differences.
public	function	UKismetTextLibrary::EqualEqual_TextText	Returns true if A and B are linguistically equal, comparing the displayed strings rather than object identity.
public	function	UKismetTextLibrary::Format	Substitutes named arguments into a text pattern, culturally formatting each argument according to its type.
public	function	UKismetTextLibrary::GetEmptyText	Returns an empty piece of text.
public	function	UKismetTextLibrary::MakeInvariantText	Converts a string to culture-invariant text, functionally identical to Conv_StringToText.
public	function	UKismetTextLibrary::NotEqual_IgnoreCase_TextText	Returns true if A and B are linguistically not equal, ignoring case differences.
public	function	UKismetTextLibrary::NotEqual_TextText	Returns true if A and B are linguistically not equal.
public	function	UKismetTextLibrary::TextIsFromStringTable	Returns true if the given text is referencing a row in a string table rather than being a literal or generated FText.
public	function	UKismetTextLibrary::TextTrimPreceding	Removes whitespace characters from the front of the text.
public	function	UKismetTextLibrary::TextTrimTrailing	Removes trailing whitespace characters from the text.
public	function	UKismetTextLibrary::AsCurrency_Float deprecated	Formats a float value as currency text using the given rounding and number formatting options.
public	function	UKismetTextLibrary::AsCurrency_Integer deprecated	Formats an integer value as currency text using the given rounding and number formatting options.
public	function	UKismetTextLibrary::AsTimespan_Timespan	Converts a passed-in time span to localized text, formatted as a time span (e.
public	function	UKismetTextLibrary::AsTimeZoneDate_DateTime	Converts a date & time to text formatted as a date only, converting from UTC to the given timezone (or the local timezone if none is specified), accounting for daylight saving time.
public	function	UKismetTextLibrary::EditTextPropertySourceString	Same as EditTextSourceString, but looks the property up by name on TextOwner instead of taking a direct reference to it.
public	function	UKismetTextLibrary::EditTextSourceString	Edits the source string of a text property in place, akin to editing that property in a details panel, while attempting to preserve its localization ID.
public	function	UKismetTextLibrary::FindTextInLocalizationTable	Looks up a text entry directly by namespace and key in the localization tables and returns whether it was found.
public	function	UKismetTextLibrary::GetTextId	Attempts to get the localization ID (namespace and key) used by the given text, returning whether an ID was found.
public	function	UKismetTextLibrary::GetTextSourceString	Gets the non-localized source string of the given text — the original, untranslated string it was authored or generated from.
public	function	UKismetTextLibrary::IsPolyglotDataValid	Checks whether the given FPolyglotTextData is valid — i.
public	function	UKismetTextLibrary::PolyglotDataToText	Gets the text instance created from the given polyglot data, or an empty text if the data is invalid.
public	function	UKismetTextLibrary::StringTableIdAndKeyFromText	Attempts to get the string table ID and key used by the given text, returning whether the lookup succeeded.
public	function	UKismetTextLibrary::TextFromStringTable	Attempts to create a text instance from a string table ID and key, looked up programmatically at runtime.
public	function	UKismetTextLibrary::TextIsCultureInvariant	Returns true if the given text is culture invariant, meaning it won't change when the active culture changes.
public	function	UKismetTextLibrary::TextIsTransient	Returns true if the given text is transient, meaning it was generated at runtime rather than loaded from a localization source.

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?