class_string

String

####Category: Built-In Types

Brief Description

Built-In string class.

Member Functions

String basename ( )
bool begins_with ( String text )
String capitalize ( )
int casecmp_to ( String to )
bool empty ( )
String extension ( )
int find ( String what, int from=0 )
int find_last ( String what )
int findn ( String what, int from=0 )
String get_base_dir ( )
String get_file ( )
int hash ( )
int hex_to_int ( )
String insert ( int pos, String what )
bool is_abs_path ( )
bool is_rel_path ( )
bool is_valid_float ( )
bool is_valid_html_color ( )
bool is_valid_identifier ( )
bool is_valid_integer ( )
bool is_valid_ip_address ( )
String left ( int pos )
int length ( )
bool match ( String expr )
bool matchn ( String expr )
int nocasecmp_to ( String to )
String ord_at ( int at )
String pad_decimals ( int digits )
String pad_zeros ( int digits )
String percent_decode ( )
String percent_encode ( )
String plus_file ( String file )
String replace ( String what, String forwhat )
String replacen ( String what, String forwhat )
int rfind ( String what, int from=-1 )
int rfindn ( String what, int from=-1 )
String right ( int pos )
StringArray split ( String divisor, bool allow_empty=True )
RealArray split_floats ( String divisor, bool allow_empty=True )
String strip_edges ( )
String substr ( int from, int len )
real to_float ( )
int to_int ( )
String to_lower ( )
String to_upper ( )
String xml_escape ( )
String xml_unescape ( )

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

basename

String basename ( )

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

begins_with

bool begins_with ( String text )

Return true if the strings begins with the given string.

capitalize

String capitalize ( )

Return the string in uppercase.

casecmp_to

int casecmp_to ( String to )

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

empty

bool empty ( )

Return true if the string is empty.

extension

String extension ( )

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

find

int find ( String what, int from=0 )

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_last

int find_last ( String what )

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.

findn

int findn ( String what, int from=0 )

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.