Class KismetTextLibrary

Kismet Text Library

Inheritance

System.Object

UObject

BlueprintFunctionLibrary

KismetTextLibrary

Inherited Members

UObject.TransientPackage

UObject.CastTo<T>(UObject)

UObject.CastTo(UObject, Type)

UObject.RemoveObject(UObject)

UObject.MakeObjectArrayField<T>(NativeArray*)

UObject.NotImplemented<T>()

UObject.Construct()

UObject.GetHashCode()

UObject.GetName()

UObject.ToString()

UObject.Name

UObject._None

UObject.None

UObject.ObjPointer

UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)

UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)

UObject.GetPropertyFor<T>(Name)

UObject.ExecuteUbergraph

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: UE4.Engine

Assembly: UE4DotNet.dll

Syntax

public class KismetTextLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration

public static KismetTextLibrary DefaultObject { get; }

Property Value

Type	Description
KismetTextLibrary

| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration

public static Class StaticClass { get; }

Property Value

Type	Description
Class

Methods

| Improve this Doc View Source

AsCurrency_Float(Single, Byte, Boolean, Boolean, Int32, Int32, Int32, Int32, String)

Converts a passed in float to a text formatted as a currency

Declaration

public static byte AsCurrency_Float(float Value, byte RoundingMode, bool bAlwaysSign, bool bUseGrouping, int MinimumIntegralDigits, int MaximumIntegralDigits, int MinimumFractionalDigits, int MaximumFractionalDigits, string CurrencyCode)

Parameters

Type	Name	Description
System.Single	Value
System.Byte	RoundingMode
System.Boolean	bAlwaysSign
System.Boolean	bUseGrouping
System.Int32	MinimumIntegralDigits
System.Int32	MaximumIntegralDigits
System.Int32	MinimumFractionalDigits
System.Int32	MaximumFractionalDigits
System.String	CurrencyCode

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsCurrency_Integer(Int32, Byte, Boolean, Boolean, Int32, Int32, Int32, Int32, String)

Converts a passed in integer to a text formatted as a currency

Declaration

public static byte AsCurrency_Integer(int Value, byte RoundingMode, bool bAlwaysSign, bool bUseGrouping, int MinimumIntegralDigits, int MaximumIntegralDigits, int MinimumFractionalDigits, int MaximumFractionalDigits, string CurrencyCode)

Parameters

Type	Name	Description
System.Int32	Value
System.Byte	RoundingMode
System.Boolean	bAlwaysSign
System.Boolean	bUseGrouping
System.Int32	MinimumIntegralDigits
System.Int32	MaximumIntegralDigits
System.Int32	MinimumFractionalDigits
System.Int32	MaximumFractionalDigits
System.String	CurrencyCode

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsCurrencyBase(Int32, String)

Declaration

public static byte AsCurrencyBase(int BaseValue, string CurrencyCode)

Parameters

Type	Name	Description
System.Int32	BaseValue
System.String	CurrencyCode

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsDate_DateTime(FDateTime)

Declaration

public static byte AsDate_DateTime(FDateTime InDateTime)

Parameters

Type	Name	Description
FDateTime	InDateTime

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsDateTime_DateTime(FDateTime)

Declaration

public static byte AsDateTime_DateTime(FDateTime In)

Parameters

Type	Name	Description
FDateTime	In

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsPercent_Float(Single, Byte, Boolean, Boolean, Int32, Int32, Int32, Int32)

Converts a passed in float to a text, formatted as a percent

Declaration

public static byte AsPercent_Float(float Value, byte RoundingMode, bool bAlwaysSign, bool bUseGrouping, int MinimumIntegralDigits, int MaximumIntegralDigits, int MinimumFractionalDigits, int MaximumFractionalDigits)

Parameters

Type	Name	Description
System.Single	Value
System.Byte	RoundingMode
System.Boolean	bAlwaysSign
System.Boolean	bUseGrouping
System.Int32	MinimumIntegralDigits
System.Int32	MaximumIntegralDigits
System.Int32	MinimumFractionalDigits
System.Int32	MaximumFractionalDigits

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsTime_DateTime(FDateTime)

Declaration

public static byte AsTime_DateTime(FDateTime In)

Parameters

Type	Name	Description
FDateTime	In

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsTimespan_Timespan(Timespan)

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

Declaration

public static byte AsTimespan_Timespan(Timespan InTimespan)

Parameters

Type	Name	Description
Timespan	InTimespan

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsTimeZoneDate_DateTime(FDateTime, String)

Declaration

public static byte AsTimeZoneDate_DateTime(FDateTime InDateTime, string InTimeZone)

Parameters

Type	Name	Description
FDateTime	InDateTime
System.String	InTimeZone

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsTimeZoneDateTime_DateTime(FDateTime, String)

Declaration

public static byte AsTimeZoneDateTime_DateTime(FDateTime InDateTime, string InTimeZone)

Parameters

Type	Name	Description
FDateTime	InDateTime
System.String	InTimeZone

Returns

Type	Description
System.Byte

| Improve this Doc View Source

AsTimeZoneTime_DateTime(FDateTime, String)

Declaration

public static byte AsTimeZoneTime_DateTime(FDateTime InDateTime, string InTimeZone)

Parameters

Type	Name	Description
FDateTime	InDateTime
System.String	InTimeZone

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_BoolToText(Boolean)

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

Declaration

public static byte Conv_BoolToText(bool InBool)

Parameters

Type	Name	Description
System.Boolean	InBool

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_ByteToText(Byte)

Converts a byte value to formatted text

Declaration

public static byte Conv_ByteToText(byte Value)

Parameters

Type	Name	Description
System.Byte	Value

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_ColorToText(LinearColor)

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

Declaration

public static byte Conv_ColorToText(LinearColor InColor)

Parameters

Type	Name	Description
LinearColor	InColor

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_FloatToText(Single, Byte, Boolean, Boolean, Int32, Int32, Int32, Int32)

Converts a passed in float to text based on formatting options

Declaration

public static byte Conv_FloatToText(float Value, byte RoundingMode, bool bAlwaysSign, bool bUseGrouping, int MinimumIntegralDigits, int MaximumIntegralDigits, int MinimumFractionalDigits, int MaximumFractionalDigits)

Parameters

Type	Name	Description
System.Single	Value
System.Byte	RoundingMode
System.Boolean	bAlwaysSign
System.Boolean	bUseGrouping
System.Int32	MinimumIntegralDigits
System.Int32	MaximumIntegralDigits
System.Int32	MinimumFractionalDigits
System.Int32	MaximumFractionalDigits

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_IntToText(Int32, Boolean, Boolean, Int32, Int32)

Converts a passed in integer to text based on formatting options

Declaration

public static byte Conv_IntToText(int Value, bool bAlwaysSign, bool bUseGrouping, int MinimumIntegralDigits, int MaximumIntegralDigits)

Parameters

Type	Name	Description
System.Int32	Value
System.Boolean	bAlwaysSign
System.Boolean	bUseGrouping
System.Int32	MinimumIntegralDigits
System.Int32	MaximumIntegralDigits

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_NameToText(Name)

Converts Name to culture invariant text

Declaration

public static byte Conv_NameToText(Name InName)

Parameters

Type	Name	Description
Name	InName

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_ObjectToText(UObject)

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

Declaration

public static byte Conv_ObjectToText(UObject InObj)

Parameters

Type	Name	Description
UObject	InObj

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_RotatorToText(Rotator)

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

Declaration

public static byte Conv_RotatorToText(Rotator InRot)

Parameters

Type	Name	Description
Rotator	InRot

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_StringToText(String)

Converts string to culture invariant text. Use Format or Make Literal Text to create localizable text

Declaration

public static byte Conv_StringToText(string InString)

Parameters

Type	Name	Description
System.String	InString

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_TextToString(Byte)

Converts localizable text to the string

Declaration

public static string Conv_TextToString(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.String

| Improve this Doc View Source

Conv_TransformToText(Transform)

Converts a transform value to localized formatted text, in the form 'Translation: X= Y= Z= Rotation: P= Y= R= Scale: X= Y= Z='

Declaration

public static byte Conv_TransformToText(Transform InTrans)

Parameters

Type	Name	Description
Transform	InTrans

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_Vector2dToText(Vector2D)

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

Declaration

public static byte Conv_Vector2dToText(Vector2D InVec)

Parameters

Type	Name	Description
Vector2D	InVec

Returns

Type	Description
System.Byte

| Improve this Doc View Source

Conv_VectorToText(Vector)

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

Declaration

public static byte Conv_VectorToText(Vector InVec)

Parameters

Type	Name	Description
Vector	InVec

Returns

Type	Description
System.Byte

| Improve this Doc View Source

EqualEqual_IgnoreCase_TextText(Byte, Byte)

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

Declaration

public static bool EqualEqual_IgnoreCase_TextText(byte A, byte B)

Parameters

Type	Name	Description
System.Byte	A
System.Byte	B

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

EqualEqual_TextText(Byte, Byte)

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

Declaration

public static bool EqualEqual_TextText(byte A, byte B)

Parameters

Type	Name	Description
System.Byte	A
System.Byte	B

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

FindTextInLocalizationTable(String, String)

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

Declaration

public static (byte, bool) FindTextInLocalizationTable(string Namespace, string Key)

Parameters

Type	Name	Description
System.String	Namespace
System.String	Key

Returns

Type	Description
System.ValueTuple<System.Byte, System.Boolean>

| Improve this Doc View Source

Format(Byte, Byte)

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

Declaration

public static byte Format(byte InPattern, byte InArgs)

Parameters

Type	Name	Description
System.Byte	InPattern
System.Byte	InArgs

Returns

Type	Description
System.Byte

| Improve this Doc View Source

GetEmptyText()

Returns an empty piece of text.

Declaration

public static byte GetEmptyText()

Returns

Type	Description
System.Byte

| Improve this Doc View Source

IsPolyglotDataValid(PolyglotTextData)

Check whether the given polyglot data is valid.

Declaration

public static (bool, byte) IsPolyglotDataValid(PolyglotTextData PolyglotData)

Parameters

Type	Name	Description
PolyglotTextData	PolyglotData

Returns

Type	Description
System.ValueTuple<System.Boolean, System.Byte>

Remarks

@return True if the polyglot data is valid, false otherwise. ErrorMessage will be filled in if the the data is invalid.

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration

public static KismetTextLibrary New(UObject obj = null, Name name = default(Name))

Parameters

Type	Name	Description
UObject	obj
Name	name

Returns

Type	Description
KismetTextLibrary

| Improve this Doc View Source

NotEqual_IgnoreCase_TextText(Byte, Byte)

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

Declaration

public static bool NotEqual_IgnoreCase_TextText(byte A, byte B)

Parameters

Type	Name	Description
System.Byte	A
System.Byte	B

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

NotEqual_TextText(Byte, Byte)

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

Declaration

public static bool NotEqual_TextText(byte A, byte B)

Parameters

Type	Name	Description
System.Byte	A
System.Byte	B

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

PolyglotDataToText(PolyglotTextData)

Get the text instance created from this polyglot data.

Declaration

public static byte PolyglotDataToText(PolyglotTextData PolyglotData)

Parameters

Type	Name	Description
PolyglotTextData	PolyglotData

Returns

Type	Description
System.Byte

Remarks

@return The text instance, or an empty text if the data is invalid.

| Improve this Doc View Source

StringTableIdAndKeyFromText(Byte)

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

Declaration

public static (Name, string, bool) StringTableIdAndKeyFromText(byte Text)

Parameters

Type	Name	Description
System.Byte	Text

Returns

Type	Description
System.ValueTuple<Name, System.String, System.Boolean>

Remarks

@return True if the String Table ID and key were found, false otherwise.

| Improve this Doc View Source

TextFromStringTable(Name, String)

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

Declaration

public static byte TextFromStringTable(Name TableId, string Key)

Parameters

Type	Name	Description
Name	TableId
System.String	Key

Returns

Type	Description
System.Byte

Remarks

@note This exists to allow programmatic look-up of a string table entry from dynamic content - you should favor setting your string table reference on a text property or pin wherever possible as it is significantly more robust (see "Make Literal Text"). @return The found text, or a dummy text if the entry could not be found.

| Improve this Doc View Source

TextIsCultureInvariant(Byte)

Returns true if text is culture invariant.

Declaration

public static bool TextIsCultureInvariant(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TextIsEmpty(Byte)

Returns true if text is empty.

Declaration

public static bool TextIsEmpty(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TextIsFromStringTable(Byte)

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

Declaration

public static bool TextIsFromStringTable(byte Text)

Parameters

Type	Name	Description
System.Byte	Text

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TextIsTransient(Byte)

Returns true if text is transient.

Declaration

public static bool TextIsTransient(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

TextToLower(Byte)

Transforms the text to lowercase in a culture correct way.

Declaration

public static byte TextToLower(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.Byte

Remarks

@note The returned instance is linked to the original and will be rebuilt if the active culture is changed.

| Improve this Doc View Source

TextToUpper(Byte)

Transforms the text to uppercase in a culture correct way.

Declaration

public static byte TextToUpper(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.Byte

Remarks

@note The returned instance is linked to the original and will be rebuilt if the active culture is changed.

| Improve this Doc View Source

TextTrimPreceding(Byte)

Removes whitespace characters from the front of the text.

Declaration

public static byte TextTrimPreceding(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.Byte

| Improve this Doc View Source

TextTrimPrecedingAndTrailing(Byte)

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

Declaration

public static byte TextTrimPrecedingAndTrailing(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.Byte

| Improve this Doc View Source

TextTrimTrailing(Byte)

Removes trailing whitespace characters.

Declaration

public static byte TextTrimTrailing(byte InText)

Parameters

Type	Name	Description
System.Byte	InText

Returns

Type	Description
System.Byte

Operators

| Improve this Doc View Source

Implicit(IntPtr to KismetTextLibrary)

Convert from IntPtr to UObject

Declaration

public static implicit operator KismetTextLibrary(IntPtr p)

Parameters

Type	Name	Description
System.IntPtr	p

Returns

Type	Description
KismetTextLibrary