mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with current master branch (cc5135959)
This commit is contained in:
Rémi Verschelde
342
classes/class_vector4i.rst
Normal file
342
classes/class_vector4i.rst
Normal file
@@ -0,0 +1,342 @@
|
||||
:github_url: hide
|
||||
|
||||
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
||||
.. DO NOT EDIT THIS FILE, but the Vector4i.xml source instead.
|
||||
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
||||
|
||||
.. _class_Vector4i:
|
||||
|
||||
Vector4i
|
||||
========
|
||||
|
||||
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------+-------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`w<class_Vector4i_property_w>` | ``0`` |
|
||||
+-----------------------+-------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`x<class_Vector4i_property_x>` | ``0`` |
|
||||
+-----------------------+-------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`y<class_Vector4i_property_y>` | ``0`` |
|
||||
+-----------------------+-------------------------------------+-------+
|
||||
| :ref:`int<class_int>` | :ref:`z<class_Vector4i_property_z>` | ``0`` |
|
||||
+-----------------------+-------------------------------------+-------+
|
||||
|
||||
Constructors
|
||||
------------
|
||||
|
||||
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>` **(** **)** |
|
||||
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` from **)** |
|
||||
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>` **(** :ref:`Vector4<class_Vector4>` from **)** |
|
||||
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` w **)** |
|
||||
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`abs<class_Vector4i_method_abs>` **(** **)** |const| |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`clamp<class_Vector4i_method_clamp>` **(** :ref:`Vector4i<class_Vector4i>` min, :ref:`Vector4i<class_Vector4i>` max **)** |const| |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`length<class_Vector4i_method_length>` **(** **)** |const| |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`length_squared<class_Vector4i_method_length_squared>` **(** **)** |const| |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`max_axis_index<class_Vector4i_method_max_axis_index>` **(** **)** |const| |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`min_axis_index<class_Vector4i_method_min_axis_index>` **(** **)** |const| |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`sign<class_Vector4i_method_sign>` **(** **)** |const| |
|
||||
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Operators
|
||||
---------
|
||||
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator !=<class_Vector4i_operator_neq_bool>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator %<class_Vector4i_operator_mod_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator %<class_Vector4i_operator_mod_Vector4i>` **(** :ref:`int<class_int>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator *<class_Vector4i_operator_mul_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_Vector4i_operator_mul_Vector4>` **(** :ref:`float<class_float>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator *<class_Vector4i_operator_mul_Vector4i>` **(** :ref:`int<class_int>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator +<class_Vector4i_operator_sum_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator -<class_Vector4i_operator_dif_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator /<class_Vector4i_operator_div_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4<class_Vector4>` | :ref:`operator /<class_Vector4i_operator_div_Vector4>` **(** :ref:`float<class_float>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator /<class_Vector4i_operator_div_Vector4i>` **(** :ref:`int<class_int>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator <<class_Vector4i_operator_lt_bool>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator <=<class_Vector4i_operator_lte_bool>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator ==<class_Vector4i_operator_eq_bool>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator ><class_Vector4i_operator_gt_bool>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`operator >=<class_Vector4i_operator_gte_bool>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`operator []<class_Vector4i_operator_idx_int>` **(** :ref:`int<class_int>` index **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator unary+<class_Vector4i_operator_unplus_Vector4i>` **(** **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator unary-<class_Vector4i_operator_unminus_Vector4i>` **(** **)** |
|
||||
+---------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Constants
|
||||
---------
|
||||
|
||||
.. _class_Vector4i_constant_AXIS_X:
|
||||
|
||||
.. _class_Vector4i_constant_AXIS_Y:
|
||||
|
||||
.. _class_Vector4i_constant_AXIS_Z:
|
||||
|
||||
.. _class_Vector4i_constant_AXIS_W:
|
||||
|
||||
.. _class_Vector4i_constant_ZERO:
|
||||
|
||||
.. _class_Vector4i_constant_ONE:
|
||||
|
||||
- **AXIS_X** = **0**
|
||||
|
||||
- **AXIS_Y** = **1**
|
||||
|
||||
- **AXIS_Z** = **2**
|
||||
|
||||
- **AXIS_W** = **3**
|
||||
|
||||
- **ZERO** = **Vector4i(0, 0, 0)**
|
||||
|
||||
- **ONE** = **Vector4i(1, 1, 1)**
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Vector4i_property_w:
|
||||
|
||||
- :ref:`int<class_int>` **w**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_property_x:
|
||||
|
||||
- :ref:`int<class_int>` **x**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_property_y:
|
||||
|
||||
- :ref:`int<class_int>` **y**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_property_z:
|
||||
|
||||
- :ref:`int<class_int>` **z**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
Constructor Descriptions
|
||||
------------------------
|
||||
|
||||
.. _class_Vector4i_constructor_Vector4i:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **Vector4i** **(** **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **Vector4i** **(** :ref:`Vector4i<class_Vector4i>` from **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **Vector4i** **(** :ref:`Vector4<class_Vector4>` from **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **Vector4i** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` w **)**
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Vector4i_method_abs:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **abs** **(** **)** |const|
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_method_clamp:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **clamp** **(** :ref:`Vector4i<class_Vector4i>` min, :ref:`Vector4i<class_Vector4i>` max **)** |const|
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_method_length:
|
||||
|
||||
- :ref:`float<class_float>` **length** **(** **)** |const|
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_method_length_squared:
|
||||
|
||||
- :ref:`int<class_int>` **length_squared** **(** **)** |const|
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_method_max_axis_index:
|
||||
|
||||
- :ref:`int<class_int>` **max_axis_index** **(** **)** |const|
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_method_min_axis_index:
|
||||
|
||||
- :ref:`int<class_int>` **min_axis_index** **(** **)** |const|
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_method_sign:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **sign** **(** **)** |const|
|
||||
|
||||
Operator Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Vector4i_operator_neq_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator !=** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_mod_Vector4i:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator %** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator %** **(** :ref:`int<class_int>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_mul_Vector4i:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator *** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Vector4<class_Vector4>` **operator *** **(** :ref:`float<class_float>` right **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator *** **(** :ref:`int<class_int>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_sum_Vector4i:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator +** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_dif_Vector4i:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator -** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_div_Vector4i:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator /** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Vector4<class_Vector4>` **operator /** **(** :ref:`float<class_float>` right **)**
|
||||
|
||||
----
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator /** **(** :ref:`int<class_int>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_lt_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator <** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_lte_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator <=** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_eq_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator ==** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_gt_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator >** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_gte_bool:
|
||||
|
||||
- :ref:`bool<class_bool>` **operator >=** **(** :ref:`Vector4i<class_Vector4i>` right **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_idx_int:
|
||||
|
||||
- :ref:`int<class_int>` **operator []** **(** :ref:`int<class_int>` index **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_unplus_Vector4i:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator unary+** **(** **)**
|
||||
|
||||
----
|
||||
|
||||
.. _class_Vector4i_operator_unminus_Vector4i:
|
||||
|
||||
- :ref:`Vector4i<class_Vector4i>` **operator unary-** **(** **)**
|
||||
|
||||
.. |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.)`
|
||||
Reference in New Issue
Block a user