Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: ace47f729c
Branches Tags
godot-docs
/
classes
/
class_string.rst

class_string.rst 49 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the String.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_String:
    6. 

  6. 

  7. String
    8. 

  8. ======
    9. 

  9. 

  10. **Category:** Built-In Types
    11. 

  11. 

  12. Brief Description
    13. 

  13. -----------------
    14. 

  14. 

  15. Built-in string class.
    16. 

  16. 

  17. Member Functions
    18. 

  18. ----------------
    19. 

  19. 

  20. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    21. 

  21. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`bool<class_bool>` from  **)**                                                              |
    22. 

  22. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`int<class_int>` from  **)**                                                                |
    24. 

  24. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`float<class_float>` from  **)**                                                            |
    26. 

  26. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Vector2<class_vector2>` from  **)**                                                        |
    28. 

  28. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Rect2<class_rect2>` from  **)**                                                            |
    30. 

  30. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Vector3<class_vector3>` from  **)**                                                        |
    32. 

  32. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Transform2D<class_transform2d>` from  **)**                                                |
    34. 

  34. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Plane<class_plane>` from  **)**                                                            |
    36. 

  36. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Quat<class_quat>` from  **)**                                                              |
    38. 

  38. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Rect3<class_rect3>` from  **)**                                                            |
    40. 

  40. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Basis<class_basis>` from  **)**                                                            |
    42. 

  42. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Transform<class_transform>` from  **)**                                                    |
    44. 

  44. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Color<class_color>` from  **)**                                                            |
    46. 

  46. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`NodePath<class_nodepath>` from  **)**                                                      |
    48. 

  48. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`RID<class_rid>` from  **)**                                                                |
    50. 

  50. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Dictionary<class_dictionary>` from  **)**                                                  |
    52. 

  52. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`Array<class_array>` from  **)**                                                            |
    54. 

  54. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`PoolByteArray<class_poolbytearray>` from  **)**                                            |
    56. 

  56. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`PoolIntArray<class_poolintarray>` from  **)**                                              |
    58. 

  58. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`PoolRealArray<class_poolrealarray>` from  **)**                                            |
    60. 

  60. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    61. 

  61. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`PoolStringArray<class_poolstringarray>` from  **)**                                        |
    62. 

  62. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    63. 

  63. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`PoolVector2Array<class_poolvector2array>` from  **)**                                      |
    64. 

  64. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    65. 

  65. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`PoolVector3Array<class_poolvector3array>` from  **)**                                      |
    66. 

  66. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    67. 

  67. | :ref:`String<class_string>`                    | :ref:`String<class_String_String>`  **(** :ref:`PoolColorArray<class_poolcolorarray>` from  **)**                                          |
    68. 

  68. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    69. 

  69. | :ref:`bool<class_bool>`                        | :ref:`begins_with<class_String_begins_with>`  **(** :ref:`String<class_string>` text  **)**                                                |
    70. 

  70. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    71. 

  71. | :ref:`PoolStringArray<class_poolstringarray>`  | :ref:`bigrams<class_String_bigrams>`  **(** **)**                                                                                          |
    72. 

  72. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    73. 

  73. | :ref:`String<class_string>`                    | :ref:`c_escape<class_String_c_escape>`  **(** **)**                                                                                        |
    74. 

  74. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    75. 

  75. | :ref:`String<class_string>`                    | :ref:`c_unescape<class_String_c_unescape>`  **(** **)**                                                                                    |
    76. 

  76. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    77. 

  77. | :ref:`String<class_string>`                    | :ref:`capitalize<class_String_capitalize>`  **(** **)**                                                                                    |
    78. 

  78. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    79. 

  79. | :ref:`int<class_int>`                          | :ref:`casecmp_to<class_String_casecmp_to>`  **(** :ref:`String<class_string>` to  **)**                                                    |
    80. 

  80. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    81. 

  81. | :ref:`bool<class_bool>`                        | :ref:`empty<class_String_empty>`  **(** **)**                                                                                              |
    82. 

  82. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    83. 

  83. | :ref:`bool<class_bool>`                        | :ref:`ends_with<class_String_ends_with>`  **(** :ref:`String<class_string>` text  **)**                                                    |
    84. 

  84. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    85. 

  85. | void                                           | :ref:`erase<class_String_erase>`  **(** :ref:`int<class_int>` position, :ref:`int<class_int>` chars  **)**                                 |
    86. 

  86. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    87. 

  87. | :ref:`int<class_int>`                          | :ref:`find<class_String_find>`  **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=0  **)**                                |
    88. 

  88. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    89. 

  89. | :ref:`int<class_int>`                          | :ref:`find_last<class_String_find_last>`  **(** :ref:`String<class_string>` what  **)**                                                    |
    90. 

  90. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    91. 

  91. | :ref:`int<class_int>`                          | :ref:`findn<class_String_findn>`  **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=0  **)**                              |
    92. 

  92. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    93. 

  93. | :ref:`String<class_string>`                    | :ref:`format<class_String_format>`  **(** var values, :ref:`String<class_string>` placeholder={_}  **)**                                   |
    94. 

  94. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    95. 

  95. | :ref:`String<class_string>`                    | :ref:`get_base_dir<class_String_get_base_dir>`  **(** **)**                                                                                |
    96. 

  96. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    97. 

  97. | :ref:`String<class_string>`                    | :ref:`get_basename<class_String_get_basename>`  **(** **)**                                                                                |
    98. 

  98. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    99. 

  99. | :ref:`String<class_string>`                    | :ref:`get_extension<class_String_get_extension>`  **(** **)**                                                                              |
    100. 

  100. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    101. 

  101. | :ref:`String<class_string>`                    | :ref:`get_file<class_String_get_file>`  **(** **)**                                                                                        |
    102. 

  102. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    103. 

  103. | :ref:`int<class_int>`                          | :ref:`hash<class_String_hash>`  **(** **)**                                                                                                |
    104. 

  104. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    105. 

  105. | :ref:`int<class_int>`                          | :ref:`hex_to_int<class_String_hex_to_int>`  **(** **)**                                                                                    |
    106. 

  106. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    107. 

  107. | :ref:`String<class_string>`                    | :ref:`insert<class_String_insert>`  **(** :ref:`int<class_int>` position, :ref:`String<class_string>` what  **)**                          |
    108. 

  108. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    109. 

  109. | :ref:`bool<class_bool>`                        | :ref:`is_abs_path<class_String_is_abs_path>`  **(** **)**                                                                                  |
    110. 

  110. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    111. 

  111. | :ref:`bool<class_bool>`                        | :ref:`is_rel_path<class_String_is_rel_path>`  **(** **)**                                                                                  |
    112. 

  112. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    113. 

  113. | :ref:`bool<class_bool>`                        | :ref:`is_subsequence_of<class_String_is_subsequence_of>`  **(** :ref:`String<class_string>` text  **)**                                    |
    114. 

  114. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    115. 

  115. | :ref:`bool<class_bool>`                        | :ref:`is_subsequence_ofi<class_String_is_subsequence_ofi>`  **(** :ref:`String<class_string>` text  **)**                                  |
    116. 

  116. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    117. 

  117. | :ref:`bool<class_bool>`                        | :ref:`is_valid_float<class_String_is_valid_float>`  **(** **)**                                                                            |
    118. 

  118. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    119. 

  119. | :ref:`bool<class_bool>`                        | :ref:`is_valid_html_color<class_String_is_valid_html_color>`  **(** **)**                                                                  |
    120. 

  120. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    121. 

  121. | :ref:`bool<class_bool>`                        | :ref:`is_valid_identifier<class_String_is_valid_identifier>`  **(** **)**                                                                  |
    122. 

  122. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    123. 

  123. | :ref:`bool<class_bool>`                        | :ref:`is_valid_integer<class_String_is_valid_integer>`  **(** **)**                                                                        |
    124. 

  124. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    125. 

  125. | :ref:`bool<class_bool>`                        | :ref:`is_valid_ip_address<class_String_is_valid_ip_address>`  **(** **)**                                                                  |
    126. 

  126. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    127. 

  127. | :ref:`String<class_string>`                    | :ref:`json_escape<class_String_json_escape>`  **(** **)**                                                                                  |
    128. 

  128. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    129. 

  129. | :ref:`String<class_string>`                    | :ref:`left<class_String_left>`  **(** :ref:`int<class_int>` position  **)**                                                                |
    130. 

  130. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    131. 

  131. | :ref:`int<class_int>`                          | :ref:`length<class_String_length>`  **(** **)**                                                                                            |
    132. 

  132. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    133. 

  133. | :ref:`bool<class_bool>`                        | :ref:`match<class_String_match>`  **(** :ref:`String<class_string>` expr  **)**                                                            |
    134. 

  134. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    135. 

  135. | :ref:`bool<class_bool>`                        | :ref:`matchn<class_String_matchn>`  **(** :ref:`String<class_string>` expr  **)**                                                          |
    136. 

  136. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    137. 

  137. | :ref:`PoolByteArray<class_poolbytearray>`      | :ref:`md5_buffer<class_String_md5_buffer>`  **(** **)**                                                                                    |
    138. 

  138. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    139. 

  139. | :ref:`String<class_string>`                    | :ref:`md5_text<class_String_md5_text>`  **(** **)**                                                                                        |
    140. 

  140. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    141. 

  141. | :ref:`int<class_int>`                          | :ref:`nocasecmp_to<class_String_nocasecmp_to>`  **(** :ref:`String<class_string>` to  **)**                                                |
    142. 

  142. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    143. 

  143. | :ref:`int<class_int>`                          | :ref:`ord_at<class_String_ord_at>`  **(** :ref:`int<class_int>` at  **)**                                                                  |
    144. 

  144. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    145. 

  145. | :ref:`String<class_string>`                    | :ref:`pad_decimals<class_String_pad_decimals>`  **(** :ref:`int<class_int>` digits  **)**                                                  |
    146. 

  146. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    147. 

  147. | :ref:`String<class_string>`                    | :ref:`pad_zeros<class_String_pad_zeros>`  **(** :ref:`int<class_int>` digits  **)**                                                        |
    148. 

  148. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    149. 

  149. | :ref:`String<class_string>`                    | :ref:`percent_decode<class_String_percent_decode>`  **(** **)**                                                                            |
    150. 

  150. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    151. 

  151. | :ref:`String<class_string>`                    | :ref:`percent_encode<class_String_percent_encode>`  **(** **)**                                                                            |
    152. 

  152. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    153. 

  153. | :ref:`String<class_string>`                    | :ref:`plus_file<class_String_plus_file>`  **(** :ref:`String<class_string>` file  **)**                                                    |
    154. 

  154. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    155. 

  155. | :ref:`String<class_string>`                    | :ref:`replace<class_String_replace>`  **(** :ref:`String<class_string>` what, :ref:`String<class_string>` forwhat  **)**                   |
    156. 

  156. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    157. 

  157. | :ref:`String<class_string>`                    | :ref:`replacen<class_String_replacen>`  **(** :ref:`String<class_string>` what, :ref:`String<class_string>` forwhat  **)**                 |
    158. 

  158. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    159. 

  159. | :ref:`int<class_int>`                          | :ref:`rfind<class_String_rfind>`  **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=-1  **)**                             |
    160. 

  160. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    161. 

  161. | :ref:`int<class_int>`                          | :ref:`rfindn<class_String_rfindn>`  **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=-1  **)**                           |
    162. 

  162. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    163. 

  163. | :ref:`String<class_string>`                    | :ref:`right<class_String_right>`  **(** :ref:`int<class_int>` position  **)**                                                              |
    164. 

  164. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    165. 

  165. | :ref:`PoolByteArray<class_poolbytearray>`      | :ref:`sha256_buffer<class_String_sha256_buffer>`  **(** **)**                                                                              |
    166. 

  166. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    167. 

  167. | :ref:`String<class_string>`                    | :ref:`sha256_text<class_String_sha256_text>`  **(** **)**                                                                                  |
    168. 

  168. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    169. 

  169. | :ref:`float<class_float>`                      | :ref:`similarity<class_String_similarity>`  **(** :ref:`String<class_string>` text  **)**                                                  |
    170. 

  170. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    171. 

  171. | :ref:`PoolStringArray<class_poolstringarray>`  | :ref:`split<class_String_split>`  **(** :ref:`String<class_string>` divisor, :ref:`bool<class_bool>` allow_empty=True  **)**               |
    172. 

  172. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    173. 

  173. | :ref:`PoolRealArray<class_poolrealarray>`      | :ref:`split_floats<class_String_split_floats>`  **(** :ref:`String<class_string>` divisor, :ref:`bool<class_bool>` allow_empty=True  **)** |
    174. 

  174. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    175. 

  175. | :ref:`String<class_string>`                    | :ref:`strip_edges<class_String_strip_edges>`  **(** :ref:`bool<class_bool>` left=True, :ref:`bool<class_bool>` right=True  **)**           |
    176. 

  176. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    177. 

  177. | :ref:`String<class_string>`                    | :ref:`substr<class_String_substr>`  **(** :ref:`int<class_int>` from, :ref:`int<class_int>` len  **)**                                     |
    178. 

  178. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    179. 

  179. | :ref:`PoolByteArray<class_poolbytearray>`      | :ref:`to_ascii<class_String_to_ascii>`  **(** **)**                                                                                        |
    180. 

  180. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    181. 

  181. | :ref:`float<class_float>`                      | :ref:`to_float<class_String_to_float>`  **(** **)**                                                                                        |
    182. 

  182. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    183. 

  183. | :ref:`int<class_int>`                          | :ref:`to_int<class_String_to_int>`  **(** **)**                                                                                            |
    184. 

  184. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    185. 

  185. | :ref:`String<class_string>`                    | :ref:`to_lower<class_String_to_lower>`  **(** **)**                                                                                        |
    186. 

  186. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    187. 

  187. | :ref:`String<class_string>`                    | :ref:`to_upper<class_String_to_upper>`  **(** **)**                                                                                        |
    188. 

  188. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    189. 

  189. | :ref:`PoolByteArray<class_poolbytearray>`      | :ref:`to_utf8<class_String_to_utf8>`  **(** **)**                                                                                          |
    190. 

  190. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    191. 

  191. | :ref:`String<class_string>`                    | :ref:`xml_escape<class_String_xml_escape>`  **(** **)**                                                                                    |
    192. 

  192. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    193. 

  193. | :ref:`String<class_string>`                    | :ref:`xml_unescape<class_String_xml_unescape>`  **(** **)**                                                                                |
    194. 

  194. +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
    195. 

  195. 

  196. Description
    197. 

  197. -----------
    198. 

  198. 

  199. 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.
    200. 

  200. 

  201. Member Function Description
    202. 

  202. ---------------------------
    203. 

  203. 

  204. .. _class_String_String:
    205. 

  205. 

  206. - :ref:`String<class_string>`  **String**  **(** :ref:`bool<class_bool>` from  **)**
    207. 

  207. 

  208. .. _class_String_String:
    209. 

  209. 

  210. - :ref:`String<class_string>`  **String**  **(** :ref:`int<class_int>` from  **)**
    211. 

  211. 

  212. .. _class_String_String:
    213. 

  213. 

  214. - :ref:`String<class_string>`  **String**  **(** :ref:`float<class_float>` from  **)**
    215. 

  215. 

  216. .. _class_String_String:
    217. 

  217. 

  218. - :ref:`String<class_string>`  **String**  **(** :ref:`Vector2<class_vector2>` from  **)**
    219. 

  219. 

  220. .. _class_String_String:
    221. 

  221. 

  222. - :ref:`String<class_string>`  **String**  **(** :ref:`Rect2<class_rect2>` from  **)**
    223. 

  223. 

  224. .. _class_String_String:
    225. 

  225. 

  226. - :ref:`String<class_string>`  **String**  **(** :ref:`Vector3<class_vector3>` from  **)**
    227. 

  227. 

  228. .. _class_String_String:
    229. 

  229. 

  230. - :ref:`String<class_string>`  **String**  **(** :ref:`Transform2D<class_transform2d>` from  **)**
    231. 

  231. 

  232. .. _class_String_String:
    233. 

  233. 

  234. - :ref:`String<class_string>`  **String**  **(** :ref:`Plane<class_plane>` from  **)**
    235. 

  235. 

  236. .. _class_String_String:
    237. 

  237. 

  238. - :ref:`String<class_string>`  **String**  **(** :ref:`Quat<class_quat>` from  **)**
    239. 

  239. 

  240. .. _class_String_String:
    241. 

  241. 

  242. - :ref:`String<class_string>`  **String**  **(** :ref:`Rect3<class_rect3>` from  **)**
    243. 

  243. 

  244. .. _class_String_String:
    245. 

  245. 

  246. - :ref:`String<class_string>`  **String**  **(** :ref:`Basis<class_basis>` from  **)**
    247. 

  247. 

  248. .. _class_String_String:
    249. 

  249. 

  250. - :ref:`String<class_string>`  **String**  **(** :ref:`Transform<class_transform>` from  **)**
    251. 

  251. 

  252. .. _class_String_String:
    253. 

  253. 

  254. - :ref:`String<class_string>`  **String**  **(** :ref:`Color<class_color>` from  **)**
    255. 

  255. 

  256. .. _class_String_String:
    257. 

  257. 

  258. - :ref:`String<class_string>`  **String**  **(** :ref:`NodePath<class_nodepath>` from  **)**
    259. 

  259. 

  260. .. _class_String_String:
    261. 

  261. 

  262. - :ref:`String<class_string>`  **String**  **(** :ref:`RID<class_rid>` from  **)**
    263. 

  263. 

  264. .. _class_String_String:
    265. 

  265. 

  266. - :ref:`String<class_string>`  **String**  **(** :ref:`Dictionary<class_dictionary>` from  **)**
    267. 

  267. 

  268. .. _class_String_String:
    269. 

  269. 

  270. - :ref:`String<class_string>`  **String**  **(** :ref:`Array<class_array>` from  **)**
    271. 

  271. 

  272. .. _class_String_String:
    273. 

  273. 

  274. - :ref:`String<class_string>`  **String**  **(** :ref:`PoolByteArray<class_poolbytearray>` from  **)**
    275. 

  275. 

  276. .. _class_String_String:
    277. 

  277. 

  278. - :ref:`String<class_string>`  **String**  **(** :ref:`PoolIntArray<class_poolintarray>` from  **)**
    279. 

  279. 

  280. .. _class_String_String:
    281. 

  281. 

  282. - :ref:`String<class_string>`  **String**  **(** :ref:`PoolRealArray<class_poolrealarray>` from  **)**
    283. 

  283. 

  284. .. _class_String_String:
    285. 

  285. 

  286. - :ref:`String<class_string>`  **String**  **(** :ref:`PoolStringArray<class_poolstringarray>` from  **)**
    287. 

  287. 

  288. .. _class_String_String:
    289. 

  289. 

  290. - :ref:`String<class_string>`  **String**  **(** :ref:`PoolVector2Array<class_poolvector2array>` from  **)**
    291. 

  291. 

  292. .. _class_String_String:
    293. 

  293. 

  294. - :ref:`String<class_string>`  **String**  **(** :ref:`PoolVector3Array<class_poolvector3array>` from  **)**
    295. 

  295. 

  296. .. _class_String_String:
    297. 

  297. 

  298. - :ref:`String<class_string>`  **String**  **(** :ref:`PoolColorArray<class_poolcolorarray>` from  **)**
    299. 

  299. 

  300. .. _class_String_begins_with:
    301. 

  301. 

  302. - :ref:`bool<class_bool>`  **begins_with**  **(** :ref:`String<class_string>` text  **)**
    303. 

  303. 

  304. Return true if the strings begins with the given string.
    305. 

  305. 

  306. .. _class_String_bigrams:
    307. 

  307. 

  308. - :ref:`PoolStringArray<class_poolstringarray>`  **bigrams**  **(** **)**
    309. 

  309. 

  310. Return the bigrams (pairs of consecutive letters) of this string.
    311. 

  311. 

  312. .. _class_String_c_escape:
    313. 

  313. 

  314. - :ref:`String<class_string>`  **c_escape**  **(** **)**
    315. 

  315. 

  316. Return a copy of the string with special characters escaped using the C language standard.
    317. 

  317. 

  318. .. _class_String_c_unescape:
    319. 

  319. 

  320. - :ref:`String<class_string>`  **c_unescape**  **(** **)**
    321. 

  321. 

  322. Return a copy of the string with escaped characters replaced by their meanings according to the C language standard.
    323. 

  323. 

  324. .. _class_String_capitalize:
    325. 

  325. 

  326. - :ref:`String<class_string>`  **capitalize**  **(** **)**
    327. 

  327. 

  328. Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For ``capitalize camelCase mixed_with_underscores`` it will return ``Capitalize Camelcase Mixed With Underscores``.
    329. 

  329. 

  330. .. _class_String_casecmp_to:
    331. 

  331. 

  332. - :ref:`int<class_int>`  **casecmp_to**  **(** :ref:`String<class_string>` to  **)**
    333. 

  333. 

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

  335. 

  336. .. _class_String_empty:
    337. 

  337. 

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

  339. 

  340. Return true if the string is empty.
    341. 

  341. 

  342. .. _class_String_ends_with:
    343. 

  343. 

  344. - :ref:`bool<class_bool>`  **ends_with**  **(** :ref:`String<class_string>` text  **)**
    345. 

  345. 

  346. Return true if the strings ends with the given string.
    347. 

  347. 

  348. .. _class_String_erase:
    349. 

  349. 

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

  351. 

  352. Erase ``chars`` characters from the string starting from ``position``.
    353. 

  353. 

  354. .. _class_String_find:
    355. 

  355. 

  356. - :ref:`int<class_int>`  **find**  **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=0  **)**
    357. 

  357. 

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

  359. 

  360. .. _class_String_find_last:
    361. 

  361. 

  362. - :ref:`int<class_int>`  **find_last**  **(** :ref:`String<class_string>` what  **)**
    363. 

  363. 

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

  365. 

  366. .. _class_String_findn:
    367. 

  367. 

  368. - :ref:`int<class_int>`  **findn**  **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=0  **)**
    369. 

  369. 

  370. Find the first occurrence 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.
    371. 

  371. 

  372. .. _class_String_format:
    373. 

  373. 

  374. - :ref:`String<class_string>`  **format**  **(** var values, :ref:`String<class_string>` placeholder={_}  **)**
    375. 

  375. 

  376. .. _class_String_get_base_dir:
    377. 

  377. 

  378. - :ref:`String<class_string>`  **get_base_dir**  **(** **)**
    379. 

  379. 

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

  381. 

  382. .. _class_String_get_basename:
    383. 

  383. 

  384. - :ref:`String<class_string>`  **get_basename**  **(** **)**
    385. 

  385. 

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

  387. 

  388. .. _class_String_get_extension:
    389. 

  389. 

  390. - :ref:`String<class_string>`  **get_extension**  **(** **)**
    391. 

  391. 

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

  393. 

  394. .. _class_String_get_file:
    395. 

  395. 

  396. - :ref:`String<class_string>`  **get_file**  **(** **)**
    397. 

  397. 

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

  399. 

  400. .. _class_String_hash:
    401. 

  401. 

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

  403. 

  404. Hash the string and return a 32 bits integer.
    405. 

  405. 

  406. .. _class_String_hex_to_int:
    407. 

  407. 

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

  409. 

  410. Convert a string containing a hexadecimal number into an int.
    411. 

  411. 

  412. .. _class_String_insert:
    413. 

  413. 

  414. - :ref:`String<class_string>`  **insert**  **(** :ref:`int<class_int>` position, :ref:`String<class_string>` what  **)**
    415. 

  415. 

  416. Insert a substring at a given position.
    417. 

  417. 

  418. .. _class_String_is_abs_path:
    419. 

  419. 

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

  421. 

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

  423. 

  424. .. _class_String_is_rel_path:
    425. 

  425. 

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

  427. 

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

  429. 

  430. .. _class_String_is_subsequence_of:
    431. 

  431. 

  432. - :ref:`bool<class_bool>`  **is_subsequence_of**  **(** :ref:`String<class_string>` text  **)**
    433. 

  433. 

  434. Check whether this string is a subsequence of the given string.
    435. 

  435. 

  436. .. _class_String_is_subsequence_ofi:
    437. 

  437. 

  438. - :ref:`bool<class_bool>`  **is_subsequence_ofi**  **(** :ref:`String<class_string>` text  **)**
    439. 

  439. 

  440. Check whether this string is a subsequence of the given string, without considering case.
    441. 

  441. 

  442. .. _class_String_is_valid_float:
    443. 

  443. 

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

  445. 

  446. Check whether the string contains a valid float.
    447. 

  447. 

  448. .. _class_String_is_valid_html_color:
    449. 

  449. 

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

  451. 

  452. Check whether the string contains a valid color in HTML notation.
    453. 

  453. 

  454. .. _class_String_is_valid_identifier:
    455. 

  455. 

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

  457. 

  458. Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (\_) and the first character may not be a digit.
    459. 

  459. 

  460. .. _class_String_is_valid_integer:
    461. 

  461. 

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

  463. 

  464. Check whether the string contains a valid integer.
    465. 

  465. 

  466. .. _class_String_is_valid_ip_address:
    467. 

  467. 

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

  469. 

  470. Check whether the string contains a valid IP address.
    471. 

  471. 

  472. .. _class_String_json_escape:
    473. 

  473. 

  474. - :ref:`String<class_string>`  **json_escape**  **(** **)**
    475. 

  475. 

  476. Return a copy of the string with special characters escaped using the JSON standard.
    477. 

  477. 

  478. .. _class_String_left:
    479. 

  479. 

  480. - :ref:`String<class_string>`  **left**  **(** :ref:`int<class_int>` position  **)**
    481. 

  481. 

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

  483. 

  484. .. _class_String_length:
    485. 

  485. 

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

  487. 

  488. Return the length of the string in characters.
    489. 

  489. 

  490. .. _class_String_match:
    491. 

  491. 

  492. - :ref:`bool<class_bool>`  **match**  **(** :ref:`String<class_string>` expr  **)**
    493. 

  493. 

  494. Do a simple expression match, where '\*' matches zero or more arbitrary characters and '?' matches any single character except '.'.
    495. 

  495. 

  496. .. _class_String_matchn:
    497. 

  497. 

  498. - :ref:`bool<class_bool>`  **matchn**  **(** :ref:`String<class_string>` expr  **)**
    499. 

  499. 

  500. Do a simple case insensitive expression match, using ? and \* wildcards (see :ref:`match<class_String_match>`).
    501. 

  501. 

  502. .. _class_String_md5_buffer:
    503. 

  503. 

  504. - :ref:`PoolByteArray<class_poolbytearray>`  **md5_buffer**  **(** **)**
    505. 

  505. 

  506. Return the MD5 hash of the string as an array of bytes.
    507. 

  507. 

  508. .. _class_String_md5_text:
    509. 

  509. 

  510. - :ref:`String<class_string>`  **md5_text**  **(** **)**
    511. 

  511. 

  512. Return the MD5 hash of the string as a string.
    513. 

  513. 

  514. .. _class_String_nocasecmp_to:
    515. 

  515. 

  516. - :ref:`int<class_int>`  **nocasecmp_to**  **(** :ref:`String<class_string>` to  **)**
    517. 

  517. 

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

  519. 

  520. .. _class_String_ord_at:
    521. 

  521. 

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

  523. 

  524. Return the character code at position ``at``.
    525. 

  525. 

  526. .. _class_String_pad_decimals:
    527. 

  527. 

  528. - :ref:`String<class_string>`  **pad_decimals**  **(** :ref:`int<class_int>` digits  **)**
    529. 

  529. 

  530. Format a number to have an exact number of ``digits`` after the decimal point.
    531. 

  531. 

  532. .. _class_String_pad_zeros:
    533. 

  533. 

  534. - :ref:`String<class_string>`  **pad_zeros**  **(** :ref:`int<class_int>` digits  **)**
    535. 

  535. 

  536. Format a number to have an exact number of ``digits`` before the decimal point.
    537. 

  537. 

  538. .. _class_String_percent_decode:
    539. 

  539. 

  540. - :ref:`String<class_string>`  **percent_decode**  **(** **)**
    541. 

  541. 

  542. Decode a percent-encoded string. See :ref:`percent_encode<class_String_percent_encode>`.
    543. 

  543. 

  544. .. _class_String_percent_encode:
    545. 

  545. 

  546. - :ref:`String<class_string>`  **percent_encode**  **(** **)**
    547. 

  547. 

  548. Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request.
    549. 

  549. 

  550. .. _class_String_plus_file:
    551. 

  551. 

  552. - :ref:`String<class_string>`  **plus_file**  **(** :ref:`String<class_string>` file  **)**
    553. 

  553. 

  554. 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"``.
    555. 

  555. 

  556. .. _class_String_replace:
    557. 

  557. 

  558. - :ref:`String<class_string>`  **replace**  **(** :ref:`String<class_string>` what, :ref:`String<class_string>` forwhat  **)**
    559. 

  559. 

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

  561. 

  562. .. _class_String_replacen:
    563. 

  563. 

  564. - :ref:`String<class_string>`  **replacen**  **(** :ref:`String<class_string>` what, :ref:`String<class_string>` forwhat  **)**
    565. 

  565. 

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

  567. 

  568. .. _class_String_rfind:
    569. 

  569. 

  570. - :ref:`int<class_int>`  **rfind**  **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=-1  **)**
    571. 

  571. 

  572. Perform a search for a substring, but start from the end of the string instead of the beginning.
    573. 

  573. 

  574. .. _class_String_rfindn:
    575. 

  575. 

  576. - :ref:`int<class_int>`  **rfindn**  **(** :ref:`String<class_string>` what, :ref:`int<class_int>` from=-1  **)**
    577. 

  577. 

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

  579. 

  580. .. _class_String_right:
    581. 

  581. 

  582. - :ref:`String<class_string>`  **right**  **(** :ref:`int<class_int>` position  **)**
    583. 

  583. 

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

  585. 

  586. .. _class_String_sha256_buffer:
    587. 

  587. 

  588. - :ref:`PoolByteArray<class_poolbytearray>`  **sha256_buffer**  **(** **)**
    589. 

  589. 

  590. .. _class_String_sha256_text:
    591. 

  591. 

  592. - :ref:`String<class_string>`  **sha256_text**  **(** **)**
    593. 

  593. 

  594. Return the SHA-256 hash of the string as a string.
    595. 

  595. 

  596. .. _class_String_similarity:
    597. 

  597. 

  598. - :ref:`float<class_float>`  **similarity**  **(** :ref:`String<class_string>` text  **)**
    599. 

  599. 

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

  601. 

  602. .. _class_String_split:
    603. 

  603. 

  604. - :ref:`PoolStringArray<class_poolstringarray>`  **split**  **(** :ref:`String<class_string>` divisor, :ref:`bool<class_bool>` allow_empty=True  **)**
    605. 

  605. 

  606. 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 ",".
    607. 

  607. 

  608. .. _class_String_split_floats:
    609. 

  609. 

  610. - :ref:`PoolRealArray<class_poolrealarray>`  **split_floats**  **(** :ref:`String<class_string>` divisor, :ref:`bool<class_bool>` allow_empty=True  **)**
    611. 

  611. 

  612. 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 ",".
    613. 

  613. 

  614. .. _class_String_strip_edges:
    615. 

  615. 

  616. - :ref:`String<class_string>`  **strip_edges**  **(** :ref:`bool<class_bool>` left=True, :ref:`bool<class_bool>` right=True  **)**
    617. 

  617. 

  618. Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.
    619. 

  619. 

  620. .. _class_String_substr:
    621. 

  621. 

  622. - :ref:`String<class_string>`  **substr**  **(** :ref:`int<class_int>` from, :ref:`int<class_int>` len  **)**
    623. 

  623. 

  624. Return part of the string from the position ``from``, with length ``len``.
    625. 

  625. 

  626. .. _class_String_to_ascii:
    627. 

  627. 

  628. - :ref:`PoolByteArray<class_poolbytearray>`  **to_ascii**  **(** **)**
    629. 

  629. 

  630. Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters.
    631. 

  631. 

  632. .. _class_String_to_float:
    633. 

  633. 

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

  635. 

  636. Convert a string, containing a decimal number, into a ``float``.
    637. 

  637. 

  638. .. _class_String_to_int:
    639. 

  639. 

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

  641. 

  642. Convert a string, containing an integer number, into an ``int``.
    643. 

  643. 

  644. .. _class_String_to_lower:
    645. 

  645. 

  646. - :ref:`String<class_string>`  **to_lower**  **(** **)**
    647. 

  647. 

  648. Return the string converted to lowercase.
    649. 

  649. 

  650. .. _class_String_to_upper:
    651. 

  651. 

  652. - :ref:`String<class_string>`  **to_upper**  **(** **)**
    653. 

  653. 

  654. Return the string converted to uppercase.
    655. 

  655. 

  656. .. _class_String_to_utf8:
    657. 

  657. 

  658. - :ref:`PoolByteArray<class_poolbytearray>`  **to_utf8**  **(** **)**
    659. 

  659. 

  660. Convert the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii().
    661. 

  661. 

  662. .. _class_String_xml_escape:
    663. 

  663. 

  664. - :ref:`String<class_string>`  **xml_escape**  **(** **)**
    665. 

  665. 

  666. Return a copy of the string with special characters escaped using the XML standard.
    667. 

  667. 

  668. .. _class_String_xml_unescape:
    669. 

  669. 

  670. - :ref:`String<class_string>`  **xml_unescape**  **(** **)**
    671. 

  671. 

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

  673. 

  674.