1. Epic GamesDeveloper
  3. UKismetTextLibrary

UKismetTextLibrary

API > API/Runtime > API/Runtime/Engine

   
Name UKismetTextLibrary
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Kismet/KismetTextLibrary.h
Include Path #include "Kismet/KismetTextLibrary.h"

Syntax

UCLASS (Meta=(BlueprintThreadSafe, ScriptName="TextLibrary"), MinimalAPI)  
class UKismetTextLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UKismetTextLibrary ( const FObjectInitializer& ObjectInitializer
)

   Kismet/KismetTextLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static FText AsCurrency_Float ( float Value,
TEnumAsByte< ERoundingMode > RoundingMode,
bool bAlwaysSign,
bool bUseGrouping,
int32 MinimumIntegralDigits,
int32 MaximumIntegralDigits,
int32 MinimumFractionalDigits,
int32 MaximumFractionalDigits,
const FString& CurrencyCode
)

 Default values are duplicated from FNumberFormattingOptions and should be replicated in all functions and in the struct when changed! Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="AsCurrency (float) - DEPRECATED (use AsCurrency)")
  • Category="Utilities|Text"

static FText AsCurrency_Integer ( int32 Value,
TEnumAsByte< ERoundingMode > RoundingMode,
bool bAlwaysSign,
bool bUseGrouping,
int32 MinimumIntegralDigits,
int32 MaximumIntegralDigits,
int32 MinimumFractionalDigits,
int32 MaximumFractionalDigits,
const FString& CurrencyCode
)

 Default values are duplicated from FNumberFormattingOptions and should be replicated in all functions and in the struct when changed! Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="AsCurrency (integer) - DEPRECATED (use AsCurrency)")
  • Category="Utilities|Text"

static FText AsCurrencyBase ( int32 BaseValue,
const FString& CurrencyCode
)

 Generate an FText that represents the passed number as currency in the current culture. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As Currency")
  • Category="Utilities|Text"

static FText AsDate_DateTime ( const FDateTime& InDateTime,
TEnumAsByte< EDateTimeStyle::Type > InDateStyle
)

 Converts a passed in date & time to a text, formatted as a date using an invariant timezone. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As Date", AdvancedDisplay="1")
  • Category="Utilities|Text"
Converts a passed in date & time to a text, formatted as a date & time using an invariant timezone. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As DateTime", AdvancedDisplay="1")
  • Category="Utilities|Text"

static FText AsMemory ( int64 NumBytes,
TEnumAsByte< EMemoryUnitStandard > UnitStandard,
bool bUseGrouping,
int32 MinimumIntegralDigits,
int32 MaximumIntegralDigits,
int32 MinimumFractionalDigits,
int32 MaximumFractionalDigits
)

 Generate an FText that represents the passed number as a memory size in the current culture Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(AdvancedDisplay="1")
  • Category="Utilities|Text"

static FText AsPercent_Float ( float Value,
TEnumAsByte< ERoundingMode > RoundingMode,
bool bAlwaysSign,
bool bUseGrouping,
int32 MinimumIntegralDigits,
int32 MaximumIntegralDigits,
int32 MinimumFractionalDigits,
int32 MaximumFractionalDigits
)

 Default values are duplicated from FNumberFormattingOptions and should be replicated in all functions and in the struct when changed! Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As Percent", AdvancedDisplay="1")
  • Category="Utilities|Text"

static FText AsTime_DateTime ( const FDateTime& In,
TEnumAsByte< EDateTimeStyle::Type > InTimeStyle
)

 Converts a passed in date & time to a text, formatted as a time using an invariant timezone. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As Time", AdvancedDisplay="1")
  • Category="Utilities|Text"

static FText AsTimespan_Timespan ( const FTimespan& InTimespan
)

 Converts a passed in time span to a text, formatted as a time span Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As Timespan", AdvancedDisplay="1")
  • Category="Utilities|Text"

static FText AsTimeZoneDate_DateTime ( const FDateTime& InDateTime,
const FString& InTimeZone,
TEnumAsByte< EDateTimeStyle::Type > InDateStyle
)

 Converts a passed in date & time to a text, formatted as a date using the given timezone (default is the local timezone). Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As Date (from UTC)", AdvancedDisplay="1")
  • Category="Utilities|Text"

static FText AsTimeZoneDateTime_DateTime ( const FDateTime& InDateTime,
const FString& InTimeZone,
TEnumAsByte< EDateTimeStyle::Type > InDateStyle,
TEnumAsByte< EDateTimeStyle::Type > InTimeStyle
)

 Converts a passed in date & time to a text, formatted as a date & time using the given timezone (default is the local timezone). Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As DateTime (from UTC)", AdvancedDisplay="1")
  • Category="Utilities|Text"

static FText AsTimeZoneTime_DateTime ( const FDateTime& InDateTime,
const FString& InTimeZone,
TEnumAsByte< EDateTimeStyle::Type > InTimeStyle
)

 Converts a passed in date & time to a text, formatted as a time using the given timezone (default is the local timezone). Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="As Time (from UTC)", AdvancedDisplay="1")
  • Category="Utilities|Text"

static FText Conv_BoolToText ( bool InBool
)

 Converts a boolean value to formatted text, either 'true' or 'false' Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Boolean)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_ByteToText ( uint8 Value
)

 Converts a byte value to formatted text Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Byte)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_ColorToText ( FLinearColor InColor
)

 Converts a linear color value to localized formatted text, in the form '(R=,G=,B=,A=)' Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (LinearColor)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_DoubleToText ( double Value,
TEnumAsByte< ERoundingMode > RoundingMode,
bool bAlwaysSign,
bool bUseGrouping,
int32 MinimumIntegralDigits,
int32 MaximumIntegralDigits,
int32 MinimumFractionalDigits,
int32 MaximumFractionalDigits
)

 Converts a passed in double to text based on formatting options Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Float)", AdvancedDisplay="1", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_Int64ToText ( int64 Value,
bool bAlwaysSign,
bool bUseGrouping,
int32 MinimumIntegralDigits,
int32 MaximumIntegralDigits
)

 Converts a passed in integer to text based on formatting options Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Integer64)", AdvancedDisplay="1", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_IntToText ( int32 Value,
bool bAlwaysSign,
bool bUseGrouping,
int32 MinimumIntegralDigits,
int32 MaximumIntegralDigits
)

 Default values are duplicated from FNumberFormattingOptions and should be replicated in all functions and in the struct when changed! Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Integer)", AdvancedDisplay="1", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_NameToText ( FName InName
)

 Converts Name to culture invariant text Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Name)", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_NumericPropertyToText ( const int32& Value
)

 Converts a generic value to localized formatted text using the user culture. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • CustomThunk
  • DisplayName="To Text"
  • Category="Utilities|Text"
  • Meta=(CustomStructureParam="Value", BlueprintInternalUseOnly="true")

static FText Conv_ObjectToText ( UObject* InObj
)

 Converts a UObject value to culture invariant text by calling the object's GetName method Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Object)", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_RotatorToText ( FRotator InRot
)

 Converts a rotator value to localized formatted text, in the form 'P= Y= R=' Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Rotator)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_StringToText ( const FString& InString
)

 Converts string to culture invariant text. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (String)", BlueprintAutocast)
  • Category="Utilities|Text"

static FString Conv_TextToString ( const FText& InText
)

 Converts localizable text to the string Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Text)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FText Conv_TransformToText ( const FTransform& InTrans
)

 Converts a transform value to localized formatted text, in the form 'Translation: X= Y= Z= Rotation: P= Y= R= Scale: X= Y= Z=' Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Transform)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_Vector2dToText ( FVector2D InVec
)

 Converts a vector2d value to localized formatted text, in the form 'X= Y=' Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Vector2d)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|Text"

static FText Conv_VectorToText ( FVector InVec
)

 Converts a vector value to localized formatted text, in the form 'X= Y= Z=' Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To Text (Vector)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|Text"

static bool EditTextPropertySourceString ( UObject* TextOwner,
const FName PropertyName,
const FString& SourceString,
const bool bEmitChangeNotify
)

 Edit the source string of the given text property, akin to what happens when editing a text property in a details panel. Kismet/KismetTextLibrary.h
  • BlueprintCallable
  • Category="Utilities|Text"
  • Meta=(DefaultToSelf="TextOwner")

static bool EditTextSourceString ( UObject* TextOwner,
FText& Text,
const FString& SourceString,
const bool bEmitChangeNotify
)

 Edit the source string of the given text property, akin to what happens when editing a text property in a details panel. Kismet/KismetTextLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Category="Utilities|Text"
  • Meta=(DefaultToSelf="TextOwner")

static bool EqualEqual_IgnoreCase_TextText ( const FText& A,
const FText& B
)

 Returns true if A and B are linguistically equal (A == B), ignoring case. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal, Case Insensitive (Text)", CompactNodeTitle="==")
  • Category="Utilities|Text"

static bool EqualEqual_TextText ( const FText& A,
const FText& B
)

 Returns true if A and B are linguistically equal (A == B). Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal Exactly (Text)", CompactNodeTitle="===")
  • Category="Utilities|Text"

static bool FindTextInLocalizationTable ( const FString& Namespace,
const FString& Key,
FText& OutText,
const FString& SourceString
)

 === !! This is an ADVANCED function. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"
  • DisplayName="Find Text in Live Table (Advanced)"
  • Meta=(AdvancedDisplay="SourceString", ScriptName="FindTextInLiveTable_Advanced;FindTextInLocalizationTable")

static FText Format ( FText InPattern,
TArray< FFormatArgumentData > InArgs
)

 Used for formatting text using the FText::Format function and utilized by the UK2Node_FormatText Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(BlueprintInternalUseOnly="true")

static bool Generic_EditTextPropertySourceString ( UObject* TextOwner,
const FTextProperty* TextProperty,
const FString& SourceString,
const bool bEmitChangeNotify
)

   Kismet/KismetTextLibrary.h
  • BlueprintCallable
  • Category="Utilities|Text"
  • Meta=(DefaultToSelf="TextOwner")

static FText GetEmptyText()

 Returns an empty piece of text. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static bool GetTextId ( FText Text,
FString& OutNamespace,
FString& OutKey
)

 Attempts to get the ID (namespace and key) used by the given text. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"
  • Meta=(DisplayName="Get ID from Text")
Get the (non-localized) source string of the given text. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"
  • Meta=(DisplayName="Get Source String from Text")

static void IsPolyglotDataValid ( const FPolyglotTextData& PolyglotData,
bool& IsValid,
FText& ErrorMessage
)

 Check whether the given polyglot data is valid. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static FText MakeInvariantText ( const FString& InString
)

 Converts string to culture invariant text. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static bool NotEqual_IgnoreCase_TextText ( const FText& A,
const FText& B
)

 Returns true if A and B are linguistically not equal (A != B), ignoring case. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal, Case Insensitive (Text)", CompactNodeTitle="!=")
  • Category="Utilities|Text"

static bool NotEqual_TextText ( const FText& A,
const FText& B
)

 Returns true if A and B are linguistically not equal (A != B). Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal Exactly (Text)", CompactNodeTitle="!==")
  • Category="Utilities|Text"

static FText PolyglotDataToText ( const FPolyglotTextData& PolyglotData
)

 Get the text instance created from this polyglot data. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static bool StringTableIdAndKeyFromText ( FText Text,
FName& OutTableId,
FString& OutKey
)

 Attempts to get the String Table ID and key used by the given text. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"
  • Meta=(DisplayName="Get String Table ID and Key from Text")

static FText TextFromStringTable ( const FName TableId,
const FString& Key
)

 Attempts to create a text instance from a string table ID and key. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"
  • Meta=(DisplayName="Make Text from String Table (Advanced)")

static bool TextIsCultureInvariant ( const FText& InText
)

 Returns true if text is culture invariant. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static bool TextIsEmpty ( const FText& InText
)

 Returns true if text is empty. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static bool TextIsFromStringTable ( const FText& Text
)

 Returns true if the given text is referencing a string table. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"
  • Meta=(DisplayName="Is Text from String Table")

static bool TextIsTransient ( const FText& InText
)

 Returns true if text is transient. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static FText TextToLower ( const FText& InText
)

 Transforms the text to lowercase in a culture correct way. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static FText TextToUpper ( const FText& InText
)

 Transforms the text to uppercase in a culture correct way. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static FText TextTrimPreceding ( const FText& InText
)

 Removes whitespace characters from the front of the text. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static FText TextTrimPrecedingAndTrailing ( const FText& InText
)

 Removes whitespace characters from the front and end of the text. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

static FText TextTrimTrailing ( const FText& InText
)

 Removes trailing whitespace characters. Kismet/KismetTextLibrary.h
  • BlueprintPure
  • Category="Utilities|Text"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page