|
G1R AngelScript
Scripting reference for the Gothic 1 Remake
|
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. | |
Converts a boolean->string, creating a new string in the form AppendTo+Prefix+InBool+Suffix.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InBool | The bool value to convert. Will add "true" or "false" to the conversion string |
| Suffix | A suffix to append to the end of the conversion string |
| 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.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InColor | The linear color value to convert. Uses the standard ToString conversion |
| Suffix | A suffix to append to the end of the conversion string |
Converts a double->string, create a new string in the form AppendTo+Prefix+InDouble+Suffix.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InDouble | The double value to convert |
| Suffix | A suffix to append to the end of the conversion string |
Converts a int->string, creating a new string in the form AppendTo+Prefix+InInt+Suffix.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InInt | The int value to convert |
| Suffix | A suffix to append to the end of the conversion string |
| 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.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InIntVector | The intVector value to convert. Uses the standard FVector::ToString conversion |
| Suffix | A suffix to append to the end of the conversion string |
Converts a color->string, creating a new string in the form AppendTo+Prefix+InName+Suffix.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InName | The name value to convert |
| Suffix | A suffix to append to the end of the conversion string |
Converts a object->string, creating a new string in the form AppendTo+Prefix+object name+Suffix.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InObj | The object to convert. Will insert the name of the object into the conversion string |
| Suffix | A suffix to append to the end of the conversion string |
Converts a rotator->string, creating a new string in the form AppendTo+Prefix+InRot+Suffix.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InRot | The rotator value to convert. Uses the standard ToString conversion |
| Suffix | A suffix to append to the end of the conversion string |
Converts a vector->string, creating a new string in the form AppendTo+Prefix+InVector+Suffix.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InVector | The vector value to convert. Uses the standard FVector::ToString conversion |
| Suffix | A suffix to append to the end of the conversion string |
| 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.
| AppendTo | An existing string to use as the start of the conversion string |
| Prefix | A string to use as a prefix, after the AppendTo string |
| InVector2d | The vector2d value to convert. Uses the standard FVector2D::ToString conversion |
| Suffix | A suffix to append to the end of the conversion 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'.
Converts a FBox value to a string of its Center and Extents values.
| 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.
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='.
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.
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.
Convert String Back To Rotator. IsValid indicates whether or not the string could be successfully converted.
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.
Convert String Back To Float Vector. IsValid indicates whether or not the string could be successfully converted.
| 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='.
Converts a vector2d value to a string, in the form 'X= Y='.
Converts a float vector value to a string, in the form 'X= Y= Z='.
Converts a vector value to a string, in the form 'X= Y= Z='.
Takes an array of strings and removes any zero length entries.
| InArray | The array to cull |
| bool EndsWith | ( | FString | SourceString, |
| FString | InSuffix, | ||
| ESearchCase | SearchCase = ESearchCase :: IgnoreCase ) |
Test whether this string ends with given string.
| SearchCase | Indicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase ) |
| 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.
| SearchIn | The string to search within |
| Substring | The string to look for in the SearchIn string |
| bUseCase | Whether or not to be case-sensitive |
| bSearchFromEnd | Whether or not to start the search from the end of the string instead of the beginning |
| StartPosition | The position to start the search from |
Returns an array that contains one entry for each character in SourceString.
| SourceString | The string to break apart into characters |
| int GetCharacterAsNumber | ( | FString | SourceString, |
| int | Index = 0 ) |
Gets a single character from the string (as an integer).
| SourceString | The string to convert |
| Index | Location of the character whose value is required |
Returns a substring from the string starting at the specified position.
| SourceString | The string to get the substring from |
| StartIndex | The location in SourceString to use as the start of the substring |
| Length | The length of the requested substring |
| bool IsEmpty | ( | FString | InString | ) |
Returns true if the string is empty.
| InString | The string to check |
| 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
Concatenates an array of strings into a single string.
| SourceArray | The array of strings to concatenate. |
| Separator | The string used to separate each element. |
Returns the left most characters from the string chopping the given number of characters from the end.
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
| 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.
| Wildcard | *?-type wildcard |
| SearchCase | Indicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase ) |
Returns the substring from Start position for Count characters.
| 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.
| SourceString | The string to chop up |
| Delimiter | The string to delimit on |
| CullEmptyStrings | = true - Cull (true) empty strings or add them to the array (false) |
| FString Replace | ( | FString | SourceString, |
| FString | From, | ||
| FString | To, | ||
| ESearchCase | SearchCase = ESearchCase :: IgnoreCase ) |
Replace all occurrences of a substring in this string.
| From | substring to replace |
| To | substring to replace From with |
| SearchCase | Indicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase ) |
| int ReplaceInline | ( | FString & | SourceString, |
| FString | SearchText, | ||
| FString | ReplacementText, | ||
| ESearchCase | SearchCase = ESearchCase :: IgnoreCase ) |
Replace all occurrences of SearchText with ReplacementText in this string.
| SearchText | the text that should be removed from this string |
| ReplacementText | the text to insert in its place |
| SearchCase | Indicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase ) |
Returns a copy of this string, with the characters in reverse order.
Returns the string to the right of the specified location, counting back from the right (end of the word).
Returns the string to the right of the specified location, counting forward from the left (from the beginning of the word).
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
| 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.
| InStr | The string to search and split at |
| LeftS | out the string to the left of InStr, not updated if return is false |
| RightS | out the string to the right of InStr, not updated if return is false |
| SearchCase | Indicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase ) |
| SearchDir | Indicates whether the search starts at the begining or at the end ( defaults to ESearchDir::FromStart ) |
| bool StartsWith | ( | FString | SourceString, |
| FString | InPrefix, | ||
| ESearchCase | SearchCase = ESearchCase :: IgnoreCase ) |
Test whether this string starts with given string.
| SearchCase | Indicates whether the search is case sensitive or not ( defaults to ESearchCase::IgnoreCase ) |
| FString TimeSecondsToString | ( | float32 | InSeconds | ) |
Convert a number of seconds into minutes:seconds.milliseconds format string (including leading zeroes).
Returns a string converted to Lower case.
| SourceString | The string to convert |
Returns a string converted to Upper case.
| SourceString | The string to convert |