Skip to content
reduz edited this page Oct 15, 2014 · 11 revisions

String

####Category: Built-In Types

Brief Description

Built-In string class.

Member Functions

Description

This is the built in string class (and the one used by GDScript). It supports Unicode and provides all necesary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources.

Member Function Description

If the string is a path to a file, return the path to the file without the extension.

Return true if the strings begins with the given string.

Return the string in uppercase.

Perform a case-sensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater.

Return true if the string is empty.

If the string is a path to a file, return the extension.

Find the first occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.

Find the last occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.

Find the first occurence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed.

If the string is a path to a file, return the base directory.

If the string is a path to a file, return the file and ignore the base directory.

Hash the string and return a 32 bits integer.

Insert a substring at a given position.

  • bool is_abs_path ( )

If the string is a path to a file or directory, return true if the path is absolute.

  • bool is_rel_path ( )

If the string is a path to a file or directory, return true if the path is relative.

Return an amount of characters from the left of the string.

  • int length ( )

Return the length of the string in characters.

Do a simple expression matching, using ? and * wildcards.

Do a simple, case insensitive, expression matching, using ? and * wildcards.

Perform a case-insensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater.

Replace occurrences of a substring for different ones inside the string.

Replace occurrences of a substring for different ones inside the string, but search case-insensitive.

Perform a search for a substring, but start from the end of the string instead of the begining.

Perform a search for a substring, but start from the end of the string instead of the begining. Also search case-insensitive.

Return the right side of the string from a given position.

Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",".

Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",".

Return a copy of the string stripped of any non-printable character at the begining and the end.

Return the string converted to lowercase.

Return the string converted to uppercase.

Perform XML escaping on the string.

Perform XML un-escaping of the string.

Clone this wiki locally