UKismetStringLibrary

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "Kismet/KismetStringLibrary.h"

Syntax

class UKismetStringLibrary : public UBlueprintFunctionLibrary

Constructors

Name Description

Public function

UKismetStringLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

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

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

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

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

Public function Static

FString

 

BuildString_IntVector

(
    const FString& AppendTo,
    const FString& Prefix,
    FIntVector InIntVector,
    const FString& Suffix
)

Converts an IntVector->string, creating a new string in the form AppendTo+Prefix+InIntVector+Suffix

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

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

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

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

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

Public function Static

FString

 

Concat_StrStr

(
    const FString& A,
    const FString& B
)

String functions. Concatenates two strings together to make a new string

Public function Static

bool

 

Contains

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

Returns whether this string contains the specified substring.

Public function Static

FString

 

Conv_BoolToString

(
    bool InBool
)

Converts a boolean value to a string, either 'true' or 'false'

Public function Static

FString

 

Conv_ByteToString

(
    uint8 InByte
)

Converts a byte value to a string

Public function Static

FString

 

Conv_ColorToString

(
    FLinearColor InColor
)

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

Public function Static

FString

 

Conv_FloatToString

(
    float InFloat
)

Converts a float value to a string

Public function Static

FString

 

Conv_IntPointToString

(
    FIntPoint InIntPoint
)

Converts an IntPoint value to a string, in the form 'X= Y='

Public function Static

FString

 

Conv_IntToString

(
    int32 InInt
)

Converts an integer value to a string

Public function Static

FString

 

Conv_IntVectorToString

(
    FIntVector InIntVec
)

Converts an IntVector value to a string, in the form 'X= Y= Z='

Public function Static

FString

 

Conv_MatrixToString

(
    const FMatrix& InMatrix
)

Converts a name value to a string

Public function Static

FString

 

Conv_NameToString

(
    FName InName
)

Converts a name value to a string

Public function Static

FString

 

Conv_ObjectToString

(
    UObject* InObj
)

Converts a UObject value to a string by calling the object's GetName method

Public function Static

FString

 

Conv_RotatorToString

(
    FRotator InRot
)

Converts a rotator value to a string, in the form 'P= Y= R='

Public function Static

void

 

Conv_StringToColor

(
    const FString& InString,
    FLinearColor& OutConvertedColor,
    bool& OutIsValid
)

Convert String Back To Color.

Public function Static

float

 

Conv_StringToFloat

(
    const FString& InString
)

Converts a string to a float value

Public function Static

int32

 

Conv_StringToInt

(
    const FString& InString
)

Converts a string to a int value

Public function Static

FName

 

Conv_StringToName

(
    const FString& InString
)

Converts a string to a name value

Public function Static

void

 

Conv_StringToRotator

(
    const FString& InString,
    FRotator& OutConvertedRotator,
    bool& OutIsValid
)

Convert String Back To Rotator.

Public function Static

void

 

Conv_StringToVector

(
    const FString& InString,
    FVector& OutConvertedVector,
    bool& OutIsValid
)

Convert String Back To Vector.

Public function Static

void

 

Conv_StringToVector2D

(
    const FString& InString,
    FVector2D& OutConvertedVector2D,
    bool& OutIsValid
)

Convert String Back To Vector2D.

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

Public function Static

FString

 

Conv_Vector2dToString

(
    FVector2D InVec
)

Converts a vector2d value to a string, in the form 'X= Y='

Public function Static

FString

 

Conv_VectorToString

(
    FVector InVec
)

Converts a vector value to a string, in the form 'X= Y= Z='

Public function Static

int32

 

CullArray

(
    const FString& SourceString,
    TArray< FString >& InArray
)

Takes an array of strings and removes any zero length entries.

Public function Static

bool

 

EndsWith

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

Test whether this string ends with given string.

Public function Static

bool

 

EqualEqual_StriStri

(
    const FString& A,
    const FString& B
)

Test if the input strings are equal (A == B), ignoring case

Public function Static

bool

 

EqualEqual_StrStr

(
    const FString& A,
    const FString& B
)

Test if the input strings are equal (A == B)

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

Public function Static

TArray< FStr...

 

GetCharacterArrayFromString

(
    const FString& SourceString
)

Returns an array that contains one entry for each character in SourceString

Public function Static

int32

 

GetCharacterAsNumber

(
    const FString& SourceString,
    int32 Index
)

Gets a single character from the string (as an integer)

Public function Static

FString

 

GetSubstring

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

Returns a substring from the string starting at the specified position

Public function Static

bool

 

IsEmpty

(
    const FString& InString
)

Returns true if the string is empty

Public function Static

bool

 

IsNumeric

(
    const FString& SourceString
)

Checks if a string contains only numeric characters

Public function Static

FString

 

JoinStringArray

(
    const TArray< FString >& SourceArr...,
    const FString& Separator
)

Concatenates an array of strings into a single string.

Public function Static

FString

 

Left

(
    const FString& SourceString,
    int32 Count
)

Returns the left most given number of characters

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

Public function Static

FString

 

LeftPad

(
    const FString& SourceString,
    int32 ChCount
)

Pad the left of this string for a specified number of characters

Public function Static

int32

 

Len

(
    const FString& S
)

Returns the number of characters in the string

Public function Static

bool

 

MatchesWildcard

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

Searches this string for a given wild card

This is a simple, SLOW routine. Use with caution

Public function Static

FString

 

Mid

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

Returns the substring from Start position for Count characters.

Public function Static

bool

 

NotEqual_StriStri

(
    const FString& A,
    const FString& B
)

Test if the input string are not equal (A != B), ignoring case differences

Public function Static

bool

 

NotEqual_StrStr

(
    const FString& A,
    const FString& B
)

Test if the input string are not equal (A != B)

Public function Static

TArray< FStr...

 

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.

Public function Static

FString

 

Replace

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

Replace all occurrences of a substring in this string

Public function Static

int32

 

ReplaceInline

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

Replace all occurrences of SearchText with ReplacementText in this string.

Public function Static

FString

 

Reverse

(
    const FString& SourceString
)

Returns a copy of this string, with the characters in reverse order

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

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

Public function Static

FString

 

RightPad

(
    const FString& SourceString,
    int32 ChCount
)

Pad the right of this string for a specified number of characters

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

Public function Static

bool

 

StartsWith

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

Test whether this string starts with given string.

Public function Static

FString

 

TimeSecondsToString

(
    float InSeconds
)

Convert a number of seconds into minutes:seconds.milliseconds format string (including leading zeroes)

Public function Static

FString

 

ToLower

(
    const FString& SourceString
)

Returns a string converted to Lower case

Public function Static

FString

 

ToUpper

(
    const FString& SourceString
)

Returns a string converted to Upper case

Public function Static

FString

 

Trim

(
    const FString& SourceString
)

Removes whitespace characters from the front of this string.

Public function Static

FString

 

TrimTrailing

(
    const FString& SourceString
)

Removes trailing whitespace characters
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss