Strings

Convert beautified string into a vector

vec

beautified string

Returns: vector resulting vector

Returns true if sample is substring of string

sample

string Finding string expression

Returns: bool true if sample is substring of string

string str = "Hello World";
Print( str.IndexOfFrom( 3, "Hello" ) );
Print( str.IndexOfFrom( 3, "Mexico" ) );

>> true
>> false

Gets n-th character from string

index

character index

Returns: string character on index-th position in string

int a = 5;
float b = 5.99;
string c = "beta";
string 	test = string.Format("Ahoj %1 = %3 , %2", a, b, c);
Print(test);
>> 'Ahoj 5 = 'beta' , 5.99'

Gets n-th character from string

index

character index

Returns: string character on index-th position in string

string str = "Hello World";
Print( str[4] ); // Print( str.Get(4) );

>> 'o'

Returns hash of string

Returns: int - Hash of string

string str = "Hello World";
int hash = str.Hash();
Print(hash);

Converts string to integer

Returns: int - Converted string.

string str = "0xFF";
int i = str.HexToInt();
Print(i);

>> i = 255

Finds 'sample' in 'str'. Returns -1 when not found

sample

string Finding string

Returns: int - Returns position where sample starts, or -1 when sample not found

string str = "Hello World";
Print( str.IndexOf( "H" ) );
Print( str.IndexOf( "W" ) );
Print( str.IndexOf( "Q" ) );

>> 0
>> 6
>> -1

Finds 'sample' in 'str' from 'start' position. Returns -1 when not found

start

int Start from position

sample

string Finding string expression

Returns: int - Length of string s

string str = "Hello World";
Print( str.IndexOfFrom( 3, "H" ) );
Print( str.IndexOfFrom( 3, "W" ) );
Print( str.IndexOfFrom( 3, "Q" ) );

>> -1
>> 6
>> -1

Inserts a string into the n-th index, increasing the string length by the size of the input

index

index to insert at

input

string value to insert with

string str = "Hello World";
str.Insert(6, "Test ");
Print( str );

>> 'Hello Test World'

Finds last 'sample' in 'str'. Returns -1 when not found

sample

string Finding string

Returns: int - Returns position where sample starts, or -1 when sample not found

string str = "Hello World";
Print( str.IndexOf( "l" ) );

>> 9

Returns length of string

Returns: int - Length of string

string str = "Hello World";
int i = str.Length();
Print(i);

>> i = 11

Returns number of characters in UTF8 string

Returns: int - Number of characters in UTF8 string

string str = "こんにちは世界";
int i = str.LengthUtf8();
Print(i);

>> i = 7

Do not use. Re-implemented for verification of new function due to design of previous function allowing for unexpected behavior that modders may depend on.

string str = "Hello World";
str.OldSet(6, "Test ");
Print( str );

>> 'Hello Test orld'

See also: string.Set, warnings, for, handling, existing, mods, in, Retail

Parses string into array of tokens returns number of tokens

out tokens

array[] Parsed string in array

Returns: int Number of tokens

string token[2];
string str = "Hello World";
int result = str.ParseString(token);

for (int i = 0; i < 2; i++)
{
	Print(token[i]);
}

>> 'Hello'
>> 'World'

Parses one token from input string. Result is put into token string, and type of token is returned. Input string is left-truncated by the resulting token length.

out token

string Founded string token

Returns: int Type of token \verbatim Token types: 0 - error, no token 1 - defined token (special characters etc. . / * ) 2 - quoted string. Quotes are removed -> TODO 3 - alphabetic string 4 - number 5 - end of line -> TODO \endverbatim

string input = "Hello*World";
string token1;
string token2;

int result1 = input.ParseStringEx(token1);
int result2 = input.ParseStringEx(token2);

Print( "Token1 = '" + token1 + "' Type = " + result1.ToString() ) );
Print( "Token2 = '" + token2 + "' Type = " + result2.ToString() ) );

>> 'Toke1 = 'Hello' Type = 3'
>> 'Toke1 = '*' Type = 1'

Replace all occurrances of 'sample' in 'str' by 'replace'

sample

string to search in str

replace

string which replace sample in str

Returns: int - number of occurrances of 'sample' in 'str'

string test = "If the length of the C string in source is less than num, only the content up to the terminating null-character is copied.";
Print(test);
int count = test.Replace("the", "*");
Print(count);
Print(test);

>> string test = 'If the length of the C string in source is less than num, only the content up to the terminating null-character is copied.';
>> int count =   4
>> string test = 'If * length of * C string in source is less than num, only * content up to * terminating null-character is copied.'

Sets the n-th character in string with the input, replacing previous value

index

index to be replaced

input

single non-terminated character value to replace with

string str = "Hello World";
str[4] = "O";
Print( str );

>> 'HellO World'

string str = "Hello World";
str[6] = "Test ";
Print( str );

>> 'Hello Test orld'

Splits string into array of strings separated by 'sample'

sample

string Strings separator

Returns: TStringArray Array with strings

string example = "The quick brown fox jumps over the lazy dog";
TStringArray strs = new TStringArray;
example.Split(" ", strs);

for (int i = 0; i < strs.Count(); i++)
{
	Print(strs.Get(i));
}

>> 'The'
>> 'quick'
>> 'brown'
>> 'fox'
>> 'jumps'
>> 'over'
>> 'the'
>> 'lazy'
>> 'dog'

Substring of 'str' from 'start' position 'len' number of characters

start

Position in str

len

Count of characters

Returns: string - Substring of str

string str = "Hello World";
string strSub = str.Substring(2, 5);
Print(strSub);

>> strSub = llo W

Inverted SubString. This deletes everything in between position_start and position_end.

Substring of 'str' from 'startChar' position 'len' number of characters for UTF8 strings with multibyte chars

startChar

Position in str.

len

Count of characters

Returns: string - Substring of str with startChar character and len characters

string str = "こんにちは世界";
string strSub = str.SubstringUtf8(2, 4);
Print(strSub);

>> strSub = にちは世

Converts string's first character to ASCII code

str

String for convert to ASCII code

Returns: ascii code int.

int ascii = "M".ToAscii();
Print(ascii);

>> ascii = 77

Converts string to float

Returns: float - Converted string in float.

string str = "56.6";
float f = str.ToFloat();
Print(f);

>> f = 56.6

Converts string to integer

Returns: int - Converted string.

string str = "56";
int i = str.ToInt();
Print(i);

>> i = 56

Changes string to lowercase. Returns length

Returns: int - Length of changed string

string str = "Hello World";
int i = str.ToLower();
Print(str);
Print(i);

>> str = hello world
>> i = 11

Returns internal type representation. Can be used in runtime, or cached in variables and used for faster inheritance checking

Returns: typename Type of class

???

Changes string to uppercase. Returns length

Returns: int - Length of changed string

string str = "Hello World";
int i = str.ToUpper();
Print(str);
Print(i);

>> str = HELLO WORLD
>> i = 11

Returns a vector from a string

Returns: vector Converted s as vector

string str = "1 0 1";
vector v = str.ToVector();
Print(v);

>> v = <1,0,1>

Returns trimmed string with removed leading and trailing whitespaces

Returns: string - Trimmed string

string str = " Hello World "
Print( str );
Print( str.Trim() );

>> ' Hello World '
>> 'Hello World'

Removes leading and trailing whitespaces in string. Returns length

Returns: int - Count of chars

string str = " Hello World ";
int i = str.TrimInPlace();
Print(str);
Print(i);

>> str = 'Hello World'
>> i = 11