Strings - NEAT Portal Wiki

The following can be used to manipulate and retrieve string details from variables.

These should be written in the following format: varname.method(arguments), e.g. myVar.subStr(3,2) if your variable name was "myVar" and you wanted to use the subStr function to find the 2 characters that begin 3 from the left.

Using the table below, you could for example find out the 4th letter of the variable named var that has stored the word "hello" like so:

// Don't forget almost all internal "counting" starts at 0, not at 1...
// so the 5th character would actually be 0, 1, 2, 3, '''4''' <--- 4! 
var="hello"
echo "The 5th letter in the word hello is: " + var.charAt(4)

Result:
01:25:34 The 5th letter in the word hello is: o
01:25:35 Script stopped

Methods

Method	Type	Example	Description
charAt	String	var="hello" echo "The 5th letter in the word hello is: " + var.charAt(4)	Returns the character in the position specified by the index parameter. In this example, returns "o".
charCodeAt	Number	var="hello" echo "The char code for the 5th letter in the word hello is: " + var.charAt(4)	Returns the numeric Unicode character code of the character at the specified index. In this example, returns "111" which is the numeric code for "o"
concat	String	var="oompa" var2="loompa" var3="dance" echo var.concat(var2," ",var3)	Appends the supplied arguments to the end of the String object, converting them to strings if necessary, and returns the resulting string. In this example, returns "oompaloompa dance".
fromCharCode	String		Returns a string comprising the characters represented by the Unicode character codes in the parameters.
indexOf	int		Searches the string and returns the position of the first occurrence of val found at or after startIndex within the calling string.
lastIndexOf	int		Searches the string from right to left and returns the index of the last occurrence of val found before startIndex.
localeCompare	int		Compares the sort order of two or more strings and returns the result of the comparison as an integer.
match	Array		Matches the specifed pattern against the string.
replace	String		Matches the specifed pattern against the string and returns a new string in which the first match of pattern is replaced with the content specified by repl.
search	int		Searches for the specifed pattern and returns the index of the first matching substring.
slice	String		Returns a string that includes the startIndex character and all characters up to, but not including, the endIndex character.
split	Array	mycoords=city.coords.split(",") echo "x:" + mycoords[0] + " y:" + mycoords[1]	Splits a String object into an array of substrings by dividing it wherever the specified delimiter parameter occurs.
substr	String		Returns a substring consisting of the characters that start at the specified startIndex and with a length specified by len.
substring	String		Returns a string consisting of the character specified by startIndex and all characters up to endIndex - 1.
toLocaleLowerCase	String		Returns a copy of this string, with all uppercase characters converted to lowercase.
toLocaleUpperCase	String		Returns a copy of this string, with all lowercase characters converted to uppercase.
toLowerCase	String		Returns a copy of this string, with all uppercase characters converted to lowercase.
toUpperCase	String		Returns a copy of this string, with all lowercase characters converted to uppercase.
valueOf	String		Returns the primitive value of a String instance.

ScriptVariables