UKismetTextLibrary

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Kismet/KismetTextLibrary.h

Include

#include "Kismet/KismetTextLibrary.h"

Syntax

class UKismetTextLibrary : public UBlueprintFunctionLibrary

Constructors

Name Description

Public function

UKismetTextLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

FText

 

AsCurrency_Float

(
    float Value,
    TEnumAsByte< ERoundingMode > Roundi...,
    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

FText

 

AsCurrency_Integer

(
    int32 Value,
    TEnumAsByte< ERoundingMode > Roundi...,
    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

FText

 

AsCurrencyBase

(
    int32 BaseValue,
    const FString& CurrencyCode
)

Generate an FText that represents the passed number as currency in the current culture.

Public function Static

FText

 

AsDate_DateTime

(
    const FDateTime& InDateTime
)

Converts a passed in date & time to a text, formatted as a date using an invariant timezone.

Public function Static

FText

 

AsDateTime_DateTime

(
    const FDateTime& In
)

Converts a passed in date & time to a text, formatted as a date & time using an invariant timezone.

Public function Static

FText

 

AsPercent_Float

(
    float Value,
    TEnumAsByte< ERoundingMode > Roundi...,
    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

FText

 

AsTime_DateTime

(
    const FDateTime& In
)

Converts a passed in date & time to a text, formatted as a time using an invariant timezone.

Public function Static

FText

 

AsTimespan_Timespan

(
    const FTimespan& InTimespan
)

Converts a passed in time span to a text, formatted as a time span

Public function Static

FText

 

AsTimeZoneDate_DateTime

(
    const FDateTime& InDateTime,
    const FString& InTimeZone
)

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

FText

 

AsTimeZoneDateTime_DateTime

(
    const FDateTime& InDateTime,
    const FString& InTimeZone
)

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

FText

 

AsTimeZoneTime_DateTime

(
    const FDateTime& InDateTime,
    const FString& InTimeZone
)

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

FText

 

Conv_BoolToText

(
    bool InBool
)

Converts a boolean value to formatted text, either 'true' or 'false'

Public function Static

FText

 

Conv_ByteToText

(
    uint8 Value
)

Converts a byte value to formatted text

Public function Static

FText

 

Conv_ColorToText

(
    FLinearColor InColor
)

Converts a linear color value to localized formatted text, in the form '(R=,G=,B=,A=)'

Public function Static

FText

 

Conv_DoubleToText

(
    double InDouble,
    TEnumAsByte< ERoundingMode > Roundi...,
    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 > Roundi...,
    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

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

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

FText

 

Conv_NameToText

(
    FName InName
)

Converts Name to culture invariant text

Public function Static

FText

 

Conv_ObjectToText

(
    UObject* InObj
)

Converts a UObject value to culture invariant text by calling the object's GetName method

Public function Static

FText

 

Conv_RotatorToText

(
    FRotator InRot
)

Converts a rotator value to localized formatted text, in the form 'P= Y= R='

Public function Static

FText

 

Conv_StringToText

(
    const FString& InString
)

Converts string to culture invariant text.

Public function Static

FString

 

Conv_TextToString

(
    const FText& InText
)

Converts localizable text to the string

Public function 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='

Public function Static

FText

 

Conv_Vector2dToText

(
    FVector2D InVec
)

Converts a vector2d value to localized formatted text, in the form 'X= Y='

Public function Static

FText

 

Conv_VectorToText

(
    FVector InVec
)

Converts a vector value to localized formatted text, in the form 'X= Y= Z='

Public function Static

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

bool

 

EqualEqual_TextText

(
    const FText& A,
    const FText& B
)

Returns true if A and B are linguistically equal (A == B).

Public function Static

bool

 

FindTextInLocalizationTable

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

Attempts to find existing Text using the representation found in the loc tables for the specified namespace and key.

Public function Static

FText

 

Format

(
    FText InPattern,
    TArray< FFormatArgumentData > InArg...
)

Used for formatting text using the FText::Format function and utilized by the UK2Node_FormatText

Public function Static

FText

 

GetEmptyText()

Returns an empty piece of text.

Public function Static

void

 

IsPolyglotDataValid

(
    const FPolyglotTextData& PolyglotD...,
    bool& IsValid,
    FText& ErrorMessage
)

Check whether the given polyglot data is valid.

Public function 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.

Public function Static

bool

 

NotEqual_TextText

(
    const FText& A,
    const FText& B
)

Returns true if A and B are linguistically not equal (A != B).

Public function Static

FText

 

PolyglotDataToText

(
    const FPolyglotTextData& PolyglotD...
)

Get the text instance created from this polyglot data.

Public function Static

bool

 

StringTableIdAndKeyFromText

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

Attempts to find the String Table ID and key used by the given text.

Public function Static

FText

 

TextFromStringTable

(
    const FName TableId,
    const FString& Key
)

Attempts to create a text instance from a string table ID and key.

Public function Static

bool

 

TextIsCultureInvariant

(
    const FText& InText
)

Returns true if text is culture invariant.

Public function Static

bool

 

TextIsEmpty

(
    const FText& InText
)

Returns true if text is empty.

Public function Static

bool

 

TextIsFromStringTable

(
    const FText& Text
)

Returns true if the given text is referencing a string table.

Public function Static

bool

 

TextIsTransient

(
    const FText& InText
)

Returns true if text is transient.

Public function Static

FText

 

TextToLower

(
    const FText& InText
)

Transforms the text to lowercase in a culture correct way.

Public function Static

FText

 

TextToUpper

(
    const FText& InText
)

Transforms the text to uppercase in a culture correct way.

Public function Static

FText

 

TextTrimPreceding

(
    const FText& InText
)

Removes whitespace characters from the front of the text.

Public function Static

FText

 

TextTrimPrecedingAndTrailing

(
    const FText& InText
)

Removes whitespace characters from the front and end of the text.

Public function Static

FText

 

TextTrimTrailing

(
    const FText& InText
)

Removes trailing whitespace characters.