Files
godot-docs/classes/class_stringarray.rst
T
Rémi Verschelde 1b5e8c18fd classref: Order everything alphabetically
And sync with current 2.0.x sources.
2016-06-25 02:10:54 +02:00

70 lines
3.0 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_StringArray:
StringArray
===========
**Category:** Built-In Types
Brief Description
-----------------
String Array.
Member Functions
----------------
+----------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`StringArray<class_StringArray_StringArray>` **(** :ref:`Array<class_array>` from **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_back<class_StringArray_push_back>` **(** :ref:`String<class_string>` string **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_StringArray_resize>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set<class_StringArray_set>` **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` string **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_StringArray_size>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------+
Description
-----------
String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory.
Member Function Description
---------------------------
.. _class_StringArray_StringArray:
- :ref:`StringArray<class_stringarray>` **StringArray** **(** :ref:`Array<class_array>` from **)**
Create from a generic array.
.. _class_StringArray_push_back:
- void **push_back** **(** :ref:`String<class_string>` string **)**
Append a string element at end of the array.
.. _class_StringArray_resize:
- void **resize** **(** :ref:`int<class_int>` idx **)**
Set the size of the :ref:`StringArray<class_stringarray>`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
.. _class_StringArray_set:
- void **set** **(** :ref:`int<class_int>` idx, :ref:`String<class_string>` string **)**
Change the :ref:`String<class_string>` at the given index.
.. _class_StringArray_size:
- :ref:`int<class_int>` **size** **(** **)**
Return the size of the array.