godot-docs/classes/class_string.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the String.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_String:

String
======

Built-in string class.

Description
-----------

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

Tutorials
---------

- :doc:`../getting_started/scripting/gdscript/gdscript_format_string`

Methods
-------

+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`bool<class_bool>` from **)**                                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`int<class_int>` from **)**                                                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`float<class_float>` from **)**                                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Vector2<class_Vector2>` from **)**                                                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Rect2<class_Rect2>` from **)**                                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Vector3<class_Vector3>` from **)**                                                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Transform2D<class_Transform2D>` from **)**                                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Plane<class_Plane>` from **)**                                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Quat<class_Quat>` from **)**                                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`AABB<class_AABB>` from **)**                                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Basis<class_Basis>` from **)**                                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Transform<class_Transform>` from **)**                                                                            |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Color<class_Color>` from **)**                                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`NodePath<class_NodePath>` from **)**                                                                              |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`RID<class_RID>` from **)**                                                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Dictionary<class_Dictionary>` from **)**                                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`Array<class_Array>` from **)**                                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)**                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)**                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)**                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)**                                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)**                                                              |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)**                                                              |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`String<class_String_method_String>` **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)**                                                                  |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`begins_with<class_String_method_begins_with>` **(** :ref:`String<class_String>` text **)**                                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`bigrams<class_String_method_bigrams>` **(** **)**                                                                                                                 |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`c_escape<class_String_method_c_escape>` **(** **)**                                                                                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`c_unescape<class_String_method_c_unescape>` **(** **)**                                                                                                           |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`capitalize<class_String_method_capitalize>` **(** **)**                                                                                                           |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`casecmp_to<class_String_method_casecmp_to>` **(** :ref:`String<class_String>` to **)**                                                                            |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`count<class_String_method_count>` **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=0, :ref:`int<class_int>` to=0 **)**                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`countn<class_String_method_countn>` **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=0, :ref:`int<class_int>` to=0 **)**                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`dedent<class_String_method_dedent>` **(** **)**                                                                                                                   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`empty<class_String_method_empty>` **(** **)**                                                                                                                     |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`ends_with<class_String_method_ends_with>` **(** :ref:`String<class_String>` text **)**                                                                            |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                          | :ref:`erase<class_String_method_erase>` **(** :ref:`int<class_int>` position, :ref:`int<class_int>` chars **)**                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`find<class_String_method_find>` **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=0 **)**                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`find_last<class_String_method_find_last>` **(** :ref:`String<class_String>` what **)**                                                                            |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`findn<class_String_method_findn>` **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=0 **)**                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`format<class_String_method_format>` **(** :ref:`Variant<class_Variant>` values, :ref:`String<class_String>` placeholder="{_}" **)**                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`get_base_dir<class_String_method_get_base_dir>` **(** **)**                                                                                                       |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`get_basename<class_String_method_get_basename>` **(** **)**                                                                                                       |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`get_extension<class_String_method_get_extension>` **(** **)**                                                                                                     |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`get_file<class_String_method_get_file>` **(** **)**                                                                                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`hash<class_String_method_hash>` **(** **)**                                                                                                                       |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`hex_to_int<class_String_method_hex_to_int>` **(** **)**                                                                                                           |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`http_escape<class_String_method_http_escape>` **(** **)**                                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`http_unescape<class_String_method_http_unescape>` **(** **)**                                                                                                     |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`humanize_size<class_String_method_humanize_size>` **(** :ref:`int<class_int>` size **)**                                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`insert<class_String_method_insert>` **(** :ref:`int<class_int>` position, :ref:`String<class_String>` what **)**                                                  |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_abs_path<class_String_method_is_abs_path>` **(** **)**                                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_rel_path<class_String_method_is_rel_path>` **(** **)**                                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_subsequence_of<class_String_method_is_subsequence_of>` **(** :ref:`String<class_String>` text **)**                                                            |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_subsequence_ofi<class_String_method_is_subsequence_ofi>` **(** :ref:`String<class_String>` text **)**                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_valid_filename<class_String_method_is_valid_filename>` **(** **)**                                                                                             |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_valid_float<class_String_method_is_valid_float>` **(** **)**                                                                                                   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_valid_hex_number<class_String_method_is_valid_hex_number>` **(** :ref:`bool<class_bool>` with_prefix=false **)**                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_valid_html_color<class_String_method_is_valid_html_color>` **(** **)**                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_valid_identifier<class_String_method_is_valid_identifier>` **(** **)**                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_valid_integer<class_String_method_is_valid_integer>` **(** **)**                                                                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`is_valid_ip_address<class_String_method_is_valid_ip_address>` **(** **)**                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`json_escape<class_String_method_json_escape>` **(** **)**                                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`left<class_String_method_left>` **(** :ref:`int<class_int>` position **)**                                                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`length<class_String_method_length>` **(** **)**                                                                                                                   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`lstrip<class_String_method_lstrip>` **(** :ref:`String<class_String>` chars **)**                                                                                 |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`match<class_String_method_match>` **(** :ref:`String<class_String>` expr **)**                                                                                    |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                       | :ref:`matchn<class_String_method_matchn>` **(** :ref:`String<class_String>` expr **)**                                                                                  |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>`     | :ref:`md5_buffer<class_String_method_md5_buffer>` **(** **)**                                                                                                           |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`md5_text<class_String_method_md5_text>` **(** **)**                                                                                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`nocasecmp_to<class_String_method_nocasecmp_to>` **(** :ref:`String<class_String>` to **)**                                                                        |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`ord_at<class_String_method_ord_at>` **(** :ref:`int<class_int>` at **)**                                                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`pad_decimals<class_String_method_pad_decimals>` **(** :ref:`int<class_int>` digits **)**                                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`pad_zeros<class_String_method_pad_zeros>` **(** :ref:`int<class_int>` digits **)**                                                                                |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`percent_decode<class_String_method_percent_decode>` **(** **)**                                                                                                   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`percent_encode<class_String_method_percent_encode>` **(** **)**                                                                                                   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`plus_file<class_String_method_plus_file>` **(** :ref:`String<class_String>` file **)**                                                                            |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`repeat<class_String_method_repeat>` **(** :ref:`int<class_int>` count **)**                                                                                       |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`replace<class_String_method_replace>` **(** :ref:`String<class_String>` what, :ref:`String<class_String>` forwhat **)**                                           |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`replacen<class_String_method_replacen>` **(** :ref:`String<class_String>` what, :ref:`String<class_String>` forwhat **)**                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`rfind<class_String_method_rfind>` **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=-1 **)**                                                     |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`rfindn<class_String_method_rfindn>` **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=-1 **)**                                                   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`right<class_String_method_right>` **(** :ref:`int<class_int>` position **)**                                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`rsplit<class_String_method_rsplit>` **(** :ref:`String<class_String>` delimiter, :ref:`bool<class_bool>` allow_empty=true, :ref:`int<class_int>` maxsplit=0 **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`rstrip<class_String_method_rstrip>` **(** :ref:`String<class_String>` chars **)**                                                                                 |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>`     | :ref:`sha1_buffer<class_String_method_sha1_buffer>` **(** **)**                                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`sha1_text<class_String_method_sha1_text>` **(** **)**                                                                                                             |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>`     | :ref:`sha256_buffer<class_String_method_sha256_buffer>` **(** **)**                                                                                                     |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`sha256_text<class_String_method_sha256_text>` **(** **)**                                                                                                         |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`similarity<class_String_method_similarity>` **(** :ref:`String<class_String>` text **)**                                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`split<class_String_method_split>` **(** :ref:`String<class_String>` delimiter, :ref:`bool<class_bool>` allow_empty=true, :ref:`int<class_int>` maxsplit=0 **)**   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolRealArray<class_PoolRealArray>`     | :ref:`split_floats<class_String_method_split_floats>` **(** :ref:`String<class_String>` delimiter, :ref:`bool<class_bool>` allow_empty=true **)**                       |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`strip_edges<class_String_method_strip_edges>` **(** :ref:`bool<class_bool>` left=true, :ref:`bool<class_bool>` right=true **)**                                   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`strip_escapes<class_String_method_strip_escapes>` **(** **)**                                                                                                     |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`substr<class_String_method_substr>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` len=-1 **)**                                                          |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>`     | :ref:`to_ascii<class_String_method_to_ascii>` **(** **)**                                                                                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                     | :ref:`to_float<class_String_method_to_float>` **(** **)**                                                                                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                         | :ref:`to_int<class_String_method_to_int>` **(** **)**                                                                                                                   |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`to_lower<class_String_method_to_lower>` **(** **)**                                                                                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`to_upper<class_String_method_to_upper>` **(** **)**                                                                                                               |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>`     | :ref:`to_utf8<class_String_method_to_utf8>` **(** **)**                                                                                                                 |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`trim_prefix<class_String_method_trim_prefix>` **(** :ref:`String<class_String>` prefix **)**                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`trim_suffix<class_String_method_trim_suffix>` **(** :ref:`String<class_String>` suffix **)**                                                                      |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`xml_escape<class_String_method_xml_escape>` **(** **)**                                                                                                           |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`                   | :ref:`xml_unescape<class_String_method_xml_unescape>` **(** **)**                                                                                                       |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Method Descriptions
-------------------

.. _class_String_method_String:

- :ref:`String<class_String>` **String** **(** :ref:`bool<class_bool>` from **)**

Constructs a new String from the given :ref:`bool<class_bool>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`int<class_int>` from **)**

Constructs a new String from the given :ref:`int<class_int>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`float<class_float>` from **)**

Constructs a new String from the given :ref:`float<class_float>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Vector2<class_Vector2>` from **)**

Constructs a new String from the given :ref:`Vector2<class_Vector2>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Rect2<class_Rect2>` from **)**

Constructs a new String from the given :ref:`Rect2<class_Rect2>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Vector3<class_Vector3>` from **)**

Constructs a new String from the given :ref:`Vector3<class_Vector3>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Transform2D<class_Transform2D>` from **)**

Constructs a new String from the given :ref:`Transform2D<class_Transform2D>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Plane<class_Plane>` from **)**

Constructs a new String from the given :ref:`Plane<class_Plane>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Quat<class_Quat>` from **)**

Constructs a new String from the given :ref:`Quat<class_Quat>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`AABB<class_AABB>` from **)**

Constructs a new String from the given :ref:`AABB<class_AABB>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Basis<class_Basis>` from **)**

Constructs a new String from the given :ref:`Basis<class_Basis>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Transform<class_Transform>` from **)**

Constructs a new String from the given :ref:`Transform<class_Transform>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Color<class_Color>` from **)**

Constructs a new String from the given :ref:`Color<class_Color>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`NodePath<class_NodePath>` from **)**

Constructs a new String from the given :ref:`NodePath<class_NodePath>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`RID<class_RID>` from **)**

Constructs a new String from the given :ref:`RID<class_RID>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Dictionary<class_Dictionary>` from **)**

Constructs a new String from the given :ref:`Dictionary<class_Dictionary>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`Array<class_Array>` from **)**

Constructs a new String from the given :ref:`Array<class_Array>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`PoolByteArray<class_PoolByteArray>` from **)**

Constructs a new String from the given :ref:`PoolByteArray<class_PoolByteArray>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`PoolIntArray<class_PoolIntArray>` from **)**

Constructs a new String from the given :ref:`PoolIntArray<class_PoolIntArray>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`PoolRealArray<class_PoolRealArray>` from **)**

Constructs a new String from the given :ref:`PoolRealArray<class_PoolRealArray>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`PoolStringArray<class_PoolStringArray>` from **)**

Constructs a new String from the given :ref:`PoolStringArray<class_PoolStringArray>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`PoolVector2Array<class_PoolVector2Array>` from **)**

Constructs a new String from the given :ref:`PoolVector2Array<class_PoolVector2Array>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` from **)**

Constructs a new String from the given :ref:`PoolVector3Array<class_PoolVector3Array>`.

----

- :ref:`String<class_String>` **String** **(** :ref:`PoolColorArray<class_PoolColorArray>` from **)**

Constructs a new String from the given :ref:`PoolColorArray<class_PoolColorArray>`.

----

.. _class_String_method_begins_with:

- :ref:`bool<class_bool>` **begins_with** **(** :ref:`String<class_String>` text **)**

Returns ``true`` if the string begins with the given string.

----

.. _class_String_method_bigrams:

- :ref:`PoolStringArray<class_PoolStringArray>` **bigrams** **(** **)**

Returns the bigrams (pairs of consecutive letters) of this string.

----

.. _class_String_method_c_escape:

- :ref:`String<class_String>` **c_escape** **(** **)**

Returns a copy of the string with special characters escaped using the C language standard.

----

.. _class_String_method_c_unescape:

- :ref:`String<class_String>` **c_unescape** **(** **)**

Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are ``\'``, ``\"``, ``\?``, ``\\``, ``\a``, ``\b``, ``\f``, ``\n``, ``\r``, ``\t``, ``\v``.

**Note:** Unlike the GDScript parser, this method doesn't support the ``\uXXXX`` escape sequence.

----

.. _class_String_method_capitalize:

- :ref:`String<class_String>` **capitalize** **(** **)**

Changes the case of some letters. Replaces underscores with spaces, adds spaces before in-word uppercase characters, converts all letters to lowercase, then capitalizes the first letter and every letter following a space character. For ``capitalize camelCase mixed_with_underscores``, it will return ``Capitalize Camel Case Mixed With Underscores``.

----

.. _class_String_method_casecmp_to:

- :ref:`int<class_int>` **casecmp_to** **(** :ref:`String<class_String>` to **)**

Performs a case-sensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal.

----

.. _class_String_method_count:

- :ref:`int<class_int>` **count** **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=0, :ref:`int<class_int>` to=0 **)**

Returns the number of occurrences of substring ``what`` between ``from`` and ``to`` positions. If ``from`` and ``to`` equals 0 the whole string will be used. If only ``to`` equals 0 the remained substring will be used.

----

.. _class_String_method_countn:

- :ref:`int<class_int>` **countn** **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=0, :ref:`int<class_int>` to=0 **)**

Returns the number of occurrences of substring ``what`` (ignoring case) between ``from`` and ``to`` positions. If ``from`` and ``to`` equals 0 the whole string will be used. If only ``to`` equals 0 the remained substring will be used.

----

.. _class_String_method_dedent:

- :ref:`String<class_String>` **dedent** **(** **)**

Returns a copy of the string with indentation (leading tabs and spaces) removed.

----

.. _class_String_method_empty:

- :ref:`bool<class_bool>` **empty** **(** **)**

Returns ``true`` if the length of the string equals ``0``.

----

.. _class_String_method_ends_with:

- :ref:`bool<class_bool>` **ends_with** **(** :ref:`String<class_String>` text **)**

Returns ``true`` if the string ends with the given string.

----

.. _class_String_method_erase:

- void **erase** **(** :ref:`int<class_int>` position, :ref:`int<class_int>` chars **)**

Erases ``chars`` characters from the string starting from ``position``.

----

.. _class_String_method_find:

- :ref:`int<class_int>` **find** **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=0 **)**

Finds the first occurrence of a substring. Returns the starting position of the substring or ``-1`` if not found. Optionally, the initial search index can be passed.

**Note:** If you just want to know whether a string contains a substring, use the ``in`` operator as follows:

::

    # Will evaluate to `false`.
    if "i" in "team":
        pass

----

.. _class_String_method_find_last:

- :ref:`int<class_int>` **find_last** **(** :ref:`String<class_String>` what **)**

Finds the last occurrence of a substring. Returns the starting position of the substring or ``-1`` if not found.

----

.. _class_String_method_findn:

- :ref:`int<class_int>` **findn** **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=0 **)**

Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or ``-1`` if not found. Optionally, the initial search index can be passed.

----

.. _class_String_method_format:

- :ref:`String<class_String>` **format** **(** :ref:`Variant<class_Variant>` values, :ref:`String<class_String>` placeholder="{_}" **)**

Formats the string by replacing all occurrences of ``placeholder`` with ``values``.

----

.. _class_String_method_get_base_dir:

- :ref:`String<class_String>` **get_base_dir** **(** **)**

If the string is a valid file path, returns the base directory name.

----

.. _class_String_method_get_basename:

- :ref:`String<class_String>` **get_basename** **(** **)**

If the string is a valid file path, returns the full file path without the extension.

----

.. _class_String_method_get_extension:

- :ref:`String<class_String>` **get_extension** **(** **)**

If the string is a valid file path, returns the extension.

----

.. _class_String_method_get_file:

- :ref:`String<class_String>` **get_file** **(** **)**

If the string is a valid file path, returns the filename.

----

.. _class_String_method_hash:

- :ref:`int<class_int>` **hash** **(** **)**

Hashes the string and returns a 32-bit integer.

----

.. _class_String_method_hex_to_int:

- :ref:`int<class_int>` **hex_to_int** **(** **)**

Converts a string containing a hexadecimal number into an integer. Hexadecimal strings are expected to be prefixed with "``0x``" otherwise ``0`` is returned.

::

    print("0xff".hex_to_int()) # Print "255"

----

.. _class_String_method_http_escape:

- :ref:`String<class_String>` **http_escape** **(** **)**

Escapes (encodes) a string to URL friendly format. Also referred to as 'URL encode'.

::

    print("https://example.org/?escaped=" + "Godot Engine:'docs'".http_escape())

----

.. _class_String_method_http_unescape:

- :ref:`String<class_String>` **http_unescape** **(** **)**

Unescapes (decodes) a string in URL encoded format. Also referred to as 'URL decode'.

::

    print("https://example.org/?escaped=" + "Godot%20Engine%3A%27docs%27".http_unescape())

----

.. _class_String_method_humanize_size:

- :ref:`String<class_String>` **humanize_size** **(** :ref:`int<class_int>` size **)**

Converts ``size`` represented as number of bytes to human-readable format using internationalized set of data size units, namely: B, KiB, MiB, GiB, TiB, PiB, EiB. Note that the next smallest unit is picked automatically to hold at most 1024 units.

::

    var bytes = 133790307
    var size = String.humanize_size(bytes)
    print(size) # prints "127.5 MiB"

----

.. _class_String_method_insert:

- :ref:`String<class_String>` **insert** **(** :ref:`int<class_int>` position, :ref:`String<class_String>` what **)**

Returns a copy of the string with the substring ``what`` inserted at the given position.

----

.. _class_String_method_is_abs_path:

- :ref:`bool<class_bool>` **is_abs_path** **(** **)**

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

----

.. _class_String_method_is_rel_path:

- :ref:`bool<class_bool>` **is_rel_path** **(** **)**

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

----

.. _class_String_method_is_subsequence_of:

- :ref:`bool<class_bool>` **is_subsequence_of** **(** :ref:`String<class_String>` text **)**

Returns ``true`` if this string is a subsequence of the given string.

----

.. _class_String_method_is_subsequence_ofi:

- :ref:`bool<class_bool>` **is_subsequence_ofi** **(** :ref:`String<class_String>` text **)**

Returns ``true`` if this string is a subsequence of the given string, without considering case.

----

.. _class_String_method_is_valid_filename:

- :ref:`bool<class_bool>` **is_valid_filename** **(** **)**

Returns ``true`` if this string is free from characters that aren't allowed in file names, those being:

``: / \ ? * " | % < >``

----

.. _class_String_method_is_valid_float:

- :ref:`bool<class_bool>` **is_valid_float** **(** **)**

Returns ``true`` if this string contains a valid float.

----

.. _class_String_method_is_valid_hex_number:

- :ref:`bool<class_bool>` **is_valid_hex_number** **(** :ref:`bool<class_bool>` with_prefix=false **)**

Returns ``true`` if this string contains a valid hexadecimal number. If ``with_prefix`` is ``true``, then a validity of the hexadecimal number is determined by ``0x`` prefix, for instance: ``0xDEADC0DE``.

----

.. _class_String_method_is_valid_html_color:

- :ref:`bool<class_bool>` **is_valid_html_color** **(** **)**

Returns ``true`` if this string contains a valid color in hexadecimal HTML notation. Other HTML notations such as named colors or ``hsl()`` colors aren't considered valid by this method and will return ``false``.

----

.. _class_String_method_is_valid_identifier:

- :ref:`bool<class_bool>` **is_valid_identifier** **(** **)**

Returns ``true`` if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores (``_``) and the first character may not be a digit.

----

.. _class_String_method_is_valid_integer:

- :ref:`bool<class_bool>` **is_valid_integer** **(** **)**

Returns ``true`` if this string contains a valid integer.

----

.. _class_String_method_is_valid_ip_address:

- :ref:`bool<class_bool>` **is_valid_ip_address** **(** **)**

Returns ``true`` if this string contains a valid IP address.

----

.. _class_String_method_json_escape:

- :ref:`String<class_String>` **json_escape** **(** **)**

Returns a copy of the string with special characters escaped using the JSON standard.

----

.. _class_String_method_left:

- :ref:`String<class_String>` **left** **(** :ref:`int<class_int>` position **)**

Returns a number of characters from the left of the string.

----

.. _class_String_method_length:

- :ref:`int<class_int>` **length** **(** **)**

Returns the string's amount of characters.

----

.. _class_String_method_lstrip:

- :ref:`String<class_String>` **lstrip** **(** :ref:`String<class_String>` chars **)**

Returns a copy of the string with characters removed from the left.

----

.. _class_String_method_match:

- :ref:`bool<class_bool>` **match** **(** :ref:`String<class_String>` expr **)**

Does a simple case-sensitive expression match, where ``"*"`` matches zero or more arbitrary characters and ``"?"`` matches any single character except a period (``"."``).

----

.. _class_String_method_matchn:

- :ref:`bool<class_bool>` **matchn** **(** :ref:`String<class_String>` expr **)**

Does a simple case-insensitive expression match, where ``"*"`` matches zero or more arbitrary characters and ``"?"`` matches any single character except a period (``"."``).

----

.. _class_String_method_md5_buffer:

- :ref:`PoolByteArray<class_PoolByteArray>` **md5_buffer** **(** **)**

Returns the MD5 hash of the string as an array of bytes.

----

.. _class_String_method_md5_text:

- :ref:`String<class_String>` **md5_text** **(** **)**

Returns the MD5 hash of the string as a string.

----

.. _class_String_method_nocasecmp_to:

- :ref:`int<class_int>` **nocasecmp_to** **(** :ref:`String<class_String>` to **)**

Performs a case-insensitive comparison to another string. Returns ``-1`` if less than, ``+1`` if greater than, or ``0`` if equal.

----

.. _class_String_method_ord_at:

- :ref:`int<class_int>` **ord_at** **(** :ref:`int<class_int>` at **)**

Returns the character code at position ``at``.

----

.. _class_String_method_pad_decimals:

- :ref:`String<class_String>` **pad_decimals** **(** :ref:`int<class_int>` digits **)**

Formats a number to have an exact number of ``digits`` after the decimal point.

----

.. _class_String_method_pad_zeros:

- :ref:`String<class_String>` **pad_zeros** **(** :ref:`int<class_int>` digits **)**

Formats a number to have an exact number of ``digits`` before the decimal point.

----

.. _class_String_method_percent_decode:

- :ref:`String<class_String>` **percent_decode** **(** **)**

Decode a percent-encoded string. See :ref:`percent_encode<class_String_method_percent_encode>`.

----

.. _class_String_method_percent_encode:

- :ref:`String<class_String>` **percent_encode** **(** **)**

Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests).

----

.. _class_String_method_plus_file:

- :ref:`String<class_String>` **plus_file** **(** :ref:`String<class_String>` file **)**

If the string is a path, this concatenates ``file`` at the end of the string as a subpath. E.g. ``"this/is".plus_file("path") == "this/is/path"``.

----

.. _class_String_method_repeat:

- :ref:`String<class_String>` **repeat** **(** :ref:`int<class_int>` count **)**

Returns original string repeated a number of times. The number of repetitions is given by the argument.

----

.. _class_String_method_replace:

- :ref:`String<class_String>` **replace** **(** :ref:`String<class_String>` what, :ref:`String<class_String>` forwhat **)**

Replaces occurrences of a case-sensitive substring with the given one inside the string.

----

.. _class_String_method_replacen:

- :ref:`String<class_String>` **replacen** **(** :ref:`String<class_String>` what, :ref:`String<class_String>` forwhat **)**

Replaces occurrences of a case-insensitive substring with the given one inside the string.

----

.. _class_String_method_rfind:

- :ref:`int<class_int>` **rfind** **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=-1 **)**

Performs a case-sensitive search for a substring, but starts from the end of the string instead of the beginning.

----

.. _class_String_method_rfindn:

- :ref:`int<class_int>` **rfindn** **(** :ref:`String<class_String>` what, :ref:`int<class_int>` from=-1 **)**

Performs a case-insensitive search for a substring, but starts from the end of the string instead of the beginning.

----

.. _class_String_method_right:

- :ref:`String<class_String>` **right** **(** :ref:`int<class_int>` position **)**

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

----

.. _class_String_method_rsplit:

- :ref:`PoolStringArray<class_PoolStringArray>` **rsplit** **(** :ref:`String<class_String>` delimiter, :ref:`bool<class_bool>` allow_empty=true, :ref:`int<class_int>` maxsplit=0 **)**

Splits the string by a ``delimiter`` string and returns an array of the substrings, starting from right.

The splits in the returned array are sorted in the same order as the original string, from left to right.

If ``maxsplit`` is specified, it defines the number of splits to do from the right up to ``maxsplit``. The default value of 0 means that all items are split, thus giving the same result as :ref:`split<class_String_method_split>`.

Example:

::

    var some_string = "One,Two,Three,Four"
    var some_array = some_string.rsplit(",", true, 1)
    print(some_array.size()) # Prints 2
    print(some_array[0]) # Prints "Four"
    print(some_array[1]) # Prints "Three,Two,One"

----

.. _class_String_method_rstrip:

- :ref:`String<class_String>` **rstrip** **(** :ref:`String<class_String>` chars **)**

Returns a copy of the string with characters removed from the right.

----

.. _class_String_method_sha1_buffer:

- :ref:`PoolByteArray<class_PoolByteArray>` **sha1_buffer** **(** **)**

Returns the SHA-1 hash of the string as an array of bytes.

----

.. _class_String_method_sha1_text:

- :ref:`String<class_String>` **sha1_text** **(** **)**

Returns the SHA-1 hash of the string as a string.

----

.. _class_String_method_sha256_buffer:

- :ref:`PoolByteArray<class_PoolByteArray>` **sha256_buffer** **(** **)**

Returns the SHA-256 hash of the string as an array of bytes.

----

.. _class_String_method_sha256_text:

- :ref:`String<class_String>` **sha256_text** **(** **)**

Returns the SHA-256 hash of the string as a string.

----

.. _class_String_method_similarity:

- :ref:`float<class_float>` **similarity** **(** :ref:`String<class_String>` text **)**

Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.

----

.. _class_String_method_split:

- :ref:`PoolStringArray<class_PoolStringArray>` **split** **(** :ref:`String<class_String>` delimiter, :ref:`bool<class_bool>` allow_empty=true, :ref:`int<class_int>` maxsplit=0 **)**

Splits the string by a ``delimiter`` string and returns an array of the substrings. The ``delimiter`` can be of any length.

If ``maxsplit`` is specified, it defines the number of splits to do from the left up to ``maxsplit``. The default value of ``0`` means that all items are split.

Example:

::

    var some_string = "One,Two,Three,Four"
    var some_array = some_string.split(",", true, 1)
    print(some_array.size()) # Prints 2
    print(some_array[0]) # Prints "One"
    print(some_array[1]) # Prints "Two,Three,Four"

If you need to split strings with more complex rules, use the :ref:`RegEx<class_RegEx>` class instead.

----

.. _class_String_method_split_floats:

- :ref:`PoolRealArray<class_PoolRealArray>` **split_floats** **(** :ref:`String<class_String>` delimiter, :ref:`bool<class_bool>` allow_empty=true **)**

Splits the string in floats by using a delimiter string and returns an array of the substrings.

For example, ``"1,2.5,3"`` will return ``[1,2.5,3]`` if split by ``","``.

----

.. _class_String_method_strip_edges:

- :ref:`String<class_String>` **strip_edges** **(** :ref:`bool<class_bool>` left=true, :ref:`bool<class_bool>` right=true **)**

Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.

----

.. _class_String_method_strip_escapes:

- :ref:`String<class_String>` **strip_escapes** **(** **)**

Returns a copy of the string stripped of any escape character. These include all non-printable control characters of the first page of the ASCII table (< 32), such as tabulation (``\t`` in C) and newline (``\n`` and ``\r``) characters, but not spaces.

----

.. _class_String_method_substr:

- :ref:`String<class_String>` **substr** **(** :ref:`int<class_int>` from, :ref:`int<class_int>` len=-1 **)**

Returns part of the string from the position ``from`` with length ``len``. Argument ``len`` is optional and using ``-1`` will return remaining characters from given position.

----

.. _class_String_method_to_ascii:

- :ref:`PoolByteArray<class_PoolByteArray>` **to_ascii** **(** **)**

Converts the String (which is a character array) to :ref:`PoolByteArray<class_PoolByteArray>` (which is an array of bytes). The conversion is faster compared to :ref:`to_utf8<class_String_method_to_utf8>`, as this method assumes that all the characters in the String are ASCII characters.

----

.. _class_String_method_to_float:

- :ref:`float<class_float>` **to_float** **(** **)**

Converts a string containing a decimal number into a ``float``.

----

.. _class_String_method_to_int:

- :ref:`int<class_int>` **to_int** **(** **)**

Converts a string containing an integer number into an ``int``.

----

.. _class_String_method_to_lower:

- :ref:`String<class_String>` **to_lower** **(** **)**

Returns the string converted to lowercase.

----

.. _class_String_method_to_upper:

- :ref:`String<class_String>` **to_upper** **(** **)**

Returns the string converted to uppercase.

----

.. _class_String_method_to_utf8:

- :ref:`PoolByteArray<class_PoolByteArray>` **to_utf8** **(** **)**

Converts the String (which is an array of characters) to :ref:`PoolByteArray<class_PoolByteArray>` (which is an array of bytes). The conversion is a bit slower than :ref:`to_ascii<class_String_method_to_ascii>`, but supports all UTF-8 characters. Therefore, you should prefer this function over :ref:`to_ascii<class_String_method_to_ascii>`.

----

.. _class_String_method_trim_prefix:

- :ref:`String<class_String>` **trim_prefix** **(** :ref:`String<class_String>` prefix **)**

Removes a given string from the start if it starts with it or leaves the string unchanged.

----

.. _class_String_method_trim_suffix:

- :ref:`String<class_String>` **trim_suffix** **(** :ref:`String<class_String>` suffix **)**

Removes a given string from the end if it ends with it or leaves the string unchanged.

----

.. _class_String_method_xml_escape:

- :ref:`String<class_String>` **xml_escape** **(** **)**

Returns a copy of the string with special characters escaped using the XML standard.

----

.. _class_String_method_xml_unescape:

- :ref:`String<class_String>` **xml_unescape** **(** **)**

Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`