class_intarray.rst 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_IntArray:
  4. IntArray
  5. ========
  6. **Category:** Built-In Types
  7. Brief Description
  8. -----------------
  9. Integer Array.
  10. Member Functions
  11. ----------------
  12. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  13. | :ref:`IntArray<class_intarray>` | :ref:`IntArray<class_IntArray_IntArray>` **(** :ref:`Array<class_array>` from **)** |
  14. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`append<class_IntArray_append>` **(** :ref:`int<class_int>` integer **)** |
  16. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`append_array<class_IntArray_append_array>` **(** :ref:`IntArray<class_intarray>` array **)** |
  18. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`insert<class_IntArray_insert>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)** |
  20. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`invert<class_IntArray_invert>` **(** **)** |
  22. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`push_back<class_IntArray_push_back>` **(** :ref:`int<class_int>` integer **)** |
  24. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`remove<class_IntArray_remove>` **(** :ref:`int<class_int>` idx **)** |
  26. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`resize<class_IntArray_resize>` **(** :ref:`int<class_int>` idx **)** |
  28. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set<class_IntArray_set>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)** |
  30. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  31. | :ref:`int<class_int>` | :ref:`size<class_IntArray_size>` **(** **)** |
  32. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  33. Description
  34. -----------
  35. Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory.
  36. Member Function Description
  37. ---------------------------
  38. .. _class_IntArray_IntArray:
  39. - :ref:`IntArray<class_intarray>` **IntArray** **(** :ref:`Array<class_array>` from **)**
  40. Create from a generic array.
  41. .. _class_IntArray_append:
  42. - void **append** **(** :ref:`int<class_int>` integer **)**
  43. Append an element at the end of the array (alias of :ref:`push_back<class_IntArray_push_back>`).
  44. .. _class_IntArray_append_array:
  45. - void **append_array** **(** :ref:`IntArray<class_intarray>` array **)**
  46. Append an :ref:`IntArray<class_intarray>` at the end of this array.
  47. .. _class_IntArray_insert:
  48. - :ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)**
  49. Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
  50. .. _class_IntArray_invert:
  51. - void **invert** **(** **)**
  52. Reverse the order of the elements in the array (so first element will now be the last).
  53. .. _class_IntArray_push_back:
  54. - void **push_back** **(** :ref:`int<class_int>` integer **)**
  55. Append a value to the array.
  56. .. _class_IntArray_remove:
  57. - void **remove** **(** :ref:`int<class_int>` idx **)**
  58. Remove an element from the array by index.
  59. .. _class_IntArray_resize:
  60. - void **resize** **(** :ref:`int<class_int>` idx **)**
  61. Set the size of the :ref:`IntArray<class_intarray>`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
  62. .. _class_IntArray_set:
  63. - void **set** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)**
  64. Change the int at the given index.
  65. .. _class_IntArray_size:
  66. - :ref:`int<class_int>` **size** **(** **)**
  67. Return the array size.