String

returns the position of the char in the charset therefore converting a single char into an int that can be converted back to a char with .toCharsetString()

Source on GitHub

Classes

StringIterator

public class StringIterator

Members:

• construct(string s, int currentpos, int stringLen)
• hasNext() returns boolean
• next() returns string
• close()

StringLines

public class StringLines

Members:

• construct(string s, int lastIndex, int lineCount)
• iterator() returns thistype ⚠️ Deprecated. class deprecated
• hasNext() returns boolean ⚠️ Deprecated. class deprecated
• next() returns string ⚠️ Deprecated. class deprecated
• close() ⚠️ Deprecated. class deprecated

Functions

stringCompare

public function stringCompare(string s1, string s2) returns int

Returns an integer result based on a lexicographic string comparison of strings s1 and s2.

Extension Functions

string.isNotBlank

public function string.isNotBlank() returns boolean

Returns true if this string is non-null and not empty or only consisting of whitespace.

string.toCharsetInt

public function string.toCharsetInt() returns int

string.toReal

public function string.toReal() returns real

Creates a real from a string that only contains numbers (0-9) and a sign

string.toInt

public function string.toInt() returns int

Creates an int from a string that only contains numbers (0-9) and a sign

int.toCharsetString

public function int.toCharsetString() returns string

Converts an int to the representative char

string.substring

public function string.substring(int start, int stop) returns string

returns a substring specified by end and start position.

string.substring

public function string.substring(int start) returns string

returns a substring specified by end and start position.

string.length

public function string.length() returns int

Length of the string

string.charAt

public function string.charAt(int index) returns string

Returns the char at the given position. 0 = first char

string.toAbilityId

public function string.toAbilityId() returns int

Converts a string to an ability id

string.endsWith

public function string.endsWith(string s) returns boolean

Returns if the given string ends with the specified string.

string.startsWith

public function string.startsWith(string s) returns boolean

Returns if the given string starts with the specified string.

string.toLowerCase

public function string.toLowerCase() returns string

Returns the string in lowercase letters

string.toUpperCase

public function string.toUpperCase() returns string

Returns the string in uppercase letters

string.isUpper

public function string.isUpper() returns boolean

True when string contains only uppercase letters

string.isLower

public function string.isLower() returns boolean

True when string contains only lowercase letters

string.trim

public function string.trim() returns string

Returns the given string with whitespaces removed from both ends

string.ltrim

public function string.ltrim() returns string

Returns the given string with whitespaces removed from the left end

string.rtrim

public function string.rtrim() returns string

Returns the given string with whitespaces removed from the right end

string.ltrim

public function string.ltrim(string val) returns string

Removes a string from the beginning of another string

string.rtrim

public function string.rtrim(string val) returns string

Removes a string from the end of another string

string.trim

public function string.trim(string val) returns string

Removes a string from both ends of another string

string.indexOf

public function string.indexOf(string s) returns int

Returns the index of the specified string inside the given string. If the string does not exist, the returnvalue is -1

string.indexOf

public function string.indexOf(string s, int startpos) returns int

Returns the index of the specified string inside the given string, starting the search at given startposition. If the string does not exist, the returnvalue is -1

string.lastIndexOf

public function string.lastIndexOf(string s) returns int

Returns the last index of the specified string inside the given string, If the string does not exist, the returnvalue is -1

string.countOccurences

public function string.countOccurences(string findStr) returns int

Returns the occurences of a certain string within a string

string.contains

public function string.contains(string s) returns boolean

True if the string contains the given string

string.isWhitespace

public function string.isWhitespace() returns boolean

Returns if the given string is a whitespace (“ “,\n,\t,\r)

string.firstUpper

public function string.firstUpper() returns string

Returns a new string with first letter is upper

string.firstLower

public function string.firstLower() returns string

Returns a new string with first letter is lower

string.replace

public function string.replace(string oldSubstring, string newSubstring) returns string

Returns a new string in which all occurrences of a specified string in the current instance are replaced with another specified string

string.getHash

public function string.getHash() returns int

string.format

public function string.format(vararg string replacements) returns string

Formats the given string replacing {x} delimiters with the passed replacements. Example: “You got {0} gold”.format(goldAmount) *

string.iterator

public function string.iterator() returns StringIterator

string.toLines

public function string.toLines() returns StringLines

Constants

ENABLE_MULTIBYTE_SUPPORT

public constant ENABLE_MULTIBYTE_SUPPORT = false

🔧 Configurable. Override it in your map’s config package.