mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 17:28:58 +00:00
classref: Sync with latest 4.0-dev
This commit is contained in:
Rémi Verschelde
@@ -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 PackedVector3Array.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
@@ -16,87 +16,98 @@ Description
|
||||
|
||||
An :ref:`Array<class_Array>` specifically designed to hold :ref:`Vector3<class_Vector3>`. Packs data tightly, so it saves memory for large array sizes.
|
||||
|
||||
Constructors
|
||||
------------
|
||||
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_constructor_PackedVector3Array>` **(** **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_constructor_PackedVector3Array>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` from **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_constructor_PackedVector3Array>` **(** :ref:`Array<class_Array>` from **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_method_PackedVector3Array>` **(** **)** |constructor| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_method_PackedVector3Array>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` from **)** |constructor| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`PackedVector3Array<class_PackedVector3Array_method_PackedVector3Array>` **(** :ref:`Array<class_Array>` from **)** |constructor| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`append<class_PackedVector3Array_method_append>` **(** :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append_array<class_PackedVector3Array_method_append_array>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` array **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch<class_PackedVector3Array_method_bsearch>` **(** :ref:`Vector3<class_Vector3>` value, :ref:`bool<class_bool>` before=true **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`duplicate<class_PackedVector3Array_method_duplicate>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`fill<class_PackedVector3Array_method_fill>` **(** :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_PackedVector3Array_method_has>` **(** :ref:`Vector3<class_Vector3>` value **)** |const| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`insert<class_PackedVector3Array_method_insert>` **(** :ref:`int<class_int>` at_index, :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedVector3Array_method_is_empty>` **(** **)** |const| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | **operator !=** **(** **)** |operator| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | **operator !=** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |operator| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | **operator *** **(** :ref:`Transform3D<class_Transform3D>` right **)** |operator| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | **operator +** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |operator| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | **operator ==** **(** **)** |operator| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | **operator ==** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |operator| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | **operator []** **(** :ref:`int<class_int>` index **)** |operator| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`push_back<class_PackedVector3Array_method_push_back>` **(** :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_PackedVector3Array_method_remove>` **(** :ref:`int<class_int>` index **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`resize<class_PackedVector3Array_method_resize>` **(** :ref:`int<class_int>` new_size **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reverse<class_PackedVector3Array_method_reverse>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set<class_PackedVector3Array_method_set>` **(** :ref:`int<class_int>` index, :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_PackedVector3Array_method_size>` **(** **)** |const| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort<class_PackedVector3Array_method_sort>` **(** **)** |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`subarray<class_PackedVector3Array_method_subarray>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)** |const| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedVector3Array_method_to_byte_array>` **(** **)** |const| |
|
||||
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`append<class_PackedVector3Array_method_append>` **(** :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`append_array<class_PackedVector3Array_method_append_array>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` array **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`bsearch<class_PackedVector3Array_method_bsearch>` **(** :ref:`Vector3<class_Vector3>` value, :ref:`bool<class_bool>` before=true **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`duplicate<class_PackedVector3Array_method_duplicate>` **(** **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`fill<class_PackedVector3Array_method_fill>` **(** :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has<class_PackedVector3Array_method_has>` **(** :ref:`Vector3<class_Vector3>` value **)** |const| |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`insert<class_PackedVector3Array_method_insert>` **(** :ref:`int<class_int>` at_index, :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedVector3Array_method_is_empty>` **(** **)** |const| |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`push_back<class_PackedVector3Array_method_push_back>` **(** :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove<class_PackedVector3Array_method_remove>` **(** :ref:`int<class_int>` index **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`resize<class_PackedVector3Array_method_resize>` **(** :ref:`int<class_int>` new_size **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`reverse<class_PackedVector3Array_method_reverse>` **(** **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set<class_PackedVector3Array_method_set>` **(** :ref:`int<class_int>` index, :ref:`Vector3<class_Vector3>` value **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`size<class_PackedVector3Array_method_size>` **(** **)** |const| |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`sort<class_PackedVector3Array_method_sort>` **(** **)** |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`subarray<class_PackedVector3Array_method_subarray>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)** |const| |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedVector3Array_method_to_byte_array>` **(** **)** |const| |
|
||||
+-----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
Operators
|
||||
---------
|
||||
|
||||
.. _class_PackedVector3Array_method_PackedVector3Array:
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedVector3Array_operator_neq_bool>` **(** **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedVector3Array_operator_neq_bool>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`operator *<class_PackedVector3Array_operator_mul_PackedVector3Array>` **(** :ref:`Transform3D<class_Transform3D>` right **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`operator +<class_PackedVector3Array_operator_sum_PackedVector3Array>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedVector3Array_operator_eq_bool>` **(** **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedVector3Array_operator_eq_bool>` **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_Vector3>` | :ref:`operator []<class_PackedVector3Array_operator_idx_Vector3>` **(** :ref:`int<class_int>` index **)** |
|
||||
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array** **(** **)** |constructor|
|
||||
Constructor Descriptions
|
||||
------------------------
|
||||
|
||||
.. _class_PackedVector3Array_constructor_PackedVector3Array:
|
||||
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array** **(** **)**
|
||||
|
||||
Constructs an empty ``PackedVector3Array``.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` from **)** |constructor|
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` from **)**
|
||||
|
||||
Constructs a ``PackedVector3Array`` as a copy of the given ``PackedVector3Array``.
|
||||
|
||||
----
|
||||
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array** **(** :ref:`Array<class_Array>` from **)** |constructor|
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **PackedVector3Array** **(** :ref:`Array<class_Array>` from **)**
|
||||
|
||||
Constructs a new ``PackedVector3Array``. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
|
||||
|
||||
----
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_PackedVector3Array_method_append:
|
||||
|
||||
@@ -164,44 +175,6 @@ Returns ``true`` if the array is empty.
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_method_operator !=:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator !=** **(** **)** |operator|
|
||||
|
||||
----
|
||||
|
||||
- :ref:`bool<class_bool>` **operator !=** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |operator|
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_method_operator *:
|
||||
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **operator *** **(** :ref:`Transform3D<class_Transform3D>` right **)** |operator|
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_method_operator +:
|
||||
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **operator +** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |operator|
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_method_operator ==:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator ==** **(** **)** |operator|
|
||||
|
||||
----
|
||||
|
||||
- :ref:`bool<class_bool>` **operator ==** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)** |operator|
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_method_operator []:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **operator []** **(** :ref:`int<class_int>` index **)** |operator|
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_method_push_back:
|
||||
|
||||
- :ref:`bool<class_bool>` **push_back** **(** :ref:`Vector3<class_Vector3>` value **)**
|
||||
@@ -268,6 +241,45 @@ Sorts the elements of the array in ascending order.
|
||||
|
||||
- :ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array** **(** **)** |const|
|
||||
|
||||
Operator Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_PackedVector3Array_operator_neq_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator !=** **(** **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`bool<class_bool>` **operator !=** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_operator_mul_PackedVector3Array:
|
||||
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **operator *** **(** :ref:`Transform3D<class_Transform3D>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_operator_sum_PackedVector3Array:
|
||||
|
||||
- :ref:`PackedVector3Array<class_PackedVector3Array>` **operator +** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_operator_eq_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator ==** **(** **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`bool<class_bool>` **operator ==** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_PackedVector3Array_operator_idx_Vector3:
|
||||
|
||||
- :ref:`Vector3<class_Vector3>` **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.)`
|
||||
|
||||
Reference in New Issue
Block a user