G1R AngelScript
Scripting reference for the Gothic 1 Remake
Loading...
Searching...
No Matches
String Namespace Reference

Functions

Utilities|String
FString Conv_TransformToString (FTransform InTrans)
 Converts a transform value to a string, in the form 'Translation: X= Y= Z= Rotation: P= Y= R= Scale: X= Y= Z='.
FString BuildString_Color (FString AppendTo, FString Prefix, FLinearColor InColor, FString Suffix)
 Converts a color->string, creating a new string in the form AppendTo+Prefix+InColor+Suffix.
FString BuildString_Double (FString AppendTo, FString Prefix, float InDouble, FString Suffix)
 Converts a double->string, create a new string in the form AppendTo+Prefix+InDouble+Suffix.
FString BuildString_Int (FString AppendTo, FString Prefix, int InInt, FString Suffix)
 Converts a int->string, creating a new string in the form AppendTo+Prefix+InInt+Suffix.
FString BuildString_IntVector (FString AppendTo, FString Prefix, FIntVector InIntVector, FString Suffix)
 Converts an IntVector->string, creating a new string in the form AppendTo+Prefix+InIntVector+Suffix.
FString BuildString_Name (FString AppendTo, FString Prefix, FName InName, FString Suffix)
 Converts a color->string, creating a new string in the form AppendTo+Prefix+InName+Suffix.
FString BuildString_Object (FString AppendTo, FString Prefix, UObject InObj, FString Suffix)
 Converts a object->string, creating a new string in the form AppendTo+Prefix+object name+Suffix.
FString BuildString_Rotator (FString AppendTo, FString Prefix, FRotator InRot, FString Suffix)
 Converts a rotator->string, creating a new string in the form AppendTo+Prefix+InRot+Suffix.
FString BuildString_Vector (FString AppendTo, FString Prefix, FVector InVector, FString Suffix)
 Converts a vector->string, creating a new string in the form AppendTo+Prefix+InVector+Suffix.
FString BuildString_Vector2d (FString AppendTo, FString Prefix, FVector2D InVector2d, FString Suffix)
 Converts a vector2d->string, creating a new string in the form AppendTo+Prefix+InVector2d+Suffix.
FString Concat_StrStr (FString A, FString B)
 Concatenates two strings together to make a new string.
bool Contains (FString SearchIn, FString Substring, bool bUseCase=false, bool bSearchFromEnd=false)
 Returns whether this string contains the specified substring.
FString Conv_BoolToString (bool InBool)
 Converts a boolean value to a string, either 'true' or 'false'.
FString Conv_BoxCenterAndExtentsToString (FBox Box)
 Converts a FBox value to a string of its Center and Extents values.
FString Conv_BoxToString (FBox Box)
 Converts a FBox value to a string.
FString Conv_ByteToString (uint8 InByte)
 Converts a byte value to a string.
FString Conv_ColorToString (FLinearColor InColor)
 Converts a linear color value to a string, in the form '(R=,G=,B=,A=)'.
FString Conv_DoubleToString (float InDouble)
 Converts a double value to a string.
FString Conv_InputDeviceIdToString (FInputDeviceId InDeviceId)
 Converts a InputDeviceId value to a string.
FString Conv_Int64ToString (int64 InInt)
 Converts an 64-bit integer value to a string.
FString Conv_IntPointToString (FIntPoint InIntPoint)
 Converts an IntPoint value to a string, in the form 'X= Y='.
FString Conv_IntToString (int InInt)
 Converts an integer value to a string.
FString Conv_IntVectorToString (FIntVector InIntVec)
 Converts an IntVector value to a string, in the form 'X= Y= Z='.
FString Conv_MatrixToString (FMatrix InMatrix)
 Converts a name value to a string.
FString Conv_NameToString (FName InName)
 Converts a name value to a string.
FString Conv_ObjectToString (UObject InObj)
 Converts a UObject value to a string by calling the object's GetName method.
FString Conv_PlatformUserIdToString (FPlatformUserId InPlatformUserId)
 Converts a PlatformUserId value to a string.
FString Conv_RotatorToString (FRotator InRot)
 Converts a rotator value to a string, in the form 'P= Y= R='.
void Conv_StringToColor (FString InString, FLinearColor &OutConvertedColor, bool &OutIsValid)
 Convert String Back To Color. IsValid indicates whether or not the string could be successfully converted.
float Conv_StringToDouble (FString InString)
 Converts a string to a double value.
int Conv_StringToInt (FString InString)
 Converts a string to a int value.
int64 Conv_StringToInt64 (FString InString)
 Converts a string to a int value.
FName Conv_StringToName (FString InString)
 Converts a string to a name value.
void Conv_StringToRotator (FString InString, FRotator &OutConvertedRotator, bool &OutIsValid)
 Convert String Back To Rotator. IsValid indicates whether or not the string could be successfully converted.
void Conv_StringToVector (FString InString, FVector &OutConvertedVector, bool &OutIsValid)
 Convert String Back To Vector. IsValid indicates whether or not the string could be successfully converted.
void Conv_StringToVector2D (FString InString, FVector2D &OutConvertedVector2D, bool &OutIsValid)
 Convert String Back To Vector2D. IsValid indicates whether or not the string could be successfully converted.
void Conv_StringToVector3f (FString InString, FVector3f &OutConvertedVector, bool &OutIsValid)
 Convert String Back To Float Vector. IsValid indicates whether or not the string could be successfully converted.
FString BuildString_Bool (FString AppendTo, FString Prefix, bool InBool, FString Suffix)
 Converts a boolean->string, creating a new string in the form AppendTo+Prefix+InBool+Suffix.
FString Conv_Vector2dToString (FVector2D InVec)
 Converts a vector2d value to a string, in the form 'X= Y='.
FString Conv_Vector3fToString (FVector3f InVec)
 Converts a float vector value to a string, in the form 'X= Y= Z='.
FString Conv_VectorToString (FVector InVec)
 Converts a vector value to a string, in the form 'X= Y= Z='.
int CullArray (FString SourceString, TArray< FString > &InArray)
 Takes an array of strings and removes any zero length entries.
bool EndsWith (FString SourceString, FString InSuffix, ESearchCase SearchCase=ESearchCase ::IgnoreCase)
 Test whether this string ends with given string.
bool EqualEqual_StriStri (FString A, FString B)
 Test if the input strings are equal (A == B), ignoring case.
bool EqualEqual_StrStr (FString A, FString B)
 Test if the input strings are equal (A == B).
int FindSubstring (FString SearchIn, FString Substring, bool bUseCase=false, bool bSearchFromEnd=false, int StartPosition=- 1)
 Finds the starting index of a substring in the a specified string.
TArray< FString > GetCharacterArrayFromString (FString SourceString)
 Returns an array that contains one entry for each character in SourceString.
int GetCharacterAsNumber (FString SourceString, int Index=0)
 Gets a single character from the string (as an integer).
FString GetSubstring (FString SourceString, int StartIndex=0, int Length=1)
 Returns a substring from the string starting at the specified position.
bool IsEmpty (FString InString)
 Returns true if the string is empty.
bool IsNumeric (FString SourceString)
 Checks if a string contains only numeric characters.
FString JoinStringArray (TArray< FString > SourceArray, FString Separator=" ")
 Concatenates an array of strings into a single string.
FString Left (FString SourceString, int Count)
 Returns the left most given number of characters.
FString LeftChop (FString SourceString, int Count)
 Returns the left most characters from the string chopping the given number of characters from the end.
FString LeftPad (FString SourceString, int ChCount)
 Pad the left of this string for a specified number of characters.
int Len (FString S)
 Returns the number of characters in the string.
bool MatchesWildcard (FString SourceString, FString Wildcard, ESearchCase SearchCase=ESearchCase ::IgnoreCase)
 Searches this string for a given wild card.
FString Mid (FString SourceString, int Start, int Count)
 Returns the substring from Start position for Count characters.
bool NotEqual_StriStri (FString A, FString B)
 Test if the input string are not equal (A != B), ignoring case differences.
bool NotEqual_StrStr (FString A, FString B)
 Test if the input string are not equal (A != B).
TArray< FString > ParseIntoArray (FString SourceString, FString Delimiter=" ", bool CullEmptyStrings=true)
 Gets an array of strings from a source string divided up by a separator and empty strings can optionally be culled.
FString Replace (FString SourceString, FString From, FString To, ESearchCase SearchCase=ESearchCase ::IgnoreCase)
 Replace all occurrences of a substring in this string.
int ReplaceInline (FString &SourceString, FString SearchText, FString ReplacementText, ESearchCase SearchCase=ESearchCase ::IgnoreCase)
 Replace all occurrences of SearchText with ReplacementText in this string.
FString Reverse (FString SourceString)
 Returns a copy of this string, with the characters in reverse order.
FString Right (FString SourceString, int Count)
 Returns the string to the right of the specified location, counting back from the right (end of the word).
FString RightChop (FString SourceString, int Count)
 Returns the string to the right of the specified location, counting forward from the left (from the beginning of the word).
FString RightPad (FString SourceString, int ChCount)
 Pad the right of this string for a specified number of characters.
bool Split (FString SourceString, FString InStr, FString &LeftS, FString &RightS, ESearchCase SearchCase=ESearchCase ::IgnoreCase, ESearchDir SearchDir=ESearchDir ::FromStart)
 Splits this string at given string position case sensitive.
bool StartsWith (FString SourceString, FString InPrefix, ESearchCase SearchCase=ESearchCase ::IgnoreCase)
 Test whether this string starts with given string.
FString TimeSecondsToString (float32 InSeconds)
 Convert a number of seconds into minutes:seconds.milliseconds format string (including leading zeroes).
FString ToLower (FString SourceString)
 Returns a string converted to Lower case.
FString ToUpper (FString SourceString)
 Returns a string converted to Upper case.
FString Trim (FString SourceString)
 Removes whitespace characters from the front of this string.
FString TrimTrailing (FString SourceString)
 Removes trailing whitespace characters.

Function Documentation

◆ BuildString_Bool()

FString BuildString_Bool ( FString AppendTo,
FString Prefix,
bool InBool,
FString Suffix )

Converts a boolean->string, creating a new string in the form AppendTo+Prefix+InBool+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InBoolThe bool value to convert. Will add "true" or "false" to the conversion string
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_Color()

FString BuildString_Color ( FString AppendTo,
FString Prefix,
FLinearColor InColor,
FString Suffix )

Converts a color->string, creating a new string in the form AppendTo+Prefix+InColor+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InColorThe linear color value to convert. Uses the standard ToString conversion
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_Double()

FString BuildString_Double ( FString AppendTo,
FString Prefix,
float InDouble,
FString Suffix )

Converts a double->string, create a new string in the form AppendTo+Prefix+InDouble+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InDoubleThe double value to convert
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_Int()

FString BuildString_Int ( FString AppendTo,
FString Prefix,
int InInt,
FString Suffix )

Converts a int->string, creating a new string in the form AppendTo+Prefix+InInt+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InIntThe int value to convert
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_IntVector()

FString BuildString_IntVector ( FString AppendTo,
FString Prefix,
FIntVector InIntVector,
FString Suffix )

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

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InIntVectorThe intVector value to convert. Uses the standard FVector::ToString conversion
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_Name()

FString BuildString_Name ( FString AppendTo,
FString Prefix,
FName InName,
FString Suffix )

Converts a color->string, creating a new string in the form AppendTo+Prefix+InName+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InNameThe name value to convert
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_Object()

FString BuildString_Object ( FString AppendTo,
FString Prefix,
UObject InObj,
FString Suffix )

Converts a object->string, creating a new string in the form AppendTo+Prefix+object name+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InObjThe object to convert. Will insert the name of the object into the conversion string
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_Rotator()

FString BuildString_Rotator ( FString AppendTo,
FString Prefix,
FRotator InRot,
FString Suffix )

Converts a rotator->string, creating a new string in the form AppendTo+Prefix+InRot+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InRotThe rotator value to convert. Uses the standard ToString conversion
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_Vector()

FString BuildString_Vector ( FString AppendTo,
FString Prefix,
FVector InVector,
FString Suffix )

Converts a vector->string, creating a new string in the form AppendTo+Prefix+InVector+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InVectorThe vector value to convert. Uses the standard FVector::ToString conversion
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ BuildString_Vector2d()

FString BuildString_Vector2d ( FString AppendTo,
FString Prefix,
FVector2D InVector2d,
FString Suffix )

Converts a vector2d->string, creating a new string in the form AppendTo+Prefix+InVector2d+Suffix.

Parameters
AppendToAn existing string to use as the start of the conversion string
PrefixA string to use as a prefix, after the AppendTo string
InVector2dThe vector2d value to convert. Uses the standard FVector2D::ToString conversion
SuffixA suffix to append to the end of the conversion string
Returns
A new string built from the passed parameters

◆ Concat_StrStr()

FString Concat_StrStr ( FString A,
FString B )

Concatenates two strings together to make a new string.

Parameters
AThe original string
BThe string to append to A
Returns
A new string which is the concatenation of A+B

◆ Contains()

bool Contains ( FString SearchIn,
FString Substring,
bool bUseCase = false,
bool bSearchFromEnd = false )

Returns whether this string contains the specified substring.

Returns
Returns whether the string contains the substring

◆ Conv_BoolToString()

FString Conv_BoolToString ( bool InBool)

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

◆ Conv_BoxCenterAndExtentsToString()

FString Conv_BoxCenterAndExtentsToString ( FBox Box)

Converts a FBox value to a string of its Center and Extents values.

◆ Conv_BoxToString()

FString Conv_BoxToString ( FBox Box)

Converts a FBox value to a string.

◆ Conv_ByteToString()

FString Conv_ByteToString ( uint8 InByte)

Converts a byte value to a string.

◆ Conv_ColorToString()

FString Conv_ColorToString ( FLinearColor InColor)

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

◆ Conv_DoubleToString()

FString Conv_DoubleToString ( float InDouble)

Converts a double value to a string.

◆ Conv_InputDeviceIdToString()

FString Conv_InputDeviceIdToString ( FInputDeviceId InDeviceId)

Converts a InputDeviceId value to a string.

◆ Conv_Int64ToString()

FString Conv_Int64ToString ( int64 InInt)

Converts an 64-bit integer value to a string.

◆ Conv_IntPointToString()

FString Conv_IntPointToString ( FIntPoint InIntPoint)

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

◆ Conv_IntToString()

FString Conv_IntToString ( int InInt)

Converts an integer value to a string.

◆ Conv_IntVectorToString()

FString Conv_IntVectorToString ( FIntVector InIntVec)

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

◆ Conv_MatrixToString()

FString Conv_MatrixToString ( FMatrix InMatrix)

Converts a name value to a string.

◆ Conv_NameToString()

FString Conv_NameToString ( FName InName)

Converts a name value to a string.

◆ Conv_ObjectToString()

FString Conv_ObjectToString ( UObject InObj)

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

◆ Conv_PlatformUserIdToString()

FString Conv_PlatformUserIdToString ( FPlatformUserId InPlatformUserId)

Converts a PlatformUserId value to a string.

◆ Conv_RotatorToString()

FString Conv_RotatorToString ( FRotator InRot)

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

◆ Conv_StringToColor()

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

Convert String Back To Color. IsValid indicates whether or not the string could be successfully converted.

◆ Conv_StringToDouble()

float Conv_StringToDouble ( FString InString)

Converts a string to a double value.

◆ Conv_StringToInt()

int Conv_StringToInt ( FString InString)

Converts a string to a int value.

◆ Conv_StringToInt64()

int64 Conv_StringToInt64 ( FString InString)

Converts a string to a int value.

◆ Conv_StringToName()

FName Conv_StringToName ( FString InString)

Converts a string to a name value.

◆ Conv_StringToRotator()

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

Convert String Back To Rotator. IsValid indicates whether or not the string could be successfully converted.

◆ Conv_StringToVector()

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

Convert String Back To Vector. IsValid indicates whether or not the string could be successfully converted.

◆ Conv_StringToVector2D()

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

Convert String Back To Vector2D. IsValid indicates whether or not the string could be successfully converted.

◆ Conv_StringToVector3f()

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

Convert String Back To Float Vector. IsValid indicates whether or not the string could be successfully converted.

◆ Conv_TransformToString()

FString Conv_TransformToString ( FTransform InTrans)

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

◆ Conv_Vector2dToString()

FString Conv_Vector2dToString ( FVector2D InVec)

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

◆ Conv_Vector3fToString()

FString Conv_Vector3fToString ( FVector3f InVec)

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

◆ Conv_VectorToString()

FString Conv_VectorToString ( FVector InVec)

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

◆ CullArray()

int CullArray ( FString SourceString,
TArray< FString > & InArray )

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

Parameters
InArrayThe array to cull
Returns
The number of elements left in InArray

◆ EndsWith()

bool EndsWith ( FString SourceString,
FString InSuffix,
ESearchCase SearchCase = ESearchCase :: IgnoreCase )

Test whether this string ends with given string.

Parameters
SearchCaseIndicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase )
Returns
true if this string ends with specified text, false otherwise

◆ EqualEqual_StriStri()

bool EqualEqual_StriStri ( FString A,
FString B )

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

Parameters
AThe string to compare against
BThe string to compare
Returns
True if the strings are equal, false otherwise

◆ EqualEqual_StrStr()

bool EqualEqual_StrStr ( FString A,
FString B )

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

Parameters
AThe string to compare against
BThe string to compare
Returns
True if the strings are equal, false otherwise

◆ FindSubstring()

int FindSubstring ( FString SearchIn,
FString Substring,
bool bUseCase = false,
bool bSearchFromEnd = false,
int StartPosition = - 1 )

Finds the starting index of a substring in the a specified string.

Parameters
SearchInThe string to search within
SubstringThe string to look for in the SearchIn string
bUseCaseWhether or not to be case-sensitive
bSearchFromEndWhether or not to start the search from the end of the string instead of the beginning
StartPositionThe position to start the search from
Returns
The index (starting from 0 if bSearchFromEnd is false) of the first occurence of the substring

◆ GetCharacterArrayFromString()

TArray< FString > GetCharacterArrayFromString ( FString SourceString)

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

Parameters
SourceStringThe string to break apart into characters
Returns
An array containing one entry for each character in SourceString

◆ GetCharacterAsNumber()

int GetCharacterAsNumber ( FString SourceString,
int Index = 0 )

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

Parameters
SourceStringThe string to convert
IndexLocation of the character whose value is required
Returns
The integer value of the character or 0 if index is out of range

◆ GetSubstring()

FString GetSubstring ( FString SourceString,
int StartIndex = 0,
int Length = 1 )

Returns a substring from the string starting at the specified position.

Parameters
SourceStringThe string to get the substring from
StartIndexThe location in SourceString to use as the start of the substring
LengthThe length of the requested substring
Returns
The requested substring

◆ IsEmpty()

bool IsEmpty ( FString InString)

Returns true if the string is empty.

Parameters
InStringThe string to check
Returns
Whether or not the string is empty

◆ IsNumeric()

bool IsNumeric ( FString SourceString)

Checks if a string contains only numeric characters.

@param SourceString   The string to check *
@return    true if the string only contains numeric characters 

◆ JoinStringArray()

FString JoinStringArray ( TArray< FString > SourceArray,
FString Separator = " " )

Concatenates an array of strings into a single string.

Parameters
SourceArrayThe array of strings to concatenate.
SeparatorThe string used to separate each element.
Returns
The final, joined, separated string.

◆ Left()

FString Left ( FString SourceString,
int Count )

Returns the left most given number of characters.

◆ LeftChop()

FString LeftChop ( FString SourceString,
int Count )

Returns the left most characters from the string chopping the given number of characters from the end.

◆ LeftPad()

FString LeftPad ( FString SourceString,
int ChCount )

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

@param SourceString   The string to pad *
@param ChCount   Amount of padding required *
@return    The padded string 

◆ Len()

int Len ( FString S)

Returns the number of characters in the string.

Returns
The number of chars in the string

◆ MatchesWildcard()

bool MatchesWildcard ( FString SourceString,
FString Wildcard,
ESearchCase SearchCase = ESearchCase :: IgnoreCase )

Searches this string for a given wild card.

Parameters
Wildcard*?-type wildcard
SearchCaseIndicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase )
Returns
true if this string matches the *?-type wildcard given.

◆ Mid()

FString Mid ( FString SourceString,
int Start,
int Count )

Returns the substring from Start position for Count characters.

◆ NotEqual_StriStri()

bool NotEqual_StriStri ( FString A,
FString B )

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

Parameters
AThe string to compare against
BThe string to compare
Returns
Returns true if the input strings are not equal, false if they are equal

◆ NotEqual_StrStr()

bool NotEqual_StrStr ( FString A,
FString B )

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

Parameters
AThe string to compare against
BThe string to compare
Returns
Returns true if the input strings are not equal, false if they are equal

◆ ParseIntoArray()

TArray< FString > ParseIntoArray ( FString SourceString,
FString Delimiter = " ",
bool CullEmptyStrings = true )

Gets an array of strings from a source string divided up by a separator and empty strings can optionally be culled.

Parameters
SourceStringThe string to chop up
DelimiterThe string to delimit on
CullEmptyStrings= true - Cull (true) empty strings or add them to the array (false)
Returns
The array of string that have been separated

◆ Replace()

FString Replace ( FString SourceString,
FString From,
FString To,
ESearchCase SearchCase = ESearchCase :: IgnoreCase )

Replace all occurrences of a substring in this string.

Parameters
Fromsubstring to replace
Tosubstring to replace From with
SearchCaseIndicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase )
Returns
a copy of this string with the replacement made

◆ ReplaceInline()

int ReplaceInline ( FString & SourceString,
FString SearchText,
FString ReplacementText,
ESearchCase SearchCase = ESearchCase :: IgnoreCase )

Replace all occurrences of SearchText with ReplacementText in this string.

Parameters
SearchTextthe text that should be removed from this string
ReplacementTextthe text to insert in its place
SearchCaseIndicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase )
Returns
the number of occurrences of SearchText that were replaced.

◆ Reverse()

FString Reverse ( FString SourceString)

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

◆ Right()

FString Right ( FString SourceString,
int Count )

Returns the string to the right of the specified location, counting back from the right (end of the word).

◆ RightChop()

FString RightChop ( FString SourceString,
int Count )

Returns the string to the right of the specified location, counting forward from the left (from the beginning of the word).

◆ RightPad()

FString RightPad ( FString SourceString,
int ChCount )

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

@param SourceString   The string to pad *
@param ChCount   Amount of padding required *
@return    The padded string 

◆ Split()

bool Split ( FString SourceString,
FString InStr,
FString & LeftS,
FString & RightS,
ESearchCase SearchCase = ESearchCase :: IgnoreCase,
ESearchDir SearchDir = ESearchDir :: FromStart )

Splits this string at given string position case sensitive.

Parameters
InStrThe string to search and split at
LeftSout the string to the left of InStr, not updated if return is false
RightSout the string to the right of InStr, not updated if return is false
SearchCaseIndicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase )
SearchDirIndicates whether the search starts at the begining or at the end ( defaults to ESearchDir::FromStart )
Returns
true if string is split, otherwise false

◆ StartsWith()

bool StartsWith ( FString SourceString,
FString InPrefix,
ESearchCase SearchCase = ESearchCase :: IgnoreCase )

Test whether this string starts with given string.

Parameters
SearchCaseIndicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase )
Returns
true if this string begins with specified text, false otherwise

◆ TimeSecondsToString()

FString TimeSecondsToString ( float32 InSeconds)

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

Returns
A new string built from the seconds parameter

◆ ToLower()

FString ToLower ( FString SourceString)

Returns a string converted to Lower case.

Parameters
SourceStringThe string to convert
Returns
The string in lower case

◆ ToUpper()

FString ToUpper ( FString SourceString)

Returns a string converted to Upper case.

Parameters
SourceStringThe string to convert
Returns
The string in upper case

◆ Trim()

FString Trim ( FString SourceString)

Removes whitespace characters from the front of this string.

◆ TrimTrailing()

FString TrimTrailing ( FString SourceString)

Removes trailing whitespace characters.