.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/String.xml. .. _class_String: String ====== .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. note:: There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information. .. rst-class:: classref-reftable-group Constructors ------------ .. table:: :widths: auto +-----------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`String` from **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`NodePath` from **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`StringName` from **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`begins_with` **(** :ref:`String` text **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`bigrams` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`bin_to_int` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`c_escape` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`c_unescape` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`capitalize` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`casecmp_to` **(** :ref:`String` to **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`chr` **(** :ref:`int` char **)** |static| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`contains` **(** :ref:`String` what **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`containsn` **(** :ref:`String` what **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`count` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`countn` **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`dedent` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`ends_with` **(** :ref:`String` text **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`erase` **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`filecasecmp_to` **(** :ref:`String` to **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`filenocasecmp_to` **(** :ref:`String` to **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`findn` **(** :ref:`String` what, :ref:`int` from=0 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`format` **(** :ref:`Variant` values, :ref:`String` placeholder="{_}" **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_base_dir` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_basename` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_extension` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_file` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_slice` **(** :ref:`String` delimiter, :ref:`int` slice **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_slice_count` **(** :ref:`String` delimiter **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_slicec` **(** :ref:`int` delimiter, :ref:`int` slice **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hash` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`hex_decode` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`hex_to_int` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`humanize_size` **(** :ref:`int` size **)** |static| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`indent` **(** :ref:`String` prefix **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`insert` **(** :ref:`int` position, :ref:`String` what **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_absolute_path` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_empty` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_relative_path` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_subsequence_of` **(** :ref:`String` text **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_subsequence_ofn` **(** :ref:`String` text **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_filename` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_float` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=false **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_html_color` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_identifier` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_int` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_ip_address` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`join` **(** :ref:`PackedStringArray` parts **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`json_escape` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`left` **(** :ref:`int` length **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`length` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`lpad` **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`lstrip` **(** :ref:`String` chars **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`match` **(** :ref:`String` expr **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`matchn` **(** :ref:`String` expr **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`md5_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`md5_text` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`naturalcasecmp_to` **(** :ref:`String` to **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`naturalnocasecmp_to` **(** :ref:`String` to **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`nocasecmp_to` **(** :ref:`String` to **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`num` **(** :ref:`float` number, :ref:`int` decimals=-1 **)** |static| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`num_int64` **(** :ref:`int` number, :ref:`int` base=10, :ref:`bool` capitalize_hex=false **)** |static| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`num_scientific` **(** :ref:`float` number **)** |static| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`num_uint64` **(** :ref:`int` number, :ref:`int` base=10, :ref:`bool` capitalize_hex=false **)** |static| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_decimals` **(** :ref:`int` digits **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`pad_zeros` **(** :ref:`int` digits **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`path_join` **(** :ref:`String` file **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`repeat` **(** :ref:`int` count **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replace` **(** :ref:`String` what, :ref:`String` forwhat **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`replacen` **(** :ref:`String` what, :ref:`String` forwhat **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`reverse` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfind` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rfindn` **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`right` **(** :ref:`int` length **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rpad` **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`rsplit` **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`rstrip` **(** :ref:`String` chars **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`sha1_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`sha1_text` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`sha256_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`sha256_text` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`similarity` **(** :ref:`String` text **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`simplify_path` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`split` **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat64Array` | :ref:`split_floats` **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`strip_edges` **(** :ref:`bool` left=true, :ref:`bool` right=true **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`strip_escapes` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`substr` **(** :ref:`int` from, :ref:`int` len=-1 **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`to_ascii_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_camel_case` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`to_float` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`to_int` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_lower` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_pascal_case` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_snake_case` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`to_upper` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`to_utf8_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`to_utf16_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`to_utf32_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedByteArray` | :ref:`to_wchar_buffer` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`trim_prefix` **(** :ref:`String` prefix **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`trim_suffix` **(** :ref:`String` suffix **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`unicode_at` **(** :ref:`int` at **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`uri_decode` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`uri_encode` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_filename` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_node_name` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`xml_escape` **(** :ref:`bool` escape_quotes=false **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`xml_unescape` **(** **)** |const| | +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Operators --------- .. table:: :widths: auto +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`String` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`StringName` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`operator %` **(** :ref:`Variant` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`operator +` **(** :ref:`String` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`operator +` **(** :ref:`StringName` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator \<` **(** :ref:`String` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator \<=` **(** :ref:`String` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`String` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`StringName` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator >` **(** :ref:`String` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator >=` **(** :ref:`String` right **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`operator []` **(** :ref:`int` index **)** | +-----------------------------+----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constructor Descriptions ------------------------ .. _class_String_constructor_String: .. rst-class:: classref-constructor :ref:`String` **String** **(** **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`String` **String** **(** :ref:`String` from **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`String` **String** **(** :ref:`NodePath` from **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`String` **String** **(** :ref:`StringName` from **)** .. container:: contribute There is currently no description for this constructor. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_String_method_begins_with: .. rst-class:: classref-method :ref:`bool` **begins_with** **(** :ref:`String` text **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_bigrams: .. rst-class:: classref-method :ref:`PackedStringArray` **bigrams** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_bin_to_int: .. rst-class:: classref-method :ref:`int` **bin_to_int** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_c_escape: .. rst-class:: classref-method :ref:`String` **c_escape** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_c_unescape: .. rst-class:: classref-method :ref:`String` **c_unescape** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_capitalize: .. rst-class:: classref-method :ref:`String` **capitalize** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_casecmp_to: .. rst-class:: classref-method :ref:`int` **casecmp_to** **(** :ref:`String` to **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_chr: .. rst-class:: classref-method :ref:`String` **chr** **(** :ref:`int` char **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_contains: .. rst-class:: classref-method :ref:`bool` **contains** **(** :ref:`String` what **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_containsn: .. rst-class:: classref-method :ref:`bool` **containsn** **(** :ref:`String` what **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_count: .. rst-class:: classref-method :ref:`int` **count** **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_countn: .. rst-class:: classref-method :ref:`int` **countn** **(** :ref:`String` what, :ref:`int` from=0, :ref:`int` to=0 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_dedent: .. rst-class:: classref-method :ref:`String` **dedent** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_ends_with: .. rst-class:: classref-method :ref:`bool` **ends_with** **(** :ref:`String` text **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_erase: .. rst-class:: classref-method :ref:`String` **erase** **(** :ref:`int` position, :ref:`int` chars=1 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_filecasecmp_to: .. rst-class:: classref-method :ref:`int` **filecasecmp_to** **(** :ref:`String` to **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_filenocasecmp_to: .. rst-class:: classref-method :ref:`int` **filenocasecmp_to** **(** :ref:`String` to **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_find: .. rst-class:: classref-method :ref:`int` **find** **(** :ref:`String` what, :ref:`int` from=0 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_findn: .. rst-class:: classref-method :ref:`int` **findn** **(** :ref:`String` what, :ref:`int` from=0 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_format: .. rst-class:: classref-method :ref:`String` **format** **(** :ref:`Variant` values, :ref:`String` placeholder="{_}" **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_get_base_dir: .. rst-class:: classref-method :ref:`String` **get_base_dir** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_get_basename: .. rst-class:: classref-method :ref:`String` **get_basename** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_get_extension: .. rst-class:: classref-method :ref:`String` **get_extension** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_get_file: .. rst-class:: classref-method :ref:`String` **get_file** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_get_slice: .. rst-class:: classref-method :ref:`String` **get_slice** **(** :ref:`String` delimiter, :ref:`int` slice **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_get_slice_count: .. rst-class:: classref-method :ref:`int` **get_slice_count** **(** :ref:`String` delimiter **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_get_slicec: .. rst-class:: classref-method :ref:`String` **get_slicec** **(** :ref:`int` delimiter, :ref:`int` slice **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_hash: .. rst-class:: classref-method :ref:`int` **hash** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_hex_decode: .. rst-class:: classref-method :ref:`PackedByteArray` **hex_decode** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_hex_to_int: .. rst-class:: classref-method :ref:`int` **hex_to_int** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_humanize_size: .. rst-class:: classref-method :ref:`String` **humanize_size** **(** :ref:`int` size **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_indent: .. rst-class:: classref-method :ref:`String` **indent** **(** :ref:`String` prefix **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_insert: .. rst-class:: classref-method :ref:`String` **insert** **(** :ref:`int` position, :ref:`String` what **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_absolute_path: .. rst-class:: classref-method :ref:`bool` **is_absolute_path** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_empty: .. rst-class:: classref-method :ref:`bool` **is_empty** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_relative_path: .. rst-class:: classref-method :ref:`bool` **is_relative_path** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_subsequence_of: .. rst-class:: classref-method :ref:`bool` **is_subsequence_of** **(** :ref:`String` text **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_subsequence_ofn: .. rst-class:: classref-method :ref:`bool` **is_subsequence_ofn** **(** :ref:`String` text **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_valid_filename: .. rst-class:: classref-method :ref:`bool` **is_valid_filename** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_valid_float: .. rst-class:: classref-method :ref:`bool` **is_valid_float** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_valid_hex_number: .. rst-class:: classref-method :ref:`bool` **is_valid_hex_number** **(** :ref:`bool` with_prefix=false **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_valid_html_color: .. rst-class:: classref-method :ref:`bool` **is_valid_html_color** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_valid_identifier: .. rst-class:: classref-method :ref:`bool` **is_valid_identifier** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_valid_int: .. rst-class:: classref-method :ref:`bool` **is_valid_int** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_is_valid_ip_address: .. rst-class:: classref-method :ref:`bool` **is_valid_ip_address** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_join: .. rst-class:: classref-method :ref:`String` **join** **(** :ref:`PackedStringArray` parts **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_json_escape: .. rst-class:: classref-method :ref:`String` **json_escape** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_left: .. rst-class:: classref-method :ref:`String` **left** **(** :ref:`int` length **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_length: .. rst-class:: classref-method :ref:`int` **length** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_lpad: .. rst-class:: classref-method :ref:`String` **lpad** **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_lstrip: .. rst-class:: classref-method :ref:`String` **lstrip** **(** :ref:`String` chars **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_match: .. rst-class:: classref-method :ref:`bool` **match** **(** :ref:`String` expr **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_matchn: .. rst-class:: classref-method :ref:`bool` **matchn** **(** :ref:`String` expr **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_md5_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **md5_buffer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_md5_text: .. rst-class:: classref-method :ref:`String` **md5_text** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_naturalcasecmp_to: .. rst-class:: classref-method :ref:`int` **naturalcasecmp_to** **(** :ref:`String` to **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_naturalnocasecmp_to: .. rst-class:: classref-method :ref:`int` **naturalnocasecmp_to** **(** :ref:`String` to **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_nocasecmp_to: .. rst-class:: classref-method :ref:`int` **nocasecmp_to** **(** :ref:`String` to **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_num: .. rst-class:: classref-method :ref:`String` **num** **(** :ref:`float` number, :ref:`int` decimals=-1 **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_num_int64: .. rst-class:: classref-method :ref:`String` **num_int64** **(** :ref:`int` number, :ref:`int` base=10, :ref:`bool` capitalize_hex=false **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_num_scientific: .. rst-class:: classref-method :ref:`String` **num_scientific** **(** :ref:`float` number **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_num_uint64: .. rst-class:: classref-method :ref:`String` **num_uint64** **(** :ref:`int` number, :ref:`int` base=10, :ref:`bool` capitalize_hex=false **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_pad_decimals: .. rst-class:: classref-method :ref:`String` **pad_decimals** **(** :ref:`int` digits **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_pad_zeros: .. rst-class:: classref-method :ref:`String` **pad_zeros** **(** :ref:`int` digits **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_path_join: .. rst-class:: classref-method :ref:`String` **path_join** **(** :ref:`String` file **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_repeat: .. rst-class:: classref-method :ref:`String` **repeat** **(** :ref:`int` count **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_replace: .. rst-class:: classref-method :ref:`String` **replace** **(** :ref:`String` what, :ref:`String` forwhat **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_replacen: .. rst-class:: classref-method :ref:`String` **replacen** **(** :ref:`String` what, :ref:`String` forwhat **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_reverse: .. rst-class:: classref-method :ref:`String` **reverse** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_rfind: .. rst-class:: classref-method :ref:`int` **rfind** **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_rfindn: .. rst-class:: classref-method :ref:`int` **rfindn** **(** :ref:`String` what, :ref:`int` from=-1 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_right: .. rst-class:: classref-method :ref:`String` **right** **(** :ref:`int` length **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_rpad: .. rst-class:: classref-method :ref:`String` **rpad** **(** :ref:`int` min_length, :ref:`String` character=" " **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_rsplit: .. rst-class:: classref-method :ref:`PackedStringArray` **rsplit** **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_rstrip: .. rst-class:: classref-method :ref:`String` **rstrip** **(** :ref:`String` chars **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_sha1_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **sha1_buffer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_sha1_text: .. rst-class:: classref-method :ref:`String` **sha1_text** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_sha256_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **sha256_buffer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_sha256_text: .. rst-class:: classref-method :ref:`String` **sha256_text** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_similarity: .. rst-class:: classref-method :ref:`float` **similarity** **(** :ref:`String` text **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_simplify_path: .. rst-class:: classref-method :ref:`String` **simplify_path** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_split: .. rst-class:: classref-method :ref:`PackedStringArray` **split** **(** :ref:`String` delimiter="", :ref:`bool` allow_empty=true, :ref:`int` maxsplit=0 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_split_floats: .. rst-class:: classref-method :ref:`PackedFloat64Array` **split_floats** **(** :ref:`String` delimiter, :ref:`bool` allow_empty=true **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_strip_edges: .. rst-class:: classref-method :ref:`String` **strip_edges** **(** :ref:`bool` left=true, :ref:`bool` right=true **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_strip_escapes: .. rst-class:: classref-method :ref:`String` **strip_escapes** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_substr: .. rst-class:: classref-method :ref:`String` **substr** **(** :ref:`int` from, :ref:`int` len=-1 **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_ascii_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **to_ascii_buffer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_camel_case: .. rst-class:: classref-method :ref:`String` **to_camel_case** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_float: .. rst-class:: classref-method :ref:`float` **to_float** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_int: .. rst-class:: classref-method :ref:`int` **to_int** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_lower: .. rst-class:: classref-method :ref:`String` **to_lower** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_pascal_case: .. rst-class:: classref-method :ref:`String` **to_pascal_case** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_snake_case: .. rst-class:: classref-method :ref:`String` **to_snake_case** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_upper: .. rst-class:: classref-method :ref:`String` **to_upper** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_utf8_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **to_utf8_buffer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_utf16_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **to_utf16_buffer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_utf32_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **to_utf32_buffer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_to_wchar_buffer: .. rst-class:: classref-method :ref:`PackedByteArray` **to_wchar_buffer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_trim_prefix: .. rst-class:: classref-method :ref:`String` **trim_prefix** **(** :ref:`String` prefix **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_trim_suffix: .. rst-class:: classref-method :ref:`String` **trim_suffix** **(** :ref:`String` suffix **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_unicode_at: .. rst-class:: classref-method :ref:`int` **unicode_at** **(** :ref:`int` at **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_uri_decode: .. rst-class:: classref-method :ref:`String` **uri_decode** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_uri_encode: .. rst-class:: classref-method :ref:`String` **uri_encode** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_validate_filename: .. rst-class:: classref-method :ref:`String` **validate_filename** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_validate_node_name: .. rst-class:: classref-method :ref:`String` **validate_node_name** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_xml_escape: .. rst-class:: classref-method :ref:`String` **xml_escape** **(** :ref:`bool` escape_quotes=false **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_method_xml_unescape: .. rst-class:: classref-method :ref:`String` **xml_unescape** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Operator Descriptions --------------------- .. _class_String_operator_neq_String: .. rst-class:: classref-operator :ref:`bool` **operator !=** **(** :ref:`String` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_neq_StringName: .. rst-class:: classref-operator :ref:`bool` **operator !=** **(** :ref:`StringName` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_mod_Variant: .. rst-class:: classref-operator :ref:`String` **operator %** **(** :ref:`Variant` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_sum_String: .. rst-class:: classref-operator :ref:`String` **operator +** **(** :ref:`String` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_sum_StringName: .. rst-class:: classref-operator :ref:`String` **operator +** **(** :ref:`StringName` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_lt_String: .. rst-class:: classref-operator :ref:`bool` **operator <** **(** :ref:`String` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_lte_String: .. rst-class:: classref-operator :ref:`bool` **operator <=** **(** :ref:`String` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_eq_String: .. rst-class:: classref-operator :ref:`bool` **operator ==** **(** :ref:`String` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_eq_StringName: .. rst-class:: classref-operator :ref:`bool` **operator ==** **(** :ref:`StringName` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_gt_String: .. rst-class:: classref-operator :ref:`bool` **operator >** **(** :ref:`String` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_gte_String: .. rst-class:: classref-operator :ref:`bool` **operator >=** **(** :ref:`String` right **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_String_operator_idx_int: .. rst-class:: classref-operator :ref:`String` **operator []** **(** :ref:`int` index **)** .. container:: contribute There is currently no description for this operator. Please help us by :ref:`contributing one `! .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`