godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with latest 4.0-dev

Browse Source
This commit is contained in:
Rémi Verschelde
2021-11-15 12:28:38 +01:00
parent d6d97aaf5e
commit 30193215cf
829 changed files with 12891 additions and 7761 deletions
Download Patch File Download Diff File Expand all files Collapse all files

198
classes/class_packedstringarray.rst
View File

@@ -1,6 +1,6 @@
:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PackedStringArray.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
@@ -21,85 +21,96 @@ Tutorials
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__
Constructors
------------
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`PackedStringArray<class_PackedStringArray_constructor_PackedStringArray>` **(** **)** |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`PackedStringArray<class_PackedStringArray_constructor_PackedStringArray>` **(** :ref:`PackedStringArray<class_PackedStringArray>` from **)** |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`PackedStringArray<class_PackedStringArray_constructor_PackedStringArray>` **(** :ref:`Array<class_Array>` from **)** |
+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
Methods
-------
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`PackedStringArray<class_PackedStringArray_method_PackedStringArray>` **(** **)** |constructor| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`PackedStringArray<class_PackedStringArray_method_PackedStringArray>` **(** :ref:`PackedStringArray<class_PackedStringArray>` from **)** |constructor| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`PackedStringArray<class_PackedStringArray_method_PackedStringArray>` **(** :ref:`Array<class_Array>` from **)** |constructor| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`append<class_PackedStringArray_method_append>` **(** :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append_array<class_PackedStringArray_method_append_array>` **(** :ref:`PackedStringArray<class_PackedStringArray>` array **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`bsearch<class_PackedStringArray_method_bsearch>` **(** :ref:`String<class_String>` value, :ref:`bool<class_bool>` before=true **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`duplicate<class_PackedStringArray_method_duplicate>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_PackedStringArray_method_fill>` **(** :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_PackedStringArray_method_has>` **(** :ref:`String<class_String>` value **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_PackedStringArray_method_insert>` **(** :ref:`int<class_int>` at_index, :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedStringArray_method_is_empty>` **(** **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | **operator !=** **(** **)** |operator| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | **operator !=** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |operator| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | **operator +** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |operator| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | **operator ==** **(** **)** |operator| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | **operator ==** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |operator| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | **operator []** **(** :ref:`int<class_int>` index **)** |operator| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`push_back<class_PackedStringArray_method_push_back>` **(** :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove<class_PackedStringArray_method_remove>` **(** :ref:`int<class_int>` index **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`resize<class_PackedStringArray_method_resize>` **(** :ref:`int<class_int>` new_size **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reverse<class_PackedStringArray_method_reverse>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set<class_PackedStringArray_method_set>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_PackedStringArray_method_size>` **(** **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort<class_PackedStringArray_method_sort>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`subarray<class_PackedStringArray_method_subarray>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedStringArray_method_to_byte_array>` **(** **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`append<class_PackedStringArray_method_append>` **(** :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append_array<class_PackedStringArray_method_append_array>` **(** :ref:`PackedStringArray<class_PackedStringArray>` array **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`bsearch<class_PackedStringArray_method_bsearch>` **(** :ref:`String<class_String>` value, :ref:`bool<class_bool>` before=true **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`duplicate<class_PackedStringArray_method_duplicate>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_PackedStringArray_method_fill>` **(** :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_PackedStringArray_method_has>` **(** :ref:`String<class_String>` value **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_PackedStringArray_method_insert>` **(** :ref:`int<class_int>` at_index, :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedStringArray_method_is_empty>` **(** **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`push_back<class_PackedStringArray_method_push_back>` **(** :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove<class_PackedStringArray_method_remove>` **(** :ref:`int<class_int>` index **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`resize<class_PackedStringArray_method_resize>` **(** :ref:`int<class_int>` new_size **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reverse<class_PackedStringArray_method_reverse>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set<class_PackedStringArray_method_set>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` value **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_PackedStringArray_method_size>` **(** **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort<class_PackedStringArray_method_sort>` **(** **)** |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`subarray<class_PackedStringArray_method_subarray>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedStringArray_method_to_byte_array>` **(** **)** |const| |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
Operators
---------
.. _class_PackedStringArray_method_PackedStringArray:
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedStringArray_operator_neq_bool>` **(** **)** |
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedStringArray_operator_neq_bool>` **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`operator +<class_PackedStringArray_operator_sum_PackedStringArray>` **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedStringArray_operator_eq_bool>` **(** **)** |
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedStringArray_operator_eq_bool>` **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`operator []<class_PackedStringArray_operator_idx_String>` **(** :ref:`int<class_int>` index **)** |
+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
- :ref:`PackedStringArray<class_PackedStringArray>` **PackedStringArray** **(** **)** |constructor|
Constructor Descriptions
------------------------
.. _class_PackedStringArray_constructor_PackedStringArray:
- :ref:`PackedStringArray<class_PackedStringArray>` **PackedStringArray** **(** **)**
Constructs an empty ``PackedStringArray``.
----
- :ref:`PackedStringArray<class_PackedStringArray>` **PackedStringArray** **(** :ref:`PackedStringArray<class_PackedStringArray>` from **)** |constructor|
- :ref:`PackedStringArray<class_PackedStringArray>` **PackedStringArray** **(** :ref:`PackedStringArray<class_PackedStringArray>` from **)**
Constructs a ``PackedStringArray`` as a copy of the given ``PackedStringArray``.
----
- :ref:`PackedStringArray<class_PackedStringArray>` **PackedStringArray** **(** :ref:`Array<class_Array>` from **)** |constructor|
- :ref:`PackedStringArray<class_PackedStringArray>` **PackedStringArray** **(** :ref:`Array<class_Array>` from **)**
Constructs a new ``PackedStringArray``. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
----
Method Descriptions
-------------------
.. _class_PackedStringArray_method_append:
@@ -167,38 +178,6 @@ Returns ``true`` if the array is empty.
----
.. _class_PackedStringArray_method_operator !=:
- :ref:`bool<class_bool>` **operator !=** **(** **)** |operator|
----
- :ref:`bool<class_bool>` **operator !=** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |operator|
----
.. _class_PackedStringArray_method_operator +:
- :ref:`PackedStringArray<class_PackedStringArray>` **operator +** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |operator|
----
.. _class_PackedStringArray_method_operator ==:
- :ref:`bool<class_bool>` **operator ==** **(** **)** |operator|
----
- :ref:`bool<class_bool>` **operator ==** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)** |operator|
----
.. _class_PackedStringArray_method_operator []:
- :ref:`String<class_String>` **operator []** **(** :ref:`int<class_int>` index **)** |operator|
----
.. _class_PackedStringArray_method_push_back:
- :ref:`bool<class_bool>` **push_back** **(** :ref:`String<class_String>` value **)**
@@ -265,6 +244,39 @@ Sorts the elements of the array in ascending order.
- :ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array** **(** **)** |const|
Operator Descriptions
---------------------
.. _class_PackedStringArray_operator_neq_bool:
- :ref:`bool<class_bool>` **operator !=** **(** **)**
----
- :ref:`bool<class_bool>` **operator !=** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)**
----
.. _class_PackedStringArray_operator_sum_PackedStringArray:
- :ref:`PackedStringArray<class_PackedStringArray>` **operator +** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)**
----
.. _class_PackedStringArray_operator_eq_bool:
- :ref:`bool<class_bool>` **operator ==** **(** **)**
----
- :ref:`bool<class_bool>` **operator ==** **(** :ref:`PackedStringArray<class_PackedStringArray>` right **)**
----
.. _class_PackedStringArray_operator_idx_String:
- :ref:`String<class_String>` **operator []** **(** :ref:`int<class_int>` index **)**
.. |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.)`