Class KismetStringLibrary
Inheritance
System.Object
KismetStringLibrary
Inherited Members
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)
Assembly: UE4DotNet.dll
Syntax
public class KismetStringLibrary : BlueprintFunctionLibrary
Properties
|
Improve this Doc
View Source
DefaultObject
Get UE4 Default Object for this Class
Declaration
public static KismetStringLibrary DefaultObject { get; }
Property Value
|
Improve this Doc
View Source
StaticClass
Declaration
public static Class StaticClass { get; }
Property Value
Methods
|
Improve this Doc
View Source
BuildString_Bool(String, String, Boolean, String)
Converts a boolean->string, creating a new string in the form AppendTo+Prefix+InBool+Suffix
@
Declaration
public static string BuildString_Bool(string AppendTo, string Prefix, bool InBool, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
System.Boolean |
InBool |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_Color(String, String, LinearColor, String)
Converts a color->string, creating a new string in the form AppendTo+Prefix+InColor+Suffix
@
Declaration
public static string BuildString_Color(string AppendTo, string Prefix, LinearColor InColor, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
LinearColor |
InColor |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_Float(String, String, Single, String)
Converts a float->string, create a new string in the form AppendTo+Prefix+InFloat+Suffix
@
Declaration
public static string BuildString_Float(string AppendTo, string Prefix, float InFloat, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
System.Single |
InFloat |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_Int(String, String, Int32, String)
Converts a int->string, creating a new string in the form AppendTo+Prefix+InInt+Suffix
@
Declaration
public static string BuildString_Int(string AppendTo, string Prefix, int InInt, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
System.Int32 |
InInt |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_IntVector(String, String, IntVector, String)
Converts an IntVector->string, creating a new string in the form AppendTo+Prefix+InIntVector+Suffix
@
Declaration
public static string BuildString_IntVector(string AppendTo, string Prefix, IntVector InIntVector, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
IntVector |
InIntVector |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_Name(String, String, Name, String)
Converts a color->string, creating a new string in the form AppendTo+Prefix+InName+Suffix
@
Declaration
public static string BuildString_Name(string AppendTo, string Prefix, Name InName, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
Name |
InName |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_Object(String, String, UObject, String)
Converts a object->string, creating a new string in the form AppendTo+Prefix+object name+Suffix
@
Declaration
public static string BuildString_Object(string AppendTo, string Prefix, UObject InObj, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
UObject |
InObj |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_Rotator(String, String, Rotator, String)
Converts a rotator->string, creating a new string in the form AppendTo+Prefix+InRot+Suffix
@
Declaration
public static string BuildString_Rotator(string AppendTo, string Prefix, Rotator InRot, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
Rotator |
InRot |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_Vector(String, String, Vector, String)
Converts a vector->string, creating a new string in the form AppendTo+Prefix+InVector+Suffix
@
Declaration
public static string BuildString_Vector(string AppendTo, string Prefix, Vector InVector, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
Vector |
InVector |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
BuildString_Vector2d(String, String, Vector2D, String)
Converts a vector2d->string, creating a new string in the form AppendTo+Prefix+InVector2d+Suffix
@
Declaration
public static string BuildString_Vector2d(string AppendTo, string Prefix, Vector2D InVector2d, string Suffix)
Parameters
Type |
Name |
Description |
System.String |
AppendTo |
|
System.String |
Prefix |
|
Vector2D |
InVector2d |
|
System.String |
Suffix |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Concat_StrStr(String, String)
Concatenates two strings together to make a new string
@
Declaration
public static string Concat_StrStr(string A, string B)
Parameters
Type |
Name |
Description |
System.String |
A |
|
System.String |
B |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Contains(String, String, Boolean, Boolean)
Returns whether this string contains the specified substring.
Declaration
public static bool Contains(string SearchIn, string Substring, bool bUseCase, bool bSearchFromEnd)
Parameters
Type |
Name |
Description |
System.String |
SearchIn |
|
System.String |
Substring |
|
System.Boolean |
bUseCase |
|
System.Boolean |
bSearchFromEnd |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
Conv_BoolToString(Boolean)
Converts a boolean value to a string, either 'true' or 'false'
Declaration
public static string Conv_BoolToString(bool InBool)
Parameters
Type |
Name |
Description |
System.Boolean |
InBool |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_ByteToString(Byte)
Converts a byte value to a string
Declaration
public static string Conv_ByteToString(byte InByte)
Parameters
Type |
Name |
Description |
System.Byte |
InByte |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_ColorToString(LinearColor)
Converts a linear color value to a string, in the form '(R=,G=,B=,A=)'
Declaration
public static string Conv_ColorToString(LinearColor InColor)
Parameters
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_FloatToString(Single)
Converts a float value to a string
Declaration
public static string Conv_FloatToString(float InFloat)
Parameters
Type |
Name |
Description |
System.Single |
InFloat |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_IntToString(Int32)
Converts an integer value to a string
Declaration
public static string Conv_IntToString(int InInt)
Parameters
Type |
Name |
Description |
System.Int32 |
InInt |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_IntVectorToString(IntVector)
Converts an IntVector value to a string, in the form 'X= Y= Z='
Declaration
public static string Conv_IntVectorToString(IntVector InIntVec)
Parameters
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_NameToString(Name)
Converts a name value to a string
Declaration
public static string Conv_NameToString(Name InName)
Parameters
Type |
Name |
Description |
Name |
InName |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_ObjectToString(UObject)
Converts a UObject value to a string by calling the object's GetName method
Declaration
public static string Conv_ObjectToString(UObject InObj)
Parameters
Type |
Name |
Description |
UObject |
InObj |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_RotatorToString(Rotator)
Converts a rotator value to a string, in the form 'P= Y= R='
Declaration
public static string Conv_RotatorToString(Rotator InRot)
Parameters
Type |
Name |
Description |
Rotator |
InRot |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_StringToColor(String)
Convert String Back To Color. IsValid indicates whether or not the string could be successfully converted.
Declaration
public static (LinearColor, bool) Conv_StringToColor(string InString)
Parameters
Type |
Name |
Description |
System.String |
InString |
|
Returns
Type |
Description |
System.ValueTuple<LinearColor, System.Boolean> |
|
|
Improve this Doc
View Source
Conv_StringToFloat(String)
Converts a string to a float value
Declaration
public static float Conv_StringToFloat(string InString)
Parameters
Type |
Name |
Description |
System.String |
InString |
|
Returns
Type |
Description |
System.Single |
|
|
Improve this Doc
View Source
Conv_StringToInt(String)
Converts a string to a int value
Declaration
public static int Conv_StringToInt(string InString)
Parameters
Type |
Name |
Description |
System.String |
InString |
|
Returns
Type |
Description |
System.Int32 |
|
|
Improve this Doc
View Source
Conv_StringToName(String)
Converts a string to a name value
Declaration
public static Name Conv_StringToName(string InString)
Parameters
Type |
Name |
Description |
System.String |
InString |
|
Returns
|
Improve this Doc
View Source
Conv_StringToRotator(String)
Convert String Back To Rotator. IsValid indicates whether or not the string could be successfully converted.
Declaration
public static (Rotator, bool) Conv_StringToRotator(string InString)
Parameters
Type |
Name |
Description |
System.String |
InString |
|
Returns
Type |
Description |
System.ValueTuple<Rotator, System.Boolean> |
|
|
Improve this Doc
View Source
Conv_StringToVector(String)
Convert String Back To Vector. IsValid indicates whether or not the string could be successfully converted.
Declaration
public static (Vector, bool) Conv_StringToVector(string InString)
Parameters
Type |
Name |
Description |
System.String |
InString |
|
Returns
Type |
Description |
System.ValueTuple<Vector, System.Boolean> |
|
|
Improve this Doc
View Source
Conv_StringToVector2D(String)
Convert String Back To Vector2D. IsValid indicates whether or not the string could be successfully converted.
Declaration
public static (Vector2D, bool) Conv_StringToVector2D(string InString)
Parameters
Type |
Name |
Description |
System.String |
InString |
|
Returns
Type |
Description |
System.ValueTuple<Vector2D, System.Boolean> |
|
|
Improve this Doc
View Source
Converts a transform value to a string, in the form 'Translation: X= Y= Z= Rotation: P= Y= R= Scale: X= Y= Z='
Declaration
public static string Conv_TransformToString(Transform InTrans)
Parameters
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_Vector2dToString(Vector2D)
Converts a vector2d value to a string, in the form 'X= Y='
Declaration
public static string Conv_Vector2dToString(Vector2D InVec)
Parameters
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Conv_VectorToString(Vector)
Converts a vector value to a string, in the form 'X= Y= Z='
Declaration
public static string Conv_VectorToString(Vector InVec)
Parameters
Type |
Name |
Description |
Vector |
InVec |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
CullArray(String)
Takes an array of strings and removes any zero length entries.
Declaration
public static (IReadOnlyCollection<string>, int) CullArray(string SourceString)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
Returns
Type |
Description |
System.ValueTuple<System.Collections.Generic.IReadOnlyCollection<System.String>, System.Int32> |
|
|
Improve this Doc
View Source
EndsWith(String, String, Byte)
Test whether this string ends with given string.
Declaration
public static bool EndsWith(string SourceString, string InSuffix, byte SearchCase)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.String |
InSuffix |
|
System.Byte |
SearchCase |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
EqualEqual_StriStri(String, String)
Test if the input strings are equal (A == B), ignoring case
@
Declaration
public static bool EqualEqual_StriStri(string A, string B)
Parameters
Type |
Name |
Description |
System.String |
A |
|
System.String |
B |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
EqualEqual_StrStr(String, String)
Test if the input strings are equal (A == B)
@
Declaration
public static bool EqualEqual_StrStr(string A, string B)
Parameters
Type |
Name |
Description |
System.String |
A |
|
System.String |
B |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
FindSubstring(String, String, Boolean, Boolean, Int32)
Finds the starting index of a substring in the a specified string
@
Declaration
public static int FindSubstring(string SearchIn, string Substring, bool bUseCase, bool bSearchFromEnd, int StartPosition)
Parameters
Type |
Name |
Description |
System.String |
SearchIn |
|
System.String |
Substring |
|
System.Boolean |
bUseCase |
|
System.Boolean |
bSearchFromEnd |
|
System.Int32 |
StartPosition |
|
Returns
Type |
Description |
System.Int32 |
|
|
Improve this Doc
View Source
GetCharacterArrayFromString(String)
Returns an array that contains one entry for each character in SourceString
@
Declaration
public static IReadOnlyCollection<string> GetCharacterArrayFromString(string SourceString)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
Returns
Type |
Description |
System.Collections.Generic.IReadOnlyCollection<System.String> |
|
|
Improve this Doc
View Source
GetCharacterAsNumber(String, Int32)
Gets a single character from the string (as an integer)
@
Declaration
public static int GetCharacterAsNumber(string SourceString, int Index)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
Index |
|
Returns
Type |
Description |
System.Int32 |
|
|
Improve this Doc
View Source
GetSubstring(String, Int32, Int32)
Returns a substring from the string starting at the specified position
@
Declaration
public static string GetSubstring(string SourceString, int StartIndex, int Length)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
StartIndex |
|
System.Int32 |
Length |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
IsNumeric(String)
- Checks if a string contains only numeric characters
- @
Declaration
public static bool IsNumeric(string SourceString)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
JoinStringArray(Byte, String)
Concatenates an array of strings into a single string.
Declaration
public static string JoinStringArray(byte SourceArray, string Separator)
Parameters
Type |
Name |
Description |
System.Byte |
SourceArray |
|
System.String |
Separator |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Left(String, Int32)
@return the left most given number of characters
Declaration
public static string Left(string SourceString, int Count)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
Count |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
LeftChop(String, Int32)
@return the left most characters from the string chopping the given number of characters from the end
Declaration
public static string LeftChop(string SourceString, int Count)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
Count |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
LeftPad(String, Int32)
- Pad the left of this string for a specified number of characters
- @
Declaration
public static string LeftPad(string SourceString, int ChCount)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
ChCount |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Len(String)
Returns the number of characters in the string
@
Declaration
public static int Len(string S)
Parameters
Type |
Name |
Description |
System.String |
S |
|
Returns
Type |
Description |
System.Int32 |
|
|
Improve this Doc
View Source
MatchesWildcard(String, String, Byte)
Searches this string for a given wild card
@
Declaration
public static bool MatchesWildcard(string SourceString, string Wildcard, byte SearchCase)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.String |
Wildcard |
|
System.Byte |
SearchCase |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
Mid(String, Int32, Int32)
@return the substring from Start position for Count characters.
Declaration
public static string Mid(string SourceString, int Start, int Count)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
Start |
|
System.Int32 |
Count |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
New(UObject, Name)
Spawn an object of this class
Declaration
public static KismetStringLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Returns
|
Improve this Doc
View Source
NotEqual_StriStri(String, String)
Test if the input string are not equal (A != B), ignoring case differences
@
Declaration
public static bool NotEqual_StriStri(string A, string B)
Parameters
Type |
Name |
Description |
System.String |
A |
|
System.String |
B |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
NotEqual_StrStr(String, String)
Test if the input string are not equal (A != B)
@
Declaration
public static bool NotEqual_StrStr(string A, string B)
Parameters
Type |
Name |
Description |
System.String |
A |
|
System.String |
B |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
ParseIntoArray(String, String, Boolean)
Gets an array of strings from a source string divided up by a separator and empty strings can optionally be culled.
Declaration
public static IReadOnlyCollection<string> ParseIntoArray(string SourceString, string Delimiter, bool CullEmptyStrings)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.String |
Delimiter |
|
System.Boolean |
CullEmptyStrings |
|
Returns
Type |
Description |
System.Collections.Generic.IReadOnlyCollection<System.String> |
|
|
Improve this Doc
View Source
Replace(String, String, String, Byte)
Replace all occurrences of a substring in this string
@
Declaration
public static string Replace(string SourceString, string From, string To, byte SearchCase)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.String |
From |
|
System.String |
To |
|
System.Byte |
SearchCase |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
ReplaceInline(String, String, String, Byte)
Replace all occurrences of SearchText with ReplacementText in this string.
Declaration
public static int ReplaceInline(string SourceString, string SearchText, string ReplacementText, byte SearchCase)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.String |
SearchText |
|
System.String |
ReplacementText |
|
System.Byte |
SearchCase |
|
Returns
Type |
Description |
System.Int32 |
|
|
Improve this Doc
View Source
Reverse(String)
Returns a copy of this string, with the characters in reverse order
Declaration
public static string Reverse(string SourceString)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Right(String, Int32)
@return the string to the right of the specified location, counting back from the right (end of the word).
Declaration
public static string Right(string SourceString, int Count)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
Count |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
RightChop(String, Int32)
@return the string to the right of the specified location, counting forward from the left (from the beginning of the word).
Declaration
public static string RightChop(string SourceString, int Count)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
Count |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
RightPad(String, Int32)
- Pad the right of this string for a specified number of characters
- @
Declaration
public static string RightPad(string SourceString, int ChCount)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.Int32 |
ChCount |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Split(String, String, Byte, Byte)
Splits this string at given string position case sensitive.
Declaration
public static (string, string, bool) Split(string SourceString, string InStr, byte SearchCase, byte SearchDir)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.String |
InStr |
|
System.Byte |
SearchCase |
|
System.Byte |
SearchDir |
|
Returns
Type |
Description |
System.ValueTuple<System.String, System.String, System.Boolean> |
|
|
Improve this Doc
View Source
StartsWith(String, String, Byte)
Test whether this string starts with given string.
Declaration
public static bool StartsWith(string SourceString, string InPrefix, byte SearchCase)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
System.String |
InPrefix |
|
System.Byte |
SearchCase |
|
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
TimeSecondsToString(Single)
Convert a number of seconds into minutes:seconds.milliseconds format string
Declaration
public static string TimeSecondsToString(float InSeconds)
Parameters
Type |
Name |
Description |
System.Single |
InSeconds |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
ToLower(String)
Returns a string converted to Lower case
@
Declaration
public static string ToLower(string SourceString)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
ToUpper(String)
Returns a string converted to Upper case
@
Declaration
public static string ToUpper(string SourceString)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
Trim(String)
Removes whitespace characters from the front of this string.
Declaration
public static string Trim(string SourceString)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
Returns
Type |
Description |
System.String |
|
|
Improve this Doc
View Source
TrimTrailing(String)
Removes trailing whitespace characters
Declaration
public static string TrimTrailing(string SourceString)
Parameters
Type |
Name |
Description |
System.String |
SourceString |
|
Returns
Type |
Description |
System.String |
|
Operators
|
Improve this Doc
View Source
Implicit(IntPtr to KismetStringLibrary)
Convert from IntPtr to UObject
Declaration
public static implicit operator KismetStringLibrary(IntPtr p)
Parameters
Type |
Name |
Description |
System.IntPtr |
p |
|
Returns