1. Epic GamesDeveloper
  3. UKismetStringLibrary

UKismetStringLibrary

API > API/Runtime > API/Runtime/Engine

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

Syntax

UCLASS (Meta=(BlueprintThreadSafe, ScriptName="StringLibrary"), MinimalAPI)  
class UKismetStringLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UKismetStringLibrary ( const FObjectInitializer& ObjectInitializer
)

   Kismet/KismetStringLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static FString BuildString_Bool ( const FString& AppendTo,
const FString& Prefix,
bool InBool,
const FString& Suffix
)

 Converts a boolean->string, creating a new string in the form AppendTo+Prefix+InBool+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (Boolean)")
  • Category="Utilities|String"

static FString BuildString_Color ( const FString& AppendTo,
const FString& Prefix,
FLinearColor InColor,
const FString& Suffix
)

 Converts a color->string, creating a new string in the form AppendTo+Prefix+InColor+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (LinearColor)")
  • Category="Utilities|String"

static FString BuildString_Double ( const FString& AppendTo,
const FString& Prefix,
double InDouble,
const FString& Suffix
)

 Converts a double->string, create a new string in the form AppendTo+Prefix+InDouble+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (Float)")
  • Category="Utilities|String"

static FString BuildString_Float ( const FString& AppendTo,
const FString& Prefix,
float InFloat,
const FString& Suffix
)

 Converts a float->string, create a new string in the form AppendTo+Prefix+InFloat+Suffix Kismet/KismetStringLibrary.h  

static FString BuildString_Int ( const FString& AppendTo,
const FString& Prefix,
int32 InInt,
const FString& Suffix
)

 Converts a int->string, creating a new string in the form AppendTo+Prefix+InInt+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (Integer)")
  • Category="Utilities|String"

static FString BuildString_IntVector ( const FString& AppendTo,
const FString& Prefix,
FIntVector InIntVector2,
const FString& Suffix
)

 Converts an IntVector->string, creating a new string in the form AppendTo+Prefix+InIntVector+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (IntVector)")
  • Category="Utilities|String"

static FString BuildString_IntVector2 ( const FString& AppendTo,
const FString& Prefix,
FIntVector2 InIntVector,
const FString& Suffix
)

 Converts an IntVector2->string, creating a new string in the form AppendTo+Prefix+InIntVector+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (IntVector2)")
  • Category="Utilities|String"

static FString BuildString_Name ( const FString& AppendTo,
const FString& Prefix,
FName InName,
const FString& Suffix
)

 Converts a color->string, creating a new string in the form AppendTo+Prefix+InName+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (Name)")
  • Category="Utilities|String"

static FString BuildString_Object ( const FString& AppendTo,
const FString& Prefix,
UObject* InObj,
const FString& Suffix
)

 Converts a object->string, creating a new string in the form AppendTo+Prefix+object name+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (Object)")
  • Category="Utilities|String"

static FString BuildString_Rotator ( const FString& AppendTo,
const FString& Prefix,
FRotator InRot,
const FString& Suffix
)

 Converts a rotator->string, creating a new string in the form AppendTo+Prefix+InRot+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (Rotator)")
  • Category="Utilities|String"

static FString BuildString_Vector ( const FString& AppendTo,
const FString& Prefix,
FVector InVector,
const FString& Suffix
)

 Converts a vector->string, creating a new string in the form AppendTo+Prefix+InVector+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (Vector)")
  • Category="Utilities|String"

static FString BuildString_Vector2d ( const FString& AppendTo,
const FString& Prefix,
FVector2D InVector2d,
const FString& Suffix
)

 Converts a vector2d->string, creating a new string in the form AppendTo+Prefix+InVector2d+Suffix Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Build String (Vector2D)")
  • Category="Utilities|String"

static FString Concat_StrStr ( const FString& A,
const FString& B
)

 String functions. Concatenates two strings together to make a new string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Append", CommutativeAssociativeBinaryOperator="true")
  • Category="Utilities|String"

static bool Contains ( const FString& SearchIn,
const FString& Substring,
bool bUseCase,
bool bSearchFromEnd
)

 Returns whether this string contains the specified substring. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString Conv_BoolToString ( bool InBool
)

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

static FString Conv_BoxCenterAndExtentsToString ( const FBox& Box
)

 Converts a FBox value to a string of its Center and Extents values. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String Center and Extents (Box)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_BoxToString ( const FBox& Box
)

 Converts a FBox value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Box)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_ByteToString ( uint8 InByte
)

 Converts a byte value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Byte)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_ColorToString ( FLinearColor InColor
)

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

static FString Conv_DoubleToString ( double InDouble
)

 Converts a double value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Float)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_FloatToString ( float InFloat
)

 Converts a float value to a string Kismet/KismetStringLibrary.h  

static FString Conv_InputDeviceIdToString ( FInputDeviceId InDeviceId
)

 Converts a InputDeviceId value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (InputDeviceId)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_Int64ToString ( int64 InInt
)

 Converts an 64-bit integer value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Integer64)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_IntPointToString ( FIntPoint InIntPoint
)

 Converts an IntPoint value to a string, in the form 'X= Y=' Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (IntPoint)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_IntToString ( int32 InInt
)

 Converts an integer value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Integer)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_IntVector2ToString ( FIntVector2 InIntVec2
)

 Converts an IntVector2 value to a string, in the form 'X= Y=' Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (IntVector2)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_IntVectorToString ( FIntVector InIntVec
)

 Converts an IntVector value to a string, in the form 'X= Y= Z=' Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (IntVector)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_MatrixToString ( const FMatrix& InMatrix
)

 Converts a name value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Matrix)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_NameToString ( FName InName
)

 Converts a name value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Name)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_ObjectToString ( UObject* InObj
)

 Converts a UObject value to a string by calling the object's GetName method Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Object)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_PlatformUserIdToString ( FPlatformUserId InPlatformUserId
)

 Converts a PlatformUserId value to a string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (PlatformUserId)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_RotatorToString ( FRotator InRot
)

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

static void Conv_StringToColor ( const FString& InString,
FLinearColor& OutConvertedColor,
bool& OutIsValid
)

 Convert String Back To Color. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Color", CompactNodeTitle="->")
  • Category="Utilities|String"

static double Conv_StringToDouble ( const FString& InString
)

 Converts a string to a double value Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Float", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static float Conv_StringToFloat ( const FString& InString
)

 Converts a string to a float value Kismet/KismetStringLibrary.h  

static int32 Conv_StringToInt ( const FString& InString
)

 Converts a string to a int value Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Integer", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static int64 Conv_StringToInt64 ( const FString& InString
)

 Converts a string to a int value Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Integer64", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FName Conv_StringToName ( const FString& InString
)

 Converts a string to a name value Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Name", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static void Conv_StringToRotator ( const FString& InString,
FRotator& OutConvertedRotator,
bool& OutIsValid
)

 Convert String Back To Rotator. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Rotator", CompactNodeTitle="->")
  • Category="Utilities|String"

static void Conv_StringToVector ( const FString& InString,
FVector& OutConvertedVector,
bool& OutIsValid
)

 Convert String Back To Vector. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Vector", CompactNodeTitle="->")
  • Category="Utilities|String"

static void Conv_StringToVector2D ( const FString& InString,
FVector2D& OutConvertedVector2D,
bool& OutIsValid
)

 Convert String Back To Vector2D. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Vector2D", CompactNodeTitle="->")
  • Category="Utilities|String"

static void Conv_StringToVector3f ( const FString& InString,
FVector3f& OutConvertedVector,
bool& OutIsValid
)

 Convert String Back To Float Vector. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="String To Float Vector", CompactNodeTitle="->")
  • Category="Utilities|String"

static FString Conv_TransformToString ( const FTransform& InTrans
)

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

static FString Conv_Vector2dToString ( FVector2D InVec
)

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

static FString Conv_Vector3fToString ( FVector3f InVec
)

 Converts a float vector value to a string, in the form 'X= Y= Z=' Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="To String (Float Vector)", CompactNodeTitle="->", BlueprintAutocast)
  • Category="Utilities|String"

static FString Conv_VectorToString ( FVector InVec
)

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

static int32 CullArray ( const FString& SourceString,
TArray< FString >& InArray
)

 Takes an array of strings and removes any zero length entries. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString DiffString ( const FString& First,
const FString& Second
)

 Returns a string describing the LCS difference between two strings, First and Second. Kismet/KismetStringLibrary.h
  • BlueprintCallable
  • Category="Utilities|String"

static bool EndsWith ( const FString& SourceString,
const FString& InSuffix,
ESearchCase::Type SearchCase
)

 Test whether this string ends with given string. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static bool EqualEqual_StriStri ( const FString& A,
const FString& B
)

 Test if the input strings are equal (A == B), ignoring case Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal, Case Insensitive (String)", CompactNodeTitle="==")
  • Category="Utilities|String"

static bool EqualEqual_StrStr ( const FString& A,
const FString& B
)

 Test if the input strings are equal (A == B) Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal Exactly (String)", CompactNodeTitle="===")
  • Category="Utilities|String"

static int32 FindSubstring ( const FString& SearchIn,
const FString& Substring,
bool bUseCase,
bool bSearchFromEnd,
int32 StartPosition
)

 Finds the starting index of a substring in the a specified string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static TArray< FString > GetCharacterArrayFromString ( const FString& SourceString
)

 Returns an array that contains one entry for each character in SourceString Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static int32 GetCharacterAsNumber ( const FString& SourceString,
int32 Index
)

 Gets a single character from the string (as an integer) Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString GetSubstring ( const FString& SourceString,
int32 StartIndex,
int32 Length
)

 Returns a substring from the string starting at the specified position Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static bool IsEmpty ( const FString& InString
)

 Returns true if the string is empty Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"
  • Meta=(Keywords="empty")

static bool IsNumeric ( const FString& SourceString
)

 Checks if a string contains only numeric characters Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString JoinStringArray ( const TArray< FString >& SourceArray,
const FString& Separator
)

 Concatenates an array of strings into a single string. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString Left ( const FString& SourceString,
int32 Count
)

 Returns the left most given number of characters Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString LeftChop ( const FString& SourceString,
int32 Count
)

 Returns the left most characters from the string chopping the given number of characters from the end Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString LeftPad ( const FString& SourceString,
int32 ChCount
)

 Pad the left of this string for a specified number of characters Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static int32 Len ( const FString& S
)

 Returns the number of characters in the string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"
  • Meta=(CompactNodeTitle="LEN", Keywords="length")

static bool MatchesWildcard ( const FString& SourceString,
const FString& Wildcard,
ESearchCase::Type SearchCase
)

 Searches this string for a given wild cardThis is a simple, SLOW routine. Use with caution Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString Mid ( const FString& SourceString,
int32 Start,
int32 Count
)

 Returns the substring from Start position for Count characters. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static bool NotEqual_StriStri ( const FString& A,
const FString& B
)

 Test if the input string are not equal (A != B), ignoring case differences Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal, Case Insenstive (String)", CompactNodeTitle="!=")
  • Category="Utilities|String"

static bool NotEqual_StrStr ( const FString& A,
const FString& B
)

 Test if the input string are not equal (A != B) Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal Exactly (String)", CompactNodeTitle="!==")
  • Category="Utilities|String"

static TArray< FString > ParseIntoArray ( const FString& SourceString,
const FString& Delimiter,
const bool CullEmptyStrings
)

 Gets an array of strings from a source string divided up by a separator and empty strings can optionally be culled. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString Replace ( const FString& SourceString,
const FString& From,
const FString& To,
ESearchCase::Type SearchCase
)

 Replace all occurrences of a substring in this string Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static int32 ReplaceInline ( FString& SourceString,
const FString& SearchText,
const FString& ReplacementText,
ESearchCase::Type SearchCase
)

 Replace all occurrences of SearchText with ReplacementText in this string. Kismet/KismetStringLibrary.h
  • BlueprintCallable
  • Category="Utilities|String"

static FString Reverse ( const FString& SourceString
)

 Returns a copy of this string, with the characters in reverse order Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString Right ( const FString& SourceString,
int32 Count
)

 Returns the string to the right of the specified location, counting back from the right (end of the word). Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString RightChop ( const FString& SourceString,
int32 Count
)

 Returns the string to the right of the specified location, counting forward from the left (from the beginning of the word). Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString RightPad ( const FString& SourceString,
int32 ChCount
)

 Pad the right of this string for a specified number of characters Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static bool Split ( const FString& SourceString,
const FString& InStr,
FString& LeftS,
FString& RightS,
ESearchCase::Type SearchCase,
ESearchDir::Type SearchDir
)

 Splits this string at given string position case sensitive. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static bool StartsWith ( const FString& SourceString,
const FString& InPrefix,
ESearchCase::Type SearchCase
)

 Test whether this string starts with given string. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString TimeSecondsToString ( float InSeconds
)

 Convert a number of seconds into minutes:seconds.milliseconds format string (including leading zeroes) Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString ToLower ( const FString& SourceString
)

 Returns a string converted to Lower case Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString ToUpper ( const FString& SourceString
)

 Returns a string converted to Upper case Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString Trim ( const FString& SourceString
)

 Removes whitespace characters from the front of this string. Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

static FString TrimTrailing ( const FString& SourceString
)

 Removes trailing whitespace characters Kismet/KismetStringLibrary.h
  • BlueprintPure
  • Category="Utilities|String"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page