1. Epic GamesDeveloper
  3. UKismetTextLibrary

UKismetTextLibrary

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Kismet

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Kismet/KismetTextLibrary.h
Include #include "Kismet/KismetTextLibrary.h"

Syntax

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

Constructors

  Type Name Description
Public function  

UKismetTextLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UFunction BlueprintPure, Category, Meta 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!
Public function Static UFunction BlueprintPure, Category, Meta 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!
Public function Static UFunction BlueprintPure, Category, Meta FText

AsCurrencyBase ( int32 BaseValue,
const FString& CurrencyCode
)

 Generate an FText that represents the passed number as currency in the current culture.
Public function Static UFunction BlueprintPure, Category, Meta 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.
Public function Static UFunction BlueprintPure, Category, Meta FText Converts a passed in date & time to a text, formatted as a date & time using an invariant timezone.
Public function Static UFunction BlueprintPure, Category, Meta 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
Public function Static UFunction BlueprintPure, Category, Meta 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!
Public function Static UFunction BlueprintPure, Category, Meta FText Converts a passed in date & time to a text, formatted as a time using an invariant timezone.
Public function Static UFunction BlueprintPure, Category, Meta FText

AsTimespan_Timespan ( const FTimespan& InTimespan
)

 Converts a passed in time span to a text, formatted as a time span
Public function Static UFunction BlueprintPure, Category, Meta 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).
Public function Static UFunction BlueprintPure, Category, Meta 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).
Public function Static UFunction BlueprintPure, Category, Meta 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).
Public function Static UFunction BlueprintPure, Category, Meta FText

Conv_BoolToText ( bool InBool
)

 Converts a boolean value to formatted text, either 'true' or 'false'
Public function Static UFunction BlueprintPure, Category, Meta FText Converts a byte value to formatted text
Public function Static UFunction BlueprintPure, Category, Meta FText Converts a linear color value to localized formatted text, in the form '(R=,G=,B=,A=)'
Public function Static UFunction BlueprintPure, Category, Meta 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
Public function Static FText

Conv_FloatToText ( 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!
Public function Static UFunction BlueprintPure, Category, Meta FText

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

 Converts a passed in integer to text based on formatting options
Public function Static UFunction BlueprintPure, Category, Meta 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!
Public function Static UFunction BlueprintPure, Category, Meta FText

Conv_NameToText ( FName InName
)

 Converts Name to culture invariant text
Public function Static UFunction BlueprintPure, Category, Meta customthunk, displayname FText

Conv_NumericPropertyToText ( UPARAM(ref) const int32& Value
)

 Converts a generic value to localized formatted text using the user culture.
Public function Static UFunction BlueprintPure, Category, Meta FText Converts a UObject value to culture invariant text by calling the object's GetName method
Public function Static UFunction BlueprintPure, Category, Meta FText Converts a rotator value to localized formatted text, in the form 'P= Y= R='
Public function Static UFunction BlueprintPure, Category, Meta FText

Conv_StringToText ( const FString& InString
)

 Converts string to culture invariant text.
Public function Static UFunction BlueprintPure, Category, Meta FString

Conv_TextToString ( const FText& InText
)

 Converts localizable text to the string
Public function Static UFunction BlueprintPure, Category, Meta 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='
Public function Static UFunction BlueprintPure, Category, Meta FText Converts a vector2d value to localized formatted text, in the form 'X= Y='
Public function Static UFunction BlueprintPure, Category, Meta FText Converts a vector value to localized formatted text, in the form 'X= Y= Z='
Public function Static UFunction BlueprintCallable, Category, Meta customthunk bool

EditTextSourceString ( UObject* TextOwner,
UPARAM(ref) FText& Text,
const FString& SourceString
)

 Edit the source string of the given text property, akin to what happens when editing a text property in a details panel.
Public function Static UFunction BlueprintPure, Category, Meta bool

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

 Returns true if A and B are linguistically equal (A == B), ignoring case.
Public function Static UFunction BlueprintPure, Category, Meta bool

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

 Returns true if A and B are linguistically equal (A == B).
Public function Static UFunction BlueprintPure, Category, Meta displayname bool

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

 === !! This is an ADVANCED function.
Public function Static UFunction BlueprintPure, Meta FText

Format ( FText InPattern,
TArray< FFormatArgumentData > InArgs
)

 Used for formatting text using the FText::Format function and utilized by the UK2Node_FormatText
Public function Static UFunction BlueprintPure, Category FText Returns an empty piece of text.
Public function Static UFunction BlueprintPure, Category, Meta bool

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

 Attempts to get the ID (namespace and key) used by the given text.
Public function Static UFunction BlueprintPure, Category, Meta FString Get the (non-localized) source string of the given text.
Public function Static UFunction BlueprintPure, Category void

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

 Check whether the given polyglot data is valid.
Public function Static UFunction BlueprintPure, Category FText

MakeInvariantText ( const FString& InString
)

 Converts string to culture invariant text.
Public function Static UFunction BlueprintPure, Category, Meta bool

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

 Returns true if A and B are linguistically not equal (A != B), ignoring case.
Public function Static UFunction BlueprintPure, Category, Meta bool

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

 Returns true if A and B are linguistically not equal (A != B).
Public function Static UFunction BlueprintPure, Category FText

PolyglotDataToText ( const FPolyglotTextData& PolyglotData
)

 Get the text instance created from this polyglot data.
Public function Static UFunction BlueprintPure, Category, Meta bool

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

 Attempts to get the String Table ID and key used by the given text.
Public function Static UFunction BlueprintPure, Category, Meta FText

TextFromStringTable ( const FName TableId,
const FString& Key
)

 Attempts to create a text instance from a string table ID and key.
Public function Static UFunction BlueprintPure, Category bool

TextIsCultureInvariant ( const FText& InText
)

 Returns true if text is culture invariant.
Public function Static UFunction BlueprintPure, Category bool

TextIsEmpty ( const FText& InText
)

 Returns true if text is empty.
Public function Static UFunction BlueprintPure, Category, Meta bool

TextIsFromStringTable ( const FText& Text
)

 Returns true if the given text is referencing a string table.
Public function Static UFunction BlueprintPure, Category bool

TextIsTransient ( const FText& InText
)

 Returns true if text is transient.
Public function Static UFunction BlueprintPure, Category FText

TextToLower ( const FText& InText
)

 Transforms the text to lowercase in a culture correct way.
Public function Static UFunction BlueprintPure, Category FText

TextToUpper ( const FText& InText
)

 Transforms the text to uppercase in a culture correct way.
Public function Static UFunction BlueprintPure, Category FText

TextTrimPreceding ( const FText& InText
)

 Removes whitespace characters from the front of the text.
Public function Static UFunction BlueprintPure, Category FText Removes whitespace characters from the front and end of the text.
Public function Static UFunction BlueprintPure, Category FText

TextTrimTrailing ( const FText& InText
)

 Removes trailing whitespace characters.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page