mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Sync with current master branch
This commit is contained in:
Rémi Verschelde
@@ -471,21 +471,19 @@ Numeric Constants
|
||||
- **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis<class_basis>`.
|
||||
- **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform<class_transform>`.
|
||||
- **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color<class_color>`.
|
||||
- **TYPE_IMAGE** = **15** --- Variable is of type :ref:`Image<class_image>`.
|
||||
- **TYPE_NODE_PATH** = **16** --- Variable is of type :ref:`NodePath<class_nodepath>`.
|
||||
- **TYPE_RID** = **17** --- Variable is of type :ref:`RID<class_rid>`.
|
||||
- **TYPE_OBJECT** = **18** --- Variable is of type :ref:`Object<class_object>`.
|
||||
- **TYPE_INPUT_EVENT** = **19** --- Variable is of type :ref:`InputEvent<class_inputevent>`.
|
||||
- **TYPE_DICTIONARY** = **20** --- Variable is of type :ref:`Dictionary<class_dictionary>`.
|
||||
- **TYPE_ARRAY** = **21** --- Variable is of type :ref:`Array<class_array>`.
|
||||
- **TYPE_RAW_ARRAY** = **22**
|
||||
- **TYPE_INT_ARRAY** = **23**
|
||||
- **TYPE_REAL_ARRAY** = **24**
|
||||
- **TYPE_STRING_ARRAY** = **25**
|
||||
- **TYPE_VECTOR2_ARRAY** = **26**
|
||||
- **TYPE_VECTOR3_ARRAY** = **27**
|
||||
- **TYPE_COLOR_ARRAY** = **28**
|
||||
- **TYPE_MAX** = **29**
|
||||
- **TYPE_NODE_PATH** = **15** --- Variable is of type :ref:`NodePath<class_nodepath>`.
|
||||
- **TYPE_RID** = **16** --- Variable is of type :ref:`RID<class_rid>`.
|
||||
- **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object<class_object>`.
|
||||
- **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary<class_dictionary>`.
|
||||
- **TYPE_ARRAY** = **19** --- Variable is of type :ref:`Array<class_array>`.
|
||||
- **TYPE_RAW_ARRAY** = **20**
|
||||
- **TYPE_INT_ARRAY** = **21**
|
||||
- **TYPE_REAL_ARRAY** = **22**
|
||||
- **TYPE_STRING_ARRAY** = **23**
|
||||
- **TYPE_VECTOR2_ARRAY** = **24**
|
||||
- **TYPE_VECTOR3_ARRAY** = **25**
|
||||
- **TYPE_COLOR_ARRAY** = **26**
|
||||
- **TYPE_MAX** = **27**
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
.. 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_@DLScript:
|
||||
.. _class_@Native:
|
||||
|
||||
@DLScript
|
||||
=========
|
||||
@Native
|
||||
=======
|
||||
|
||||
**Category:** Core
|
||||
|
||||
@@ -44,7 +44,11 @@ Signals
|
||||
-------
|
||||
|
||||
- **confirmed** **(** **)**
|
||||
Emitted when accepted.
|
||||
|
||||
- **custom_action** **(** :ref:`String<class_string>` action **)**
|
||||
Emitted with a custom button is added.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -58,7 +58,11 @@ Signals
|
||||
-------
|
||||
|
||||
- **animation_finished** **(** **)**
|
||||
Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn, before looping.
|
||||
|
||||
- **frame_changed** **(** **)**
|
||||
Emitted when frame is changed.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -42,6 +42,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **frame_changed** **(** **)**
|
||||
Emitted when frame is changed.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -100,8 +100,14 @@ Signals
|
||||
-------
|
||||
|
||||
- **animation_changed** **(** :ref:`String<class_string>` old_name, :ref:`String<class_string>` new_name **)**
|
||||
If the currently being played animation changes, this signal will notify of such change.
|
||||
|
||||
- **animation_finished** **(** :ref:`String<class_string>` name **)**
|
||||
Notifies when an animation finished playing.
|
||||
|
||||
- **animation_started** **(** :ref:`String<class_string>` name **)**
|
||||
Notifies when an animation starts playing.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -18,89 +18,105 @@ General purpose area detection and influence for 3D physics.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area_get_angular_damp>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area_get_collision_mask>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area_get_gravity>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area_get_gravity_distance_scale>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity_vector<class_Area_get_gravity_vector>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_layer_mask<class_Area_get_layer_mask>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_layer_mask_bit<class_Area_get_layer_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area_get_linear_damp>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area_get_overlapping_areas>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area_get_overlapping_bodies>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_priority<class_Area_get_priority>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area_get_space_override_mode>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area_is_monitorable>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area_is_monitoring>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area_overlaps_body>` **(** :ref:`Object<class_object>` body **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_angular_damp<class_Area_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_Area_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Area_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_distance_scale<class_Area_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_is_point<class_Area_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_vector<class_Area_set_gravity_vector>` **(** :ref:`Vector3<class_vector3>` vector **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_layer_mask<class_Area_set_layer_mask>` **(** :ref:`int<class_int>` layer_mask **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_layer_mask_bit<class_Area_set_layer_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_linear_damp<class_Area_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitorable<class_Area_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitoring<class_Area_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_priority<class_Area_set_priority>` **(** :ref:`float<class_float>` priority **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_space_override_mode<class_Area_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area_get_angular_damp>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Area_get_collision_layer>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area_get_collision_mask>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area_get_gravity>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area_get_gravity_distance_scale>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity_vector<class_Area_get_gravity_vector>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area_get_linear_damp>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area_get_overlapping_areas>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area_get_overlapping_bodies>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_priority<class_Area_get_priority>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area_get_space_override_mode>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area_is_monitorable>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area_is_monitoring>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area_overlaps_body>` **(** :ref:`Object<class_object>` body **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_angular_damp<class_Area_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer<class_Area_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_Area_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Area_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_distance_scale<class_Area_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_is_point<class_Area_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_vector<class_Area_set_gravity_vector>` **(** :ref:`Vector3<class_vector3>` vector **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_linear_damp<class_Area_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitorable<class_Area_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitoring<class_Area_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_priority<class_Area_set_priority>` **(** :ref:`float<class_float>` priority **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_space_override_mode<class_Area_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **area_entered** **(** :ref:`Object<class_object>` area **)**
|
||||
This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area.
|
||||
|
||||
- **area_exited** **(** :ref:`Object<class_object>` area **)**
|
||||
This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area.
|
||||
|
||||
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
This signal triggers only once when an area enters this area. The first parameter is the area's :ref:`RID<class_rid>`. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
|
||||
|
||||
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
This signal triggers only once when an area exits this area. The first parameter is the area's :ref:`RID<class_rid>`. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
|
||||
|
||||
- **body_entered** **(** :ref:`Object<class_object>` body **)**
|
||||
This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area.
|
||||
|
||||
- **body_exited** **(** :ref:`Object<class_object>` body **)**
|
||||
This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area.
|
||||
|
||||
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
This signal triggers only once when a body enters this area. The first parameter is the body's :ref:`RID<class_rid>`. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering.
|
||||
|
||||
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
This signal triggers only once when a body exits this area. The first parameter is the body's :ref:`RID<class_rid>`. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`float<class_float>` **angular_damp**
|
||||
- :ref:`int<class_int>` **collision_layers**
|
||||
- :ref:`int<class_int>` **collision_layer**
|
||||
- :ref:`int<class_int>` **collision_mask**
|
||||
- :ref:`float<class_float>` **gravity**
|
||||
- :ref:`float<class_float>` **gravity_distance_scale**
|
||||
@@ -126,6 +142,18 @@ Member Function Description
|
||||
|
||||
Return the angular damp rate.
|
||||
|
||||
.. _class_Area_get_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
||||
|
||||
Return the physics layer this area is in.
|
||||
|
||||
.. _class_Area_get_collision_layer_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the layer mask.
|
||||
|
||||
.. _class_Area_get_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
|
||||
@@ -156,18 +184,6 @@ Return the falloff factor for point gravity.
|
||||
|
||||
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
|
||||
|
||||
.. _class_Area_get_layer_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_layer_mask** **(** **)** const
|
||||
|
||||
Return the physics layer this area is in.
|
||||
|
||||
.. _class_Area_get_layer_mask_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_layer_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the layer mask.
|
||||
|
||||
.. _class_Area_get_linear_damp:
|
||||
|
||||
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
|
||||
@@ -236,6 +252,22 @@ Set the rate at which objects stop spinning in this area, if there are not any o
|
||||
|
||||
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
|
||||
|
||||
.. _class_Area_set_collision_layer:
|
||||
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
||||
|
||||
Set the physics layers this area is in.
|
||||
|
||||
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask<class_Area_set_collision_mask>`.
|
||||
|
||||
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
|
||||
|
||||
.. _class_Area_set_collision_layer_bit:
|
||||
|
||||
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
|
||||
|
||||
.. _class_Area_set_collision_mask:
|
||||
|
||||
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
|
||||
@@ -276,22 +308,6 @@ Set the gravity vector. This vector does not have to be normalized.
|
||||
|
||||
If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
|
||||
|
||||
.. _class_Area_set_layer_mask:
|
||||
|
||||
- void **set_layer_mask** **(** :ref:`int<class_int>` layer_mask **)**
|
||||
|
||||
Set the physics layers this area is in.
|
||||
|
||||
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask<class_Area_set_collision_mask>`.
|
||||
|
||||
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
|
||||
|
||||
.. _class_Area_set_layer_mask_bit:
|
||||
|
||||
- void **set_layer_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
|
||||
|
||||
.. _class_Area_set_linear_damp:
|
||||
|
||||
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
|
||||
|
||||
@@ -18,89 +18,105 @@ General purpose area detection and influence for 2D physics.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area2D_get_angular_damp>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area2D_get_collision_mask>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area2D_get_gravity>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area2D_get_gravity_distance_scale>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_gravity_vector<class_Area2D_get_gravity_vector>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_layer_mask<class_Area2D_get_layer_mask>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_layer_mask_bit<class_Area2D_get_layer_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area2D_get_linear_damp>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area2D_get_overlapping_areas>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area2D_get_overlapping_bodies>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_priority<class_Area2D_get_priority>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area2D_get_space_override_mode>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area2D_is_monitorable>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area2D_is_monitoring>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_overlaps_body>` **(** :ref:`Object<class_object>` body **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_angular_damp<class_Area2D_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_Area2D_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Area2D_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_distance_scale<class_Area2D_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_is_point<class_Area2D_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>` **(** :ref:`Vector2<class_vector2>` vector **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_layer_mask<class_Area2D_set_layer_mask>` **(** :ref:`int<class_int>` layer_mask **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_layer_mask_bit<class_Area2D_set_layer_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_linear_damp<class_Area2D_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitorable<class_Area2D_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitoring<class_Area2D_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_priority<class_Area2D_set_priority>` **(** :ref:`float<class_float>` priority **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_space_override_mode<class_Area2D_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area2D_get_angular_damp>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Area2D_get_collision_layer>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_Area2D_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area2D_get_collision_mask>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area2D_get_gravity>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area2D_get_gravity_distance_scale>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_gravity_vector<class_Area2D_get_gravity_vector>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area2D_get_linear_damp>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area2D_get_overlapping_areas>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area2D_get_overlapping_bodies>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_priority<class_Area2D_get_priority>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area2D_get_space_override_mode>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area2D_is_monitorable>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_monitoring<class_Area2D_is_monitoring>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_overlaps_body>` **(** :ref:`Object<class_object>` body **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_angular_damp<class_Area2D_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer<class_Area2D_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_Area2D_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask<class_Area2D_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Area2D_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_distance_scale<class_Area2D_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_is_point<class_Area2D_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>` **(** :ref:`Vector2<class_vector2>` vector **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_linear_damp<class_Area2D_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitorable<class_Area2D_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_monitoring<class_Area2D_set_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_priority<class_Area2D_set_priority>` **(** :ref:`float<class_float>` priority **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_space_override_mode<class_Area2D_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **area_entered** **(** :ref:`Object<class_object>` area **)**
|
||||
This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area.
|
||||
|
||||
- **area_exited** **(** :ref:`Object<class_object>` area **)**
|
||||
This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area.
|
||||
|
||||
- **area_shape_entered** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
This signal triggers only once when an area enters this area. The first parameter is the area's :ref:`RID<class_rid>`. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
|
||||
|
||||
- **area_shape_exited** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` self_shape **)**
|
||||
This signal triggers only once when an area exits this area. The first parameter is the area's :ref:`RID<class_rid>`. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering.
|
||||
|
||||
- **body_entered** **(** :ref:`Object<class_object>` body **)**
|
||||
This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area.
|
||||
|
||||
- **body_exited** **(** :ref:`Object<class_object>` body **)**
|
||||
This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area.
|
||||
|
||||
- **body_shape_entered** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
This signal triggers only once when a body enters this area. The first parameter is the body's :ref:`RID<class_rid>`. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering.
|
||||
|
||||
- **body_shape_exited** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
|
||||
This signal triggers only once when a body exits this area. The first parameter is the body's :ref:`RID<class_rid>`. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`float<class_float>` **angular_damp**
|
||||
- :ref:`int<class_int>` **collision_layers**
|
||||
- :ref:`int<class_int>` **collision_layer**
|
||||
- :ref:`int<class_int>` **collision_mask**
|
||||
- :ref:`float<class_float>` **gravity**
|
||||
- :ref:`float<class_float>` **gravity_distance_scale**
|
||||
@@ -126,6 +142,18 @@ Member Function Description
|
||||
|
||||
Return the angular damp rate.
|
||||
|
||||
.. _class_Area2D_get_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
||||
|
||||
Return the physics layer this area is in.
|
||||
|
||||
.. _class_Area2D_get_collision_layer_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the layer mask.
|
||||
|
||||
.. _class_Area2D_get_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
|
||||
@@ -156,18 +184,6 @@ Return the falloff factor for point gravity.
|
||||
|
||||
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
|
||||
|
||||
.. _class_Area2D_get_layer_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_layer_mask** **(** **)** const
|
||||
|
||||
Return the physics layer this area is in.
|
||||
|
||||
.. _class_Area2D_get_layer_mask_bit:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_layer_mask_bit** **(** :ref:`int<class_int>` bit **)** const
|
||||
|
||||
Return an individual bit on the layer mask.
|
||||
|
||||
.. _class_Area2D_get_linear_damp:
|
||||
|
||||
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
|
||||
@@ -236,6 +252,22 @@ Set the rate at which objects stop spinning in this area, if there are not any o
|
||||
|
||||
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
|
||||
|
||||
.. _class_Area2D_set_collision_layer:
|
||||
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
||||
|
||||
Set the physics layers this area is in.
|
||||
|
||||
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask<class_Area2D_set_collision_mask>`.
|
||||
|
||||
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
|
||||
|
||||
.. _class_Area2D_set_collision_layer_bit:
|
||||
|
||||
- void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
|
||||
|
||||
.. _class_Area2D_set_collision_mask:
|
||||
|
||||
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
|
||||
@@ -276,22 +308,6 @@ Set the gravity vector. This vector does not have to be normalized.
|
||||
|
||||
If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
|
||||
|
||||
.. _class_Area2D_set_layer_mask:
|
||||
|
||||
- void **set_layer_mask** **(** :ref:`int<class_int>` layer_mask **)**
|
||||
|
||||
Set the physics layers this area is in.
|
||||
|
||||
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask<class_Area2D_set_collision_mask>`.
|
||||
|
||||
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
|
||||
|
||||
.. _class_Area2D_set_layer_mask_bit:
|
||||
|
||||
- void **set_layer_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
|
||||
|
||||
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
|
||||
|
||||
.. _class_Area2D_set_linear_damp:
|
||||
|
||||
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
|
||||
|
||||
203
classes/class_arraymesh.rst
Normal file
203
classes/class_arraymesh.rst
Normal file
@@ -0,0 +1,203 @@
|
||||
.. 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_ArrayMesh:
|
||||
|
||||
ArrayMesh
|
||||
=========
|
||||
|
||||
**Inherits:** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_shape<class_ArrayMesh_add_blend_shape>` **(** :ref:`String<class_string>` name **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_add_surface_from_arrays>` **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[], :ref:`int<class_int>` compress_flags=97792 **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`center_geometry<class_ArrayMesh_center_geometry>` **(** **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_blend_shapes<class_ArrayMesh_clear_blend_shapes>` **(** **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_get_blend_shape_count>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_mode<class_ArrayMesh_get_blend_shape_mode>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_ArrayMesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect3<class_rect3>` | :ref:`get_custom_aabb<class_ArrayMesh_get_custom_aabb>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_surface_count<class_ArrayMesh_get_surface_count>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`regen_normalmaps<class_ArrayMesh_regen_normalmaps>` **(** **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_shape_mode<class_ArrayMesh_set_blend_shape_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_custom_aabb<class_ArrayMesh_set_custom_aabb>` **(** :ref:`Rect3<class_rect3>` aabb **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_ArrayMesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_ArrayMesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_format<class_ArrayMesh_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Material<class_material>` | :ref:`surface_get_material<class_ArrayMesh_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`surface_get_name<class_ArrayMesh_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_primitive_type<class_ArrayMesh_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_remove<class_ArrayMesh_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_set_material<class_ArrayMesh_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_set_name<class_ArrayMesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present.
|
||||
- **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4).
|
||||
- **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3<class_vector3>` vertices).
|
||||
- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3<class_vector3>` normals).
|
||||
- **ARRAY_TANGENT** = **2** --- Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
|
||||
- **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color<class_color>` colors).
|
||||
- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3<class_vector3>` UVs or float array of groups of 2 floats (u,v)).
|
||||
- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3<class_vector3>` UVs or float array of groups of 2 floats (u,v)).
|
||||
- **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats.
|
||||
- **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats.
|
||||
- **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
|
||||
- **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory).
|
||||
- **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals
|
||||
- **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents
|
||||
- **ARRAY_FORMAT_COLOR** = **8** --- Array format will include a color array.
|
||||
- **ARRAY_FORMAT_TEX_UV** = **16** --- Array format will include UVs.
|
||||
- **ARRAY_FORMAT_TEX_UV2** = **32** --- Array format will include another set of UVs.
|
||||
- **ARRAY_FORMAT_BONES** = **64** --- Array format will include bone indices.
|
||||
- **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights.
|
||||
- **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used.
|
||||
- **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point).
|
||||
- **PRIMITIVE_LINES** = **1** --- Render array as lines (every two vertices a line is created).
|
||||
- **PRIMITIVE_LINE_STRIP** = **2** --- Render array as line strip.
|
||||
- **PRIMITIVE_LINE_LOOP** = **3** --- Render array as line loop (like line strip, but closed).
|
||||
- **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created).
|
||||
- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips.
|
||||
- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_ArrayMesh_add_blend_shape:
|
||||
|
||||
- void **add_blend_shape** **(** :ref:`String<class_string>` name **)**
|
||||
|
||||
.. _class_ArrayMesh_add_surface_from_arrays:
|
||||
|
||||
- void **add_surface_from_arrays** **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[], :ref:`int<class_int>` compress_flags=97792 **)**
|
||||
|
||||
Create a new surface (:ref:`get_surface_count<class_ArrayMesh_get_surface_count>` that will become surf_idx for this.
|
||||
|
||||
Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles).
|
||||
|
||||
.. _class_ArrayMesh_center_geometry:
|
||||
|
||||
- void **center_geometry** **(** **)**
|
||||
|
||||
.. _class_ArrayMesh_clear_blend_shapes:
|
||||
|
||||
- void **clear_blend_shapes** **(** **)**
|
||||
|
||||
.. _class_ArrayMesh_get_blend_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const
|
||||
|
||||
.. _class_ArrayMesh_get_blend_shape_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_shape_mode** **(** **)** const
|
||||
|
||||
.. _class_ArrayMesh_get_blend_shape_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
.. _class_ArrayMesh_get_custom_aabb:
|
||||
|
||||
- :ref:`Rect3<class_rect3>` **get_custom_aabb** **(** **)** const
|
||||
|
||||
.. _class_ArrayMesh_get_surface_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_surface_count** **(** **)** const
|
||||
|
||||
Return the amount of surfaces that the :ref:`ArrayMesh<class_arraymesh>` holds.
|
||||
|
||||
.. _class_ArrayMesh_regen_normalmaps:
|
||||
|
||||
- void **regen_normalmaps** **(** **)**
|
||||
|
||||
.. _class_ArrayMesh_set_blend_shape_mode:
|
||||
|
||||
- void **set_blend_shape_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_ArrayMesh_set_custom_aabb:
|
||||
|
||||
- void **set_custom_aabb** **(** :ref:`Rect3<class_rect3>` aabb **)**
|
||||
|
||||
.. _class_ArrayMesh_surface_get_array_index_len:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the length in indices of the index array in the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_array_len:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_format:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the format mask of the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_get_material:
|
||||
|
||||
- :ref:`Material<class_material>` **surface_get_material** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return a :ref:`Material<class_material>` in a given surface. Surface is rendered using this material.
|
||||
|
||||
.. _class_ArrayMesh_surface_get_name:
|
||||
|
||||
- :ref:`String<class_string>` **surface_get_name** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
.. _class_ArrayMesh_surface_get_primitive_type:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the primitive type of the requested surface (see :ref:`add_surface<class_ArrayMesh_add_surface>`).
|
||||
|
||||
.. _class_ArrayMesh_surface_remove:
|
||||
|
||||
- void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)**
|
||||
|
||||
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
|
||||
|
||||
.. _class_ArrayMesh_surface_set_material:
|
||||
|
||||
- void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)**
|
||||
|
||||
.. _class_ArrayMesh_surface_set_name:
|
||||
|
||||
- void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)**
|
||||
|
||||
Set a :ref:`Material<class_material>` for a given surface. Surface will be rendered using this material.
|
||||
|
||||
|
||||
@@ -18,37 +18,37 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_compute_cost<class_AStar__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_estimate_cost<class_AStar__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_pos_in_segment<class_AStar_get_closest_pos_in_segment>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_AStar_get_point_pos>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_compute_cost<class_AStar__compute_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_estimate_cost<class_AStar__estimate_cost>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** virtual |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_AStar_add_point>` **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`are_points_connected<class_AStar_are_points_connected>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_AStar_clear>` **(** **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`connect_points<class_AStar_connect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect_points<class_AStar_disconnect_points>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_available_point_id<class_AStar_get_available_point_id>` **(** **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_closest_point<class_AStar_get_closest_point>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_pos_in_segment<class_AStar_get_closest_pos_in_segment>` **(** :ref:`Vector3<class_vector3>` to_pos **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolIntArray<class_poolintarray>` | :ref:`get_id_path<class_AStar_get_id_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_point_path<class_AStar_get_point_path>` **(** :ref:`int<class_int>` from_id, :ref:`int<class_int>` to_id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_AStar_get_point_pos>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_point_weight_scale<class_AStar_get_point_weight_scale>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_AStar_remove_point>` **(** :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
@@ -65,6 +65,8 @@ Member Function Description
|
||||
|
||||
- void **add_point** **(** :ref:`int<class_int>` id, :ref:`Vector3<class_vector3>` pos, :ref:`float<class_float>` weight_scale=1 **)**
|
||||
|
||||
Add a new point at the given position. The ``weight_scale`` has to be 1 or larger.
|
||||
|
||||
.. _class_AStar_are_points_connected:
|
||||
|
||||
- :ref:`bool<class_bool>` **are_points_connected** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)** const
|
||||
@@ -75,7 +77,7 @@ Member Function Description
|
||||
|
||||
.. _class_AStar_connect_points:
|
||||
|
||||
- void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id **)**
|
||||
- void **connect_points** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` to_id, :ref:`bool<class_bool>` bidirectional=true **)**
|
||||
|
||||
.. _class_AStar_disconnect_points:
|
||||
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
.. 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_BakedLight:
|
||||
|
||||
BakedLight
|
||||
==========
|
||||
|
||||
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bake<class_BakedLight_bake>` **(** **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bake_lights<class_BakedLight_bake_lights>` **(** **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`bake_radiance<class_BakedLight_bake_radiance>` **(** **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`debug_mesh_albedo<class_BakedLight_debug_mesh_albedo>` **(** **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`debug_mesh_light<class_BakedLight_debug_mesh_light>` **(** **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_cell_subdiv<class_BakedLight_get_cell_subdiv>` **(** **)** const |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_cell_subdiv<class_BakedLight_set_cell_subdiv>` **(** :ref:`int<class_int>` steps **)** |
|
||||
+------------------------+----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **baked_light_changed** **(** **)**
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **cell_subdiv**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_BakedLight_bake:
|
||||
|
||||
- void **bake** **(** **)**
|
||||
|
||||
.. _class_BakedLight_bake_lights:
|
||||
|
||||
- void **bake_lights** **(** **)**
|
||||
|
||||
.. _class_BakedLight_bake_radiance:
|
||||
|
||||
- void **bake_radiance** **(** **)**
|
||||
|
||||
.. _class_BakedLight_debug_mesh_albedo:
|
||||
|
||||
- void **debug_mesh_albedo** **(** **)**
|
||||
|
||||
.. _class_BakedLight_debug_mesh_light:
|
||||
|
||||
- void **debug_mesh_light** **(** **)**
|
||||
|
||||
.. _class_BakedLight_get_cell_subdiv:
|
||||
|
||||
- :ref:`int<class_int>` **get_cell_subdiv** **(** **)** const
|
||||
|
||||
.. _class_BakedLight_set_cell_subdiv:
|
||||
|
||||
- void **set_cell_subdiv** **(** :ref:`int<class_int>` steps **)**
|
||||
|
||||
|
||||
@@ -62,9 +62,17 @@ Signals
|
||||
-------
|
||||
|
||||
- **button_down** **(** **)**
|
||||
Emitted when the button starts being held down.
|
||||
|
||||
- **button_up** **(** **)**
|
||||
Emitted when the button stops being held down.
|
||||
|
||||
- **pressed** **(** **)**
|
||||
This signal is emitted every time the button is toggled or pressed (i.e. activated, so on ``button_down`` if "Click on press" is active and on ``button_up`` otherwise).
|
||||
|
||||
- **toggled** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the *pressed* argument.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -19,6 +19,8 @@ Member Functions
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Quat<class_quat>` from **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` euler **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`Basis<class_Basis_Basis>` **(** :ref:`Vector3<class_vector3>` x_axis, :ref:`Vector3<class_vector3>` y_axis, :ref:`Vector3<class_vector3>` z_axis **)** |
|
||||
@@ -39,6 +41,12 @@ Member Functions
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Basis<class_basis>` | :ref:`scaled<class_Basis_scaled>` **(** :ref:`Vector3<class_vector3>` scale **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotation_axis_angle<class_Basis_set_rotation_axis_angle>` **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotation_euler<class_Basis_set_rotation_euler>` **(** :ref:`Vector3<class_vector3>` euler **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_scale<class_Basis_set_scale>` **(** :ref:`Vector3<class_vector3>` scale **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tdotx<class_Basis_tdotx>` **(** :ref:`Vector3<class_vector3>` with **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`tdoty<class_Basis_tdoty>` **(** :ref:`Vector3<class_vector3>` with **)** |
|
||||
@@ -77,6 +85,12 @@ Create a rotation matrix from the given quaternion.
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
|
||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` euler **)**
|
||||
|
||||
Create a rotation matrix (in the XYZ convention: first Z, then Y, and X last) from the specified Euler angles, given in the vector format as (third, second, first).
|
||||
|
||||
.. _class_Basis_Basis:
|
||||
|
||||
- :ref:`Basis<class_basis>` **Basis** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
|
||||
|
||||
Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector.
|
||||
@@ -97,9 +111,7 @@ Return the determinant of the matrix.
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_euler** **(** **)**
|
||||
|
||||
Return Euler angles (in the XYZ convention: first Z, then Y, and X last) from the matrix. Returned vector contains the rotation angles in the format (third,second,first).
|
||||
|
||||
This function only works if the matrix represents a proper rotation.
|
||||
Assuming that the matrix is a proper rotation matrix (orthonormal matrix with determinant +1), return Euler angles (in the XYZ convention: first Z, then Y, and X last). Returned vector contains the rotation angles in the format (third,second,first).
|
||||
|
||||
.. _class_Basis_get_orthogonal_index:
|
||||
|
||||
@@ -129,7 +141,7 @@ Return the orthonormalized version of the matrix (useful to call from time to ti
|
||||
|
||||
- :ref:`Basis<class_basis>` **rotated** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` phi **)**
|
||||
|
||||
Introduce an additional rotation around the given axis by phi. Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`. The axis must be a normalized vector.
|
||||
Introduce an additional rotation around the given axis by phi (radians). Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`. The axis must be a normalized vector.
|
||||
|
||||
.. _class_Basis_scaled:
|
||||
|
||||
@@ -137,6 +149,24 @@ Introduce an additional rotation around the given axis by phi. Only relevant whe
|
||||
|
||||
Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of :ref:`Transform<class_transform>`.
|
||||
|
||||
.. _class_Basis_set_rotation_axis_angle:
|
||||
|
||||
- void **set_rotation_axis_angle** **(** :ref:`Vector3<class_vector3>` axis, :ref:`float<class_float>` angle **)**
|
||||
|
||||
Changes only the rotation part of the :ref:`Basis<class_basis>` to a rotation around given axis by phi, while preserving the scaling part (as determined by get_scale).
|
||||
|
||||
.. _class_Basis_set_rotation_euler:
|
||||
|
||||
- void **set_rotation_euler** **(** :ref:`Vector3<class_vector3>` euler **)**
|
||||
|
||||
Changes only the rotation part of the :ref:`Basis<class_basis>` to a rotation corresponding to given Euler angles, while preserving the scaling part (as determined by get_scale).
|
||||
|
||||
.. _class_Basis_set_scale:
|
||||
|
||||
- void **set_scale** **(** :ref:`Vector3<class_vector3>` scale **)**
|
||||
|
||||
Changes only the scaling part of the Basis to the specified scaling, while preserving the rotation part (as determined by get_rotation).
|
||||
|
||||
.. _class_Basis_tdotx:
|
||||
|
||||
- :ref:`float<class_float>` **tdotx** **(** :ref:`Vector3<class_vector3>` with **)**
|
||||
|
||||
@@ -21,7 +21,7 @@ Member Functions
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create<class_BitMap_create>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create_from_image_alpha<class_BitMap_create_from_image_alpha>` **(** :ref:`Image<class_image>` image **)** |
|
||||
| void | :ref:`create_from_image_alpha<class_BitMap_create_from_image_alpha>` **(** :ref:`Object<class_object>` image **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_bit<class_BitMap_get_bit>` **(** :ref:`Vector2<class_vector2>` pos **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -48,7 +48,7 @@ Member Function Description
|
||||
|
||||
.. _class_BitMap_create_from_image_alpha:
|
||||
|
||||
- void **create_from_image_alpha** **(** :ref:`Image<class_image>` image **)**
|
||||
- void **create_from_image_alpha** **(** :ref:`Object<class_object>` image **)**
|
||||
|
||||
.. _class_BitMap_get_bit:
|
||||
|
||||
|
||||
@@ -1,178 +0,0 @@
|
||||
.. 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_ButtonArray:
|
||||
|
||||
ButtonArray
|
||||
===========
|
||||
|
||||
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`HButtonArray<class_hbuttonarray>`, :ref:`VButtonArray<class_vbuttonarray>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Array of Buttons.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_button<class_ButtonArray_add_button>` **(** :ref:`String<class_string>` text, :ref:`String<class_string>` tooltip="" **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_icon_button<class_ButtonArray_add_icon_button>` **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="", :ref:`String<class_string>` tooltip="" **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_ButtonArray_clear>` **(** **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_button<class_ButtonArray_erase_button>` **(** :ref:`int<class_int>` button_idx **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_button_count<class_ButtonArray_get_button_count>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_ButtonArray_get_button_icon>` **(** :ref:`int<class_int>` button_idx **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_button_text<class_ButtonArray_get_button_text>` **(** :ref:`int<class_int>` button_idx **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_button_tooltip<class_ButtonArray_get_button_tooltip>` **(** :ref:`int<class_int>` button_idx **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_hovered<class_ButtonArray_get_hovered>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_selected<class_ButtonArray_get_selected>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_flat<class_ButtonArray_is_flat>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_button_icon<class_ButtonArray_set_button_icon>` **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_button_text<class_ButtonArray_set_button_text>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_button_tooltip<class_ButtonArray_set_button_tooltip>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flat<class_ButtonArray_set_flat>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_selected<class_ButtonArray_set_selected>` **(** :ref:`int<class_int>` button_idx **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **button_selected** **(** :ref:`int<class_int>` button_idx **)**
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`bool<class_bool>` **flat**
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **ALIGN_BEGIN** = **0** --- Align buttons at the beginning.
|
||||
- **ALIGN_CENTER** = **1** --- Align buttons in the middle.
|
||||
- **ALIGN_END** = **2** --- Align buttons at the end.
|
||||
- **ALIGN_FILL** = **3** --- Spread the buttons, but keep them small.
|
||||
- **ALIGN_EXPAND_FILL** = **4** --- Spread the buttons, but expand them.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Array of Buttons. A ButtonArray is useful to have an array of buttons laid out vertically or horizontally. Only one button can be selected, and is referenced by its index in the array (first button is 0, second button is 1, etc.).
|
||||
|
||||
This is useful *e.g.* for joypad-friendly interfaces and option menus.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_ButtonArray_add_button:
|
||||
|
||||
- void **add_button** **(** :ref:`String<class_string>` text, :ref:`String<class_string>` tooltip="" **)**
|
||||
|
||||
Append a new button to the array, with the specified text and tooltip.
|
||||
|
||||
.. _class_ButtonArray_add_icon_button:
|
||||
|
||||
- void **add_icon_button** **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="", :ref:`String<class_string>` tooltip="" **)**
|
||||
|
||||
Append a new button to the array, with the specified icon, text and tooltip.
|
||||
|
||||
.. _class_ButtonArray_clear:
|
||||
|
||||
- void **clear** **(** **)**
|
||||
|
||||
Remove all buttons from the array.
|
||||
|
||||
.. _class_ButtonArray_erase_button:
|
||||
|
||||
- void **erase_button** **(** :ref:`int<class_int>` button_idx **)**
|
||||
|
||||
Remove the specified button in the array.
|
||||
|
||||
.. _class_ButtonArray_get_button_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_button_count** **(** **)** const
|
||||
|
||||
Return the amount of buttons in the array.
|
||||
|
||||
.. _class_ButtonArray_get_button_icon:
|
||||
|
||||
- :ref:`Texture<class_texture>` **get_button_icon** **(** :ref:`int<class_int>` button_idx **)** const
|
||||
|
||||
Return the icon of the specified button.
|
||||
|
||||
.. _class_ButtonArray_get_button_text:
|
||||
|
||||
- :ref:`String<class_string>` **get_button_text** **(** :ref:`int<class_int>` button_idx **)** const
|
||||
|
||||
Return the text of the specified button.
|
||||
|
||||
.. _class_ButtonArray_get_button_tooltip:
|
||||
|
||||
- :ref:`String<class_string>` **get_button_tooltip** **(** :ref:`int<class_int>` button_idx **)** const
|
||||
|
||||
Return the tooltip of the specified button.
|
||||
|
||||
.. _class_ButtonArray_get_hovered:
|
||||
|
||||
- :ref:`int<class_int>` **get_hovered** **(** **)** const
|
||||
|
||||
Return the index of the currently hovered button in the array.
|
||||
|
||||
.. _class_ButtonArray_get_selected:
|
||||
|
||||
- :ref:`int<class_int>` **get_selected** **(** **)** const
|
||||
|
||||
Return the index of the currently selected button in the array.
|
||||
|
||||
.. _class_ButtonArray_is_flat:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_flat** **(** **)** const
|
||||
|
||||
.. _class_ButtonArray_set_button_icon:
|
||||
|
||||
- void **set_button_icon** **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)**
|
||||
|
||||
Set the icon of the specified button.
|
||||
|
||||
.. _class_ButtonArray_set_button_text:
|
||||
|
||||
- void **set_button_text** **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)**
|
||||
|
||||
Define the text of the specified button.
|
||||
|
||||
.. _class_ButtonArray_set_button_tooltip:
|
||||
|
||||
- void **set_button_tooltip** **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)**
|
||||
|
||||
Define the tooltip of the specified button.
|
||||
|
||||
.. _class_ButtonArray_set_flat:
|
||||
|
||||
- void **set_flat** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_ButtonArray_set_selected:
|
||||
|
||||
- void **set_selected** **(** :ref:`int<class_int>` button_idx **)**
|
||||
|
||||
Select a button in the array based on the given index.
|
||||
|
||||
|
||||
@@ -65,7 +65,7 @@ Member Functions
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_canvas_transform<class_CanvasItem_get_canvas_transform>` **(** **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_mouse_pos<class_CanvasItem_get_global_mouse_pos>` **(** **)** const |
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_mouse_position<class_CanvasItem_get_global_mouse_position>` **(** **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_global_transform<class_CanvasItem_get_global_transform>` **(** **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -111,7 +111,7 @@ Member Functions
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`make_canvas_pos_local<class_CanvasItem_make_canvas_pos_local>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`InputEvent<class_inputevent>` | :ref:`make_input_local<class_CanvasItem_make_input_local>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
|
||||
| :ref:`Object<class_object>` | :ref:`make_input_local<class_CanvasItem_make_input_local>` **(** :ref:`Object<class_object>` event **)** const |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -142,9 +142,17 @@ Signals
|
||||
-------
|
||||
|
||||
- **draw** **(** **)**
|
||||
Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing.
|
||||
|
||||
- **hide** **(** **)**
|
||||
Emitted when becoming hidden.
|
||||
|
||||
- **item_rect_changed** **(** **)**
|
||||
Emitted when the item rect has changed.
|
||||
|
||||
- **visibility_changed** **(** **)**
|
||||
Emitted when the visibility (hidden/visible) changes.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -296,7 +304,7 @@ Used for editing, handle rotation.
|
||||
|
||||
- void **edit_set_state** **(** :ref:`Variant<class_variant>` state **)**
|
||||
|
||||
Set the transform state of this CanvasItem. For :ref:`Node2D<class_node2d>`, this is an :ref:`Array<class_array>` with (in order) a :ref:`Vector2<class_vector2>` for position, a float for rotation and another :ref:`Vector2<class_vector2>` for scale. For :ref:`Control<class_control>` this is a :ref:`Rect2<class_rect2>` with the position and size.
|
||||
Set the transform state of this CanvasItem. For :ref:`Node2D<class_node2d>`, this is an :ref:`Array<class_array>` with (in order) a :ref:`Vector2<class_vector2>` for position, a float for rotation (radians) and another :ref:`Vector2<class_vector2>` for scale. For :ref:`Control<class_control>` this is a :ref:`Rect2<class_rect2>` with the position and size.
|
||||
|
||||
.. _class_CanvasItem_get_canvas:
|
||||
|
||||
@@ -316,9 +324,9 @@ Return the canvas item RID used by :ref:`VisualServer<class_visualserver>` for t
|
||||
|
||||
Get the transform matrix of this item's canvas.
|
||||
|
||||
.. _class_CanvasItem_get_global_mouse_pos:
|
||||
.. _class_CanvasItem_get_global_mouse_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_global_mouse_pos** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_global_mouse_position** **(** **)** const
|
||||
|
||||
Get the global position of the mouse.
|
||||
|
||||
@@ -448,9 +456,7 @@ Return true if this CanvasItem is visible. It may be invisible because itself or
|
||||
|
||||
.. _class_CanvasItem_make_input_local:
|
||||
|
||||
- :ref:`InputEvent<class_inputevent>` **make_input_local** **(** :ref:`InputEvent<class_inputevent>` event **)** const
|
||||
|
||||
Takes a global input event and convert to this item's coordinate system.
|
||||
- :ref:`Object<class_object>` **make_input_local** **(** :ref:`Object<class_object>` event **)** const
|
||||
|
||||
.. _class_CanvasItem_set_as_toplevel:
|
||||
|
||||
|
||||
@@ -88,13 +88,13 @@ Return the base offset for this layer (helper).
|
||||
|
||||
- :ref:`float<class_float>` **get_rotation** **(** **)** const
|
||||
|
||||
Return the base rotation for this layer (helper).
|
||||
Return the base rotation for this layer in radians (helper).
|
||||
|
||||
.. _class_CanvasLayer_get_rotationd:
|
||||
|
||||
- :ref:`float<class_float>` **get_rotationd** **(** **)** const
|
||||
|
||||
Get rotation of the layer in degree.
|
||||
Return the base rotation for this layer in degrees.
|
||||
|
||||
.. _class_CanvasLayer_get_scale:
|
||||
|
||||
@@ -134,13 +134,13 @@ Set the base offset for this layer (helper).
|
||||
|
||||
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
|
||||
|
||||
Set the base rotation for this layer (helper).
|
||||
Set the base rotation for this layer in radians (helper).
|
||||
|
||||
.. _class_CanvasLayer_set_rotationd:
|
||||
|
||||
- void **set_rotationd** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
Set rotation of the layer in degree.
|
||||
Set the base rotation for this layer in degrees (helper).
|
||||
|
||||
.. _class_CanvasLayer_set_scale:
|
||||
|
||||
|
||||
82
classes/class_capsulemesh.rst
Normal file
82
classes/class_capsulemesh.rst
Normal file
@@ -0,0 +1,82 @@
|
||||
.. 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_CapsuleMesh:
|
||||
|
||||
CapsuleMesh
|
||||
===========
|
||||
|
||||
**Inherits:** :ref:`PrimitiveMesh<class_primitivemesh>` **<** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_mid_height<class_CapsuleMesh_get_mid_height>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_radial_segments<class_CapsuleMesh_get_radial_segments>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleMesh_get_radius>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_rings<class_CapsuleMesh_get_rings>` **(** **)** const |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mid_height<class_CapsuleMesh_set_mid_height>` **(** :ref:`float<class_float>` mid_height **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radial_segments<class_CapsuleMesh_set_radial_segments>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radius<class_CapsuleMesh_set_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rings<class_CapsuleMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
|
||||
+----------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`float<class_float>` **mid_height**
|
||||
- :ref:`int<class_int>` **radial_segments**
|
||||
- :ref:`float<class_float>` **radius**
|
||||
- :ref:`int<class_int>` **rings**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_CapsuleMesh_get_mid_height:
|
||||
|
||||
- :ref:`float<class_float>` **get_mid_height** **(** **)** const
|
||||
|
||||
.. _class_CapsuleMesh_get_radial_segments:
|
||||
|
||||
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
||||
|
||||
.. _class_CapsuleMesh_get_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_radius** **(** **)** const
|
||||
|
||||
.. _class_CapsuleMesh_get_rings:
|
||||
|
||||
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
||||
|
||||
.. _class_CapsuleMesh_set_mid_height:
|
||||
|
||||
- void **set_mid_height** **(** :ref:`float<class_float>` mid_height **)**
|
||||
|
||||
.. _class_CapsuleMesh_set_radial_segments:
|
||||
|
||||
- void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
|
||||
|
||||
.. _class_CapsuleMesh_set_radius:
|
||||
|
||||
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
.. _class_CapsuleMesh_set_rings:
|
||||
|
||||
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
||||
|
||||
|
||||
@@ -31,6 +31,8 @@ Member Functions
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`class_get_method_list<class_ClassDB_class_get_method_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`class_get_property<class_ClassDB_class_get_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`class_get_property_list<class_ClassDB_class_get_property_list>` **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`class_get_signal<class_ClassDB_class_get_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
|
||||
@@ -43,6 +45,8 @@ Member Functions
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`class_has_signal<class_ClassDB_class_has_signal>` **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Error | :ref:`class_set_property<class_ClassDB_class_set_property>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_class_list<class_ClassDB_get_class_list>` **(** **)** const |
|
||||
+------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_inheriters_from_class<class_ClassDB_get_inheriters_from_class>` **(** :ref:`String<class_string>` class **)** const |
|
||||
@@ -83,6 +87,10 @@ Member Function Description
|
||||
|
||||
- :ref:`Array<class_array>` **class_get_method_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
|
||||
.. _class_ClassDB_class_get_property:
|
||||
|
||||
- :ref:`Variant<class_variant>` **class_get_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property **)** const
|
||||
|
||||
.. _class_ClassDB_class_get_property_list:
|
||||
|
||||
- :ref:`Array<class_array>` **class_get_property_list** **(** :ref:`String<class_string>` class, :ref:`bool<class_bool>` no_inheritance=false **)** const
|
||||
@@ -107,6 +115,10 @@ Member Function Description
|
||||
|
||||
- :ref:`bool<class_bool>` **class_has_signal** **(** :ref:`String<class_string>` class, :ref:`String<class_string>` signal **)** const
|
||||
|
||||
.. _class_ClassDB_class_set_property:
|
||||
|
||||
- Error **class_set_property** **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** const
|
||||
|
||||
.. _class_ClassDB_get_class_list:
|
||||
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_class_list** **(** **)** const
|
||||
|
||||
@@ -57,7 +57,7 @@ Member Functions
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **input_event** **(** :ref:`Object<class_object>` camera, :ref:`InputEvent<class_inputevent>` event, :ref:`Vector3<class_vector3>` click_pos, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
|
||||
- **input_event** **(** :ref:`Object<class_object>` camera, :ref:`Object<class_object>` event, :ref:`Vector3<class_vector3>` click_pos, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
|
||||
- **mouse_entered** **(** **)**
|
||||
- **mouse_exited** **(** **)**
|
||||
|
||||
|
||||
@@ -53,9 +53,13 @@ Member Functions
|
||||
Signals
|
||||
-------
|
||||
|
||||
- **input_event** **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)**
|
||||
- **input_event** **(** :ref:`Object<class_object>` viewport, :ref:`Object<class_object>` event, :ref:`int<class_int>` shape_idx **)**
|
||||
- **mouse_entered** **(** **)**
|
||||
This event fires only once when the mouse pointer enters any shape of this object.
|
||||
|
||||
- **mouse_exited** **(** **)**
|
||||
This event fires only once when the mouse pointer exits all shapes of this object.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -74,8 +78,6 @@ Member Function Description
|
||||
|
||||
- void **_input_event** **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)** virtual
|
||||
|
||||
This method can be used to override normal input processing. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened.
|
||||
|
||||
.. _class_CollisionObject2D_add_shape:
|
||||
|
||||
- void **add_shape** **(** :ref:`Shape2D<class_shape2d>` shape, :ref:`Transform2D<class_transform2d>` transform=((1, 0), (0, 1), (0, 0)) **)**
|
||||
|
||||
@@ -38,6 +38,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **color_changed** **(** :ref:`Color<class_color>` color **)**
|
||||
Emitted when the color is changed.
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -34,6 +34,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **color_changed** **(** :ref:`Color<class_color>` color **)**
|
||||
Emitted when the color is changed.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -8,7 +8,7 @@ Container
|
||||
|
||||
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`PanelContainer<class_panelcontainer>`, :ref:`GridContainer<class_gridcontainer>`, :ref:`ScrollContainer<class_scrollcontainer>`, :ref:`ViewportContainer<class_viewportcontainer>`, :ref:`MarginContainer<class_margincontainer>`, :ref:`CenterContainer<class_centercontainer>`, :ref:`GraphNode<class_graphnode>`, :ref:`SplitContainer<class_splitcontainer>`, :ref:`BoxContainer<class_boxcontainer>`
|
||||
**Inherited By:** :ref:`PanelContainer<class_panelcontainer>`, :ref:`GridContainer<class_gridcontainer>`, :ref:`ScrollContainer<class_scrollcontainer>`, :ref:`ViewportContainer<class_viewportcontainer>`, :ref:`CenterContainer<class_centercontainer>`, :ref:`MarginContainer<class_margincontainer>`, :ref:`GraphNode<class_graphnode>`, :ref:`SplitContainer<class_splitcontainer>`, :ref:`BoxContainer<class_boxcontainer>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
@@ -30,6 +30,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **sort_children** **(** **)**
|
||||
Emitted when sorting the children is needed.
|
||||
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
@@ -8,7 +8,7 @@ Control
|
||||
|
||||
**Inherits:** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`TextureRect<class_texturerect>`, :ref:`ColorRect<class_colorrect>`, :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`ButtonArray<class_buttonarray>`, :ref:`GraphEdit<class_graphedit>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`NinePatchRect<class_ninepatchrect>`, :ref:`LineEdit<class_lineedit>`, :ref:`Container<class_container>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`ReferenceRect<class_referencerect>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`ItemList<class_itemlist>`
|
||||
**Inherited By:** :ref:`TextureRect<class_texturerect>`, :ref:`ColorRect<class_colorrect>`, :ref:`Label<class_label>`, :ref:`Tabs<class_tabs>`, :ref:`GraphEdit<class_graphedit>`, :ref:`VideoPlayer<class_videoplayer>`, :ref:`NinePatchRect<class_ninepatchrect>`, :ref:`LineEdit<class_lineedit>`, :ref:`Container<class_container>`, :ref:`TextEdit<class_textedit>`, :ref:`BaseButton<class_basebutton>`, :ref:`Popup<class_popup>`, :ref:`Tree<class_tree>`, :ref:`Separator<class_separator>`, :ref:`ReferenceRect<class_referencerect>`, :ref:`Panel<class_panel>`, :ref:`TabContainer<class_tabcontainer>`, :ref:`Range<class_range>`, :ref:`RichTextLabel<class_richtextlabel>`, :ref:`ItemList<class_itemlist>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
@@ -73,7 +73,7 @@ Member Functions
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Font<class_font>` | :ref:`get_font<class_Control_get_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_pos<class_Control_get_global_pos>` **(** **)** const |
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_position<class_Control_get_global_position>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_global_rect<class_Control_get_global_rect>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -91,7 +91,7 @@ Member Functions
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Control<class_control>` | :ref:`get_parent_control<class_Control_get_parent_control>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_pos<class_Control_get_pos>` **(** **)** const |
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_Control_get_position>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_Control_get_rect>` **(** **)** const |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -171,7 +171,7 @@ Member Functions
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_focus_neighbour<class_Control_set_focus_neighbour>` **(** :ref:`int<class_int>` margin, :ref:`NodePath<class_nodepath>` neighbour **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_global_pos<class_Control_set_global_pos>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||
| void | :ref:`set_global_position<class_Control_set_global_position>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_size_flags<class_Control_set_h_size_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -179,7 +179,7 @@ Member Functions
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_mouse_filter<class_Control_set_mouse_filter>` **(** :ref:`int<class_int>` filter **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pos<class_Control_set_pos>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||
| void | :ref:`set_position<class_Control_set_position>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rotation<class_Control_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
|
||||
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -206,14 +206,28 @@ Signals
|
||||
-------
|
||||
|
||||
- **focus_entered** **(** **)**
|
||||
Emitted when keyboard focus is gained.
|
||||
|
||||
- **focus_exited** **(** **)**
|
||||
- **gui_input** **(** :ref:`InputEvent<class_inputevent>` ev **)**
|
||||
Emitted when the keyboard focus is lost.
|
||||
|
||||
- **gui_input** **(** :ref:`Object<class_object>` ev **)**
|
||||
- **minimum_size_changed** **(** **)**
|
||||
Emitted when the minimum size of the control changed.
|
||||
|
||||
- **modal_closed** **(** **)**
|
||||
- **mouse_entered** **(** **)**
|
||||
Emitted when the mouse enters the control area.
|
||||
|
||||
- **mouse_exited** **(** **)**
|
||||
Emitted when the mouse left the control area.
|
||||
|
||||
- **resized** **(** **)**
|
||||
Emitted when the control changed size.
|
||||
|
||||
- **size_flags_changed** **(** **)**
|
||||
Emitted when the size flags changed.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -234,7 +248,7 @@ Member Variables
|
||||
- :ref:`int<class_int>` **mouse_filter**
|
||||
- :ref:`bool<class_bool>` **rect_clip_content**
|
||||
- :ref:`Vector2<class_vector2>` **rect_min_size**
|
||||
- :ref:`Vector2<class_vector2>` **rect_pos**
|
||||
- :ref:`Vector2<class_vector2>` **rect_position**
|
||||
- :ref:`float<class_float>` **rect_rotation**
|
||||
- :ref:`Vector2<class_vector2>` **rect_scale**
|
||||
- :ref:`Vector2<class_vector2>` **rect_size**
|
||||
@@ -292,7 +306,7 @@ Controls are relative to the parent position and size by using anchors and margi
|
||||
|
||||
Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range.
|
||||
|
||||
Input device events (:ref:`InputEvent<class_inputevent>`) are first sent to the root controls via the :ref:`Node._input<class_Node__input>`, which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling :ref:`MainLoop._input_event<class_MainLoop__input_event>`. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even :ref:`Node._unhandled_input<class_Node__unhandled_input>`), the control can accept it by calling :ref:`accept_event<class_Control_accept_event>`.
|
||||
Input device events are first sent to the root controls via the :ref:`Node._input<class_Node__input>`, which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling :ref:`MainLoop._input_event<class_MainLoop__input_event>`. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even :ref:`Node._unhandled_input<class_Node__unhandled_input>`), the control can accept it by calling :ref:`accept_event<class_Control_accept_event>`.
|
||||
|
||||
Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with :ref:`set_focus_mode<class_Control_set_focus_mode>`. Focus is lost when another control gains it, or the current focus owner is hidden.
|
||||
|
||||
@@ -313,8 +327,6 @@ Return the minimum size this Control can shrink to. A control will never be disp
|
||||
|
||||
- void **_gui_input** **(** :ref:`InputEvent<class_inputevent>` event **)** virtual
|
||||
|
||||
Called when an input event reaches the control.
|
||||
|
||||
.. _class_Control_accept_event:
|
||||
|
||||
- void **accept_event** **(** **)**
|
||||
@@ -435,9 +447,9 @@ Return which control is owning the keyboard focus, or null if no one.
|
||||
|
||||
- :ref:`Font<class_font>` **get_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const
|
||||
|
||||
.. _class_Control_get_global_pos:
|
||||
.. _class_Control_get_global_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_global_pos** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_global_position** **(** **)** const
|
||||
|
||||
Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
|
||||
|
||||
@@ -483,9 +495,9 @@ Return when the control is ignoring mouse events (even touchpad events send mous
|
||||
|
||||
- :ref:`Control<class_control>` **get_parent_control** **(** **)** const
|
||||
|
||||
.. _class_Control_get_pos:
|
||||
.. _class_Control_get_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_pos** **(** **)** const
|
||||
- :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
|
||||
|
||||
Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode.
|
||||
|
||||
@@ -499,10 +511,14 @@ Return position and size of the Control, relative to the top-left corner of the
|
||||
|
||||
- :ref:`float<class_float>` **get_rotation** **(** **)** const
|
||||
|
||||
Return the rotation (in radians)
|
||||
|
||||
.. _class_Control_get_rotation_deg:
|
||||
|
||||
- :ref:`float<class_float>` **get_rotation_deg** **(** **)** const
|
||||
|
||||
Return the rotation (in degrees)
|
||||
|
||||
.. _class_Control_get_scale:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_scale** **(** **)** const
|
||||
@@ -681,9 +697,9 @@ Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL).
|
||||
|
||||
Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function.
|
||||
|
||||
.. _class_Control_set_global_pos:
|
||||
.. _class_Control_set_global_position:
|
||||
|
||||
- void **set_global_pos** **(** :ref:`Vector2<class_vector2>` pos **)**
|
||||
- void **set_global_position** **(** :ref:`Vector2<class_vector2>` pos **)**
|
||||
|
||||
Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin<class_Control_set_margin>`).
|
||||
|
||||
@@ -705,9 +721,9 @@ Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT
|
||||
|
||||
Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER\_\* constants)
|
||||
|
||||
.. _class_Control_set_pos:
|
||||
.. _class_Control_set_position:
|
||||
|
||||
- void **set_pos** **(** :ref:`Vector2<class_vector2>` pos **)**
|
||||
- void **set_position** **(** :ref:`Vector2<class_vector2>` pos **)**
|
||||
|
||||
Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see :ref:`set_margin<class_Control_set_margin>`).
|
||||
|
||||
@@ -715,10 +731,14 @@ Move the Control to a new position, relative to the top-left corner of the paren
|
||||
|
||||
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
|
||||
|
||||
Set the rotation (in radians).
|
||||
|
||||
.. _class_Control_set_rotation_deg:
|
||||
|
||||
- void **set_rotation_deg** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
Set the rotation (in degrees).
|
||||
|
||||
.. _class_Control_set_scale:
|
||||
|
||||
- void **set_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
|
||||
|
||||
@@ -18,27 +18,27 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_storage<class_CubeMap_get_storage>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flags<class_CubeMap_set_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_lossy_storage_quality<class_CubeMap_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_storage<class_CubeMap_set_storage>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_storage<class_CubeMap_get_storage>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flags<class_CubeMap_set_flags>` **(** :ref:`int<class_int>` flags **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_lossy_storage_quality<class_CubeMap_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Object<class_object>` image **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_storage<class_CubeMap_set_storage>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+------------------------------+---------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -74,7 +74,7 @@ Member Function Description
|
||||
|
||||
.. _class_CubeMap_get_side:
|
||||
|
||||
- :ref:`Image<class_image>` **get_side** **(** :ref:`int<class_int>` side **)** const
|
||||
- :ref:`Object<class_object>` **get_side** **(** :ref:`int<class_int>` side **)** const
|
||||
|
||||
.. _class_CubeMap_get_storage:
|
||||
|
||||
@@ -94,7 +94,7 @@ Member Function Description
|
||||
|
||||
.. _class_CubeMap_set_side:
|
||||
|
||||
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)**
|
||||
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Object<class_object>` image **)**
|
||||
|
||||
.. _class_CubeMap_set_storage:
|
||||
|
||||
|
||||
82
classes/class_cubemesh.rst
Normal file
82
classes/class_cubemesh.rst
Normal file
@@ -0,0 +1,82 @@
|
||||
.. 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_CubeMesh:
|
||||
|
||||
CubeMesh
|
||||
========
|
||||
|
||||
**Inherits:** :ref:`PrimitiveMesh<class_primitivemesh>` **<** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_size<class_CubeMesh_get_size>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_depth<class_CubeMesh_get_subdivide_depth>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_height<class_CubeMesh_get_subdivide_height>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_width<class_CubeMesh_get_subdivide_width>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_CubeMesh_set_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_depth<class_CubeMesh_set_subdivide_depth>` **(** :ref:`int<class_int>` divisions **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_height<class_CubeMesh_set_subdivide_height>` **(** :ref:`int<class_int>` divisions **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_width<class_CubeMesh_set_subdivide_width>` **(** :ref:`int<class_int>` subdivide **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **size**
|
||||
- :ref:`int<class_int>` **subdivide_depth**
|
||||
- :ref:`int<class_int>` **subdivide_height**
|
||||
- :ref:`int<class_int>` **subdivide_width**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_CubeMesh_get_size:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
||||
|
||||
.. _class_CubeMesh_get_subdivide_depth:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
|
||||
|
||||
.. _class_CubeMesh_get_subdivide_height:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_height** **(** **)** const
|
||||
|
||||
.. _class_CubeMesh_get_subdivide_width:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
|
||||
|
||||
.. _class_CubeMesh_set_size:
|
||||
|
||||
- void **set_size** **(** :ref:`Vector3<class_vector3>` size **)**
|
||||
|
||||
.. _class_CubeMesh_set_subdivide_depth:
|
||||
|
||||
- void **set_subdivide_depth** **(** :ref:`int<class_int>` divisions **)**
|
||||
|
||||
.. _class_CubeMesh_set_subdivide_height:
|
||||
|
||||
- void **set_subdivide_height** **(** :ref:`int<class_int>` divisions **)**
|
||||
|
||||
.. _class_CubeMesh_set_subdivide_width:
|
||||
|
||||
- void **set_subdivide_width** **(** :ref:`int<class_int>` subdivide **)**
|
||||
|
||||
|
||||
95
classes/class_cylindermesh.rst
Normal file
95
classes/class_cylindermesh.rst
Normal file
@@ -0,0 +1,95 @@
|
||||
.. 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_CylinderMesh:
|
||||
|
||||
CylinderMesh
|
||||
============
|
||||
|
||||
**Inherits:** :ref:`PrimitiveMesh<class_primitivemesh>` **<** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_bottom_radius<class_CylinderMesh_get_bottom_radius>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_CylinderMesh_get_height>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_radial_segments<class_CylinderMesh_get_radial_segments>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_rings<class_CylinderMesh_get_rings>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_top_radius<class_CylinderMesh_get_top_radius>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_bottom_radius<class_CylinderMesh_set_bottom_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_CylinderMesh_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_radial_segments<class_CylinderMesh_set_radial_segments>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_rings<class_CylinderMesh_set_rings>` **(** :ref:`int<class_int>` rings **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_top_radius<class_CylinderMesh_set_top_radius>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`float<class_float>` **bottom_radius**
|
||||
- :ref:`float<class_float>` **height**
|
||||
- :ref:`int<class_int>` **radial_segments**
|
||||
- :ref:`int<class_int>` **rings**
|
||||
- :ref:`float<class_float>` **top_radius**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_CylinderMesh_get_bottom_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_bottom_radius** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_get_height:
|
||||
|
||||
- :ref:`float<class_float>` **get_height** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_get_radial_segments:
|
||||
|
||||
- :ref:`int<class_int>` **get_radial_segments** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_get_rings:
|
||||
|
||||
- :ref:`int<class_int>` **get_rings** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_get_top_radius:
|
||||
|
||||
- :ref:`float<class_float>` **get_top_radius** **(** **)** const
|
||||
|
||||
.. _class_CylinderMesh_set_bottom_radius:
|
||||
|
||||
- void **set_bottom_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
.. _class_CylinderMesh_set_height:
|
||||
|
||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
|
||||
.. _class_CylinderMesh_set_radial_segments:
|
||||
|
||||
- void **set_radial_segments** **(** :ref:`int<class_int>` segments **)**
|
||||
|
||||
.. _class_CylinderMesh_set_rings:
|
||||
|
||||
- void **set_rings** **(** :ref:`int<class_int>` rings **)**
|
||||
|
||||
.. _class_CylinderMesh_set_top_radius:
|
||||
|
||||
- void **set_top_radius** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
|
||||
@@ -31,7 +31,6 @@ Member Functions
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`float<class_float>` **directional_shadow_bias_split_scale**
|
||||
- :ref:`bool<class_bool>` **directional_shadow_blend_splits**
|
||||
- :ref:`int<class_int>` **directional_shadow_mode**
|
||||
- :ref:`float<class_float>` **directional_shadow_normal_bias**
|
||||
|
||||
@@ -40,7 +40,11 @@ Signals
|
||||
-------
|
||||
|
||||
- **filesystem_changed** **(** **)**
|
||||
Emitted if the filesystem changed.
|
||||
|
||||
- **sources_changed** **(** :ref:`bool<class_bool>` exist **)**
|
||||
Emitted if the source of any imported file changed.
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
86
classes/class_editorimportplugin.rst
Normal file
86
classes/class_editorimportplugin.rst
Normal file
@@ -0,0 +1,86 @@
|
||||
.. 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_EditorImportPlugin:
|
||||
|
||||
EditorImportPlugin
|
||||
==================
|
||||
|
||||
**Inherits:** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_import_options<class_EditorImportPlugin_get_import_options>` **(** :ref:`int<class_int>` preset **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_importer_name<class_EditorImportPlugin_get_importer_name>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_option_visibility<class_EditorImportPlugin_get_option_visibility>` **(** :ref:`String<class_string>` option, :ref:`Dictionary<class_dictionary>` options **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_preset_count<class_EditorImportPlugin_get_preset_count>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_preset_name<class_EditorImportPlugin_get_preset_name>` **(** :ref:`int<class_int>` preset **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_recognized_extensions<class_EditorImportPlugin_get_recognized_extensions>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_resource_type<class_EditorImportPlugin_get_resource_type>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_save_extension<class_EditorImportPlugin_get_save_extension>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_visible_name<class_EditorImportPlugin_get_visible_name>` **(** **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`import<class_EditorImportPlugin_import>` **(** :ref:`String<class_string>` source_file, :ref:`String<class_string>` save_path, :ref:`Dictionary<class_dictionary>` options, :ref:`Array<class_array>` r_platform_variants, :ref:`Array<class_array>` r_gen_files **)** virtual |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_EditorImportPlugin_get_import_options:
|
||||
|
||||
- :ref:`Array<class_array>` **get_import_options** **(** :ref:`int<class_int>` preset **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_importer_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_importer_name** **(** **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_option_visibility:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_option_visibility** **(** :ref:`String<class_string>` option, :ref:`Dictionary<class_dictionary>` options **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_preset_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_preset_count** **(** **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_preset_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_preset_name** **(** :ref:`int<class_int>` preset **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_recognized_extensions:
|
||||
|
||||
- :ref:`Array<class_array>` **get_recognized_extensions** **(** **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_resource_type:
|
||||
|
||||
- :ref:`String<class_string>` **get_resource_type** **(** **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_save_extension:
|
||||
|
||||
- :ref:`String<class_string>` **get_save_extension** **(** **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_get_visible_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_visible_name** **(** **)** virtual
|
||||
|
||||
.. _class_EditorImportPlugin_import:
|
||||
|
||||
- :ref:`int<class_int>` **import** **(** :ref:`String<class_string>` source_file, :ref:`String<class_string>` save_path, :ref:`Dictionary<class_dictionary>` options, :ref:`Array<class_array>` r_platform_variants, :ref:`Array<class_array>` r_gen_files **)** virtual
|
||||
|
||||
|
||||
@@ -27,6 +27,8 @@ Member Functions
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>` **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_import_plugin<class_EditorPlugin_add_import_plugin>` **(** :ref:`Object<class_object>` arg0 **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_tool_submenu_item<class_EditorPlugin_add_tool_submenu_item>` **(** :ref:`String<class_string>` name, :ref:`PopupMenu<class_popupmenu>` submenu **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
|
||||
@@ -87,6 +89,8 @@ Member Functions
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_import_plugin<class_EditorPlugin_remove_import_plugin>` **(** :ref:`Object<class_object>` arg0 **)** |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`save_external_data<class_EditorPlugin_save_external_data>` **(** **)** virtual |
|
||||
+------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
|
||||
@@ -162,6 +166,10 @@ You can use the :ref:`EditorPlugin.handles<class_EditorPlugin_handles>` to check
|
||||
|
||||
During run-time, this will be a simple object with a script so this function does not need to be called then.
|
||||
|
||||
.. _class_EditorPlugin_add_import_plugin:
|
||||
|
||||
- void **add_import_plugin** **(** :ref:`Object<class_object>` arg0 **)**
|
||||
|
||||
.. _class_EditorPlugin_add_tool_submenu_item:
|
||||
|
||||
- void **add_tool_submenu_item** **(** :ref:`String<class_string>` name, :ref:`PopupMenu<class_popupmenu>` submenu **)**
|
||||
@@ -200,8 +208,6 @@ This function is used for plugins that edit specific object types (nodes or reso
|
||||
|
||||
- :ref:`bool<class_bool>` **forward_canvas_gui_input** **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`InputEvent<class_inputevent>` event **)** virtual
|
||||
|
||||
If your plugin is active (because handles() returned true to the object), any input interaction with the 2D canvas editor will be first forwarded here. The canvas transform (containing zoom and offset to transform to edited world coordinates) is provided, but the input supplied is in untransformed coordinates to the canvas editor. Return true if you want to eat this event and not pass it to the canvas editor.
|
||||
|
||||
.. _class_EditorPlugin_forward_draw_over_canvas:
|
||||
|
||||
- void **forward_draw_over_canvas** **(** :ref:`Transform2D<class_transform2d>` canvas_xform, :ref:`Control<class_control>` canvas **)** virtual
|
||||
@@ -212,12 +218,6 @@ This function is called every time the 2D canvas editor draws (which overlays ov
|
||||
|
||||
- :ref:`bool<class_bool>` **forward_spatial_gui_input** **(** :ref:`Camera<class_camera>` camera, :ref:`InputEvent<class_inputevent>` event **)** virtual
|
||||
|
||||
This is a low level function for plugins that edit a given objet type derived from Spatial to capture the input of the viewport. The function is only being called if your object is being edited.
|
||||
|
||||
By using the :ref:`InputEvent<class_inputevent>` and the :ref:`Camera<class_camera>` arguments it's pretty easy to do raycasts into space using Camera functions.
|
||||
|
||||
Return true if you want to capture the input, otherwise false.
|
||||
|
||||
.. _class_EditorPlugin_get_base_control:
|
||||
|
||||
- :ref:`Control<class_control>` **get_base_control** **(** **)**
|
||||
@@ -342,6 +342,10 @@ Remove the control from the dock. Don't forget to call this if you added one, so
|
||||
|
||||
Remove a custom type added by :ref:`EditorPlugin.add_custom_type<class_EditorPlugin_add_custom_type>`
|
||||
|
||||
.. _class_EditorPlugin_remove_import_plugin:
|
||||
|
||||
- void **remove_import_plugin** **(** :ref:`Object<class_object>` arg0 **)**
|
||||
|
||||
.. _class_EditorPlugin_save_external_data:
|
||||
|
||||
- void **save_external_data** **(** **)** virtual
|
||||
|
||||
@@ -34,6 +34,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **preview_invalidated** **(** :ref:`String<class_string>` path **)**
|
||||
If a preview was invalidated (changed) this signal will emit (using the path of the preview)
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -34,6 +34,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **selection_changed** **(** **)**
|
||||
Emitted when the selection changes.
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -27,7 +27,7 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_lines<class_EditorSpatialGizmo_add_lines>` **(** :ref:`PoolVector3Array<class_poolvector3array>` lines, :ref:`Material<class_material>` material, :ref:`bool<class_bool>` billboard=false **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_mesh<class_EditorSpatialGizmo_add_mesh>` **(** :ref:`Mesh<class_mesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`RID<class_rid>` skeleton=RID() **)** |
|
||||
| void | :ref:`add_mesh<class_EditorSpatialGizmo_add_mesh>` **(** :ref:`Mesh<class_mesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`RID<class_rid>` skeleton=[RID] **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_unscaled_billboard<class_EditorSpatialGizmo_add_unscaled_billboard>` **(** :ref:`Material<class_material>` material, :ref:`float<class_float>` default_scale=1 **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -80,7 +80,7 @@ Add lines to the gizmo (as sets of 2 points), with a given material. The lines a
|
||||
|
||||
.. _class_EditorSpatialGizmo_add_mesh:
|
||||
|
||||
- void **add_mesh** **(** :ref:`Mesh<class_mesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`RID<class_rid>` skeleton=RID() **)**
|
||||
- void **add_mesh** **(** :ref:`Mesh<class_mesh>` mesh, :ref:`bool<class_bool>` billboard=false, :ref:`RID<class_rid>` skeleton=[RID] **)**
|
||||
|
||||
Add a mesh to the gizmo, this is used for visualization. Call this function during :ref:`redraw<class_EditorSpatialGizmo_redraw>`.
|
||||
|
||||
|
||||
@@ -35,6 +35,8 @@ Member Functions
|
||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_version_info<class_Engine_get_version_info>` **(** **)** const |
|
||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_in_fixed_frame<class_Engine_is_in_fixed_frame>` **(** **)** const |
|
||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_iterations_per_second<class_Engine_set_iterations_per_second>` **(** :ref:`int<class_int>` iterations_per_second **)** |
|
||||
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_target_fps<class_Engine_set_target_fps>` **(** :ref:`int<class_int>` target_fps **)** |
|
||||
@@ -103,6 +105,10 @@ Returns the current engine version information in a Dictionary.
|
||||
|
||||
"string" - major + minor + patch + status + revision in a single String
|
||||
|
||||
.. _class_Engine_is_in_fixed_frame:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_in_fixed_frame** **(** **)** const
|
||||
|
||||
.. _class_Engine_set_iterations_per_second:
|
||||
|
||||
- void **set_iterations_per_second** **(** :ref:`int<class_int>` iterations_per_second **)**
|
||||
|
||||
@@ -31,7 +31,7 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ambient_light_energy<class_Environment_get_ambient_light_energy>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ambient_light_skybox_contribution<class_Environment_get_ambient_light_skybox_contribution>` **(** **)** const |
|
||||
| :ref:`float<class_float>` | :ref:`get_ambient_light_sky_contribution<class_Environment_get_ambient_light_sky_contribution>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_background<class_Environment_get_background>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -57,6 +57,24 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_dof_blur_near_transition<class_Environment_get_dof_blur_near_transition>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_fog_color<class_Environment_get_fog_color>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fog_depth_begin<class_Environment_get_fog_depth_begin>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fog_depth_curve<class_Environment_get_fog_depth_curve>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fog_height_curve<class_Environment_get_fog_height_curve>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fog_height_max<class_Environment_get_fog_height_max>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fog_height_min<class_Environment_get_fog_height_min>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fog_sun_amount<class_Environment_get_fog_sun_amount>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_fog_sun_color<class_Environment_get_fog_sun_color>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_fog_transmit_curve<class_Environment_get_fog_transmit_curve>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_glow_blend_mode<class_Environment_get_glow_blend_mode>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_glow_bloom<class_Environment_get_glow_bloom>` **(** **)** const |
|
||||
@@ -69,9 +87,9 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_glow_strength<class_Environment_get_glow_strength>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`CubeMap<class_cubemap>` | :ref:`get_skybox<class_Environment_get_skybox>` **(** **)** const |
|
||||
| :ref:`CubeMap<class_cubemap>` | :ref:`get_sky<class_Environment_get_sky>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_skybox_scale<class_Environment_get_skybox_scale>` **(** **)** const |
|
||||
| :ref:`float<class_float>` | :ref:`get_sky_scale<class_Environment_get_sky_scale>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ssao_bias<class_Environment_get_ssao_bias>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -87,11 +105,11 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ssao_radius2<class_Environment_get_ssao_radius2>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ssr_accel<class_Environment_get_ssr_accel>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ssr_depth_tolerance<class_Environment_get_ssr_depth_tolerance>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ssr_fade<class_Environment_get_ssr_fade>` **(** **)** const |
|
||||
| :ref:`float<class_float>` | :ref:`get_ssr_fade_in<class_Environment_get_ssr_fade_in>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ssr_fade_out<class_Environment_get_ssr_fade_out>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_ssr_max_steps<class_Environment_get_ssr_max_steps>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -117,6 +135,14 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_dof_blur_near_enabled<class_Environment_is_dof_blur_near_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_fog_depth_enabled<class_Environment_is_fog_depth_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_fog_enabled<class_Environment_is_fog_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_fog_height_enabled<class_Environment_is_fog_height_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_fog_transmit_enabled<class_Environment_is_fog_transmit_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_glow_bicubic_upscale_enabled<class_Environment_is_glow_bicubic_upscale_enabled>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_glow_enabled<class_Environment_is_glow_enabled>` **(** **)** const |
|
||||
@@ -131,8 +157,6 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_ssr_rough<class_Environment_is_ssr_rough>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_ssr_smooth<class_Environment_is_ssr_smooth>` **(** **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_adjustment_brightness<class_Environment_set_adjustment_brightness>` **(** :ref:`float<class_float>` brightness **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_adjustment_color_correction<class_Environment_set_adjustment_color_correction>` **(** :ref:`Object<class_object>` color_correction **)** |
|
||||
@@ -147,7 +171,7 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ambient_light_energy<class_Environment_set_ambient_light_energy>` **(** :ref:`float<class_float>` energy **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ambient_light_skybox_contribution<class_Environment_set_ambient_light_skybox_contribution>` **(** :ref:`float<class_float>` energy **)** |
|
||||
| void | :ref:`set_ambient_light_sky_contribution<class_Environment_set_ambient_light_sky_contribution>` **(** :ref:`float<class_float>` energy **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_background<class_Environment_set_background>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -177,6 +201,32 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_dof_blur_near_transition<class_Environment_set_dof_blur_near_transition>` **(** :ref:`float<class_float>` intensity **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_color<class_Environment_set_fog_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_depth_begin<class_Environment_set_fog_depth_begin>` **(** :ref:`float<class_float>` distance **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_depth_curve<class_Environment_set_fog_depth_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_depth_enabled<class_Environment_set_fog_depth_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_enabled<class_Environment_set_fog_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_height_curve<class_Environment_set_fog_height_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_height_enabled<class_Environment_set_fog_height_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_height_max<class_Environment_set_fog_height_max>` **(** :ref:`float<class_float>` height **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_height_min<class_Environment_set_fog_height_min>` **(** :ref:`float<class_float>` height **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_sun_amount<class_Environment_set_fog_sun_amount>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_sun_color<class_Environment_set_fog_sun_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_transmit_curve<class_Environment_set_fog_transmit_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fog_transmit_enabled<class_Environment_set_fog_transmit_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_glow_bicubic_upscale<class_Environment_set_glow_bicubic_upscale>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_glow_blend_mode<class_Environment_set_glow_blend_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
@@ -195,9 +245,9 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_glow_strength<class_Environment_set_glow_strength>` **(** :ref:`float<class_float>` strength **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_skybox<class_Environment_set_skybox>` **(** :ref:`CubeMap<class_cubemap>` skybox **)** |
|
||||
| void | :ref:`set_sky<class_Environment_set_sky>` **(** :ref:`CubeMap<class_cubemap>` sky **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_skybox_scale<class_Environment_set_skybox_scale>` **(** :ref:`float<class_float>` scale **)** |
|
||||
| void | :ref:`set_sky_scale<class_Environment_set_sky_scale>` **(** :ref:`float<class_float>` scale **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssao_bias<class_Environment_set_ssao_bias>` **(** :ref:`float<class_float>` bias **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -217,20 +267,18 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssao_radius2<class_Environment_set_ssao_radius2>` **(** :ref:`float<class_float>` radius **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssr_accel<class_Environment_set_ssr_accel>` **(** :ref:`float<class_float>` accel **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssr_depth_tolerance<class_Environment_set_ssr_depth_tolerance>` **(** :ref:`float<class_float>` depth_tolerance **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssr_enabled<class_Environment_set_ssr_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssr_fade<class_Environment_set_ssr_fade>` **(** :ref:`float<class_float>` fade **)** |
|
||||
| void | :ref:`set_ssr_fade_in<class_Environment_set_ssr_fade_in>` **(** :ref:`float<class_float>` fade_in **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssr_fade_out<class_Environment_set_ssr_fade_out>` **(** :ref:`float<class_float>` fade_out **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssr_max_steps<class_Environment_set_ssr_max_steps>` **(** :ref:`int<class_int>` max_steps **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssr_rough<class_Environment_set_ssr_rough>` **(** :ref:`bool<class_bool>` rough **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ssr_smooth<class_Environment_set_ssr_smooth>` **(** :ref:`bool<class_bool>` smooth **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tonemap_auto_exposure<class_Environment_set_tonemap_auto_exposure>` **(** :ref:`bool<class_bool>` auto_exposure **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_tonemap_auto_exposure_grey<class_Environment_set_tonemap_auto_exposure_grey>` **(** :ref:`float<class_float>` exposure_grey **)** |
|
||||
@@ -258,18 +306,18 @@ Member Variables
|
||||
- :ref:`float<class_float>` **adjustment_saturation**
|
||||
- :ref:`Color<class_color>` **ambient_light_color**
|
||||
- :ref:`float<class_float>` **ambient_light_energy**
|
||||
- :ref:`float<class_float>` **ambient_light_skybox_contribution**
|
||||
- :ref:`bool<class_bool>` **auto_expoure_enabled**
|
||||
- :ref:`float<class_float>` **auto_expoure_max_luma**
|
||||
- :ref:`float<class_float>` **auto_expoure_min_luma**
|
||||
- :ref:`float<class_float>` **auto_expoure_scale**
|
||||
- :ref:`float<class_float>` **auto_expoure_speed**
|
||||
- :ref:`float<class_float>` **ambient_light_sky_contribution**
|
||||
- :ref:`bool<class_bool>` **auto_exposure_enabled**
|
||||
- :ref:`float<class_float>` **auto_exposure_max_luma**
|
||||
- :ref:`float<class_float>` **auto_exposure_min_luma**
|
||||
- :ref:`float<class_float>` **auto_exposure_scale**
|
||||
- :ref:`float<class_float>` **auto_exposure_speed**
|
||||
- :ref:`int<class_int>` **background_canvas_max_layer**
|
||||
- :ref:`Color<class_color>` **background_color**
|
||||
- :ref:`float<class_float>` **background_energy**
|
||||
- :ref:`int<class_int>` **background_mode**
|
||||
- :ref:`SkyBox<class_skybox>` **background_skybox**
|
||||
- :ref:`float<class_float>` **background_skybox_scale**
|
||||
- :ref:`Sky<class_sky>` **background_sky**
|
||||
- :ref:`float<class_float>` **background_sky_scale**
|
||||
- :ref:`float<class_float>` **dof_blur_far_amount**
|
||||
- :ref:`float<class_float>` **dof_blur_far_distance**
|
||||
- :ref:`bool<class_bool>` **dof_blur_far_enabled**
|
||||
@@ -280,6 +328,19 @@ Member Variables
|
||||
- :ref:`bool<class_bool>` **dof_blur_near_enabled**
|
||||
- :ref:`int<class_int>` **dof_blur_near_quality**
|
||||
- :ref:`float<class_float>` **dof_blur_near_transition**
|
||||
- :ref:`Color<class_color>` **fog_color**
|
||||
- :ref:`float<class_float>` **fog_depth_begin**
|
||||
- :ref:`float<class_float>` **fog_depth_curve**
|
||||
- :ref:`bool<class_bool>` **fog_depth_enabled**
|
||||
- :ref:`bool<class_bool>` **fog_enabled**
|
||||
- :ref:`float<class_float>` **fog_height_curve**
|
||||
- :ref:`bool<class_bool>` **fog_height_enabled**
|
||||
- :ref:`float<class_float>` **fog_height_max**
|
||||
- :ref:`float<class_float>` **fog_height_min**
|
||||
- :ref:`float<class_float>` **fog_sun_amount**
|
||||
- :ref:`Color<class_color>` **fog_sun_color**
|
||||
- :ref:`float<class_float>` **fog_transmit_curve**
|
||||
- :ref:`bool<class_bool>` **fog_transmit_enabled**
|
||||
- :ref:`bool<class_bool>` **glow_bicubic_upscale**
|
||||
- :ref:`int<class_int>` **glow_blend_mode**
|
||||
- :ref:`float<class_float>` **glow_bloom**
|
||||
@@ -295,11 +356,10 @@ Member Variables
|
||||
- :ref:`bool<class_bool>` **glow_levels/6**
|
||||
- :ref:`bool<class_bool>` **glow_levels/7**
|
||||
- :ref:`float<class_float>` **glow_strength**
|
||||
- :ref:`float<class_float>` **ss_reflections_accel**
|
||||
- :ref:`bool<class_bool>` **ss_reflections_accel_smooth**
|
||||
- :ref:`float<class_float>` **ss_reflections_depth_tolerance**
|
||||
- :ref:`bool<class_bool>` **ss_reflections_enabled**
|
||||
- :ref:`float<class_float>` **ss_reflections_fade**
|
||||
- :ref:`float<class_float>` **ss_reflections_fade_in**
|
||||
- :ref:`float<class_float>` **ss_reflections_fade_out**
|
||||
- :ref:`int<class_int>` **ss_reflections_max_steps**
|
||||
- :ref:`bool<class_bool>` **ss_reflections_roughness**
|
||||
- :ref:`float<class_float>` **ssao_bias**
|
||||
@@ -321,7 +381,7 @@ Numeric Constants
|
||||
- **BG_KEEP** = **4**
|
||||
- **BG_CLEAR_COLOR** = **0**
|
||||
- **BG_COLOR** = **1**
|
||||
- **BG_SKYBOX** = **2**
|
||||
- **BG_SKY** = **2**
|
||||
- **BG_CANVAS** = **3**
|
||||
- **BG_MAX** = **5**
|
||||
- **GLOW_BLEND_MODE_ADDITIVE** = **0**
|
||||
@@ -363,9 +423,9 @@ Member Function Description
|
||||
|
||||
- :ref:`float<class_float>` **get_ambient_light_energy** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_ambient_light_skybox_contribution:
|
||||
.. _class_Environment_get_ambient_light_sky_contribution:
|
||||
|
||||
- :ref:`float<class_float>` **get_ambient_light_skybox_contribution** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_ambient_light_sky_contribution** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_background:
|
||||
|
||||
@@ -415,6 +475,42 @@ Member Function Description
|
||||
|
||||
- :ref:`float<class_float>` **get_dof_blur_near_transition** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_fog_color** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_depth_begin:
|
||||
|
||||
- :ref:`float<class_float>` **get_fog_depth_begin** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_depth_curve:
|
||||
|
||||
- :ref:`float<class_float>` **get_fog_depth_curve** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_height_curve:
|
||||
|
||||
- :ref:`float<class_float>` **get_fog_height_curve** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_height_max:
|
||||
|
||||
- :ref:`float<class_float>` **get_fog_height_max** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_height_min:
|
||||
|
||||
- :ref:`float<class_float>` **get_fog_height_min** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_sun_amount:
|
||||
|
||||
- :ref:`float<class_float>` **get_fog_sun_amount** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_sun_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_fog_sun_color** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_fog_transmit_curve:
|
||||
|
||||
- :ref:`float<class_float>` **get_fog_transmit_curve** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_glow_blend_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_glow_blend_mode** **(** **)** const
|
||||
@@ -439,13 +535,13 @@ Member Function Description
|
||||
|
||||
- :ref:`float<class_float>` **get_glow_strength** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_skybox:
|
||||
.. _class_Environment_get_sky:
|
||||
|
||||
- :ref:`CubeMap<class_cubemap>` **get_skybox** **(** **)** const
|
||||
- :ref:`CubeMap<class_cubemap>` **get_sky** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_skybox_scale:
|
||||
.. _class_Environment_get_sky_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_skybox_scale** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_sky_scale** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_ssao_bias:
|
||||
|
||||
@@ -475,17 +571,17 @@ Member Function Description
|
||||
|
||||
- :ref:`float<class_float>` **get_ssao_radius2** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_ssr_accel:
|
||||
|
||||
- :ref:`float<class_float>` **get_ssr_accel** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_ssr_depth_tolerance:
|
||||
|
||||
- :ref:`float<class_float>` **get_ssr_depth_tolerance** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_ssr_fade:
|
||||
.. _class_Environment_get_ssr_fade_in:
|
||||
|
||||
- :ref:`float<class_float>` **get_ssr_fade** **(** **)** const
|
||||
- :ref:`float<class_float>` **get_ssr_fade_in** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_ssr_fade_out:
|
||||
|
||||
- :ref:`float<class_float>` **get_ssr_fade_out** **(** **)** const
|
||||
|
||||
.. _class_Environment_get_ssr_max_steps:
|
||||
|
||||
@@ -535,6 +631,22 @@ Member Function Description
|
||||
|
||||
- :ref:`bool<class_bool>` **is_dof_blur_near_enabled** **(** **)** const
|
||||
|
||||
.. _class_Environment_is_fog_depth_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_fog_depth_enabled** **(** **)** const
|
||||
|
||||
.. _class_Environment_is_fog_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_fog_enabled** **(** **)** const
|
||||
|
||||
.. _class_Environment_is_fog_height_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_fog_height_enabled** **(** **)** const
|
||||
|
||||
.. _class_Environment_is_fog_transmit_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_fog_transmit_enabled** **(** **)** const
|
||||
|
||||
.. _class_Environment_is_glow_bicubic_upscale_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_glow_bicubic_upscale_enabled** **(** **)** const
|
||||
@@ -563,10 +675,6 @@ Member Function Description
|
||||
|
||||
- :ref:`bool<class_bool>` **is_ssr_rough** **(** **)** const
|
||||
|
||||
.. _class_Environment_is_ssr_smooth:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_ssr_smooth** **(** **)** const
|
||||
|
||||
.. _class_Environment_set_adjustment_brightness:
|
||||
|
||||
- void **set_adjustment_brightness** **(** :ref:`float<class_float>` brightness **)**
|
||||
@@ -595,9 +703,9 @@ Member Function Description
|
||||
|
||||
- void **set_ambient_light_energy** **(** :ref:`float<class_float>` energy **)**
|
||||
|
||||
.. _class_Environment_set_ambient_light_skybox_contribution:
|
||||
.. _class_Environment_set_ambient_light_sky_contribution:
|
||||
|
||||
- void **set_ambient_light_skybox_contribution** **(** :ref:`float<class_float>` energy **)**
|
||||
- void **set_ambient_light_sky_contribution** **(** :ref:`float<class_float>` energy **)**
|
||||
|
||||
.. _class_Environment_set_background:
|
||||
|
||||
@@ -655,6 +763,58 @@ Member Function Description
|
||||
|
||||
- void **set_dof_blur_near_transition** **(** :ref:`float<class_float>` intensity **)**
|
||||
|
||||
.. _class_Environment_set_fog_color:
|
||||
|
||||
- void **set_fog_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_Environment_set_fog_depth_begin:
|
||||
|
||||
- void **set_fog_depth_begin** **(** :ref:`float<class_float>` distance **)**
|
||||
|
||||
.. _class_Environment_set_fog_depth_curve:
|
||||
|
||||
- void **set_fog_depth_curve** **(** :ref:`float<class_float>` curve **)**
|
||||
|
||||
.. _class_Environment_set_fog_depth_enabled:
|
||||
|
||||
- void **set_fog_depth_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Environment_set_fog_enabled:
|
||||
|
||||
- void **set_fog_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Environment_set_fog_height_curve:
|
||||
|
||||
- void **set_fog_height_curve** **(** :ref:`float<class_float>` curve **)**
|
||||
|
||||
.. _class_Environment_set_fog_height_enabled:
|
||||
|
||||
- void **set_fog_height_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Environment_set_fog_height_max:
|
||||
|
||||
- void **set_fog_height_max** **(** :ref:`float<class_float>` height **)**
|
||||
|
||||
.. _class_Environment_set_fog_height_min:
|
||||
|
||||
- void **set_fog_height_min** **(** :ref:`float<class_float>` height **)**
|
||||
|
||||
.. _class_Environment_set_fog_sun_amount:
|
||||
|
||||
- void **set_fog_sun_amount** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_Environment_set_fog_sun_color:
|
||||
|
||||
- void **set_fog_sun_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_Environment_set_fog_transmit_curve:
|
||||
|
||||
- void **set_fog_transmit_curve** **(** :ref:`float<class_float>` curve **)**
|
||||
|
||||
.. _class_Environment_set_fog_transmit_enabled:
|
||||
|
||||
- void **set_fog_transmit_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Environment_set_glow_bicubic_upscale:
|
||||
|
||||
- void **set_glow_bicubic_upscale** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
@@ -691,13 +851,13 @@ Member Function Description
|
||||
|
||||
- void **set_glow_strength** **(** :ref:`float<class_float>` strength **)**
|
||||
|
||||
.. _class_Environment_set_skybox:
|
||||
.. _class_Environment_set_sky:
|
||||
|
||||
- void **set_skybox** **(** :ref:`CubeMap<class_cubemap>` skybox **)**
|
||||
- void **set_sky** **(** :ref:`CubeMap<class_cubemap>` sky **)**
|
||||
|
||||
.. _class_Environment_set_skybox_scale:
|
||||
.. _class_Environment_set_sky_scale:
|
||||
|
||||
- void **set_skybox_scale** **(** :ref:`float<class_float>` scale **)**
|
||||
- void **set_sky_scale** **(** :ref:`float<class_float>` scale **)**
|
||||
|
||||
.. _class_Environment_set_ssao_bias:
|
||||
|
||||
@@ -735,10 +895,6 @@ Member Function Description
|
||||
|
||||
- void **set_ssao_radius2** **(** :ref:`float<class_float>` radius **)**
|
||||
|
||||
.. _class_Environment_set_ssr_accel:
|
||||
|
||||
- void **set_ssr_accel** **(** :ref:`float<class_float>` accel **)**
|
||||
|
||||
.. _class_Environment_set_ssr_depth_tolerance:
|
||||
|
||||
- void **set_ssr_depth_tolerance** **(** :ref:`float<class_float>` depth_tolerance **)**
|
||||
@@ -747,9 +903,13 @@ Member Function Description
|
||||
|
||||
- void **set_ssr_enabled** **(** :ref:`bool<class_bool>` enabled **)**
|
||||
|
||||
.. _class_Environment_set_ssr_fade:
|
||||
.. _class_Environment_set_ssr_fade_in:
|
||||
|
||||
- void **set_ssr_fade** **(** :ref:`float<class_float>` fade **)**
|
||||
- void **set_ssr_fade_in** **(** :ref:`float<class_float>` fade_in **)**
|
||||
|
||||
.. _class_Environment_set_ssr_fade_out:
|
||||
|
||||
- void **set_ssr_fade_out** **(** :ref:`float<class_float>` fade_out **)**
|
||||
|
||||
.. _class_Environment_set_ssr_max_steps:
|
||||
|
||||
@@ -759,10 +919,6 @@ Member Function Description
|
||||
|
||||
- void **set_ssr_rough** **(** :ref:`bool<class_bool>` rough **)**
|
||||
|
||||
.. _class_Environment_set_ssr_smooth:
|
||||
|
||||
- void **set_ssr_smooth** **(** :ref:`bool<class_bool>` smooth **)**
|
||||
|
||||
.. _class_Environment_set_tonemap_auto_exposure:
|
||||
|
||||
- void **set_tonemap_auto_exposure** **(** :ref:`bool<class_bool>` auto_exposure **)**
|
||||
|
||||
@@ -60,8 +60,14 @@ Signals
|
||||
-------
|
||||
|
||||
- **dir_selected** **(** :ref:`String<class_string>` dir **)**
|
||||
Event emitted when the user selects a directory.
|
||||
|
||||
- **file_selected** **(** :ref:`String<class_string>` path **)**
|
||||
Event emitted when the user selects a file (double clicks it or presses the OK button).
|
||||
|
||||
- **files_selected** **(** :ref:`PoolStringArray<class_poolstringarray>` paths **)**
|
||||
Event emitted when the user selects multiple files.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -18,11 +18,11 @@ State of a function call after yielding.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_valid<class_GDFunctionState_is_valid>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`resume<class_GDFunctionState_resume>` **(** :ref:`Variant<class_variant>` arg=NULL **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_valid<class_GDFunctionState_is_valid>` **(** :ref:`bool<class_bool>` extended_check=false **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`resume<class_GDFunctionState_resume>` **(** :ref:`Variant<class_variant>` arg=NULL **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -34,10 +34,12 @@ Member Function Description
|
||||
|
||||
.. _class_GDFunctionState_is_valid:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_valid** **(** **)** const
|
||||
- :ref:`bool<class_bool>` **is_valid** **(** :ref:`bool<class_bool>` extended_check=false **)** const
|
||||
|
||||
Check whether the function call may be resumed. This is not the case if the function state was already resumed.
|
||||
|
||||
If ``extended_check`` is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of :ref:`GDFunctionState.resume<class_GDFunctionState_resume>`, but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point.
|
||||
|
||||
.. _class_GDFunctionState_resume:
|
||||
|
||||
- :ref:`Variant<class_variant>` **resume** **(** :ref:`Variant<class_variant>` arg=NULL **)**
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
.. 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_DLLibrary:
|
||||
.. _class_GDNativeLibrary:
|
||||
|
||||
DLLibrary
|
||||
=========
|
||||
GDNativeLibrary
|
||||
===============
|
||||
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
@@ -18,20 +18,20 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_platform_file<class_DLLibrary_get_platform_file>` **(** :ref:`String<class_string>` platform **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_platform_file<class_DLLibrary_set_platform_file>` **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` file **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_platform_file<class_GDNativeLibrary_get_platform_file>` **(** :ref:`String<class_string>` platform **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_platform_file<class_GDNativeLibrary_set_platform_file>` **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` file **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_DLLibrary_get_platform_file:
|
||||
.. _class_GDNativeLibrary_get_platform_file:
|
||||
|
||||
- :ref:`String<class_string>` **get_platform_file** **(** :ref:`String<class_string>` platform **)** const
|
||||
|
||||
.. _class_DLLibrary_set_platform_file:
|
||||
.. _class_GDNativeLibrary_set_platform_file:
|
||||
|
||||
- void **set_platform_file** **(** :ref:`String<class_string>` platform, :ref:`String<class_string>` file **)**
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
.. 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_DLScript:
|
||||
.. _class_GDNativeScript:
|
||||
|
||||
DLScript
|
||||
========
|
||||
GDNativeScript
|
||||
==============
|
||||
|
||||
**Inherits:** :ref:`Script<class_script>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
@@ -18,38 +18,44 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_library<class_DLScript_get_library>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_script_name<class_DLScript_get_script_name>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_library<class_DLScript_set_library>` **(** :ref:`Object<class_object>` library **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_script_name<class_DLScript_set_script_name>` **(** :ref:`String<class_string>` script_name **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_library<class_GDNativeScript_get_library>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_script_name<class_GDNativeScript_get_script_name>` **(** **)** const |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`new<class_GDNativeScript_new>` **(** **)** vararg |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_library<class_GDNativeScript_set_library>` **(** :ref:`Object<class_object>` library **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_script_name<class_GDNativeScript_set_script_name>` **(** :ref:`String<class_string>` script_name **)** |
|
||||
+------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`DLLibrary<class_dllibrary>` **library**
|
||||
- :ref:`GDNativeLibrary<class_gdnativelibrary>` **library**
|
||||
- :ref:`String<class_string>` **script_name**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_DLScript_get_library:
|
||||
.. _class_GDNativeScript_get_library:
|
||||
|
||||
- :ref:`Object<class_object>` **get_library** **(** **)** const
|
||||
|
||||
.. _class_DLScript_get_script_name:
|
||||
.. _class_GDNativeScript_get_script_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_script_name** **(** **)** const
|
||||
|
||||
.. _class_DLScript_set_library:
|
||||
.. _class_GDNativeScript_new:
|
||||
|
||||
- :ref:`Object<class_object>` **new** **(** **)** vararg
|
||||
|
||||
.. _class_GDNativeScript_set_library:
|
||||
|
||||
- void **set_library** **(** :ref:`Object<class_object>` library **)**
|
||||
|
||||
.. _class_DLScript_set_script_name:
|
||||
.. _class_GDNativeScript_set_script_name:
|
||||
|
||||
- void **set_script_name** **(** :ref:`String<class_string>` script_name **)**
|
||||
|
||||
@@ -8,7 +8,7 @@ GeometryInstance
|
||||
|
||||
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`MultiMeshInstance<class_multimeshinstance>`, :ref:`SpriteBase3D<class_spritebase3d>`, :ref:`MeshInstance<class_meshinstance>`, :ref:`Particles<class_particles>`, :ref:`Quad<class_quad>`, :ref:`TestCube<class_testcube>`, :ref:`ImmediateGeometry<class_immediategeometry>`
|
||||
**Inherited By:** :ref:`MultiMeshInstance<class_multimeshinstance>`, :ref:`SpriteBase3D<class_spritebase3d>`, :ref:`MeshInstance<class_meshinstance>`, :ref:`Particles<class_particles>`, :ref:`ImmediateGeometry<class_immediategeometry>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -53,7 +53,7 @@ Member Functions
|
||||
Description
|
||||
-----------
|
||||
|
||||
Contains global variables accessible from everywhere. Use the normal :ref:`Object<class_object>` API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in godot.cfg are also loaded into globals, making this object very useful for reading custom game configuration options.
|
||||
Contains global variables accessible from everywhere. Use the normal :ref:`Object<class_object>` API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in project.godot are also loaded into globals, making this object very useful for reading custom game configuration options.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
.. 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_ColorRamp:
|
||||
.. _class_Gradient:
|
||||
|
||||
ColorRamp
|
||||
=========
|
||||
Gradient
|
||||
========
|
||||
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
@@ -18,31 +18,31 @@ Color interpolator node
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_ColorRamp_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorRamp_get_color>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolColorArray<class_poolcolorarray>` | :ref:`get_colors<class_ColorRamp_get_colors>` **(** **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_offset<class_ColorRamp_get_offset>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolRealArray<class_poolrealarray>` | :ref:`get_offsets<class_ColorRamp_get_offsets>` **(** **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_ColorRamp_get_point_count>` **(** **)** const |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`interpolate<class_ColorRamp_interpolate>` **(** :ref:`float<class_float>` offset **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_ColorRamp_remove_point>` **(** :ref:`int<class_int>` offset **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_color<class_ColorRamp_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_colors<class_ColorRamp_set_colors>` **(** :ref:`PoolColorArray<class_poolcolorarray>` colors **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offset<class_ColorRamp_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offsets<class_ColorRamp_set_offsets>` **(** :ref:`PoolRealArray<class_poolrealarray>` offsets **)** |
|
||||
+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_point<class_Gradient_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_color<class_Gradient_get_color>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolColorArray<class_poolcolorarray>` | :ref:`get_colors<class_Gradient_get_colors>` **(** **)** const |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_offset<class_Gradient_get_offset>` **(** :ref:`int<class_int>` point **)** const |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolRealArray<class_poolrealarray>` | :ref:`get_offsets<class_Gradient_get_offsets>` **(** **)** const |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_point_count<class_Gradient_get_point_count>` **(** **)** const |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`interpolate<class_Gradient_interpolate>` **(** :ref:`float<class_float>` offset **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_point<class_Gradient_remove_point>` **(** :ref:`int<class_int>` offset **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_color<class_Gradient_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_colors<class_Gradient_set_colors>` **(** :ref:`PoolColorArray<class_poolcolorarray>` colors **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offset<class_Gradient_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offsets<class_Gradient_set_offsets>` **(** :ref:`PoolRealArray<class_poolrealarray>` offsets **)** |
|
||||
+----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -58,73 +58,73 @@ Given a set of colors, this node will interpolate them in order, meaning, that i
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_ColorRamp_add_point:
|
||||
.. _class_Gradient_add_point:
|
||||
|
||||
- void **add_point** **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)**
|
||||
|
||||
Adds the specified color to the end of the ramp, with the specified offset
|
||||
|
||||
.. _class_ColorRamp_get_color:
|
||||
.. _class_Gradient_get_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_color** **(** :ref:`int<class_int>` point **)** const
|
||||
|
||||
Returns the color of the ramp color at index *point*
|
||||
|
||||
.. _class_ColorRamp_get_colors:
|
||||
.. _class_Gradient_get_colors:
|
||||
|
||||
- :ref:`PoolColorArray<class_poolcolorarray>` **get_colors** **(** **)** const
|
||||
|
||||
Returns the colors in the ramp
|
||||
|
||||
.. _class_ColorRamp_get_offset:
|
||||
.. _class_Gradient_get_offset:
|
||||
|
||||
- :ref:`float<class_float>` **get_offset** **(** :ref:`int<class_int>` point **)** const
|
||||
|
||||
Returns the offset of the ramp color at index *point*
|
||||
|
||||
.. _class_ColorRamp_get_offsets:
|
||||
.. _class_Gradient_get_offsets:
|
||||
|
||||
- :ref:`PoolRealArray<class_poolrealarray>` **get_offsets** **(** **)** const
|
||||
|
||||
Returns the offsets for the colors in this ramp
|
||||
|
||||
.. _class_ColorRamp_get_point_count:
|
||||
.. _class_Gradient_get_point_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_point_count** **(** **)** const
|
||||
|
||||
Returns the number of colors in the ramp
|
||||
|
||||
.. _class_ColorRamp_interpolate:
|
||||
.. _class_Gradient_interpolate:
|
||||
|
||||
- :ref:`Color<class_color>` **interpolate** **(** :ref:`float<class_float>` offset **)**
|
||||
|
||||
Returns the interpolated color specified by *offset*
|
||||
|
||||
.. _class_ColorRamp_remove_point:
|
||||
.. _class_Gradient_remove_point:
|
||||
|
||||
- void **remove_point** **(** :ref:`int<class_int>` offset **)**
|
||||
|
||||
Removes the color at the index *offset*
|
||||
|
||||
.. _class_ColorRamp_set_color:
|
||||
.. _class_Gradient_set_color:
|
||||
|
||||
- void **set_color** **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)**
|
||||
|
||||
Sets the color of the ramp color at index *point*
|
||||
|
||||
.. _class_ColorRamp_set_colors:
|
||||
.. _class_Gradient_set_colors:
|
||||
|
||||
- void **set_colors** **(** :ref:`PoolColorArray<class_poolcolorarray>` colors **)**
|
||||
|
||||
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements.
|
||||
|
||||
.. _class_ColorRamp_set_offset:
|
||||
.. _class_Gradient_set_offset:
|
||||
|
||||
- void **set_offset** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)**
|
||||
|
||||
Sets the offset for the ramp color at index *point*
|
||||
|
||||
.. _class_ColorRamp_set_offsets:
|
||||
.. _class_Gradient_set_offsets:
|
||||
|
||||
- void **set_offsets** **(** :ref:`PoolRealArray<class_poolrealarray>` offsets **)**
|
||||
|
||||
@@ -54,14 +54,28 @@ Signals
|
||||
-------
|
||||
|
||||
- **_begin_node_move** **(** **)**
|
||||
Signal sent at the beginning of a GraphNode movement.
|
||||
|
||||
- **_end_node_move** **(** **)**
|
||||
Signal sent at the end of a GraphNode movement.
|
||||
|
||||
- **connection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
|
||||
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created.
|
||||
|
||||
- **connection_to_empty** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`Vector2<class_vector2>` release_pos **)**
|
||||
- **delete_nodes_request** **(** **)**
|
||||
Signal sent when a GraphNode is attempted to be removed from the GraphEdit.
|
||||
|
||||
- **disconnection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
|
||||
Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed.
|
||||
|
||||
- **duplicate_nodes_request** **(** **)**
|
||||
Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit.
|
||||
|
||||
- **node_selected** **(** :ref:`Object<class_object>` node **)**
|
||||
- **popup_request** **(** :ref:`Vector2<class_vector2>` p_position **)**
|
||||
Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent.
|
||||
|
||||
- **scroll_offset_changed** **(** :ref:`Vector2<class_vector2>` ofs **)**
|
||||
|
||||
Description
|
||||
|
||||
@@ -86,9 +86,17 @@ Signals
|
||||
-------
|
||||
|
||||
- **close_request** **(** **)**
|
||||
Signal sent on closing the GraphNode.
|
||||
|
||||
- **dragged** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)**
|
||||
Signal sent when the GraphNode is dragged.
|
||||
|
||||
- **offset_changed** **(** **)**
|
||||
Signal sent when the GraphNode is moved.
|
||||
|
||||
- **raise_request** **(** **)**
|
||||
Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode.
|
||||
|
||||
- **resize_request** **(** :ref:`Vector2<class_vector2>` new_minsize **)**
|
||||
|
||||
Member Variables
|
||||
|
||||
@@ -1,22 +0,0 @@
|
||||
.. 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_HButtonArray:
|
||||
|
||||
HButtonArray
|
||||
============
|
||||
|
||||
**Inherits:** :ref:`ButtonArray<class_buttonarray>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Horizontal button array.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Horizontal button array. See :ref:`ButtonArray<class_buttonarray>`.
|
||||
|
||||
@@ -50,6 +50,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **request_completed** **(** :ref:`int<class_int>` result, :ref:`int<class_int>` response_code, :ref:`PoolStringArray<class_poolstringarray>` headers, :ref:`PoolByteArray<class_poolbytearray>` body **)**
|
||||
This signal is emitted upon request completion.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -6,7 +6,9 @@
|
||||
Image
|
||||
=====
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
@@ -16,71 +18,114 @@ Image datatype.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`Image<class_Image_Image>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` mipmaps, :ref:`int<class_int>` format **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blit_rect<class_Image_blit_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`compressed<class_Image_compressed>` **(** :ref:`int<class_int>` format=0 **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`converted<class_Image_converted>` **(** :ref:`int<class_int>` format=0 **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`decompressed<class_Image_decompressed>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`empty<class_Image_empty>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`fix_alpha_edges<class_Image_fix_alpha_edges>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_Image_get_data>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_format<class_Image_get_format>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_height<class_Image_get_height>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`get_rect<class_Image_get_rect>` **(** :ref:`Rect2<class_rect2>` area=0 **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_used_rect<class_Image_get_used_rect>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_width<class_Image_get_width>` **(** **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`load<class_Image_load>` **(** :ref:`String<class_string>` path=0 **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`resized<class_Image_resized>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` interpolation=1 **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`save_png<class_Image_save_png>` **(** :ref:`String<class_string>` path=0 **)** |
|
||||
+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`blit_rect<class_Image_blit_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_mipmaps<class_Image_clear_mipmaps>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`compress<class_Image_compress>` **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` arg1, :ref:`float<class_float>` arg2 **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`convert<class_Image_convert>` **(** :ref:`int<class_int>` format **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`copy_from<class_Image_copy_from>` **(** :ref:`Image<class_image>` src **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create<class_Image_create>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`int<class_int>` format **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create_from_data<class_Image_create_from_data>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`int<class_int>` format, :ref:`PoolByteArray<class_poolbytearray>` data **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`crop<class_Image_crop>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`decompress<class_Image_decompress>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`detect_alpha<class_Image_detect_alpha>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`expand_x2_hq2x<class_Image_expand_x2_hq2x>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`fix_alpha_edges<class_Image_fix_alpha_edges>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`flip_x<class_Image_flip_x>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`flip_y<class_Image_flip_y>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`generate_mipmaps<class_Image_generate_mipmaps>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolByteArray<class_poolbytearray>` | :ref:`get_data<class_Image_get_data>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_format<class_Image_get_format>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_height<class_Image_get_height>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_mipmap_offset<class_Image_get_mipmap_offset>` **(** :ref:`int<class_int>` mipmap **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_pixel<class_Image_get_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`get_rect<class_Image_get_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect2<class_rect2>` | :ref:`get_used_rect<class_Image_get_used_rect>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_width<class_Image_get_width>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_mipmaps<class_Image_has_mipmaps>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_compressed<class_Image_is_compressed>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_empty<class_Image_is_empty>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_invisible<class_Image_is_invisible>` **(** **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`load<class_Image_load>` **(** :ref:`String<class_string>` path **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`lock<class_Image_lock>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`normalmap_to_xy<class_Image_normalmap_to_xy>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`premultiply_alpha<class_Image_premultiply_alpha>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`put_pixel<class_Image_put_pixel>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`Color<class_color>` color **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize<class_Image_resize>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` interpolation=1 **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`resize_to_po2<class_Image_resize_to_po2>` **(** :ref:`bool<class_bool>` square="false" **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`save_png<class_Image_save_png>` **(** :ref:`String<class_string>` path **)** const |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shrink_x2<class_Image_shrink_x2>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`srgb_to_linear<class_Image_srgb_to_linear>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`unlock<class_Image_unlock>` **(** **)** |
|
||||
+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`Dictionary<class_dictionary>` **data**
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **COMPRESS_16BIT** = **0**
|
||||
- **COMPRESS_S3TC** = **1**
|
||||
- **COMPRESS_PVRTC2** = **2**
|
||||
- **COMPRESS_PVRTC4** = **3**
|
||||
- **COMPRESS_ETC** = **4**
|
||||
- **COMPRESS_ETC2** = **5**
|
||||
- **FORMAT_L8** = **0**
|
||||
- **FORMAT_LA8** = **1**
|
||||
- **FORMAT_R8** = **2**
|
||||
- **FORMAT_RG8** = **3**
|
||||
- **FORMAT_RGB8** = **4**
|
||||
- **FORMAT_RGBA8** = **5**
|
||||
- **FORMAT_RGB565** = **6**
|
||||
- **FORMAT_RGBA4444** = **7**
|
||||
- **FORMAT_RGBA5551** = **17**
|
||||
- **FORMAT_RF** = **9**
|
||||
- **FORMAT_RGF** = **10**
|
||||
- **FORMAT_RGBF** = **11**
|
||||
- **FORMAT_RGBAF** = **12**
|
||||
- **FORMAT_RH** = **13**
|
||||
- **FORMAT_RGH** = **14**
|
||||
- **FORMAT_RGBH** = **15**
|
||||
- **FORMAT_RGBAH** = **16**
|
||||
- **FORMAT_RGBA4444** = **6**
|
||||
- **FORMAT_RGBA5551** = **7**
|
||||
- **FORMAT_RF** = **8**
|
||||
- **FORMAT_RGF** = **9**
|
||||
- **FORMAT_RGBF** = **10**
|
||||
- **FORMAT_RGBAF** = **11**
|
||||
- **FORMAT_RH** = **12**
|
||||
- **FORMAT_RGH** = **13**
|
||||
- **FORMAT_RGBH** = **14**
|
||||
- **FORMAT_RGBAH** = **15**
|
||||
- **FORMAT_RGBE9995** = **16**
|
||||
- **FORMAT_DXT1** = **17**
|
||||
- **FORMAT_DXT3** = **18**
|
||||
- **FORMAT_DXT5** = **19**
|
||||
- **FORMAT_ATI1** = **20**
|
||||
- **FORMAT_ATI2** = **21**
|
||||
- **FORMAT_RGTC_R** = **20**
|
||||
- **FORMAT_RGTC_RG** = **21**
|
||||
- **FORMAT_BPTC_RGBA** = **22**
|
||||
- **FORMAT_BPTC_RGBF** = **23**
|
||||
- **FORMAT_BPTC_RGBFU** = **24**
|
||||
@@ -100,107 +145,196 @@ Numeric Constants
|
||||
- **INTERPOLATE_NEAREST** = **0**
|
||||
- **INTERPOLATE_BILINEAR** = **1**
|
||||
- **INTERPOLATE_CUBIC** = **2**
|
||||
- **ALPHA_NONE** = **0**
|
||||
- **ALPHA_BIT** = **1**
|
||||
- **ALPHA_BLEND** = **2**
|
||||
- **COMPRESS_S3TC** = **0**
|
||||
- **COMPRESS_PVRTC2** = **1**
|
||||
- **COMPRESS_PVRTC4** = **2**
|
||||
- **COMPRESS_ETC** = **3**
|
||||
- **COMPRESS_ETC2** = **4**
|
||||
- **COMPRESS_SOURCE_GENERIC** = **0**
|
||||
- **COMPRESS_SOURCE_SRGB** = **1**
|
||||
- **COMPRESS_SOURCE_NORMAL** = **2**
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Built in native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it.
|
||||
Native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_Image_Image:
|
||||
|
||||
- :ref:`Image<class_image>` **Image** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` mipmaps, :ref:`int<class_int>` format **)**
|
||||
|
||||
Create an empty image of a specific size and format.
|
||||
|
||||
.. _class_Image_blit_rect:
|
||||
|
||||
- void **blit_rect** **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)**
|
||||
- void **blit_rect** **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dst **)**
|
||||
|
||||
Copy a "src_rect" :ref:`Rect2<class_rect2>` from "src" :ref:`Image<class_image>` to this :ref:`Image<class_image>` on coordinates "dest".
|
||||
|
||||
.. _class_Image_compressed:
|
||||
.. _class_Image_clear_mipmaps:
|
||||
|
||||
- :ref:`Image<class_image>` **compressed** **(** :ref:`int<class_int>` format=0 **)**
|
||||
- void **clear_mipmaps** **(** **)**
|
||||
|
||||
Return a new compressed :ref:`Image<class_image>` from this :ref:`Image<class_image>` using one of :ref:`Image<class_image>`.COMPRESS\_\*.
|
||||
.. _class_Image_compress:
|
||||
|
||||
.. _class_Image_converted:
|
||||
- :ref:`int<class_int>` **compress** **(** :ref:`int<class_int>` mode, :ref:`int<class_int>` arg1, :ref:`float<class_float>` arg2 **)**
|
||||
|
||||
- :ref:`Image<class_image>` **converted** **(** :ref:`int<class_int>` format=0 **)**
|
||||
.. _class_Image_convert:
|
||||
|
||||
Return a new :ref:`Image<class_image>` from this :ref:`Image<class_image>` with a different format.
|
||||
- void **convert** **(** :ref:`int<class_int>` format **)**
|
||||
|
||||
.. _class_Image_decompressed:
|
||||
.. _class_Image_copy_from:
|
||||
|
||||
- :ref:`Image<class_image>` **decompressed** **(** **)**
|
||||
- void **copy_from** **(** :ref:`Image<class_image>` src **)**
|
||||
|
||||
Return a new decompressed :ref:`Image<class_image>`.
|
||||
.. _class_Image_create:
|
||||
|
||||
.. _class_Image_empty:
|
||||
- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`int<class_int>` format **)**
|
||||
|
||||
- :ref:`bool<class_bool>` **empty** **(** **)**
|
||||
Create an empty image of a specific size and format.
|
||||
|
||||
Return whether this :ref:`Image<class_image>` is empty(no data).
|
||||
.. _class_Image_create_from_data:
|
||||
|
||||
- void **create_from_data** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`int<class_int>` format, :ref:`PoolByteArray<class_poolbytearray>` data **)**
|
||||
|
||||
.. _class_Image_crop:
|
||||
|
||||
- void **crop** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
|
||||
|
||||
.. _class_Image_decompress:
|
||||
|
||||
- :ref:`int<class_int>` **decompress** **(** **)**
|
||||
|
||||
.. _class_Image_detect_alpha:
|
||||
|
||||
- :ref:`int<class_int>` **detect_alpha** **(** **)** const
|
||||
|
||||
.. _class_Image_expand_x2_hq2x:
|
||||
|
||||
- void **expand_x2_hq2x** **(** **)**
|
||||
|
||||
.. _class_Image_fix_alpha_edges:
|
||||
|
||||
- void **fix_alpha_edges** **(** **)**
|
||||
|
||||
.. _class_Image_flip_x:
|
||||
|
||||
- void **flip_x** **(** **)**
|
||||
|
||||
.. _class_Image_flip_y:
|
||||
|
||||
- void **flip_y** **(** **)**
|
||||
|
||||
.. _class_Image_generate_mipmaps:
|
||||
|
||||
- :ref:`int<class_int>` **generate_mipmaps** **(** **)**
|
||||
|
||||
.. _class_Image_get_data:
|
||||
|
||||
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)**
|
||||
- :ref:`PoolByteArray<class_poolbytearray>` **get_data** **(** **)** const
|
||||
|
||||
Return the raw data of the :ref:`Image<class_image>`.
|
||||
|
||||
.. _class_Image_get_format:
|
||||
|
||||
- :ref:`int<class_int>` **get_format** **(** **)**
|
||||
- :ref:`int<class_int>` **get_format** **(** **)** const
|
||||
|
||||
Return the format of the :ref:`Image<class_image>`, one of :ref:`Image<class_image>`.FORMAT\_\*.
|
||||
|
||||
.. _class_Image_get_height:
|
||||
|
||||
- :ref:`int<class_int>` **get_height** **(** **)**
|
||||
- :ref:`int<class_int>` **get_height** **(** **)** const
|
||||
|
||||
Return the height of the :ref:`Image<class_image>`.
|
||||
|
||||
.. _class_Image_get_mipmap_offset:
|
||||
|
||||
- :ref:`int<class_int>` **get_mipmap_offset** **(** :ref:`int<class_int>` mipmap **)** const
|
||||
|
||||
.. _class_Image_get_pixel:
|
||||
|
||||
- :ref:`Color<class_color>` **get_pixel** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y **)** const
|
||||
|
||||
.. _class_Image_get_rect:
|
||||
|
||||
- :ref:`Image<class_image>` **get_rect** **(** :ref:`Rect2<class_rect2>` area=0 **)**
|
||||
- :ref:`Image<class_image>` **get_rect** **(** :ref:`Rect2<class_rect2>` rect **)** const
|
||||
|
||||
Return a new :ref:`Image<class_image>` that is a copy of "area" in this :ref:`Image<class_image>`.
|
||||
|
||||
.. _class_Image_get_used_rect:
|
||||
|
||||
- :ref:`Rect2<class_rect2>` **get_used_rect** **(** **)**
|
||||
- :ref:`Rect2<class_rect2>` **get_used_rect** **(** **)** const
|
||||
|
||||
Return the area of this :ref:`Image<class_image>` that is used/visibly colored/opaque.
|
||||
|
||||
.. _class_Image_get_width:
|
||||
|
||||
- :ref:`int<class_int>` **get_width** **(** **)**
|
||||
- :ref:`int<class_int>` **get_width** **(** **)** const
|
||||
|
||||
Return the width of the :ref:`Image<class_image>`.
|
||||
|
||||
.. _class_Image_has_mipmaps:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_mipmaps** **(** **)** const
|
||||
|
||||
.. _class_Image_is_compressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_compressed** **(** **)** const
|
||||
|
||||
.. _class_Image_is_empty:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_empty** **(** **)** const
|
||||
|
||||
.. _class_Image_is_invisible:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_invisible** **(** **)** const
|
||||
|
||||
.. _class_Image_load:
|
||||
|
||||
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path=0 **)**
|
||||
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path **)**
|
||||
|
||||
Load an :ref:`Image<class_image>`.
|
||||
|
||||
.. _class_Image_resized:
|
||||
.. _class_Image_lock:
|
||||
|
||||
- :ref:`Image<class_image>` **resized** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` interpolation=1 **)**
|
||||
- void **lock** **(** **)**
|
||||
|
||||
Return a new :ref:`Image<class_image>` from this :ref:`Image<class_image>` that is resized to size "x,y" using :ref:`Image<class_image>`.INTERPOLATE\_\*.
|
||||
.. _class_Image_normalmap_to_xy:
|
||||
|
||||
- void **normalmap_to_xy** **(** **)**
|
||||
|
||||
.. _class_Image_premultiply_alpha:
|
||||
|
||||
- void **premultiply_alpha** **(** **)**
|
||||
|
||||
.. _class_Image_put_pixel:
|
||||
|
||||
- void **put_pixel** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_Image_resize:
|
||||
|
||||
- void **resize** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` interpolation=1 **)**
|
||||
|
||||
.. _class_Image_resize_to_po2:
|
||||
|
||||
- void **resize_to_po2** **(** :ref:`bool<class_bool>` square="false" **)**
|
||||
|
||||
.. _class_Image_save_png:
|
||||
|
||||
- :ref:`int<class_int>` **save_png** **(** :ref:`String<class_string>` path=0 **)**
|
||||
- :ref:`int<class_int>` **save_png** **(** :ref:`String<class_string>` path **)** const
|
||||
|
||||
Save this :ref:`Image<class_image>` as a png.
|
||||
|
||||
.. _class_Image_shrink_x2:
|
||||
|
||||
- void **shrink_x2** **(** **)**
|
||||
|
||||
.. _class_Image_srgb_to_linear:
|
||||
|
||||
- void **srgb_to_linear** **(** **)**
|
||||
|
||||
.. _class_Image_unlock:
|
||||
|
||||
- void **unlock** **(** **)**
|
||||
|
||||
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
.. 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_ImageSkyBox:
|
||||
|
||||
ImageSkyBox
|
||||
===========
|
||||
|
||||
**Inherits:** :ref:`SkyBox<class_skybox>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_image_path<class_ImageSkyBox_get_image_path>` **(** :ref:`int<class_int>` image **)** const |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_image_path<class_ImageSkyBox_set_image_path>` **(** :ref:`int<class_int>` image, :ref:`String<class_string>` path **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`String<class_string>` **image_path_negative_x**
|
||||
- :ref:`String<class_string>` **image_path_negative_y**
|
||||
- :ref:`String<class_string>` **image_path_negative_z**
|
||||
- :ref:`String<class_string>` **image_path_positive_x**
|
||||
- :ref:`String<class_string>` **image_path_positive_y**
|
||||
- :ref:`String<class_string>` **image_path_positive_z**
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **IMAGE_PATH_NEGATIVE_X** = **0**
|
||||
- **IMAGE_PATH_POSITIVE_X** = **1**
|
||||
- **IMAGE_PATH_NEGATIVE_Y** = **2**
|
||||
- **IMAGE_PATH_POSITIVE_Y** = **3**
|
||||
- **IMAGE_PATH_NEGATIVE_Z** = **4**
|
||||
- **IMAGE_PATH_POSITIVE_Z** = **5**
|
||||
- **IMAGE_PATH_MAX** = **6**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_ImageSkyBox_get_image_path:
|
||||
|
||||
- :ref:`String<class_string>` **get_image_path** **(** :ref:`int<class_int>` image **)** const
|
||||
|
||||
.. _class_ImageSkyBox_set_image_path:
|
||||
|
||||
- void **set_image_path** **(** :ref:`int<class_int>` image, :ref:`String<class_string>` path **)**
|
||||
|
||||
|
||||
@@ -23,8 +23,6 @@ Member Functions
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`create_from_image<class_ImageTexture_create_from_image>` **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`fix_alpha_edges<class_ImageTexture_fix_alpha_edges>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Image<class_image>` | :ref:`get_data<class_ImageTexture_get_data>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_format<class_ImageTexture_get_format>` **(** **)** const |
|
||||
@@ -35,10 +33,6 @@ Member Functions
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`load<class_ImageTexture_load>` **(** :ref:`String<class_string>` path **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`normal_to_xy<class_ImageTexture_normal_to_xy>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`premultiply_alpha<class_ImageTexture_premultiply_alpha>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_data<class_ImageTexture_set_data>` **(** :ref:`Image<class_image>` image **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_lossy_storage_quality<class_ImageTexture_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
|
||||
@@ -47,8 +41,6 @@ Member Functions
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_storage<class_ImageTexture_set_storage>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`shrink_x2_and_keep_size<class_ImageTexture_shrink_x2_and_keep_size>` **(** **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -81,10 +73,6 @@ Create a new :ref:`ImageTexture<class_imagetexture>` with "width" and "height".
|
||||
|
||||
Create a new :ref:`ImageTexture<class_imagetexture>` from an :ref:`Image<class_image>` with "flags" from :ref:`Texture<class_texture>`.FLAG\_\*.
|
||||
|
||||
.. _class_ImageTexture_fix_alpha_edges:
|
||||
|
||||
- void **fix_alpha_edges** **(** **)**
|
||||
|
||||
.. _class_ImageTexture_get_data:
|
||||
|
||||
- :ref:`Image<class_image>` **get_data** **(** **)** const
|
||||
@@ -115,14 +103,6 @@ Return the storage type. One of :ref:`ImageTexture<class_imagetexture>`.STORAGE\
|
||||
|
||||
Load an :ref:`ImageTexure<class_imagetexure>`.
|
||||
|
||||
.. _class_ImageTexture_normal_to_xy:
|
||||
|
||||
- void **normal_to_xy** **(** **)**
|
||||
|
||||
.. _class_ImageTexture_premultiply_alpha:
|
||||
|
||||
- void **premultiply_alpha** **(** **)**
|
||||
|
||||
.. _class_ImageTexture_set_data:
|
||||
|
||||
- void **set_data** **(** :ref:`Image<class_image>` image **)**
|
||||
@@ -145,8 +125,4 @@ Set the storage quality in case of :ref:`ImageTexture<class_imagetexture>`.STORA
|
||||
|
||||
Set the storage type. One of :ref:`ImageTexture<class_imagetexture>`.STORAGE\_\*.
|
||||
|
||||
.. _class_ImageTexture_shrink_x2_and_keep_size:
|
||||
|
||||
- void **shrink_x2_and_keep_size** **(** **)**
|
||||
|
||||
|
||||
|
||||
@@ -75,7 +75,7 @@ Member Functions
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** const |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`parse_input_event<class_Input_parse_input_event>` **(** :ref:`InputEvent<class_inputevent>` event **)** |
|
||||
| void | :ref:`parse_input_event<class_Input_parse_input_event>` **(** :ref:`Object<class_object>` event **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_joy_mapping<class_Input_remove_joy_mapping>` **(** :ref:`String<class_string>` guid **)** |
|
||||
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -94,6 +94,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **joy_connection_changed** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` connected **)**
|
||||
Emitted when a joypad device has been connected or disconnected
|
||||
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -261,7 +263,7 @@ Returns true or false depending on whether mouse button is pressed or not. You c
|
||||
|
||||
.. _class_Input_parse_input_event:
|
||||
|
||||
- void **parse_input_event** **(** :ref:`InputEvent<class_inputevent>` event **)**
|
||||
- void **parse_input_event** **(** :ref:`Object<class_object>` event **)**
|
||||
|
||||
.. _class_Input_remove_joy_mapping:
|
||||
|
||||
|
||||
@@ -6,92 +6,111 @@
|
||||
InputEvent
|
||||
==========
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`InputEventScreenTouch<class_inputeventscreentouch>`, :ref:`InputEventWithModifiers<class_inputeventwithmodifiers>`, :ref:`InputEventScreenDrag<class_inputeventscreendrag>`, :ref:`InputEventJoypadMotion<class_inputeventjoypadmotion>`, :ref:`InputEventJoypadButton<class_inputeventjoypadbutton>`, :ref:`InputEventAction<class_inputeventaction>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event data.
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEvent_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEvent_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEvent_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEvent_is_echo>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEvent_is_pressed>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEvent_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Built-in input event data. InputEvent is a built-in engine datatype, given that it's passed around and used so much. Depending on its type, the members contained can be different, so read the documentation well! Input events can also represent actions (editable from the project settings).
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`action_match<class_InputEvent_action_match>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`as_text<class_InputEvent_as_text>` **(** **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_device<class_InputEvent_get_device>` **(** **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_id<class_InputEvent_get_id>` **(** **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEvent_is_action>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEvent_is_action_pressed>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEvent_is_action_released>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_type<class_InputEvent_is_action_type>` **(** **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEvent_is_echo>` **(** **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEvent_is_pressed>` **(** **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_device<class_InputEvent_set_device>` **(** :ref:`int<class_int>` device **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_id<class_InputEvent_set_id>` **(** :ref:`int<class_int>` id **)** |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`InputEvent<class_inputevent>` | :ref:`xformed_by<class_InputEvent_xformed_by>` **(** :ref:`Transform2D<class_transform2d>` xform, :ref:`Vector2<class_vector2>` local_ofs=Vector2(0, 0) **)** const |
|
||||
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEvent_action_match:
|
||||
|
||||
- :ref:`bool<class_bool>` **action_match** **(** :ref:`InputEvent<class_inputevent>` event **)** const
|
||||
|
||||
.. _class_InputEvent_as_text:
|
||||
|
||||
- :ref:`String<class_string>` **as_text** **(** **)** const
|
||||
|
||||
.. _class_InputEvent_get_device:
|
||||
|
||||
- :ref:`int<class_int>` **get_device** **(** **)** const
|
||||
|
||||
.. _class_InputEvent_get_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_id** **(** **)** const
|
||||
|
||||
.. _class_InputEvent_is_action:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)** const
|
||||
|
||||
Return if this input event matches a pre-defined action, no matter the type.
|
||||
|
||||
.. _class_InputEvent_is_action_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)** const
|
||||
|
||||
Return whether the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
|
||||
|
||||
.. _class_InputEvent_is_action_released:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)** const
|
||||
|
||||
Return whether the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
|
||||
|
||||
.. _class_InputEvent_is_action_type:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_type** **(** **)** const
|
||||
|
||||
.. _class_InputEvent_is_echo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)** const
|
||||
|
||||
Return if this input event is an echo event (only for events of type KEY, it will return false for other types).
|
||||
|
||||
.. _class_InputEvent_is_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)** const
|
||||
|
||||
Return if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE.
|
||||
|
||||
.. _class_InputEvent_set_as_action:
|
||||
.. _class_InputEvent_set_device:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
- void **set_device** **(** :ref:`int<class_int>` device **)**
|
||||
|
||||
Change the input event to an action event of the given name, regardless of its initial type, with the pressed status passed as argument.
|
||||
.. _class_InputEvent_set_id:
|
||||
|
||||
- void **set_id** **(** :ref:`int<class_int>` id **)**
|
||||
|
||||
.. _class_InputEvent_xformed_by:
|
||||
|
||||
- :ref:`InputEvent<class_inputevent>` **xformed_by** **(** :ref:`Transform2D<class_transform2d>` xform, :ref:`Vector2<class_vector2>` local_ofs=Vector2(0, 0) **)** const
|
||||
|
||||
|
||||
|
||||
@@ -6,92 +6,45 @@
|
||||
InputEventAction
|
||||
================
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event type for actions.
|
||||
Input event type for actions.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventAction_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventAction_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventAction_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventAction_is_echo>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventAction_is_pressed>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEventAction_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_action<class_InputEventAction_get_action>` **(** **)** const |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_action<class_InputEventAction_set_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pressed<class_InputEventAction_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
||||
+------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Input event type for actions that extends the global :ref:`InputEvent<class_inputevent>` type.
|
||||
- :ref:`String<class_string>` **action**
|
||||
- :ref:`bool<class_bool>` **pressed**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventAction_is_action:
|
||||
.. _class_InputEventAction_get_action:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`String<class_string>` **get_action** **(** **)** const
|
||||
|
||||
Return if this input event matches a pre-defined action, i.e. always true for InputEventAction.
|
||||
.. _class_InputEventAction_set_action:
|
||||
|
||||
.. _class_InputEventAction_is_action_pressed:
|
||||
- void **set_action** **(** :ref:`String<class_string>` action **)**
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
.. _class_InputEventAction_set_pressed:
|
||||
|
||||
Return whether the given action is being pressed.
|
||||
|
||||
.. _class_InputEventAction_is_action_released:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
|
||||
Return whether the given action is released (i.e. not pressed).
|
||||
|
||||
.. _class_InputEventAction_is_echo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
|
||||
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
|
||||
|
||||
.. _class_InputEventAction_is_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
|
||||
Return if this input event is pressed.
|
||||
|
||||
.. _class_InputEventAction_set_as_action:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Change the input event to an action event of the given name with the pressed status passed as argument.
|
||||
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
|
||||
|
||||
@@ -6,95 +6,58 @@
|
||||
InputEventJoypadButton
|
||||
======================
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event type for joypad button events.
|
||||
Input event type for joypad button events.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventJoypadButton_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventJoypadButton_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventJoypadButton_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventJoypadButton_is_echo>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventJoypadButton_is_pressed>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEventJoypadButton_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_button_index<class_InputEventJoypadButton_get_button_index>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pressure<class_InputEventJoypadButton_get_pressure>` **(** **)** const |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_button_index<class_InputEventJoypadButton_set_button_index>` **(** :ref:`int<class_int>` button_index **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pressed<class_InputEventJoypadButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pressure<class_InputEventJoypadButton_set_pressure>` **(** :ref:`float<class_float>` pressure **)** |
|
||||
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`int<class_int>` **button_index** - Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope].
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`bool<class_bool>` **pressed** - Pressed state of the joypad button.
|
||||
- :ref:`float<class_float>` **pressure** - Intensity of the button pressure, ranges from 0 to 1.0.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Input event type for joypad button events that extends the global :ref:`InputEvent<class_inputevent>` type.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventJoypadButton_is_action:
|
||||
.. _class_InputEventJoypadButton_get_button_index:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`int<class_int>` **get_button_index** **(** **)** const
|
||||
|
||||
Return if this input event matches a pre-defined action.
|
||||
.. _class_InputEventJoypadButton_get_pressure:
|
||||
|
||||
.. _class_InputEventJoypadButton_is_action_pressed:
|
||||
- :ref:`float<class_float>` **get_pressure** **(** **)** const
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
.. _class_InputEventJoypadButton_set_button_index:
|
||||
|
||||
Return whether the given action is being pressed.
|
||||
- void **set_button_index** **(** :ref:`int<class_int>` button_index **)**
|
||||
|
||||
.. _class_InputEventJoypadButton_is_action_released:
|
||||
.. _class_InputEventJoypadButton_set_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Return whether the given action is released (i.e. not pressed).
|
||||
.. _class_InputEventJoypadButton_set_pressure:
|
||||
|
||||
.. _class_InputEventJoypadButton_is_echo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
|
||||
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
|
||||
|
||||
.. _class_InputEventJoypadButton_is_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
|
||||
Return if this input event is pressed.
|
||||
|
||||
.. _class_InputEventJoypadButton_set_as_action:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Change the input event to an action event of the given name with the pressed status passed as argument.
|
||||
- void **set_pressure** **(** :ref:`float<class_float>` pressure **)**
|
||||
|
||||
|
||||
|
||||
@@ -6,92 +6,51 @@
|
||||
InputEventJoypadMotion
|
||||
======================
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event type for joypad motion/axis events.
|
||||
Input event type for joypad motion/axis events.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventJoypadMotion_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventJoypadMotion_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventJoypadMotion_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventJoypadMotion_is_echo>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventJoypadMotion_is_pressed>` **(** **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEventJoypadMotion_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_axis<class_InputEventJoypadMotion_get_axis>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_axis_value<class_InputEventJoypadMotion_get_axis_value>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_axis<class_InputEventJoypadMotion_set_axis>` **(** :ref:`int<class_int>` axis **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_axis_value<class_InputEventJoypadMotion_set_axis_value>` **(** :ref:`float<class_float>` axis_value **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`int<class_int>` **axis** - Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope].
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
- :ref:`float<class_float>` **value** - Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position.
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Input event type for joypad motion/axis events that extends the global :ref:`InputEvent<class_inputevent>` type.
|
||||
- :ref:`float<class_float>` **axis_value** - Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventJoypadMotion_is_action:
|
||||
.. _class_InputEventJoypadMotion_get_axis:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`int<class_int>` **get_axis** **(** **)** const
|
||||
|
||||
.. _class_InputEventJoypadMotion_is_action_pressed:
|
||||
.. _class_InputEventJoypadMotion_get_axis_value:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`float<class_float>` **get_axis_value** **(** **)** const
|
||||
|
||||
Return whether the given action is being pressed.
|
||||
.. _class_InputEventJoypadMotion_set_axis:
|
||||
|
||||
.. _class_InputEventJoypadMotion_is_action_released:
|
||||
- void **set_axis** **(** :ref:`int<class_int>` axis **)**
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
.. _class_InputEventJoypadMotion_set_axis_value:
|
||||
|
||||
Return whether the given action is released (i.e. not pressed).
|
||||
|
||||
.. _class_InputEventJoypadMotion_is_echo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
|
||||
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
|
||||
|
||||
.. _class_InputEventJoypadMotion_is_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
|
||||
Return if this input event is pressed.
|
||||
|
||||
.. _class_InputEventJoypadMotion_set_as_action:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Change the input event to an action event of the given name with the pressed status passed as argument.
|
||||
- void **set_axis_value** **(** :ref:`float<class_float>` axis_value **)**
|
||||
|
||||
|
||||
|
||||
@@ -6,100 +6,71 @@
|
||||
InputEventKey
|
||||
=============
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`InputEventWithModifiers<class_inputeventwithmodifiers>` **<** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event type for keyboard events.
|
||||
Input event type for keyboard events.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventKey_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventKey_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventKey_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventKey_is_echo>` **(** **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventKey_is_pressed>` **(** **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEventKey_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_scancode<class_InputEventKey_get_scancode>` **(** **)** const |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_scancode_with_modifiers<class_InputEventKey_get_scancode_with_modifiers>` **(** **)** const |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_unicode<class_InputEventKey_get_unicode>` **(** **)** const |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_echo<class_InputEventKey_set_echo>` **(** :ref:`bool<class_bool>` echo **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pressed<class_InputEventKey_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_scancode<class_InputEventKey_set_scancode>` **(** :ref:`int<class_int>` scancode **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_unicode<class_InputEventKey_set_unicode>` **(** :ref:`int<class_int>` unicode **)** |
|
||||
+------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`bool<class_bool>` **alt** - State of the Alt modifier.
|
||||
- :ref:`bool<class_bool>` **control** - State of the Ctrl modifier.
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`bool<class_bool>` **echo** - Echo state of the key, i.e. whether it's a repeat event or not.
|
||||
- :ref:`bool<class_bool>` **meta** - State of the Meta modifier.
|
||||
- :ref:`int<class_int>` **echo** - Echo state of the key, i.e. whether it's a repeat event or not.
|
||||
- :ref:`bool<class_bool>` **pressed** - Pressed state of the key.
|
||||
- :ref:`int<class_int>` **scancode** - Scancode of the key, one of the KEY_* constants in [@Global Scope].
|
||||
- :ref:`bool<class_bool>` **shift** - State of the Shift modifier.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
- :ref:`int<class_int>` **unicode** - Unicode identifier of the key (when relevant).
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Input event type for keyboard events that extends the global :ref:`InputEvent<class_inputevent>` type.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventKey_is_action:
|
||||
.. _class_InputEventKey_get_scancode:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`int<class_int>` **get_scancode** **(** **)** const
|
||||
|
||||
Return if this input event matches a pre-defined action.
|
||||
.. _class_InputEventKey_get_scancode_with_modifiers:
|
||||
|
||||
.. _class_InputEventKey_is_action_pressed:
|
||||
- :ref:`int<class_int>` **get_scancode_with_modifiers** **(** **)** const
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
.. _class_InputEventKey_get_unicode:
|
||||
|
||||
Return whether the given action is being pressed.
|
||||
- :ref:`int<class_int>` **get_unicode** **(** **)** const
|
||||
|
||||
.. _class_InputEventKey_is_action_released:
|
||||
.. _class_InputEventKey_set_echo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
- void **set_echo** **(** :ref:`bool<class_bool>` echo **)**
|
||||
|
||||
Return whether the given action is released (i.e. not pressed).
|
||||
.. _class_InputEventKey_set_pressed:
|
||||
|
||||
.. _class_InputEventKey_is_echo:
|
||||
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
.. _class_InputEventKey_set_scancode:
|
||||
|
||||
Return if this input event is an echo event.
|
||||
- void **set_scancode** **(** :ref:`int<class_int>` scancode **)**
|
||||
|
||||
.. _class_InputEventKey_is_pressed:
|
||||
.. _class_InputEventKey_set_unicode:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
|
||||
Return if this input event is pressed.
|
||||
|
||||
.. _class_InputEventKey_set_as_action:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Change the input event to an action event of the given name with the pressed status passed as argument.
|
||||
- void **set_unicode** **(** :ref:`int<class_int>` unicode **)**
|
||||
|
||||
|
||||
|
||||
71
classes/class_inputeventmouse.rst
Normal file
71
classes/class_inputeventmouse.rst
Normal file
@@ -0,0 +1,71 @@
|
||||
.. 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_InputEventMouse:
|
||||
|
||||
InputEventMouse
|
||||
===============
|
||||
|
||||
**Inherits:** :ref:`InputEventWithModifiers<class_inputeventwithmodifiers>` **<** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`InputEventMouseMotion<class_inputeventmousemotion>`, :ref:`InputEventMouseButton<class_inputeventmousebutton>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Base input event type for mouse events.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_button_mask<class_InputEventMouse_get_button_mask>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_global_position<class_InputEventMouse_get_global_position>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_InputEventMouse_get_position>` **(** **)** const |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_button_mask<class_InputEventMouse_set_button_mask>` **(** :ref:`int<class_int>` button_mask **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_global_position<class_InputEventMouse_set_global_position>` **(** :ref:`Vector2<class_vector2>` global_position **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_position<class_InputEventMouse_set_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
|
||||
- :ref:`Vector2<class_vector2>` **global_position** - Global position of the mouse click.
|
||||
- :ref:`Vector2<class_vector2>` **position** - Local position of the mouse click.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventMouse_get_button_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_button_mask** **(** **)** const
|
||||
|
||||
.. _class_InputEventMouse_get_global_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_global_position** **(** **)** const
|
||||
|
||||
.. _class_InputEventMouse_get_position:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
|
||||
|
||||
.. _class_InputEventMouse_set_button_mask:
|
||||
|
||||
- void **set_button_mask** **(** :ref:`int<class_int>` button_mask **)**
|
||||
|
||||
.. _class_InputEventMouse_set_global_position:
|
||||
|
||||
- void **set_global_position** **(** :ref:`Vector2<class_vector2>` global_position **)**
|
||||
|
||||
.. _class_InputEventMouse_set_position:
|
||||
|
||||
- void **set_position** **(** :ref:`Vector2<class_vector2>` position **)**
|
||||
|
||||
|
||||
@@ -6,106 +6,71 @@
|
||||
InputEventMouseButton
|
||||
=====================
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`InputEventMouse<class_inputeventmouse>` **<** :ref:`InputEventWithModifiers<class_inputeventwithmodifiers>` **<** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event type for mouse button events.
|
||||
Input event type for mouse button events.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventMouseButton_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventMouseButton_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventMouseButton_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventMouseButton_is_echo>` **(** **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventMouseButton_is_pressed>` **(** **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEventMouseButton_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_button_index<class_InputEventMouseButton_get_button_index>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_factor<class_InputEventMouseButton_get_factor>` **(** **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_doubleclick<class_InputEventMouseButton_is_doubleclick>` **(** **)** const |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_button_index<class_InputEventMouseButton_set_button_index>` **(** :ref:`int<class_int>` button_index **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_doubleclick<class_InputEventMouseButton_set_doubleclick>` **(** :ref:`bool<class_bool>` doubleclick **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_factor<class_InputEventMouseButton_set_factor>` **(** :ref:`float<class_float>` factor **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pressed<class_InputEventMouseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
||||
+----------------------------+------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`bool<class_bool>` **alt** - State of the Alt modifier.
|
||||
- :ref:`int<class_int>` **button_index** - Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope].
|
||||
- :ref:`int<class_int>` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
|
||||
- :ref:`bool<class_bool>` **control** - State of the Control modifier.
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`bool<class_bool>` **doubleclick** - Whether the event is a double-click.
|
||||
- :ref:`Vector2<class_vector2>` **global_pos** - Global position of the mouse click.
|
||||
- :ref:`float<class_float>` **global_x** - Global X coordinate of the mouse click.
|
||||
- :ref:`float<class_float>` **global_y** - Global Y coordinate of the mouse click.
|
||||
- :ref:`bool<class_bool>` **meta** - State of the Meta modifier.
|
||||
- :ref:`Vector2<class_vector2>` **pos** - Local position of the mouse click.
|
||||
- :ref:`float<class_float>` **factor**
|
||||
- :ref:`bool<class_bool>` **pressed** - Pressed state of the mouse button.
|
||||
- :ref:`bool<class_bool>` **shift** - State of the Shift modifier.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
- :ref:`float<class_float>` **x** - Local X coordinate of the mouse click.
|
||||
- :ref:`float<class_float>` **y** - Local Y coordinate of the mouse click.
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Input event type for mouse button events that extends the global :ref:`InputEvent<class_inputevent>` type.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventMouseButton_is_action:
|
||||
.. _class_InputEventMouseButton_get_button_index:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`int<class_int>` **get_button_index** **(** **)** const
|
||||
|
||||
Return if this input event matches a pre-defined action.
|
||||
.. _class_InputEventMouseButton_get_factor:
|
||||
|
||||
.. _class_InputEventMouseButton_is_action_pressed:
|
||||
- :ref:`float<class_float>` **get_factor** **(** **)**
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
.. _class_InputEventMouseButton_is_doubleclick:
|
||||
|
||||
Return whether the given action is being pressed.
|
||||
- :ref:`bool<class_bool>` **is_doubleclick** **(** **)** const
|
||||
|
||||
.. _class_InputEventMouseButton_is_action_released:
|
||||
.. _class_InputEventMouseButton_set_button_index:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
- void **set_button_index** **(** :ref:`int<class_int>` button_index **)**
|
||||
|
||||
Return whether the given action is released (i.e. not pressed).
|
||||
.. _class_InputEventMouseButton_set_doubleclick:
|
||||
|
||||
.. _class_InputEventMouseButton_is_echo:
|
||||
- void **set_doubleclick** **(** :ref:`bool<class_bool>` doubleclick **)**
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
.. _class_InputEventMouseButton_set_factor:
|
||||
|
||||
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
|
||||
- void **set_factor** **(** :ref:`float<class_float>` factor **)**
|
||||
|
||||
.. _class_InputEventMouseButton_is_pressed:
|
||||
.. _class_InputEventMouseButton_set_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
|
||||
Return if this input event is pressed.
|
||||
|
||||
.. _class_InputEventMouseButton_set_as_action:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Change the input event to an action event of the given name with the pressed status passed as argument.
|
||||
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
|
||||
|
||||
@@ -6,109 +6,51 @@
|
||||
InputEventMouseMotion
|
||||
=====================
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`InputEventMouse<class_inputeventmouse>` **<** :ref:`InputEventWithModifiers<class_inputeventwithmodifiers>` **<** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event type for mouse motion events.
|
||||
Input event type for mouse motion events.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventMouseMotion_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventMouseMotion_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventMouseMotion_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventMouseMotion_is_echo>` **(** **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventMouseMotion_is_pressed>` **(** **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEventMouseMotion_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_relative<class_InputEventMouseMotion_get_relative>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_speed<class_InputEventMouseMotion_get_speed>` **(** **)** const |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_relative<class_InputEventMouseMotion_set_relative>` **(** :ref:`Vector2<class_vector2>` relative **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_speed<class_InputEventMouseMotion_set_speed>` **(** :ref:`Vector2<class_vector2>` speed **)** |
|
||||
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`bool<class_bool>` **alt** - State of the Alt modifier.
|
||||
- :ref:`int<class_int>` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
|
||||
- :ref:`bool<class_bool>` **control** - State of the Ctrl modifier.
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`Vector2<class_vector2>` **global_pos** - Global position of the mouse pointer.
|
||||
- :ref:`float<class_float>` **global_x** - Global X coordinate of the mouse pointer.
|
||||
- :ref:`float<class_float>` **global_y** - Global Y coordinate of the mouse pointer.
|
||||
- :ref:`bool<class_bool>` **meta** - State of the Meta modifier.
|
||||
- :ref:`Vector2<class_vector2>` **pos** - Local position of the mouse pointer.
|
||||
- :ref:`Vector2<class_vector2>` **relative_pos** - Position of the mouse pointer relative to the previous mouse position.
|
||||
- :ref:`float<class_float>` **relative_x** - X coordinate of the mouse pointer relative to the previous mouse position.
|
||||
- :ref:`float<class_float>` **relative_y** - Y coordinate of the mouse pointer relative to the previous mouse position.
|
||||
- :ref:`bool<class_bool>` **shift** - State of the Shift modifier.
|
||||
- :ref:`Vector2<class_vector2>` **relative** - Position of the mouse pointer relative to the previous mouse position.
|
||||
- :ref:`Vector2<class_vector2>` **speed** - Speed of the mouse pointer.
|
||||
- :ref:`float<class_float>` **speed_x** - Speed of the mouse pointer on the X axis.
|
||||
- :ref:`float<class_float>` **speed_y** - Speed of the mouse pointer on the Y axis.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
- :ref:`float<class_float>` **x** - Local X coordinate of the mouse pointer.
|
||||
- :ref:`float<class_float>` **y** - Local Y coordinate of the mouse pointer.
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Input event type for mouse motion events that extends the global :ref:`InputEvent<class_inputevent>` type.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventMouseMotion_is_action:
|
||||
.. _class_InputEventMouseMotion_get_relative:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`Vector2<class_vector2>` **get_relative** **(** **)** const
|
||||
|
||||
Return if this input event matches a pre-defined action.
|
||||
.. _class_InputEventMouseMotion_get_speed:
|
||||
|
||||
.. _class_InputEventMouseMotion_is_action_pressed:
|
||||
- :ref:`Vector2<class_vector2>` **get_speed** **(** **)** const
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
.. _class_InputEventMouseMotion_set_relative:
|
||||
|
||||
Return whether the given action is being pressed. Not relevant for MOUSE_MOTION events, always false.
|
||||
- void **set_relative** **(** :ref:`Vector2<class_vector2>` relative **)**
|
||||
|
||||
.. _class_InputEventMouseMotion_is_action_released:
|
||||
.. _class_InputEventMouseMotion_set_speed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
|
||||
Return whether the given action is released (i.e. not pressed). Not relevant for MOUSE_MOTION events, can be true or false depending on whether :ref:`is_action<class_InputEventMouseMotion_is_action>` is true.
|
||||
|
||||
.. _class_InputEventMouseMotion_is_echo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
|
||||
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
|
||||
|
||||
.. _class_InputEventMouseMotion_is_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
|
||||
Return if this input event is pressed. Not relevant for MOUSE_MOTION events, always false.
|
||||
|
||||
.. _class_InputEventMouseMotion_set_as_action:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Change the input event to an action event of the given name with the (irrelevant for this type) pressed status passed as argument.
|
||||
- void **set_speed** **(** :ref:`Vector2<class_vector2>` speed **)**
|
||||
|
||||
|
||||
|
||||
@@ -6,102 +6,77 @@
|
||||
InputEventScreenDrag
|
||||
====================
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event type for screen drag events.
|
||||
Input event type for screen drag events.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventScreenDrag_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventScreenDrag_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventScreenDrag_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventScreenDrag_is_echo>` **(** **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventScreenDrag_is_pressed>` **(** **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEventScreenDrag_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_index<class_InputEventScreenDrag_get_index>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_InputEventScreenDrag_get_position>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_relative<class_InputEventScreenDrag_get_relative>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_speed<class_InputEventScreenDrag_get_speed>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_index<class_InputEventScreenDrag_set_index>` **(** :ref:`int<class_int>` index **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_position<class_InputEventScreenDrag_set_position>` **(** :ref:`Vector2<class_vector2>` position **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_relative<class_InputEventScreenDrag_set_relative>` **(** :ref:`Vector2<class_vector2>` relative **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_speed<class_InputEventScreenDrag_set_speed>` **(** :ref:`Vector2<class_vector2>` speed **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`int<class_int>` **index** - Drag event index in the case of a multi-drag event.
|
||||
- :ref:`Vector2<class_vector2>` **pos** - Position of the drag event.
|
||||
- :ref:`Vector2<class_vector2>` **relative_pos** - Position of the drag event relative to its start position.
|
||||
- :ref:`float<class_float>` **relative_x** - X coordinate of the drag event relative to its start position.
|
||||
- :ref:`float<class_float>` **relative_y** - Y coordinate of the drag event relative to its start position.
|
||||
- :ref:`Vector2<class_vector2>` **position** - Position of the drag event.
|
||||
- :ref:`Vector2<class_vector2>` **relative** - Position of the drag event relative to its start position.
|
||||
- :ref:`Vector2<class_vector2>` **speed** - Speed of the drag event.
|
||||
- :ref:`float<class_float>` **speed_x** - Speed of the drag event on the X axis.
|
||||
- :ref:`float<class_float>` **speed_y** - Speed of the drag event on the Y axis.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
- :ref:`float<class_float>` **x** - X coordinate of the drag event.
|
||||
- :ref:`float<class_float>` **y** - Y coordinate of the drag event.
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Input event type for screen drag events that extends the global :ref:`InputEvent<class_inputevent>` type.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventScreenDrag_is_action:
|
||||
.. _class_InputEventScreenDrag_get_index:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`int<class_int>` **get_index** **(** **)** const
|
||||
|
||||
Return if this input event matches a pre-defined action.
|
||||
.. _class_InputEventScreenDrag_get_position:
|
||||
|
||||
.. _class_InputEventScreenDrag_is_action_pressed:
|
||||
- :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
.. _class_InputEventScreenDrag_get_relative:
|
||||
|
||||
Return whether the given action is being pressed. Not relevant for SCREEN_DRAG events, always false.
|
||||
- :ref:`Vector2<class_vector2>` **get_relative** **(** **)** const
|
||||
|
||||
.. _class_InputEventScreenDrag_is_action_released:
|
||||
.. _class_InputEventScreenDrag_get_speed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`Vector2<class_vector2>` **get_speed** **(** **)** const
|
||||
|
||||
Return whether the given action is released (i.e. not pressed). Not relevant for SCREEN_DRAG events, can be true or false depending on whether :ref:`is_action<class_InputEventScreenDrag_is_action>` is true.
|
||||
.. _class_InputEventScreenDrag_set_index:
|
||||
|
||||
.. _class_InputEventScreenDrag_is_echo:
|
||||
- void **set_index** **(** :ref:`int<class_int>` index **)**
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
.. _class_InputEventScreenDrag_set_position:
|
||||
|
||||
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
|
||||
- void **set_position** **(** :ref:`Vector2<class_vector2>` position **)**
|
||||
|
||||
.. _class_InputEventScreenDrag_is_pressed:
|
||||
.. _class_InputEventScreenDrag_set_relative:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
- void **set_relative** **(** :ref:`Vector2<class_vector2>` relative **)**
|
||||
|
||||
Return if this input event is pressed. Not relevant for SCREEN_DRAG events, always false.
|
||||
.. _class_InputEventScreenDrag_set_speed:
|
||||
|
||||
.. _class_InputEventScreenDrag_set_as_action:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Change the input event to an action event of the given name with the (irrelevant for this type) pressed status passed as argument.
|
||||
- void **set_speed** **(** :ref:`Vector2<class_vector2>` speed **)**
|
||||
|
||||
|
||||
|
||||
@@ -6,97 +6,58 @@
|
||||
InputEventScreenTouch
|
||||
=====================
|
||||
|
||||
**Category:** Built-In Types
|
||||
**Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Built-in input event type for touchscreen drag events.
|
||||
Input event type for screen touch events.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventScreenTouch_is_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventScreenTouch_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventScreenTouch_is_action_released>` **(** :ref:`String<class_string>` action **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventScreenTouch_is_echo>` **(** **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_InputEventScreenTouch_is_pressed>` **(** **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_as_action<class_InputEventScreenTouch_set_as_action>` **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_index<class_InputEventScreenTouch_get_index>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_position<class_InputEventScreenTouch_get_position>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_index<class_InputEventScreenTouch_set_index>` **(** :ref:`int<class_int>` index **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_position<class_InputEventScreenTouch_set_position>` **(** :ref:`Vector2<class_vector2>` pos **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pressed<class_InputEventScreenTouch_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
|
||||
- :ref:`int<class_int>` **device** - Device identifier.
|
||||
- :ref:`int<class_int>` **index** - Touch event index in the case of a multi-touch event.
|
||||
- :ref:`Vector2<class_vector2>` **pos** - Position of the touch event.
|
||||
- :ref:`Vector2<class_vector2>` **position** - Position of the touch event.
|
||||
- :ref:`bool<class_bool>` **pressed** - Pressed state of the touch event.
|
||||
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
|
||||
- :ref:`float<class_float>` **x** - X coordinate of the touch event.
|
||||
- :ref:`float<class_float>` **y** - Y coordinate of the touch event.
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NONE** = **0** --- Empty input event.
|
||||
- **KEY** = **1** --- Key event.
|
||||
- **MOUSE_MOTION** = **2** --- Mouse motion event.
|
||||
- **MOUSE_BUTTON** = **3** --- Mouse button event.
|
||||
- **JOYPAD_MOTION** = **4** --- Joypad motion event.
|
||||
- **JOYPAD_BUTTON** = **5** --- Joypad button event.
|
||||
- **SCREEN_TOUCH** = **6** --- Screen touch event.
|
||||
- **SCREEN_DRAG** = **7** --- Screen drag event.
|
||||
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Input event type for touchscreen drag events that extends the global :ref:`InputEvent<class_inputevent>` type.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventScreenTouch_is_action:
|
||||
.. _class_InputEventScreenTouch_get_index:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
|
||||
- :ref:`int<class_int>` **get_index** **(** **)** const
|
||||
|
||||
Return if this input event matches a pre-defined action.
|
||||
.. _class_InputEventScreenTouch_get_position:
|
||||
|
||||
.. _class_InputEventScreenTouch_is_action_pressed:
|
||||
- :ref:`Vector2<class_vector2>` **get_position** **(** **)** const
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
|
||||
.. _class_InputEventScreenTouch_set_index:
|
||||
|
||||
Return whether the given action is being pressed.
|
||||
- void **set_index** **(** :ref:`int<class_int>` index **)**
|
||||
|
||||
.. _class_InputEventScreenTouch_is_action_released:
|
||||
.. _class_InputEventScreenTouch_set_position:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
|
||||
- void **set_position** **(** :ref:`Vector2<class_vector2>` pos **)**
|
||||
|
||||
Return whether the given action is released (i.e. not pressed).
|
||||
.. _class_InputEventScreenTouch_set_pressed:
|
||||
|
||||
.. _class_InputEventScreenTouch_is_echo:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_echo** **(** **)**
|
||||
|
||||
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
|
||||
|
||||
.. _class_InputEventScreenTouch_is_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
|
||||
|
||||
Return if this input event is pressed.
|
||||
|
||||
.. _class_InputEventScreenTouch_set_as_action:
|
||||
|
||||
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
Change the input event to an action event of the given name with the pressed status passed as argument.
|
||||
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
||||
|
||||
|
||||
|
||||
97
classes/class_inputeventwithmodifiers.rst
Normal file
97
classes/class_inputeventwithmodifiers.rst
Normal file
@@ -0,0 +1,97 @@
|
||||
.. 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_InputEventWithModifiers:
|
||||
|
||||
InputEventWithModifiers
|
||||
=======================
|
||||
|
||||
**Inherits:** :ref:`InputEvent<class_inputevent>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`InputEventKey<class_inputeventkey>`, :ref:`InputEventMouse<class_inputeventmouse>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
Base class for input events with modifiers.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_alt<class_InputEventWithModifiers_get_alt>` **(** **)** const |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_command<class_InputEventWithModifiers_get_command>` **(** **)** const |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_control<class_InputEventWithModifiers_get_control>` **(** **)** const |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_metakey<class_InputEventWithModifiers_get_metakey>` **(** **)** const |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_shift<class_InputEventWithModifiers_get_shift>` **(** **)** const |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_alt<class_InputEventWithModifiers_set_alt>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_command<class_InputEventWithModifiers_set_command>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_control<class_InputEventWithModifiers_set_control>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_metakey<class_InputEventWithModifiers_set_metakey>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shift<class_InputEventWithModifiers_set_shift>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------+------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`bool<class_bool>` **alt** - State of the Alt modifier.
|
||||
- :ref:`bool<class_bool>` **command** - State of the Command modifier.
|
||||
- :ref:`bool<class_bool>` **control** - State of the Ctrl modifier.
|
||||
- :ref:`bool<class_bool>` **meta** - State of the Meta modifier.
|
||||
- :ref:`bool<class_bool>` **shift** - State of the Shift modifier.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputEventWithModifiers_get_alt:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_alt** **(** **)** const
|
||||
|
||||
.. _class_InputEventWithModifiers_get_command:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_command** **(** **)** const
|
||||
|
||||
.. _class_InputEventWithModifiers_get_control:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_control** **(** **)** const
|
||||
|
||||
.. _class_InputEventWithModifiers_get_metakey:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_metakey** **(** **)** const
|
||||
|
||||
.. _class_InputEventWithModifiers_get_shift:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_shift** **(** **)** const
|
||||
|
||||
.. _class_InputEventWithModifiers_set_alt:
|
||||
|
||||
- void **set_alt** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_InputEventWithModifiers_set_command:
|
||||
|
||||
- void **set_command** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_InputEventWithModifiers_set_control:
|
||||
|
||||
- void **set_control** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_InputEventWithModifiers_set_metakey:
|
||||
|
||||
- void **set_metakey** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_InputEventWithModifiers_set_shift:
|
||||
|
||||
- void **set_shift** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
|
||||
@@ -18,55 +18,46 @@ Singleton that manages actions.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_action_from_id<class_InputMap_get_action_from_id>` **(** :ref:`int<class_int>` id **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_action_id<class_InputMap_get_action_id>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_string>` action **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_actions<class_InputMap_get_actions>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_has_action>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`load_from_globals<class_InputMap_load_from_globals>` **(** **)** |
|
||||
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Singleton that manages actions. InputMap has a list of the actions used in InputEvent, which can be modified.
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_string>` action **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`Object<class_object>` event, :ref:`String<class_string>` action **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_string>` action **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_actions<class_InputMap_get_actions>` **(** **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_has_action>` **(** :ref:`String<class_string>` action **)** const |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`load_from_globals<class_InputMap_load_from_globals>` **(** **)** |
|
||||
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_InputMap_action_add_event:
|
||||
|
||||
- void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
|
||||
- void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)**
|
||||
|
||||
Add an :ref:`InputEvent<class_inputevent>` to an action. This :ref:`InputEvent<class_inputevent>` will trigger the action.
|
||||
|
||||
.. _class_InputMap_action_erase_event:
|
||||
|
||||
- void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
|
||||
- void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)**
|
||||
|
||||
Remove an :ref:`InputEvent<class_inputevent>` from an action.
|
||||
|
||||
.. _class_InputMap_action_has_event:
|
||||
|
||||
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
|
||||
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`Object<class_object>` event **)**
|
||||
|
||||
Whether an action has an :ref:`InputEvent<class_inputevent>` associated with it.
|
||||
|
||||
@@ -84,22 +75,10 @@ Remove an action from the :ref:`InputMap<class_inputmap>`.
|
||||
|
||||
.. _class_InputMap_event_is_action:
|
||||
|
||||
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const
|
||||
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`Object<class_object>` event, :ref:`String<class_string>` action **)** const
|
||||
|
||||
Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent<class_inputevent>` is not pressed (for proper release detection). See :ref:`action_has_event<class_InputMap_action_has_event>` if you don't want this behavior.
|
||||
|
||||
.. _class_InputMap_get_action_from_id:
|
||||
|
||||
- :ref:`String<class_string>` **get_action_from_id** **(** :ref:`int<class_int>` id **)** const
|
||||
|
||||
Return the action corresponding to the identifier.
|
||||
|
||||
.. _class_InputMap_get_action_id:
|
||||
|
||||
- :ref:`int<class_int>` **get_action_id** **(** :ref:`String<class_string>` action **)** const
|
||||
|
||||
Return the identifier of the given action.
|
||||
|
||||
.. _class_InputMap_get_action_list:
|
||||
|
||||
- :ref:`Array<class_array>` **get_action_list** **(** :ref:`String<class_string>` action **)**
|
||||
|
||||
@@ -122,9 +122,21 @@ Signals
|
||||
-------
|
||||
|
||||
- **item_activated** **(** :ref:`int<class_int>` index **)**
|
||||
Fired when specified list item is activated via double click or Enter.
|
||||
|
||||
- **item_rmb_selected** **(** :ref:`int<class_int>` index, :ref:`Vector2<class_vector2>` atpos **)**
|
||||
Fired when specified list item has been selected via right mouse clicking.
|
||||
|
||||
The click position is also provided to allow appropriate popup of context menus
|
||||
|
||||
at the correct location.
|
||||
|
||||
- **item_selected** **(** :ref:`int<class_int>` index **)**
|
||||
Fired when specified item has been selected.
|
||||
|
||||
- **multi_selected** **(** :ref:`int<class_int>` index, :ref:`bool<class_bool>` selected **)**
|
||||
Fired when a multiple selection is altered on a list allowing mutliple selection.
|
||||
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
@@ -18,45 +18,59 @@ Kinematic body 3D node.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_collide_with_character_bodies<class_KinematicBody_can_collide_with_character_bodies>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_collide_with_kinematic_bodies<class_KinematicBody_can_collide_with_kinematic_bodies>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_collide_with_rigid_bodies<class_KinematicBody_can_collide_with_rigid_bodies>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_collide_with_static_bodies<class_KinematicBody_can_collide_with_static_bodies>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_teleport_to<class_KinematicBody_can_teleport_to>` **(** :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`get_collider<class_KinematicBody_get_collider>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collider_shape<class_KinematicBody_get_collider_shape>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collider_velocity<class_KinematicBody_get_collider_velocity>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_collision_margin<class_KinematicBody_get_collision_margin>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_normal<class_KinematicBody_get_collision_normal>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_pos<class_KinematicBody_get_collision_pos>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_colliding<class_KinematicBody_is_colliding>` **(** **)** const |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`move<class_KinematicBody_move>` **(** :ref:`Vector3<class_vector3>` rel_vec **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`move_to<class_KinematicBody_move_to>` **(** :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collide_with_character_bodies<class_KinematicBody_set_collide_with_character_bodies>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collide_with_kinematic_bodies<class_KinematicBody_set_collide_with_kinematic_bodies>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collide_with_rigid_bodies<class_KinematicBody_set_collide_with_rigid_bodies>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collide_with_static_bodies<class_KinematicBody_set_collide_with_static_bodies>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_margin<class_KinematicBody_set_collision_margin>` **(** :ref:`float<class_float>` pixels **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_collide_with_character_bodies<class_KinematicBody_can_collide_with_character_bodies>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_collide_with_kinematic_bodies<class_KinematicBody_can_collide_with_kinematic_bodies>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_collide_with_rigid_bodies<class_KinematicBody_can_collide_with_rigid_bodies>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_collide_with_static_bodies<class_KinematicBody_can_collide_with_static_bodies>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_teleport_to<class_KinematicBody_can_teleport_to>` **(** :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`get_collider<class_KinematicBody_get_collider>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_collider_shape<class_KinematicBody_get_collider_shape>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collider_velocity<class_KinematicBody_get_collider_velocity>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_collision_margin<class_KinematicBody_get_collision_margin>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_normal<class_KinematicBody_get_collision_normal>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_collision_pos<class_KinematicBody_get_collision_pos>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_move_and_slide_colliders<class_KinematicBody_get_move_and_slide_colliders>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_travel<class_KinematicBody_get_travel>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_colliding<class_KinematicBody_is_colliding>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_ceiling<class_KinematicBody_is_move_and_slide_on_ceiling>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_floor<class_KinematicBody_is_move_and_slide_on_floor>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_move_and_slide_on_wall<class_KinematicBody_is_move_and_slide_on_wall>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`move<class_KinematicBody_move>` **(** :ref:`Vector3<class_vector3>` rel_vec **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`move_and_slide<class_KinematicBody_move_and_slide>` **(** :ref:`Vector3<class_vector3>` linear_velocity, :ref:`Vector3<class_vector3>` floor_normal=Vector3(0, 0, 0), :ref:`Vector3<class_vector3>` ceil_normal=Vector3(0, 0, 0), :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=4, :ref:`float<class_float>` floor_max_angle=0.785398, :ref:`float<class_float>` ceil_max_angle=0.785398 **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`move_to<class_KinematicBody_move_to>` **(** :ref:`Vector3<class_vector3>` position **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`revert_motion<class_KinematicBody_revert_motion>` **(** **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collide_with_character_bodies<class_KinematicBody_set_collide_with_character_bodies>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collide_with_kinematic_bodies<class_KinematicBody_set_collide_with_kinematic_bodies>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collide_with_rigid_bodies<class_KinematicBody_set_collide_with_rigid_bodies>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collide_with_static_bodies<class_KinematicBody_set_collide_with_static_bodies>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_margin<class_KinematicBody_set_collision_margin>` **(** :ref:`float<class_float>` pixels **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -145,24 +159,52 @@ Return the normal of the surface the body collided with. This is useful to imple
|
||||
|
||||
Return the point in space where the body is touching another. If there is no collision, this method will return (0,0,0), so collisions must be checked first with :ref:`is_colliding<class_KinematicBody_is_colliding>`.
|
||||
|
||||
.. _class_KinematicBody_get_move_and_slide_colliders:
|
||||
|
||||
- :ref:`Array<class_array>` **get_move_and_slide_colliders** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody_get_travel:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_travel** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody_is_colliding:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_colliding** **(** **)** const
|
||||
|
||||
Return whether the body is colliding with another.
|
||||
|
||||
.. _class_KinematicBody_is_move_and_slide_on_ceiling:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_move_and_slide_on_ceiling** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody_is_move_and_slide_on_floor:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_move_and_slide_on_floor** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody_is_move_and_slide_on_wall:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_move_and_slide_on_wall** **(** **)** const
|
||||
|
||||
.. _class_KinematicBody_move:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **move** **(** :ref:`Vector3<class_vector3>` rel_vec **)**
|
||||
|
||||
Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
|
||||
|
||||
.. _class_KinematicBody_move_and_slide:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **move_and_slide** **(** :ref:`Vector3<class_vector3>` linear_velocity, :ref:`Vector3<class_vector3>` floor_normal=Vector3(0, 0, 0), :ref:`Vector3<class_vector3>` ceil_normal=Vector3(0, 0, 0), :ref:`float<class_float>` slope_stop_min_velocity=5, :ref:`int<class_int>` max_bounces=4, :ref:`float<class_float>` floor_max_angle=0.785398, :ref:`float<class_float>` ceil_max_angle=0.785398 **)**
|
||||
|
||||
.. _class_KinematicBody_move_to:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **move_to** **(** :ref:`Vector3<class_vector3>` position **)**
|
||||
|
||||
Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped.
|
||||
|
||||
.. _class_KinematicBody_revert_motion:
|
||||
|
||||
- void **revert_motion** **(** **)**
|
||||
|
||||
.. _class_KinematicBody_set_collide_with_character_bodies:
|
||||
|
||||
- void **set_collide_with_character_bodies** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
@@ -81,8 +81,7 @@ Numeric Constants
|
||||
- **PARAM_SHADOW_SPLIT_3_OFFSET** = **10**
|
||||
- **PARAM_SHADOW_NORMAL_BIAS** = **11**
|
||||
- **PARAM_SHADOW_BIAS** = **12**
|
||||
- **PARAM_SHADOW_BIAS_SPLIT_SCALE** = **13**
|
||||
- **PARAM_MAX** = **14**
|
||||
- **PARAM_MAX** = **13**
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -43,6 +43,8 @@ Member Functions
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_shadow_gradient_length<class_Light2D_get_shadow_gradient_length>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_shadow_smooth<class_Light2D_get_shadow_smooth>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Object<class_object>` | :ref:`get_texture<class_Light2D_get_texture>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_texture_offset<class_Light2D_get_texture_offset>` **(** **)** const |
|
||||
@@ -89,6 +91,8 @@ Member Functions
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shadow_gradient_length<class_Light2D_set_shadow_gradient_length>` **(** :ref:`float<class_float>` multiplier **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_shadow_smooth<class_Light2D_set_shadow_smooth>` **(** :ref:`float<class_float>` smooth **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_texture<class_Light2D_set_texture>` **(** :ref:`Object<class_object>` texture **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_texture_offset<class_Light2D_set_texture_offset>` **(** :ref:`Vector2<class_vector2>` texture_offset **)** |
|
||||
@@ -120,6 +124,7 @@ Member Variables
|
||||
- :ref:`Color<class_color>` **shadow_color**
|
||||
- :ref:`bool<class_bool>` **shadow_enabled**
|
||||
- :ref:`float<class_float>` **shadow_filter**
|
||||
- :ref:`float<class_float>` **shadow_filter_smooth**
|
||||
- :ref:`float<class_float>` **shadow_gradient_length**
|
||||
- :ref:`int<class_int>` **shadow_item_cull_mask**
|
||||
- :ref:`Texture<class_texture>` **texture**
|
||||
@@ -204,6 +209,10 @@ Return the color of casted shadows for this Light2D.
|
||||
|
||||
- :ref:`float<class_float>` **get_shadow_gradient_length** **(** **)** const
|
||||
|
||||
.. _class_Light2D_get_shadow_smooth:
|
||||
|
||||
- :ref:`float<class_float>` **get_shadow_smooth** **(** **)** const
|
||||
|
||||
.. _class_Light2D_get_texture:
|
||||
|
||||
- :ref:`Object<class_object>` **get_texture** **(** **)** const
|
||||
@@ -334,6 +343,10 @@ Enable or disable shadows casting from this Light2D according to the 'enabled' p
|
||||
|
||||
- void **set_shadow_gradient_length** **(** :ref:`float<class_float>` multiplier **)**
|
||||
|
||||
.. _class_Light2D_set_shadow_smooth:
|
||||
|
||||
- void **set_shadow_smooth** **(** :ref:`float<class_float>` smooth **)**
|
||||
|
||||
.. _class_Light2D_set_texture:
|
||||
|
||||
- void **set_texture** **(** :ref:`Object<class_object>` texture **)**
|
||||
|
||||
@@ -80,7 +80,7 @@ Member Variables
|
||||
- :ref:`int<class_int>` **begin_cap_mode**
|
||||
- :ref:`Color<class_color>` **default_color**
|
||||
- :ref:`int<class_int>` **end_cap_mode**
|
||||
- :ref:`ColorRamp<class_colorramp>` **gradient**
|
||||
- :ref:`Gradient<class_gradient>` **gradient**
|
||||
- :ref:`int<class_int>` **joint_mode**
|
||||
- :ref:`PoolVector2Array<class_poolvector2array>` **points**
|
||||
- :ref:`int<class_int>` **round_precision**
|
||||
|
||||
@@ -80,7 +80,11 @@ Signals
|
||||
-------
|
||||
|
||||
- **text_changed** **(** :ref:`String<class_string>` text **)**
|
||||
When the text changes, this signal is emitted.
|
||||
|
||||
- **text_entered** **(** :ref:`String<class_string>` text **)**
|
||||
This signal is emitted when the user presses KEY_ENTER on the :ref:`LineEdit<class_lineedit>`. This signal is often used as an alternate confirmation mechanism in dialogs.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -41,7 +41,7 @@ Member Functions
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`init<class_MainLoop_init>` **(** **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`input_event<class_MainLoop_input_event>` **(** :ref:`InputEvent<class_inputevent>` ev **)** |
|
||||
| void | :ref:`input_event<class_MainLoop_input_event>` **(** :ref:`Object<class_object>` ev **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`input_text<class_MainLoop_input_text>` **(** :ref:`String<class_string>` text **)** |
|
||||
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -109,7 +109,7 @@ Member Function Description
|
||||
|
||||
.. _class_MainLoop_input_event:
|
||||
|
||||
- void **input_event** **(** :ref:`InputEvent<class_inputevent>` ev **)**
|
||||
- void **input_event** **(** :ref:`Object<class_object>` ev **)**
|
||||
|
||||
.. _class_MainLoop_input_text:
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Mesh
|
||||
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`QuadMesh<class_quadmesh>`
|
||||
**Inherited By:** :ref:`ArrayMesh<class_arraymesh>`, :ref:`PrimitiveMesh<class_primitivemesh>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
@@ -20,80 +20,17 @@ A :ref:`Resource<class_resource>` that contains vertex-array based geometry.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_blend_shape<class_Mesh_add_blend_shape>` **(** :ref:`String<class_string>` name **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_surface_from_arrays<class_Mesh_add_surface_from_arrays>` **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=Array(), :ref:`int<class_int>` compress_flags=97792 **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`center_geometry<class_Mesh_center_geometry>` **(** **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_blend_shapes<class_Mesh_clear_blend_shapes>` **(** **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_Mesh_get_blend_shape_count>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_blend_shape_mode<class_Mesh_get_blend_shape_mode>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_blend_shape_name<class_Mesh_get_blend_shape_name>` **(** :ref:`int<class_int>` index **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect3<class_rect3>` | :ref:`get_custom_aabb<class_Mesh_get_custom_aabb>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_surface_count<class_Mesh_get_surface_count>` **(** **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`regen_normalmaps<class_Mesh_regen_normalmaps>` **(** **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_blend_shape_mode<class_Mesh_set_blend_shape_mode>` **(** :ref:`int<class_int>` mode **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_custom_aabb<class_Mesh_set_custom_aabb>` **(** :ref:`Rect3<class_rect3>` aabb **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_index_len<class_Mesh_surface_get_array_index_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_array_len<class_Mesh_surface_get_array_len>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_format<class_Mesh_surface_get_format>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Material<class_material>` | :ref:`surface_get_material<class_Mesh_surface_get_material>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`surface_get_name<class_Mesh_surface_get_name>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`surface_get_primitive_type<class_Mesh_surface_get_primitive_type>` **(** :ref:`int<class_int>` surf_idx **)** const |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_remove<class_Mesh_surface_remove>` **(** :ref:`int<class_int>` surf_idx **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_set_material<class_Mesh_surface_set_material>` **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`surface_set_name<class_Mesh_surface_set_name>` **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)** |
|
||||
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
|
||||
- **NO_INDEX_ARRAY** = **-1** --- Default value used for index_array_len when no indices are present.
|
||||
- **ARRAY_WEIGHTS_SIZE** = **4** --- Amount of weights/bone indices per vertex (always 4).
|
||||
- **ARRAY_VERTEX** = **0** --- Vertex array (array of :ref:`Vector3<class_vector3>` vertices).
|
||||
- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`Vector3<class_vector3>` normals).
|
||||
- **ARRAY_TANGENT** = **2** --- Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1.
|
||||
- **ARRAY_COLOR** = **3** --- Vertex array (array of :ref:`Color<class_color>` colors).
|
||||
- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3<class_vector3>` UVs or float array of groups of 2 floats (u,v)).
|
||||
- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`Vector3<class_vector3>` UVs or float array of groups of 2 floats (u,v)).
|
||||
- **ARRAY_BONES** = **6** --- Array of bone indices, as a float array. Each element in groups of 4 floats.
|
||||
- **ARRAY_WEIGHTS** = **7** --- Array of bone weights, as a float array. Each element in groups of 4 floats.
|
||||
- **ARRAY_INDEX** = **8** --- Array of integers, used as indices referencing vertices. No index can be beyond the vertex array size.
|
||||
- **ARRAY_FORMAT_VERTEX** = **1** --- Array format will include vertices (mandatory).
|
||||
- **ARRAY_FORMAT_NORMAL** = **2** --- Array format will include normals
|
||||
- **ARRAY_FORMAT_TANGENT** = **4** --- Array format will include tangents
|
||||
- **ARRAY_FORMAT_COLOR** = **8** --- Array format will include a color array.
|
||||
- **ARRAY_FORMAT_TEX_UV** = **16** --- Array format will include UVs.
|
||||
- **ARRAY_FORMAT_TEX_UV2** = **32** --- Array format will include another set of UVs.
|
||||
- **ARRAY_FORMAT_BONES** = **64** --- Array format will include bone indices.
|
||||
- **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights.
|
||||
- **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used.
|
||||
- **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point).
|
||||
- **PRIMITIVE_LINES** = **1** --- Render array as lines (every two vertices a line is created).
|
||||
- **PRIMITIVE_LINE_STRIP** = **2** --- Render array as line strip.
|
||||
- **PRIMITIVE_LINE_LOOP** = **3** --- Render array as line loop (like line strip, but closed).
|
||||
- **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created).
|
||||
- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips.
|
||||
- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans.
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Shape<class_shape>` | :ref:`create_convex_shape<class_Mesh_create_convex_shape>` **(** **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ArrayMesh<class_arraymesh>` | :ref:`create_outline<class_Mesh_create_outline>` **(** :ref:`float<class_float>` margin **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Shape<class_shape>` | :ref:`create_trimesh_shape<class_Mesh_create_trimesh_shape>` **(** **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`TriangleMesh<class_trianglemesh>` | :ref:`generate_triangle_mesh<class_Mesh_generate_triangle_mesh>` **(** **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector3Array<class_poolvector3array>` | :ref:`get_faces<class_Mesh_get_faces>` **(** **)** const |
|
||||
+--------------------------------------------------+-------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -103,110 +40,24 @@ Mesh is a type of :ref:`Resource<class_resource>` that contains vertex-array bas
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_Mesh_add_blend_shape:
|
||||
.. _class_Mesh_create_convex_shape:
|
||||
|
||||
- void **add_blend_shape** **(** :ref:`String<class_string>` name **)**
|
||||
- :ref:`Shape<class_shape>` **create_convex_shape** **(** **)** const
|
||||
|
||||
.. _class_Mesh_add_surface_from_arrays:
|
||||
.. _class_Mesh_create_outline:
|
||||
|
||||
- void **add_surface_from_arrays** **(** :ref:`int<class_int>` primitive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=Array(), :ref:`int<class_int>` compress_flags=97792 **)**
|
||||
- :ref:`ArrayMesh<class_arraymesh>` **create_outline** **(** :ref:`float<class_float>` margin **)** const
|
||||
|
||||
Create a new surface (:ref:`get_surface_count<class_Mesh_get_surface_count>` that will become surf_idx for this.
|
||||
.. _class_Mesh_create_trimesh_shape:
|
||||
|
||||
Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles).
|
||||
- :ref:`Shape<class_shape>` **create_trimesh_shape** **(** **)** const
|
||||
|
||||
(might be obsolete) The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT\_\* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed
|
||||
.. _class_Mesh_generate_triangle_mesh:
|
||||
|
||||
.. _class_Mesh_center_geometry:
|
||||
- :ref:`TriangleMesh<class_trianglemesh>` **generate_triangle_mesh** **(** **)** const
|
||||
|
||||
- void **center_geometry** **(** **)**
|
||||
.. _class_Mesh_get_faces:
|
||||
|
||||
.. _class_Mesh_clear_blend_shapes:
|
||||
|
||||
- void **clear_blend_shapes** **(** **)**
|
||||
|
||||
.. _class_Mesh_get_blend_shape_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_shape_count** **(** **)** const
|
||||
|
||||
.. _class_Mesh_get_blend_shape_mode:
|
||||
|
||||
- :ref:`int<class_int>` **get_blend_shape_mode** **(** **)** const
|
||||
|
||||
.. _class_Mesh_get_blend_shape_name:
|
||||
|
||||
- :ref:`String<class_string>` **get_blend_shape_name** **(** :ref:`int<class_int>` index **)** const
|
||||
|
||||
.. _class_Mesh_get_custom_aabb:
|
||||
|
||||
- :ref:`Rect3<class_rect3>` **get_custom_aabb** **(** **)** const
|
||||
|
||||
.. _class_Mesh_get_surface_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_surface_count** **(** **)** const
|
||||
|
||||
Return the amount of surfaces that the :ref:`Mesh<class_mesh>` holds.
|
||||
|
||||
.. _class_Mesh_regen_normalmaps:
|
||||
|
||||
- void **regen_normalmaps** **(** **)**
|
||||
|
||||
.. _class_Mesh_set_blend_shape_mode:
|
||||
|
||||
- void **set_blend_shape_mode** **(** :ref:`int<class_int>` mode **)**
|
||||
|
||||
.. _class_Mesh_set_custom_aabb:
|
||||
|
||||
- void **set_custom_aabb** **(** :ref:`Rect3<class_rect3>` aabb **)**
|
||||
|
||||
.. _class_Mesh_surface_get_array_index_len:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_array_index_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the length in indices of the index array in the requested surface (see :ref:`add_surface<class_Mesh_add_surface>`).
|
||||
|
||||
.. _class_Mesh_surface_get_array_len:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_array_len** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface<class_Mesh_add_surface>`).
|
||||
|
||||
.. _class_Mesh_surface_get_format:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_format** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the format mask of the requested surface (see :ref:`add_surface<class_Mesh_add_surface>`).
|
||||
|
||||
.. _class_Mesh_surface_get_material:
|
||||
|
||||
- :ref:`Material<class_material>` **surface_get_material** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return a :ref:`Material<class_material>` in a given surface. Surface is rendered using this material.
|
||||
|
||||
.. _class_Mesh_surface_get_name:
|
||||
|
||||
- :ref:`String<class_string>` **surface_get_name** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
.. _class_Mesh_surface_get_primitive_type:
|
||||
|
||||
- :ref:`int<class_int>` **surface_get_primitive_type** **(** :ref:`int<class_int>` surf_idx **)** const
|
||||
|
||||
Return the primitive type of the requested surface (see :ref:`add_surface<class_Mesh_add_surface>`).
|
||||
|
||||
.. _class_Mesh_surface_remove:
|
||||
|
||||
- void **surface_remove** **(** :ref:`int<class_int>` surf_idx **)**
|
||||
|
||||
Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down.
|
||||
|
||||
.. _class_Mesh_surface_set_material:
|
||||
|
||||
- void **surface_set_material** **(** :ref:`int<class_int>` surf_idx, :ref:`Material<class_material>` material **)**
|
||||
|
||||
Set a :ref:`Material<class_material>` for a given surface. Surface will be rendered using this material.
|
||||
|
||||
.. _class_Mesh_surface_set_name:
|
||||
|
||||
- void **surface_set_name** **(** :ref:`int<class_int>` surf_idx, :ref:`String<class_string>` name **)**
|
||||
- :ref:`PoolVector3Array<class_poolvector3array>` **get_faces** **(** **)** const
|
||||
|
||||
|
||||
|
||||
@@ -39,6 +39,7 @@ Numeric Constants
|
||||
- **COMPRESS_RANGE_CODER** = **1**
|
||||
- **COMPRESS_FASTLZ** = **2**
|
||||
- **COMPRESS_ZLIB** = **3**
|
||||
- **COMPRESS_ZSTD** = **4**
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -35,16 +35,12 @@ Member Functions
|
||||
+-------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`Nil<class_Nil_Nil>` **(** :ref:`Dictionary<class_dictionary>` from **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`Nil<class_Nil_Nil>` **(** :ref:`InputEvent<class_inputevent>` from **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`Nil<class_Nil_Nil>` **(** :ref:`Object<class_object>` from **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`Nil<class_Nil_Nil>` **(** :ref:`RID<class_rid>` from **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`Nil<class_Nil_Nil>` **(** :ref:`NodePath<class_nodepath>` from **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`Nil<class_Nil_Nil>` **(** :ref:`Image<class_image>` from **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`Nil<class_Nil_Nil>` **(** :ref:`Color<class_color>` from **)** |
|
||||
+-------+----------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`Nil<class_Nil_Nil>` **(** :ref:`Transform<class_transform>` from **)** |
|
||||
@@ -115,10 +111,6 @@ Member Function Description
|
||||
|
||||
.. _class_Nil_Nil:
|
||||
|
||||
- void **Nil** **(** :ref:`InputEvent<class_inputevent>` from **)**
|
||||
|
||||
.. _class_Nil_Nil:
|
||||
|
||||
- void **Nil** **(** :ref:`Object<class_object>` from **)**
|
||||
|
||||
.. _class_Nil_Nil:
|
||||
@@ -131,10 +123,6 @@ Member Function Description
|
||||
|
||||
.. _class_Nil_Nil:
|
||||
|
||||
- void **Nil** **(** :ref:`Image<class_image>` from **)**
|
||||
|
||||
.. _class_Nil_Nil:
|
||||
|
||||
- void **Nil** **(** :ref:`Color<class_color>` from **)**
|
||||
|
||||
.. _class_Nil_Nil:
|
||||
|
||||
@@ -35,7 +35,7 @@ Member Functions
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_unhandled_input<class_Node__unhandled_input>` **(** :ref:`InputEvent<class_inputevent>` event **)** virtual |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_unhandled_key_input<class_Node__unhandled_key_input>` **(** :ref:`InputEvent<class_inputevent>` key_event **)** virtual |
|
||||
| void | :ref:`_unhandled_key_input<class_Node__unhandled_key_input>` **(** :ref:`InputEventKey<class_inputeventkey>` event **)** virtual |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_child<class_Node_add_child>` **(** :ref:`Node<class_node>` node, :ref:`bool<class_bool>` legible_unique_name=false **)** |
|
||||
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -194,6 +194,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **renamed** **(** **)**
|
||||
Emitted when the node is renamed.
|
||||
|
||||
- **tree_entered** **(** **)**
|
||||
- **tree_exited** **(** **)**
|
||||
|
||||
@@ -296,10 +298,6 @@ Corresponds to the NOTIFICATION_FIXED_PROCESS notification in :ref:`Object._noti
|
||||
|
||||
- void **_input** **(** :ref:`InputEvent<class_inputevent>` event **)** virtual
|
||||
|
||||
Called for every input event.
|
||||
|
||||
It has to be enabled with :ref:`set_process_input<class_Node_set_process_input>` or the corresponding property in the inspector.
|
||||
|
||||
.. _class_Node__process:
|
||||
|
||||
- void **_process** **(** :ref:`float<class_float>` delta **)** virtual
|
||||
@@ -322,17 +320,9 @@ Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification
|
||||
|
||||
- void **_unhandled_input** **(** :ref:`InputEvent<class_inputevent>` event **)** virtual
|
||||
|
||||
Called for every input event that has not already been handled by another node.
|
||||
|
||||
It has to be enabled with :ref:`set_process_unhandled_input<class_Node_set_process_unhandled_input>` or the corresponding property in the inspector.
|
||||
|
||||
.. _class_Node__unhandled_key_input:
|
||||
|
||||
- void **_unhandled_key_input** **(** :ref:`InputEvent<class_inputevent>` key_event **)** virtual
|
||||
|
||||
Called for every *key* input event that has not already been handled by another node.
|
||||
|
||||
It has to be enabled with :ref:`set_process_unhandled_key_input<class_Node_set_process_unhandled_key_input>` or the corresponding property in the inspector.
|
||||
- void **_unhandled_key_input** **(** :ref:`InputEventKey<class_inputeventkey>` event **)** virtual
|
||||
|
||||
.. _class_Node_add_child:
|
||||
|
||||
|
||||
@@ -216,7 +216,7 @@ Apply a local translation on Y axis to the 2D node according to the 'delta' of t
|
||||
|
||||
- void **rotate** **(** :ref:`float<class_float>` radians **)**
|
||||
|
||||
Apply a 'radians' rotation to the 2D node, starting from its current rotation.
|
||||
Apply a rotation (in radians) to the 2D node, starting from its current rotation.
|
||||
|
||||
.. _class_Node2D_scale:
|
||||
|
||||
|
||||
@@ -18,87 +18,87 @@ Base class for all non built-in types.
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`XL_MESSAGE<class_Object_XL_MESSAGE>` **(** :ref:`String<class_string>` message **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_get<class_Object__get>` **(** :ref:`String<class_string>` property **)** virtual |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`_get_property_list<class_Object__get_property_list>` **(** **)** virtual |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_init<class_Object__init>` **(** **)** virtual |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_notification<class_Object__notification>` **(** :ref:`int<class_int>` what **)** virtual |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_set<class_Object__set>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** virtual |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_user_signal<class_Object_add_user_signal>` **(** :ref:`String<class_string>` signal, :ref:`Array<class_array>` arguments=Array() **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`call<class_Object_call>` **(** :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call_deferred<class_Object_call_deferred>` **(** :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`callv<class_Object_callv>` **(** :ref:`String<class_string>` method, :ref:`Array<class_array>` arg_array **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_translate_messages<class_Object_can_translate_messages>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`connect<class_Object_connect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=Array(), :ref:`int<class_int>` flags=0 **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect<class_Object_disconnect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`emit_signal<class_Object_emit_signal>` **(** :ref:`String<class_string>` signal **)** vararg |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`free<class_Object_free>` **(** **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`get<class_Object_get>` **(** :ref:`String<class_string>` property **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_class<class_Object_get_class>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_instance_ID<class_Object_get_instance_ID>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`get_meta<class_Object_get_meta>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_meta_list<class_Object_get_meta_list>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_method_list<class_Object_get_method_list>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_property_list<class_Object_get_property_list>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Script<class_script>` | :ref:`get_script<class_Object_get_script>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_signal_connection_list<class_Object_get_signal_connection_list>` **(** :ref:`String<class_string>` signal **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_signal_list<class_Object_get_signal_list>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_meta<class_Object_has_meta>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_method<class_Object_has_method>` **(** :ref:`String<class_string>` method **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_user_signal<class_Object_has_user_signal>` **(** :ref:`String<class_string>` signal **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_blocking_signals<class_Object_is_blocking_signals>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class<class_Object_is_class>` **(** :ref:`String<class_string>` type **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_connected<class_Object_is_connected>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_queued_for_deletion<class_Object_is_queued_for_deletion>` **(** **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`notification<class_Object_notification>` **(** :ref:`int<class_int>` what, :ref:`bool<class_bool>` reversed=false **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`property_list_changed_notify<class_Object_property_list_changed_notify>` **(** **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set<class_Object_set>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_block_signals<class_Object_set_block_signals>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_message_translation<class_Object_set_message_translation>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_meta<class_Object_set_meta>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_script<class_Object_set_script>` **(** :ref:`Script<class_script>` script **)** |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`tr<class_Object_tr>` **(** :ref:`String<class_string>` message **)** const |
|
||||
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`XL_MESSAGE<class_Object_XL_MESSAGE>` **(** :ref:`String<class_string>` message **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_get<class_Object__get>` **(** :ref:`String<class_string>` property **)** virtual |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`_get_property_list<class_Object__get_property_list>` **(** **)** virtual |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_init<class_Object__init>` **(** **)** virtual |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_notification<class_Object__notification>` **(** :ref:`int<class_int>` what **)** virtual |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`_set<class_Object__set>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** virtual |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_user_signal<class_Object_add_user_signal>` **(** :ref:`String<class_string>` signal, :ref:`Array<class_array>` arguments=[] **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`call<class_Object_call>` **(** :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`call_deferred<class_Object_call_deferred>` **(** :ref:`String<class_string>` method **)** vararg |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`callv<class_Object_callv>` **(** :ref:`String<class_string>` method, :ref:`Array<class_array>` arg_array **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_translate_messages<class_Object_can_translate_messages>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`connect<class_Object_connect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=[], :ref:`int<class_int>` flags=0 **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`disconnect<class_Object_disconnect>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`emit_signal<class_Object_emit_signal>` **(** :ref:`String<class_string>` signal **)** vararg |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`free<class_Object_free>` **(** **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Variant<class_variant>` | :ref:`get<class_Object_get>` **(** :ref:`String<class_string>` property **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`get_class<class_Object_get_class>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_instance_ID<class_Object_get_instance_ID>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`get_meta<class_Object_get_meta>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_meta_list<class_Object_get_meta_list>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_method_list<class_Object_get_method_list>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_property_list<class_Object_get_property_list>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Script<class_script>` | :ref:`get_script<class_Object_get_script>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_signal_connection_list<class_Object_get_signal_connection_list>` **(** :ref:`String<class_string>` signal **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_signal_list<class_Object_get_signal_list>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_meta<class_Object_has_meta>` **(** :ref:`String<class_string>` name **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_method<class_Object_has_method>` **(** :ref:`String<class_string>` method **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_user_signal<class_Object_has_user_signal>` **(** :ref:`String<class_string>` signal **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_blocking_signals<class_Object_is_blocking_signals>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_class<class_Object_is_class>` **(** :ref:`String<class_string>` type **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_connected<class_Object_is_connected>` **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_queued_for_deletion<class_Object_is_queued_for_deletion>` **(** **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`notification<class_Object_notification>` **(** :ref:`int<class_int>` what, :ref:`bool<class_bool>` reversed=false **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`property_list_changed_notify<class_Object_property_list_changed_notify>` **(** **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set<class_Object_set>` **(** :ref:`String<class_string>` property, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_block_signals<class_Object_set_block_signals>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_message_translation<class_Object_set_message_translation>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_meta<class_Object_set_meta>` **(** :ref:`String<class_string>` name, :ref:`Variant<class_variant>` value **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_script<class_Object_set_script>` **(** :ref:`Script<class_script>` script **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`String<class_string>` | :ref:`tr<class_Object_tr>` **(** :ref:`String<class_string>` message **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -112,7 +112,7 @@ Numeric Constants
|
||||
- **NOTIFICATION_PREDELETE** = **1** --- Called before the object is about to be deleted.
|
||||
- **CONNECT_DEFERRED** = **1** --- Connect a signal in deferred mode. This way, signal emissions are stored in a queue, then set on idle time.
|
||||
- **CONNECT_PERSIST** = **2** --- Persisting connections are saved when the object is serialized to file.
|
||||
- **CONNECT_ONESHOT** = **4** --- One short connections disconnect themselves after emission.
|
||||
- **CONNECT_ONESHOT** = **4** --- One shot connections disconnect themselves after emission.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -166,7 +166,7 @@ Set a property. Return true if the property was found.
|
||||
|
||||
.. _class_Object_add_user_signal:
|
||||
|
||||
- void **add_user_signal** **(** :ref:`String<class_string>` signal, :ref:`Array<class_array>` arguments=Array() **)**
|
||||
- void **add_user_signal** **(** :ref:`String<class_string>` signal, :ref:`Array<class_array>` arguments=[] **)**
|
||||
|
||||
Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from :ref:`@Global Scope<class_@global scope>` TYPE\_\*).
|
||||
|
||||
@@ -190,7 +190,7 @@ Return true if this object can translate strings.
|
||||
|
||||
.. _class_Object_connect:
|
||||
|
||||
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=Array(), :ref:`int<class_int>` flags=0 **)**
|
||||
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` signal, :ref:`Object<class_object>` target, :ref:`String<class_string>` method, :ref:`Array<class_array>` binds=[], :ref:`int<class_int>` flags=0 **)**
|
||||
|
||||
Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT\_\*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use :ref:`is_connected<class_Object_is_connected>` to check.
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ Member Variables
|
||||
Description
|
||||
-----------
|
||||
|
||||
An OmniDirectional light is a type of :ref:`Light<class_light>` node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light<class_light>`. TODO: Image of an omnilight.
|
||||
An OmniDirectional light is a type of :ref:`Light<class_light>` node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light<class_light>`.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
@@ -64,6 +64,8 @@ Signals
|
||||
-------
|
||||
|
||||
- **item_selected** **(** :ref:`int<class_int>` ID **)**
|
||||
This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index).
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -33,7 +33,7 @@ Member Functions
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`dump_resources_to_file<class_OS_dump_resources_to_file>` **(** :ref:`String<class_string>` file **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`execute<class_OS_execute>` **(** :ref:`String<class_string>` path, :ref:`PoolStringArray<class_poolstringarray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_array>` output=Array() **)** |
|
||||
| :ref:`int<class_int>` | :ref:`execute<class_OS_execute>` **(** :ref:`String<class_string>` path, :ref:`PoolStringArray<class_poolstringarray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_array>` output=[] **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`find_scancode_from_string<class_OS_find_scancode_from_string>` **(** :ref:`String<class_string>` string **)** const |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -177,7 +177,7 @@ Member Functions
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_exit_code<class_OS_set_exit_code>` **(** :ref:`int<class_int>` code **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_icon<class_OS_set_icon>` **(** :ref:`Image<class_image>` icon **)** |
|
||||
| void | :ref:`set_icon<class_OS_set_icon>` **(** :ref:`Object<class_object>` icon **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_keep_screen_on<class_OS_set_keep_screen_on>` **(** :ref:`bool<class_bool>` enabled **)** |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -311,7 +311,7 @@ At the end of the file is a statistic of all used Resource Types.
|
||||
|
||||
.. _class_OS_execute:
|
||||
|
||||
- :ref:`int<class_int>` **execute** **(** :ref:`String<class_string>` path, :ref:`PoolStringArray<class_poolstringarray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_array>` output=Array() **)**
|
||||
- :ref:`int<class_int>` **execute** **(** :ref:`String<class_string>` path, :ref:`PoolStringArray<class_poolstringarray>` arguments, :ref:`bool<class_bool>` blocking, :ref:`Array<class_array>` output=[] **)**
|
||||
|
||||
Execute the binary file in given path, optionally blocking until it returns. A process ID is returned.
|
||||
|
||||
@@ -417,7 +417,7 @@ Returns the model name of the current device.
|
||||
|
||||
- :ref:`String<class_string>` **get_name** **(** **)** const
|
||||
|
||||
Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11"
|
||||
Return the name of the host OS. Possible values are: "Android", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11".
|
||||
|
||||
.. _class_OS_get_power_percent_left:
|
||||
|
||||
@@ -711,7 +711,7 @@ Set clipboard to the OS.
|
||||
|
||||
.. _class_OS_set_icon:
|
||||
|
||||
- void **set_icon** **(** :ref:`Image<class_image>` icon **)**
|
||||
- void **set_icon** **(** :ref:`Object<class_object>` icon **)**
|
||||
|
||||
.. _class_OS_set_keep_screen_on:
|
||||
|
||||
|
||||
@@ -18,15 +18,15 @@ Brief Description
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_instance<class_PackedScene_can_instance>` **(** **)** const |
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SceneState<class_scenestate>` | :ref:`get_state<class_PackedScene_get_state>` **(** **)** |
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`instance<class_PackedScene_instance>` **(** :ref:`int<class_int>` edit_state=false **)** const |
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`pack<class_PackedScene_pack>` **(** :ref:`Node<class_node>` path **)** |
|
||||
+--------------------------------------+--------------------------------------------------------------------------------------------------------+
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`can_instance<class_PackedScene_can_instance>` **(** **)** const |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`SceneState<class_scenestate>` | :ref:`get_state<class_PackedScene_get_state>` **(** **)** |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Node<class_node>` | :ref:`instance<class_PackedScene_instance>` **(** :ref:`int<class_int>` edit_state=0 **)** const |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`pack<class_PackedScene_pack>` **(** :ref:`Node<class_node>` path **)** |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
@@ -58,7 +58,7 @@ Member Function Description
|
||||
|
||||
.. _class_PackedScene_instance:
|
||||
|
||||
- :ref:`Node<class_node>` **instance** **(** :ref:`int<class_int>` edit_state=false **)** const
|
||||
- :ref:`Node<class_node>` **instance** **(** :ref:`int<class_int>` edit_state=0 **)** const
|
||||
|
||||
.. _class_PackedScene_pack:
|
||||
|
||||
|
||||
43
classes/class_panoramasky.rst
Normal file
43
classes/class_panoramasky.rst
Normal file
@@ -0,0 +1,43 @@
|
||||
.. 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_PanoramaSky:
|
||||
|
||||
PanoramaSky
|
||||
===========
|
||||
|
||||
**Inherits:** :ref:`Sky<class_sky>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`get_panorama<class_PanoramaSky_get_panorama>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_panorama<class_PanoramaSky_set_panorama>` **(** :ref:`Texture<class_texture>` texture **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`Texture<class_texture>` **panorama**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_PanoramaSky_get_panorama:
|
||||
|
||||
- :ref:`Texture<class_texture>` **get_panorama** **(** **)** const
|
||||
|
||||
.. _class_PanoramaSky_set_panorama:
|
||||
|
||||
- void **set_panorama** **(** :ref:`Texture<class_texture>` texture **)**
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_amount<class_Particles_get_amount>` **(** **)** const |
|
||||
| :ref:`Rect3<class_rect3>` | :ref:`capture_aabb<class_Particles_capture_aabb>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect3<class_rect3>` | :ref:`get_custom_aabb<class_Particles_get_custom_aabb>` **(** **)** const |
|
||||
| :ref:`int<class_int>` | :ref:`get_amount<class_Particles_get_amount>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_draw_order<class_Particles_get_draw_order>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -35,8 +35,6 @@ Member Functions
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_fractional_delta<class_Particles_get_fractional_delta>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity<class_Particles_get_gravity>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_lifetime<class_Particles_get_lifetime>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_pre_process_time<class_Particles_get_pre_process_time>` **(** **)** const |
|
||||
@@ -45,14 +43,16 @@ Member Functions
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_randomness_ratio<class_Particles_get_randomness_ratio>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_speed_scale<class_Particles_get_speed_scale>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_use_local_coordinates<class_Particles_get_use_local_coordinates>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Rect3<class_rect3>` | :ref:`get_visibility_aabb<class_Particles_get_visibility_aabb>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_emitting<class_Particles_is_emitting>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_amount<class_Particles_set_amount>` **(** :ref:`int<class_int>` amount **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_custom_aabb<class_Particles_set_custom_aabb>` **(** :ref:`Rect3<class_rect3>` aabb **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_draw_order<class_Particles_set_draw_order>` **(** :ref:`int<class_int>` order **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_draw_pass_mesh<class_Particles_set_draw_pass_mesh>` **(** :ref:`int<class_int>` pass, :ref:`Mesh<class_mesh>` mesh **)** |
|
||||
@@ -67,8 +67,6 @@ Member Functions
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_fractional_delta<class_Particles_set_fractional_delta>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_Particles_set_gravity>` **(** :ref:`Vector3<class_vector3>` accel_vec **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_lifetime<class_Particles_set_lifetime>` **(** :ref:`float<class_float>` secs **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_pre_process_time<class_Particles_set_pre_process_time>` **(** :ref:`float<class_float>` secs **)** |
|
||||
@@ -77,14 +75,17 @@ Member Functions
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_randomness_ratio<class_Particles_set_randomness_ratio>` **(** :ref:`float<class_float>` ratio **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_speed_scale<class_Particles_set_speed_scale>` **(** :ref:`float<class_float>` scale **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_use_local_coordinates<class_Particles_set_use_local_coordinates>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_visibility_aabb<class_Particles_set_visibility_aabb>` **(** :ref:`Rect3<class_rect3>` aabb **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **amount**
|
||||
- :ref:`Rect3<class_rect3>` **custom_aabb**
|
||||
- :ref:`int<class_int>` **draw_order**
|
||||
- :ref:`Mesh<class_mesh>` **draw_pass_1**
|
||||
- :ref:`Mesh<class_mesh>` **draw_pass_2**
|
||||
@@ -95,12 +96,13 @@ Member Variables
|
||||
- :ref:`float<class_float>` **explosiveness**
|
||||
- :ref:`int<class_int>` **fixed_fps**
|
||||
- :ref:`bool<class_bool>` **fract_delta**
|
||||
- :ref:`Vector3<class_vector3>` **gravity**
|
||||
- :ref:`float<class_float>` **lifetime**
|
||||
- :ref:`bool<class_bool>` **local_coords**
|
||||
- :ref:`float<class_float>` **preprocess**
|
||||
- ParticlesMaterial,ShaderMaterial **process_material**
|
||||
- :ref:`float<class_float>` **randomness**
|
||||
- :ref:`float<class_float>` **speed_scale**
|
||||
- :ref:`Rect3<class_rect3>` **visibility_aabb**
|
||||
|
||||
Numeric Constants
|
||||
-----------------
|
||||
@@ -113,14 +115,14 @@ Numeric Constants
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_Particles_capture_aabb:
|
||||
|
||||
- :ref:`Rect3<class_rect3>` **capture_aabb** **(** **)** const
|
||||
|
||||
.. _class_Particles_get_amount:
|
||||
|
||||
- :ref:`int<class_int>` **get_amount** **(** **)** const
|
||||
|
||||
.. _class_Particles_get_custom_aabb:
|
||||
|
||||
- :ref:`Rect3<class_rect3>` **get_custom_aabb** **(** **)** const
|
||||
|
||||
.. _class_Particles_get_draw_order:
|
||||
|
||||
- :ref:`int<class_int>` **get_draw_order** **(** **)** const
|
||||
@@ -145,10 +147,6 @@ Member Function Description
|
||||
|
||||
- :ref:`bool<class_bool>` **get_fractional_delta** **(** **)** const
|
||||
|
||||
.. _class_Particles_get_gravity:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_gravity** **(** **)** const
|
||||
|
||||
.. _class_Particles_get_lifetime:
|
||||
|
||||
- :ref:`float<class_float>` **get_lifetime** **(** **)** const
|
||||
@@ -165,10 +163,18 @@ Member Function Description
|
||||
|
||||
- :ref:`float<class_float>` **get_randomness_ratio** **(** **)** const
|
||||
|
||||
.. _class_Particles_get_speed_scale:
|
||||
|
||||
- :ref:`float<class_float>` **get_speed_scale** **(** **)** const
|
||||
|
||||
.. _class_Particles_get_use_local_coordinates:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_use_local_coordinates** **(** **)** const
|
||||
|
||||
.. _class_Particles_get_visibility_aabb:
|
||||
|
||||
- :ref:`Rect3<class_rect3>` **get_visibility_aabb** **(** **)** const
|
||||
|
||||
.. _class_Particles_is_emitting:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_emitting** **(** **)** const
|
||||
@@ -177,10 +183,6 @@ Member Function Description
|
||||
|
||||
- void **set_amount** **(** :ref:`int<class_int>` amount **)**
|
||||
|
||||
.. _class_Particles_set_custom_aabb:
|
||||
|
||||
- void **set_custom_aabb** **(** :ref:`Rect3<class_rect3>` aabb **)**
|
||||
|
||||
.. _class_Particles_set_draw_order:
|
||||
|
||||
- void **set_draw_order** **(** :ref:`int<class_int>` order **)**
|
||||
@@ -209,10 +211,6 @@ Member Function Description
|
||||
|
||||
- void **set_fractional_delta** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_Particles_set_gravity:
|
||||
|
||||
- void **set_gravity** **(** :ref:`Vector3<class_vector3>` accel_vec **)**
|
||||
|
||||
.. _class_Particles_set_lifetime:
|
||||
|
||||
- void **set_lifetime** **(** :ref:`float<class_float>` secs **)**
|
||||
@@ -229,8 +227,16 @@ Member Function Description
|
||||
|
||||
- void **set_randomness_ratio** **(** :ref:`float<class_float>` ratio **)**
|
||||
|
||||
.. _class_Particles_set_speed_scale:
|
||||
|
||||
- void **set_speed_scale** **(** :ref:`float<class_float>` scale **)**
|
||||
|
||||
.. _class_Particles_set_use_local_coordinates:
|
||||
|
||||
- void **set_use_local_coordinates** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_Particles_set_visibility_aabb:
|
||||
|
||||
- void **set_visibility_aabb** **(** :ref:`Rect3<class_rect3>` aabb **)**
|
||||
|
||||
|
||||
|
||||
@@ -29,8 +29,6 @@ Member Functions
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_color_phases<class_Particles2D_get_color_phases>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ColorRamp<class_colorramp>` | :ref:`get_color_ramp<class_Particles2D_get_color_ramp>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_emission_half_extents<class_Particles2D_get_emission_half_extents>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`get_emission_points<class_Particles2D_get_emission_points>` **(** **)** const |
|
||||
@@ -41,6 +39,8 @@ Member Functions
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_explosiveness<class_Particles2D_get_explosiveness>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Gradient<class_gradient>` | :ref:`get_gradient<class_Particles2D_get_gradient>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_h_frames<class_Particles2D_get_h_frames>` **(** **)** const |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_initial_velocity<class_Particles2D_get_initial_velocity>` **(** **)** const |
|
||||
@@ -83,8 +83,6 @@ Member Functions
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_color_phases<class_Particles2D_set_color_phases>` **(** :ref:`int<class_int>` phases **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`ColorRamp<class_colorramp>` | :ref:`set_color_ramp<class_Particles2D_set_color_ramp>` **(** :ref:`Object<class_object>` color_ramp **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_emission_half_extents<class_Particles2D_set_emission_half_extents>` **(** :ref:`Vector2<class_vector2>` extents **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_emission_points<class_Particles2D_set_emission_points>` **(** :ref:`PoolVector2Array<class_poolvector2array>` points **)** |
|
||||
@@ -101,6 +99,8 @@ Member Functions
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flip_v<class_Particles2D_set_flip_v>` **(** :ref:`bool<class_bool>` enable **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Gradient<class_gradient>` | :ref:`set_gradient<class_Particles2D_set_gradient>` **(** :ref:`Object<class_object>` gradient **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_h_frames<class_Particles2D_set_h_frames>` **(** :ref:`int<class_int>` enable **)** |
|
||||
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_initial_velocity<class_Particles2D_set_initial_velocity>` **(** :ref:`Vector2<class_vector2>` velocity **)** |
|
||||
@@ -133,7 +133,7 @@ Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`Color<class_color>` **color/color**
|
||||
- :ref:`ColorRamp<class_colorramp>` **color/color_ramp**
|
||||
- :ref:`Gradient<class_gradient>` **color/color_ramp**
|
||||
- :ref:`int<class_int>` **color_phases/count**
|
||||
- :ref:`int<class_int>` **config/amount**
|
||||
- :ref:`float<class_float>` **config/emit_timeout**
|
||||
@@ -247,12 +247,6 @@ Returns the tint color for each particle.
|
||||
|
||||
- :ref:`int<class_int>` **get_color_phases** **(** **)** const
|
||||
|
||||
.. _class_Particles2D_get_color_ramp:
|
||||
|
||||
- :ref:`ColorRamp<class_colorramp>` **get_color_ramp** **(** **)** const
|
||||
|
||||
Returns the :ref:`ColorRamp<class_colorramp>` used to tint each particle
|
||||
|
||||
.. _class_Particles2D_get_emission_half_extents:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_emission_half_extents** **(** **)** const
|
||||
@@ -279,6 +273,12 @@ Returns the amount of seconds during which the emitter will spawn particles
|
||||
|
||||
- :ref:`float<class_float>` **get_explosiveness** **(** **)** const
|
||||
|
||||
.. _class_Particles2D_get_gradient:
|
||||
|
||||
- :ref:`Gradient<class_gradient>` **get_gradient** **(** **)** const
|
||||
|
||||
Returns the :ref:`Gradient<class_gradient>` used to tint each particle.
|
||||
|
||||
.. _class_Particles2D_get_h_frames:
|
||||
|
||||
- :ref:`int<class_int>` **get_h_frames** **(** **)** const
|
||||
@@ -379,12 +379,6 @@ Set the tint color for each particle.
|
||||
|
||||
- void **set_color_phases** **(** :ref:`int<class_int>` phases **)**
|
||||
|
||||
.. _class_Particles2D_set_color_ramp:
|
||||
|
||||
- :ref:`ColorRamp<class_colorramp>` **set_color_ramp** **(** :ref:`Object<class_object>` color_ramp **)**
|
||||
|
||||
Sets the :ref:`ColorRamp<class_colorramp>` used to tint each particle. Particle will be tinted according to their lifetimes.
|
||||
|
||||
.. _class_Particles2D_set_emission_half_extents:
|
||||
|
||||
- void **set_emission_half_extents** **(** :ref:`Vector2<class_vector2>` extents **)**
|
||||
@@ -425,6 +419,12 @@ If this is set to true then the particle emitter will emit particles, if its fal
|
||||
|
||||
- void **set_flip_v** **(** :ref:`bool<class_bool>` enable **)**
|
||||
|
||||
.. _class_Particles2D_set_gradient:
|
||||
|
||||
- :ref:`Gradient<class_gradient>` **set_gradient** **(** :ref:`Object<class_object>` gradient **)**
|
||||
|
||||
Sets the :ref:`Gradient<class_gradient>` used to tint each particle. Particle will be tinted according to their lifetimes.
|
||||
|
||||
.. _class_Particles2D_set_h_frames:
|
||||
|
||||
- void **set_h_frames** **(** :ref:`int<class_int>` enable **)**
|
||||
|
||||
@@ -39,6 +39,8 @@ Member Functions
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_flatness<class_ParticlesMaterial_get_flatness>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity<class_ParticlesMaterial_get_gravity>` **(** **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_param<class_ParticlesMaterial_get_param>` **(** :ref:`int<class_int>` param **)** const |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_param_randomness<class_ParticlesMaterial_get_param_randomness>` **(** :ref:`int<class_int>` param **)** const |
|
||||
@@ -73,6 +75,8 @@ Member Functions
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_flatness<class_ParticlesMaterial_set_flatness>` **(** :ref:`float<class_float>` amount **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_gravity<class_ParticlesMaterial_set_gravity>` **(** :ref:`Vector3<class_vector3>` accel_vec **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_param<class_ParticlesMaterial_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||
+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_param_randomness<class_ParticlesMaterial_set_param_randomness>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` randomness **)** |
|
||||
@@ -117,6 +121,7 @@ Member Variables
|
||||
- :ref:`bool<class_bool>` **flag_align_y**
|
||||
- :ref:`bool<class_bool>` **flag_rotate_y**
|
||||
- :ref:`float<class_float>` **flatness**
|
||||
- :ref:`Vector3<class_vector3>` **gravity**
|
||||
- :ref:`float<class_float>` **hue_variation**
|
||||
- :ref:`CurveTexture<class_curvetexture>` **hue_variation_curve**
|
||||
- :ref:`float<class_float>` **hue_variation_random**
|
||||
@@ -210,6 +215,10 @@ Member Function Description
|
||||
|
||||
- :ref:`float<class_float>` **get_flatness** **(** **)** const
|
||||
|
||||
.. _class_ParticlesMaterial_get_gravity:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_gravity** **(** **)** const
|
||||
|
||||
.. _class_ParticlesMaterial_get_param:
|
||||
|
||||
- :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
|
||||
@@ -278,6 +287,10 @@ Member Function Description
|
||||
|
||||
- void **set_flatness** **(** :ref:`float<class_float>` amount **)**
|
||||
|
||||
.. _class_ParticlesMaterial_set_gravity:
|
||||
|
||||
- void **set_gravity** **(** :ref:`Vector3<class_vector3>` accel_vec **)**
|
||||
|
||||
.. _class_ParticlesMaterial_set_param:
|
||||
|
||||
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
|
||||
|
||||
@@ -25,9 +25,9 @@ Member Functions
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_rest_info<class_Physics2DDirectSpaceState_get_rest_info>` **(** :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>` shape **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`intersect_point<class_Physics2DDirectSpaceState_intersect_point>` **(** :ref:`Vector2<class_vector2>` point, :ref:`int<class_int>` max_results=32, :ref:`Array<class_array>` exclude=Array(), :ref:`int<class_int>` layer_mask=2147483647, :ref:`int<class_int>` type_mask=15 **)** |
|
||||
| :ref:`Array<class_array>` | :ref:`intersect_point<class_Physics2DDirectSpaceState_intersect_point>` **(** :ref:`Vector2<class_vector2>` point, :ref:`int<class_int>` max_results=32, :ref:`Array<class_array>` exclude=[], :ref:`int<class_int>` collision_layer=2147483647, :ref:`int<class_int>` type_mask=15 **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`intersect_ray<class_Physics2DDirectSpaceState_intersect_ray>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Array<class_array>` exclude=Array(), :ref:`int<class_int>` layer_mask=2147483647, :ref:`int<class_int>` type_mask=15 **)** |
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`intersect_ray<class_Physics2DDirectSpaceState_intersect_ray>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Array<class_array>` exclude=[], :ref:`int<class_int>` collision_layer=2147483647, :ref:`int<class_int>` type_mask=15 **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`intersect_shape<class_Physics2DDirectSpaceState_intersect_shape>` **(** :ref:`Physics2DShapeQueryParameters<class_physics2dshapequeryparameters>` shape, :ref:`int<class_int>` max_results=32 **)** |
|
||||
+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -90,7 +90,7 @@ If the shape did not intersect anything, then an empty dictionary (dir.empty()==
|
||||
|
||||
.. _class_Physics2DDirectSpaceState_intersect_point:
|
||||
|
||||
- :ref:`Array<class_array>` **intersect_point** **(** :ref:`Vector2<class_vector2>` point, :ref:`int<class_int>` max_results=32, :ref:`Array<class_array>` exclude=Array(), :ref:`int<class_int>` layer_mask=2147483647, :ref:`int<class_int>` type_mask=15 **)**
|
||||
- :ref:`Array<class_array>` **intersect_point** **(** :ref:`Vector2<class_vector2>` point, :ref:`int<class_int>` max_results=32, :ref:`Array<class_array>` exclude=[], :ref:`int<class_int>` collision_layer=2147483647, :ref:`int<class_int>` type_mask=15 **)**
|
||||
|
||||
Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields:
|
||||
|
||||
@@ -108,7 +108,7 @@ Additionally, the method can take an array of objects or :ref:`RID<class_rid>`s
|
||||
|
||||
.. _class_Physics2DDirectSpaceState_intersect_ray:
|
||||
|
||||
- :ref:`Dictionary<class_dictionary>` **intersect_ray** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Array<class_array>` exclude=Array(), :ref:`int<class_int>` layer_mask=2147483647, :ref:`int<class_int>` type_mask=15 **)**
|
||||
- :ref:`Dictionary<class_dictionary>` **intersect_ray** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Array<class_array>` exclude=[], :ref:`int<class_int>` collision_layer=2147483647, :ref:`int<class_int>` type_mask=15 **)**
|
||||
|
||||
Intersect a ray in a given space. The returned object is a dictionary with the following fields:
|
||||
|
||||
|
||||
@@ -47,9 +47,9 @@ Member Functions
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_remove_shape<class_Physics2DServer_area_remove_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_collision_mask<class_Physics2DServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
|
||||
| void | :ref:`area_set_collision_layer<class_Physics2DServer_area_set_collision_layer>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_layer_mask<class_Physics2DServer_area_set_layer_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
|
||||
| void | :ref:`area_set_collision_mask<class_Physics2DServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_monitor_callback<class_Physics2DServer_area_set_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -79,12 +79,12 @@ Member Functions
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`body_create<class_Physics2DServer_body_create>` **(** :ref:`int<class_int>` mode=2, :ref:`bool<class_bool>` init_sleeping=false **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_Physics2DServer_body_get_collision_layer>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_Physics2DServer_body_get_collision_mask>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_continuous_collision_detection_mode<class_Physics2DServer_body_get_continuous_collision_detection_mode>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_layer_mask<class_Physics2DServer_body_get_layer_mask>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_Physics2DServer_body_get_max_contacts_reported>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_mode<class_Physics2DServer_body_get_mode>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
@@ -119,14 +119,14 @@ Member Functions
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_axis_velocity<class_Physics2DServer_body_set_axis_velocity>` **(** :ref:`RID<class_rid>` body, :ref:`Vector2<class_vector2>` axis_velocity **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_collision_layer<class_Physics2DServer_body_set_collision_layer>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` layer **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_collision_mask<class_Physics2DServer_body_set_collision_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_continuous_collision_detection_mode<class_Physics2DServer_body_set_continuous_collision_detection_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_force_integration_callback<class_Physics2DServer_body_set_force_integration_callback>` **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=NULL **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_layer_mask<class_Physics2DServer_body_set_layer_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_max_contacts_reported<class_Physics2DServer_body_set_max_contacts_reported>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_mode<class_Physics2DServer_body_set_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
|
||||
@@ -153,7 +153,7 @@ Member Functions
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`body_test_motion<class_Physics2DServer_body_test_motion>` **(** :ref:`RID<class_rid>` body, :ref:`Transform2D<class_transform2d>` from, :ref:`Vector2<class_vector2>` motion, :ref:`float<class_float>` margin=0.08, :ref:`Physics2DTestMotionResult<class_physics2dtestmotionresult>` result=NULL **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`damped_spring_joint_create<class_Physics2DServer_damped_spring_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=RID() **)** |
|
||||
| :ref:`RID<class_rid>` | :ref:`damped_spring_joint_create<class_Physics2DServer_damped_spring_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=[RID] **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`damped_string_joint_get_param<class_Physics2DServer_damped_string_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -163,7 +163,7 @@ Member Functions
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_process_info<class_Physics2DServer_get_process_info>` **(** :ref:`int<class_int>` process_info **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`groove_joint_create<class_Physics2DServer_groove_joint_create>` **(** :ref:`Vector2<class_vector2>` groove1_a, :ref:`Vector2<class_vector2>` groove2_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a=RID(), :ref:`RID<class_rid>` body_b=RID() **)** |
|
||||
| :ref:`RID<class_rid>` | :ref:`groove_joint_create<class_Physics2DServer_groove_joint_create>` **(** :ref:`Vector2<class_vector2>` groove1_a, :ref:`Vector2<class_vector2>` groove2_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a=[RID], :ref:`RID<class_rid>` body_b=[RID] **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`joint_get_param<class_Physics2DServer_joint_get_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param **)** const |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -171,7 +171,7 @@ Member Functions
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`joint_set_param<class_Physics2DServer_joint_set_param>` **(** :ref:`RID<class_rid>` joint, :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`RID<class_rid>` | :ref:`pin_joint_create<class_Physics2DServer_pin_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=RID() **)** |
|
||||
| :ref:`RID<class_rid>` | :ref:`pin_joint_create<class_Physics2DServer_pin_joint_create>` **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=[RID] **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_active<class_Physics2DServer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
|
||||
+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -345,18 +345,18 @@ Return the transform matrix for an area.
|
||||
|
||||
Remove a shape from an area. It does not delete the shape, so it can be reassigned later.
|
||||
|
||||
.. _class_Physics2DServer_area_set_collision_layer:
|
||||
|
||||
- void **area_set_collision_layer** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)**
|
||||
|
||||
Assign the area to one or many physics layers.
|
||||
|
||||
.. _class_Physics2DServer_area_set_collision_mask:
|
||||
|
||||
- void **area_set_collision_mask** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)**
|
||||
|
||||
Set which physics layers the area will monitor.
|
||||
|
||||
.. _class_Physics2DServer_area_set_layer_mask:
|
||||
|
||||
- void **area_set_layer_mask** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)**
|
||||
|
||||
Assign the area to one or many physics layers.
|
||||
|
||||
.. _class_Physics2DServer_area_set_monitor_callback:
|
||||
|
||||
- void **area_set_monitor_callback** **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)**
|
||||
@@ -451,6 +451,12 @@ Remove all shapes from a body.
|
||||
|
||||
Create a physics body. The first parameter can be any value from constants BODY_MODE\*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
|
||||
|
||||
.. _class_Physics2DServer_body_get_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_rid>` body **)** const
|
||||
|
||||
Return the physics layer or layers a body belongs to.
|
||||
|
||||
.. _class_Physics2DServer_body_get_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_rid>` body **)** const
|
||||
@@ -463,12 +469,6 @@ Return the physics layer or layers a body can collide with.
|
||||
|
||||
Return the continuous collision detection mode.
|
||||
|
||||
.. _class_Physics2DServer_body_get_layer_mask:
|
||||
|
||||
- :ref:`int<class_int>` **body_get_layer_mask** **(** :ref:`RID<class_rid>` body **)** const
|
||||
|
||||
Return the physics layer or layers a body belongs to.
|
||||
|
||||
.. _class_Physics2DServer_body_get_max_contacts_reported:
|
||||
|
||||
- :ref:`int<class_int>` **body_get_max_contacts_reported** **(** :ref:`RID<class_rid>` body **)** const
|
||||
@@ -571,6 +571,12 @@ Remove a shape from a body. The shape is not deleted, so it can be reused afterw
|
||||
|
||||
Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
|
||||
|
||||
.. _class_Physics2DServer_body_set_collision_layer:
|
||||
|
||||
- void **body_set_collision_layer** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` layer **)**
|
||||
|
||||
Set the physics layer or layers a body belongs to.
|
||||
|
||||
.. _class_Physics2DServer_body_set_collision_mask:
|
||||
|
||||
- void **body_set_collision_mask** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)**
|
||||
@@ -591,12 +597,6 @@ Continuous collision detection tries to predict where a moving body will collide
|
||||
|
||||
Set the function used to calculate physics for an object, if that object allows it (see :ref:`body_set_omit_force integration<class_Physics2DServer_body_set_omit_force integration>`).
|
||||
|
||||
.. _class_Physics2DServer_body_set_layer_mask:
|
||||
|
||||
- void **body_set_layer_mask** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)**
|
||||
|
||||
Set the physics layer or layers a body belongs to.
|
||||
|
||||
.. _class_Physics2DServer_body_set_max_contacts_reported:
|
||||
|
||||
- void **body_set_max_contacts_reported** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)**
|
||||
@@ -677,7 +677,7 @@ Return whether a body can move from a given point in a given direction. Apart fr
|
||||
|
||||
.. _class_Physics2DServer_damped_spring_joint_create:
|
||||
|
||||
- :ref:`RID<class_rid>` **damped_spring_joint_create** **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=RID() **)**
|
||||
- :ref:`RID<class_rid>` **damped_spring_joint_create** **(** :ref:`Vector2<class_vector2>` anchor_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=[RID] **)**
|
||||
|
||||
Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself.
|
||||
|
||||
@@ -707,7 +707,7 @@ Return information about the current state of the 2D physics engine. The states
|
||||
|
||||
.. _class_Physics2DServer_groove_joint_create:
|
||||
|
||||
- :ref:`RID<class_rid>` **groove_joint_create** **(** :ref:`Vector2<class_vector2>` groove1_a, :ref:`Vector2<class_vector2>` groove2_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a=RID(), :ref:`RID<class_rid>` body_b=RID() **)**
|
||||
- :ref:`RID<class_rid>` **groove_joint_create** **(** :ref:`Vector2<class_vector2>` groove1_a, :ref:`Vector2<class_vector2>` groove2_a, :ref:`Vector2<class_vector2>` anchor_b, :ref:`RID<class_rid>` body_a=[RID], :ref:`RID<class_rid>` body_b=[RID] **)**
|
||||
|
||||
Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself.
|
||||
|
||||
@@ -731,7 +731,7 @@ Set a joint parameter. Parameters are explained in the JOINT_PARAM\* constants.
|
||||
|
||||
.. _class_Physics2DServer_pin_joint_create:
|
||||
|
||||
- :ref:`RID<class_rid>` **pin_joint_create** **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=RID() **)**
|
||||
- :ref:`RID<class_rid>` **pin_joint_create** **(** :ref:`Vector2<class_vector2>` anchor, :ref:`RID<class_rid>` body_a, :ref:`RID<class_rid>` body_b=[RID] **)**
|
||||
|
||||
Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself.
|
||||
|
||||
|
||||
@@ -19,9 +19,9 @@ Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_exclude<class_Physics2DShapeQueryParameters_get_exclude>` **(** **)** const |
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_Physics2DShapeQueryParameters_get_collision_layer>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_layer_mask<class_Physics2DShapeQueryParameters_get_layer_mask>` **(** **)** const |
|
||||
| :ref:`Array<class_array>` | :ref:`get_exclude<class_Physics2DShapeQueryParameters_get_exclude>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_margin<class_Physics2DShapeQueryParameters_get_margin>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -33,9 +33,9 @@ Member Functions
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform2D<class_transform2d>` | :ref:`get_transform<class_Physics2DShapeQueryParameters_get_transform>` **(** **)** const |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_exclude<class_Physics2DShapeQueryParameters_set_exclude>` **(** :ref:`Array<class_array>` exclude **)** |
|
||||
| void | :ref:`set_collision_layer<class_Physics2DShapeQueryParameters_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_layer_mask<class_Physics2DShapeQueryParameters_set_layer_mask>` **(** :ref:`int<class_int>` layer_mask **)** |
|
||||
| void | :ref:`set_exclude<class_Physics2DShapeQueryParameters_set_exclude>` **(** :ref:`Array<class_array>` exclude **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_margin<class_Physics2DShapeQueryParameters_set_margin>` **(** :ref:`float<class_float>` margin **)** |
|
||||
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -58,18 +58,18 @@ This class contains the shape and other parameters for intersection/collision qu
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_Physics2DShapeQueryParameters_get_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
||||
|
||||
Return the physics layer the shape belongs to.
|
||||
|
||||
.. _class_Physics2DShapeQueryParameters_get_exclude:
|
||||
|
||||
- :ref:`Array<class_array>` **get_exclude** **(** **)** const
|
||||
|
||||
Return the list of objects, or object :ref:`RID<class_rid>`s, that will be excluded from collisions.
|
||||
|
||||
.. _class_Physics2DShapeQueryParameters_get_layer_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_layer_mask** **(** **)** const
|
||||
|
||||
Return the physics layer(s) the shape belongs to.
|
||||
|
||||
.. _class_Physics2DShapeQueryParameters_get_margin:
|
||||
|
||||
- :ref:`float<class_float>` **get_margin** **(** **)** const
|
||||
@@ -100,18 +100,18 @@ Return the :ref:`RID<class_rid>` of the shape queried.
|
||||
|
||||
Return the transform matrix of the shape queried.
|
||||
|
||||
.. _class_Physics2DShapeQueryParameters_set_collision_layer:
|
||||
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
||||
|
||||
Set the physics layer the shape belongs to.
|
||||
|
||||
.. _class_Physics2DShapeQueryParameters_set_exclude:
|
||||
|
||||
- void **set_exclude** **(** :ref:`Array<class_array>` exclude **)**
|
||||
|
||||
Set the list of objects, or object :ref:`RID<class_rid>`s, that will be excluded from collisions.
|
||||
|
||||
.. _class_Physics2DShapeQueryParameters_set_layer_mask:
|
||||
|
||||
- void **set_layer_mask** **(** :ref:`int<class_int>` layer_mask **)**
|
||||
|
||||
Set the physics layer(s) the shape belongs to.
|
||||
|
||||
.. _class_Physics2DShapeQueryParameters_set_margin:
|
||||
|
||||
- void **set_margin** **(** :ref:`float<class_float>` margin **)**
|
||||
|
||||
@@ -8,7 +8,7 @@ PhysicsBody
|
||||
|
||||
**Inherits:** :ref:`CollisionObject<class_collisionobject>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`VehicleBody<class_vehiclebody>`, :ref:`StaticBody<class_staticbody>`, :ref:`KinematicBody<class_kinematicbody>`, :ref:`RigidBody<class_rigidbody>`
|
||||
**Inherited By:** :ref:`RigidBody<class_rigidbody>`, :ref:`VehicleBody<class_vehiclebody>`, :ref:`StaticBody<class_staticbody>`, :ref:`KinematicBody<class_kinematicbody>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ Member Functions
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_collision_exception_with<class_PhysicsBody2D_remove_collision_exception_with>` **(** :ref:`PhysicsBody2D<class_physicsbody2d>` body **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer<class_PhysicsBody2D_set_collision_layer>` **(** :ref:`int<class_int>` mask **)** |
|
||||
| void | :ref:`set_collision_layer<class_PhysicsBody2D_set_collision_layer>` **(** :ref:`int<class_int>` layer **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_collision_layer_bit<class_PhysicsBody2D_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
|
||||
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -117,7 +117,7 @@ Removes a body from the collision exception list.
|
||||
|
||||
.. _class_PhysicsBody2D_set_collision_layer:
|
||||
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` mask **)**
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` layer **)**
|
||||
|
||||
Set the physics layers this area is in.
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ Member Functions
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`get_rest_info<class_PhysicsDirectSpaceState_get_rest_info>` **(** :ref:`PhysicsShapeQueryParameters<class_physicsshapequeryparameters>` shape **)** |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`intersect_ray<class_PhysicsDirectSpaceState_intersect_ray>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Array<class_array>` exclude=Array(), :ref:`int<class_int>` layer_mask=2147483647, :ref:`int<class_int>` type_mask=15 **)** |
|
||||
| :ref:`Dictionary<class_dictionary>` | :ref:`intersect_ray<class_PhysicsDirectSpaceState_intersect_ray>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Array<class_array>` exclude=[], :ref:`int<class_int>` collision_layer=2147483647, :ref:`int<class_int>` type_mask=15 **)** |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`intersect_shape<class_PhysicsDirectSpaceState_intersect_shape>` **(** :ref:`PhysicsShapeQueryParameters<class_physicsshapequeryparameters>` shape, :ref:`int<class_int>` max_results=32 **)** |
|
||||
+--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -57,7 +57,7 @@ Member Function Description
|
||||
|
||||
.. _class_PhysicsDirectSpaceState_intersect_ray:
|
||||
|
||||
- :ref:`Dictionary<class_dictionary>` **intersect_ray** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Array<class_array>` exclude=Array(), :ref:`int<class_int>` layer_mask=2147483647, :ref:`int<class_int>` type_mask=15 **)**
|
||||
- :ref:`Dictionary<class_dictionary>` **intersect_ray** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Array<class_array>` exclude=[], :ref:`int<class_int>` collision_layer=2147483647, :ref:`int<class_int>` type_mask=15 **)**
|
||||
|
||||
.. _class_PhysicsDirectSpaceState_intersect_shape:
|
||||
|
||||
|
||||
@@ -49,9 +49,9 @@ Member Functions
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_remove_shape<class_PhysicsServer_area_remove_shape>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_collision_mask<class_PhysicsServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
|
||||
| void | :ref:`area_set_collision_layer<class_PhysicsServer_area_set_collision_layer>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_layer_mask<class_PhysicsServer_area_set_layer_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
|
||||
| void | :ref:`area_set_collision_mask<class_PhysicsServer_area_set_collision_mask>` **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`area_set_monitor_callback<class_PhysicsServer_area_set_monitor_callback>` **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -85,9 +85,9 @@ Member Functions
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_axis_lock<class_PhysicsServer_body_get_axis_lock>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer_body_get_collision_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` arg1 **)** const |
|
||||
| :ref:`int<class_int>` | :ref:`body_get_collision_layer<class_PhysicsServer_body_get_collision_layer>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_layer_mask<class_PhysicsServer_body_get_layer_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` arg1 **)** const |
|
||||
| :ref:`int<class_int>` | :ref:`body_get_collision_mask<class_PhysicsServer_body_get_collision_mask>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`body_get_max_contacts_reported<class_PhysicsServer_body_get_max_contacts_reported>` **(** :ref:`RID<class_rid>` body **)** const |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -121,14 +121,14 @@ Member Functions
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_axis_velocity<class_PhysicsServer_body_set_axis_velocity>` **(** :ref:`RID<class_rid>` body, :ref:`Vector3<class_vector3>` axis_velocity **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_collision_layer<class_PhysicsServer_body_set_collision_layer>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` layer **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_collision_mask<class_PhysicsServer_body_set_collision_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_enable_continuous_collision_detection<class_PhysicsServer_body_set_enable_continuous_collision_detection>` **(** :ref:`RID<class_rid>` body, :ref:`bool<class_bool>` enable **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_force_integration_callback<class_PhysicsServer_body_set_force_integration_callback>` **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=NULL **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_layer_mask<class_PhysicsServer_body_set_layer_mask>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_max_contacts_reported<class_PhysicsServer_body_set_max_contacts_reported>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)** |
|
||||
+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`body_set_mode<class_PhysicsServer_body_set_mode>` **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mode **)** |
|
||||
@@ -395,14 +395,14 @@ Member Function Description
|
||||
|
||||
- void **area_remove_shape** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` shape_idx **)**
|
||||
|
||||
.. _class_PhysicsServer_area_set_collision_layer:
|
||||
|
||||
- void **area_set_collision_layer** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` layer **)**
|
||||
|
||||
.. _class_PhysicsServer_area_set_collision_mask:
|
||||
|
||||
- void **area_set_collision_mask** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)**
|
||||
|
||||
.. _class_PhysicsServer_area_set_layer_mask:
|
||||
|
||||
- void **area_set_layer_mask** **(** :ref:`RID<class_rid>` area, :ref:`int<class_int>` mask **)**
|
||||
|
||||
.. _class_PhysicsServer_area_set_monitor_callback:
|
||||
|
||||
- void **area_set_monitor_callback** **(** :ref:`RID<class_rid>` area, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method **)**
|
||||
@@ -467,13 +467,13 @@ Member Function Description
|
||||
|
||||
- :ref:`int<class_int>` **body_get_axis_lock** **(** :ref:`RID<class_rid>` body **)** const
|
||||
|
||||
.. _class_PhysicsServer_body_get_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **body_get_collision_layer** **(** :ref:`RID<class_rid>` body **)** const
|
||||
|
||||
.. _class_PhysicsServer_body_get_collision_mask:
|
||||
|
||||
- :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` arg1 **)** const
|
||||
|
||||
.. _class_PhysicsServer_body_get_layer_mask:
|
||||
|
||||
- :ref:`int<class_int>` **body_get_layer_mask** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` arg1 **)** const
|
||||
- :ref:`int<class_int>` **body_get_collision_mask** **(** :ref:`RID<class_rid>` body **)** const
|
||||
|
||||
.. _class_PhysicsServer_body_get_max_contacts_reported:
|
||||
|
||||
@@ -539,6 +539,10 @@ Member Function Description
|
||||
|
||||
- void **body_set_axis_velocity** **(** :ref:`RID<class_rid>` body, :ref:`Vector3<class_vector3>` axis_velocity **)**
|
||||
|
||||
.. _class_PhysicsServer_body_set_collision_layer:
|
||||
|
||||
- void **body_set_collision_layer** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` layer **)**
|
||||
|
||||
.. _class_PhysicsServer_body_set_collision_mask:
|
||||
|
||||
- void **body_set_collision_mask** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)**
|
||||
@@ -551,10 +555,6 @@ Member Function Description
|
||||
|
||||
- void **body_set_force_integration_callback** **(** :ref:`RID<class_rid>` body, :ref:`Object<class_object>` receiver, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata=NULL **)**
|
||||
|
||||
.. _class_PhysicsServer_body_set_layer_mask:
|
||||
|
||||
- void **body_set_layer_mask** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` mask **)**
|
||||
|
||||
.. _class_PhysicsServer_body_set_max_contacts_reported:
|
||||
|
||||
- void **body_set_max_contacts_reported** **(** :ref:`RID<class_rid>` body, :ref:`int<class_int>` amount **)**
|
||||
|
||||
@@ -19,9 +19,9 @@ Member Functions
|
||||
----------------
|
||||
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Array<class_array>` | :ref:`get_exclude<class_PhysicsShapeQueryParameters_get_exclude>` **(** **)** const |
|
||||
| :ref:`int<class_int>` | :ref:`get_collision_layer<class_PhysicsShapeQueryParameters_get_collision_layer>` **(** **)** const |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_layer_mask<class_PhysicsShapeQueryParameters_get_layer_mask>` **(** **)** const |
|
||||
| :ref:`Array<class_array>` | :ref:`get_exclude<class_PhysicsShapeQueryParameters_get_exclude>` **(** **)** const |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_margin<class_PhysicsShapeQueryParameters_get_margin>` **(** **)** const |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -31,9 +31,9 @@ Member Functions
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Transform<class_transform>` | :ref:`get_transform<class_PhysicsShapeQueryParameters_get_transform>` **(** **)** const |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_exclude<class_PhysicsShapeQueryParameters_set_exclude>` **(** :ref:`Array<class_array>` exclude **)** |
|
||||
| void | :ref:`set_collision_layer<class_PhysicsShapeQueryParameters_set_collision_layer>` **(** :ref:`int<class_int>` collision_layer **)** |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_layer_mask<class_PhysicsShapeQueryParameters_set_layer_mask>` **(** :ref:`int<class_int>` layer_mask **)** |
|
||||
| void | :ref:`set_exclude<class_PhysicsShapeQueryParameters_set_exclude>` **(** :ref:`Array<class_array>` exclude **)** |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_margin<class_PhysicsShapeQueryParameters_set_margin>` **(** :ref:`float<class_float>` margin **)** |
|
||||
+------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@@ -49,14 +49,14 @@ Member Functions
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_PhysicsShapeQueryParameters_get_collision_layer:
|
||||
|
||||
- :ref:`int<class_int>` **get_collision_layer** **(** **)** const
|
||||
|
||||
.. _class_PhysicsShapeQueryParameters_get_exclude:
|
||||
|
||||
- :ref:`Array<class_array>` **get_exclude** **(** **)** const
|
||||
|
||||
.. _class_PhysicsShapeQueryParameters_get_layer_mask:
|
||||
|
||||
- :ref:`int<class_int>` **get_layer_mask** **(** **)** const
|
||||
|
||||
.. _class_PhysicsShapeQueryParameters_get_margin:
|
||||
|
||||
- :ref:`float<class_float>` **get_margin** **(** **)** const
|
||||
@@ -73,14 +73,14 @@ Member Function Description
|
||||
|
||||
- :ref:`Transform<class_transform>` **get_transform** **(** **)** const
|
||||
|
||||
.. _class_PhysicsShapeQueryParameters_set_collision_layer:
|
||||
|
||||
- void **set_collision_layer** **(** :ref:`int<class_int>` collision_layer **)**
|
||||
|
||||
.. _class_PhysicsShapeQueryParameters_set_exclude:
|
||||
|
||||
- void **set_exclude** **(** :ref:`Array<class_array>` exclude **)**
|
||||
|
||||
.. _class_PhysicsShapeQueryParameters_set_layer_mask:
|
||||
|
||||
- void **set_layer_mask** **(** :ref:`int<class_int>` layer_mask **)**
|
||||
|
||||
.. _class_PhysicsShapeQueryParameters_set_margin:
|
||||
|
||||
- void **set_margin** **(** :ref:`float<class_float>` margin **)**
|
||||
|
||||
69
classes/class_planemesh.rst
Normal file
69
classes/class_planemesh.rst
Normal file
@@ -0,0 +1,69 @@
|
||||
.. 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_PlaneMesh:
|
||||
|
||||
PlaneMesh
|
||||
=========
|
||||
|
||||
**Inherits:** :ref:`PrimitiveMesh<class_primitivemesh>` **<** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_PlaneMesh_get_size>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_depth<class_PlaneMesh_get_subdivide_depth>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_width<class_PlaneMesh_get_subdivide_width>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_PlaneMesh_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_depth<class_PlaneMesh_set_subdivide_depth>` **(** :ref:`int<class_int>` subdivide **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_width<class_PlaneMesh_set_subdivide_width>` **(** :ref:`int<class_int>` subdivide **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **size**
|
||||
- :ref:`int<class_int>` **subdivide_depth**
|
||||
- :ref:`int<class_int>` **subdivide_width**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_PlaneMesh_get_size:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
|
||||
|
||||
.. _class_PlaneMesh_get_subdivide_depth:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
|
||||
|
||||
.. _class_PlaneMesh_get_subdivide_width:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
|
||||
|
||||
.. _class_PlaneMesh_set_size:
|
||||
|
||||
- void **set_size** **(** :ref:`Vector2<class_vector2>` size **)**
|
||||
|
||||
.. _class_PlaneMesh_set_subdivide_depth:
|
||||
|
||||
- void **set_subdivide_depth** **(** :ref:`int<class_int>` subdivide **)**
|
||||
|
||||
.. _class_PlaneMesh_set_subdivide_width:
|
||||
|
||||
- void **set_subdivide_width** **(** :ref:`int<class_int>` subdivide **)**
|
||||
|
||||
|
||||
@@ -38,7 +38,11 @@ Signals
|
||||
-------
|
||||
|
||||
- **about_to_show** **(** **)**
|
||||
This signal is emitted when a popup is about to be shown. (often used in :ref:`PopupMenu<class_popupmenu>` for clearing the list of options and creating a new one according to the current context).
|
||||
|
||||
- **popup_hide** **(** **)**
|
||||
This signal is emitted when a popup is hidden.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
@@ -106,7 +106,11 @@ Signals
|
||||
-------
|
||||
|
||||
- **id_pressed** **(** :ref:`int<class_int>` ID **)**
|
||||
This event is emitted when an item of some id is pressed or its accelerator is activated.
|
||||
|
||||
- **index_pressed** **(** :ref:`int<class_int>` index **)**
|
||||
This event is emitted when an item of some index is pressed or its accelerator is activated.
|
||||
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
45
classes/class_primitivemesh.rst
Normal file
45
classes/class_primitivemesh.rst
Normal file
@@ -0,0 +1,45 @@
|
||||
.. 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_PrimitiveMesh:
|
||||
|
||||
PrimitiveMesh
|
||||
=============
|
||||
|
||||
**Inherits:** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherited By:** :ref:`PlaneMesh<class_planemesh>`, :ref:`CubeMesh<class_cubemesh>`, :ref:`SphereMesh<class_spheremesh>`, :ref:`CylinderMesh<class_cylindermesh>`, :ref:`CapsuleMesh<class_capsulemesh>`, :ref:`QuadMesh<class_quadmesh>`, :ref:`PrismMesh<class_prismmesh>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Material<class_material>` | :ref:`get_material<class_PrimitiveMesh_get_material>` **(** **)** const |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_material<class_PrimitiveMesh_set_material>` **(** :ref:`Material<class_material>` material **)** |
|
||||
+----------------------------------+--------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`Material<class_material>` **material**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_PrimitiveMesh_get_material:
|
||||
|
||||
- :ref:`Material<class_material>` **get_material** **(** **)** const
|
||||
|
||||
.. _class_PrimitiveMesh_set_material:
|
||||
|
||||
- void **set_material** **(** :ref:`Material<class_material>` material **)**
|
||||
|
||||
|
||||
95
classes/class_prismmesh.rst
Normal file
95
classes/class_prismmesh.rst
Normal file
@@ -0,0 +1,95 @@
|
||||
.. 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_PrismMesh:
|
||||
|
||||
PrismMesh
|
||||
=========
|
||||
|
||||
**Inherits:** :ref:`PrimitiveMesh<class_primitivemesh>` **<** :ref:`Mesh<class_mesh>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_left_to_right<class_PrismMesh_get_left_to_right>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector3<class_vector3>` | :ref:`get_size<class_PrismMesh_get_size>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_depth<class_PrismMesh_get_subdivide_depth>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_height<class_PrismMesh_get_subdivide_height>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_subdivide_width<class_PrismMesh_get_subdivide_width>` **(** **)** const |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_left_to_right<class_PrismMesh_set_left_to_right>` **(** :ref:`float<class_float>` left_to_right **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_PrismMesh_set_size>` **(** :ref:`Vector3<class_vector3>` size **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_depth<class_PrismMesh_set_subdivide_depth>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_height<class_PrismMesh_set_subdivide_height>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_subdivide_width<class_PrismMesh_set_subdivide_width>` **(** :ref:`int<class_int>` segments **)** |
|
||||
+--------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`float<class_float>` **left_to_right**
|
||||
- :ref:`Vector2<class_vector2>` **size**
|
||||
- :ref:`int<class_int>` **subdivide_depth**
|
||||
- :ref:`int<class_int>` **subdivide_height**
|
||||
- :ref:`int<class_int>` **subdivide_width**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_PrismMesh_get_left_to_right:
|
||||
|
||||
- :ref:`float<class_float>` **get_left_to_right** **(** **)** const
|
||||
|
||||
.. _class_PrismMesh_get_size:
|
||||
|
||||
- :ref:`Vector3<class_vector3>` **get_size** **(** **)** const
|
||||
|
||||
.. _class_PrismMesh_get_subdivide_depth:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_depth** **(** **)** const
|
||||
|
||||
.. _class_PrismMesh_get_subdivide_height:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_height** **(** **)** const
|
||||
|
||||
.. _class_PrismMesh_get_subdivide_width:
|
||||
|
||||
- :ref:`int<class_int>` **get_subdivide_width** **(** **)** const
|
||||
|
||||
.. _class_PrismMesh_set_left_to_right:
|
||||
|
||||
- void **set_left_to_right** **(** :ref:`float<class_float>` left_to_right **)**
|
||||
|
||||
.. _class_PrismMesh_set_size:
|
||||
|
||||
- void **set_size** **(** :ref:`Vector3<class_vector3>` size **)**
|
||||
|
||||
.. _class_PrismMesh_set_subdivide_depth:
|
||||
|
||||
- void **set_subdivide_depth** **(** :ref:`int<class_int>` segments **)**
|
||||
|
||||
.. _class_PrismMesh_set_subdivide_height:
|
||||
|
||||
- void **set_subdivide_height** **(** :ref:`int<class_int>` segments **)**
|
||||
|
||||
.. _class_PrismMesh_set_subdivide_width:
|
||||
|
||||
- void **set_subdivide_width** **(** :ref:`int<class_int>` segments **)**
|
||||
|
||||
|
||||
238
classes/class_proceduralsky.rst
Normal file
238
classes/class_proceduralsky.rst
Normal file
@@ -0,0 +1,238 @@
|
||||
.. 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_ProceduralSky:
|
||||
|
||||
ProceduralSky
|
||||
=============
|
||||
|
||||
**Inherits:** :ref:`Sky<class_sky>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_ground_bottom_color<class_ProceduralSky_get_ground_bottom_color>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ground_curve<class_ProceduralSky_get_ground_curve>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_ground_energy<class_ProceduralSky_get_ground_energy>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_ground_horizon_color<class_ProceduralSky_get_ground_horizon_color>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_sky_curve<class_ProceduralSky_get_sky_curve>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_sky_energy<class_ProceduralSky_get_sky_energy>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_sky_horizon_color<class_ProceduralSky_get_sky_horizon_color>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_sky_top_color<class_ProceduralSky_get_sky_top_color>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_sun_angle_max<class_ProceduralSky_get_sun_angle_max>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_sun_angle_min<class_ProceduralSky_get_sun_angle_min>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Color<class_color>` | :ref:`get_sun_color<class_ProceduralSky_get_sun_color>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_sun_curve<class_ProceduralSky_get_sun_curve>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_sun_energy<class_ProceduralSky_get_sun_energy>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_sun_latitude<class_ProceduralSky_get_sun_latitude>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_sun_longitude<class_ProceduralSky_get_sun_longitude>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_texture_size<class_ProceduralSky_get_texture_size>` **(** **)** const |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ground_bottom_color<class_ProceduralSky_set_ground_bottom_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ground_curve<class_ProceduralSky_set_ground_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ground_energy<class_ProceduralSky_set_ground_energy>` **(** :ref:`float<class_float>` energy **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_ground_horizon_color<class_ProceduralSky_set_ground_horizon_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sky_curve<class_ProceduralSky_set_sky_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sky_energy<class_ProceduralSky_set_sky_energy>` **(** :ref:`float<class_float>` energy **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sky_horizon_color<class_ProceduralSky_set_sky_horizon_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sky_top_color<class_ProceduralSky_set_sky_top_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sun_angle_max<class_ProceduralSky_set_sun_angle_max>` **(** :ref:`float<class_float>` degrees **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sun_angle_min<class_ProceduralSky_set_sun_angle_min>` **(** :ref:`float<class_float>` degrees **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sun_color<class_ProceduralSky_set_sun_color>` **(** :ref:`Color<class_color>` color **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sun_curve<class_ProceduralSky_set_sun_curve>` **(** :ref:`float<class_float>` curve **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sun_energy<class_ProceduralSky_set_sun_energy>` **(** :ref:`float<class_float>` energy **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sun_latitude<class_ProceduralSky_set_sun_latitude>` **(** :ref:`float<class_float>` degrees **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_sun_longitude<class_ProceduralSky_set_sun_longitude>` **(** :ref:`float<class_float>` degrees **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_texture_size<class_ProceduralSky_set_texture_size>` **(** :ref:`int<class_int>` size **)** |
|
||||
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`Color<class_color>` **ground_bottom_color**
|
||||
- :ref:`float<class_float>` **ground_curve**
|
||||
- :ref:`float<class_float>` **ground_energy**
|
||||
- :ref:`Color<class_color>` **ground_horizon_color**
|
||||
- :ref:`float<class_float>` **sky_curve**
|
||||
- :ref:`float<class_float>` **sky_energy**
|
||||
- :ref:`Color<class_color>` **sky_horizon_color**
|
||||
- :ref:`Color<class_color>` **sky_top_color**
|
||||
- :ref:`float<class_float>` **sun_angle_max**
|
||||
- :ref:`float<class_float>` **sun_angle_min**
|
||||
- :ref:`Color<class_color>` **sun_color**
|
||||
- :ref:`float<class_float>` **sun_curve**
|
||||
- :ref:`float<class_float>` **sun_energy**
|
||||
- :ref:`float<class_float>` **sun_latitude**
|
||||
- :ref:`float<class_float>` **sun_longitude**
|
||||
- :ref:`int<class_int>` **texture_size**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_ProceduralSky_get_ground_bottom_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_ground_bottom_color** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_ground_curve:
|
||||
|
||||
- :ref:`float<class_float>` **get_ground_curve** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_ground_energy:
|
||||
|
||||
- :ref:`float<class_float>` **get_ground_energy** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_ground_horizon_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_ground_horizon_color** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sky_curve:
|
||||
|
||||
- :ref:`float<class_float>` **get_sky_curve** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sky_energy:
|
||||
|
||||
- :ref:`float<class_float>` **get_sky_energy** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sky_horizon_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_sky_horizon_color** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sky_top_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_sky_top_color** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sun_angle_max:
|
||||
|
||||
- :ref:`float<class_float>` **get_sun_angle_max** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sun_angle_min:
|
||||
|
||||
- :ref:`float<class_float>` **get_sun_angle_min** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sun_color:
|
||||
|
||||
- :ref:`Color<class_color>` **get_sun_color** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sun_curve:
|
||||
|
||||
- :ref:`float<class_float>` **get_sun_curve** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sun_energy:
|
||||
|
||||
- :ref:`float<class_float>` **get_sun_energy** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sun_latitude:
|
||||
|
||||
- :ref:`float<class_float>` **get_sun_latitude** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_sun_longitude:
|
||||
|
||||
- :ref:`float<class_float>` **get_sun_longitude** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_get_texture_size:
|
||||
|
||||
- :ref:`int<class_int>` **get_texture_size** **(** **)** const
|
||||
|
||||
.. _class_ProceduralSky_set_ground_bottom_color:
|
||||
|
||||
- void **set_ground_bottom_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_ProceduralSky_set_ground_curve:
|
||||
|
||||
- void **set_ground_curve** **(** :ref:`float<class_float>` curve **)**
|
||||
|
||||
.. _class_ProceduralSky_set_ground_energy:
|
||||
|
||||
- void **set_ground_energy** **(** :ref:`float<class_float>` energy **)**
|
||||
|
||||
.. _class_ProceduralSky_set_ground_horizon_color:
|
||||
|
||||
- void **set_ground_horizon_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sky_curve:
|
||||
|
||||
- void **set_sky_curve** **(** :ref:`float<class_float>` curve **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sky_energy:
|
||||
|
||||
- void **set_sky_energy** **(** :ref:`float<class_float>` energy **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sky_horizon_color:
|
||||
|
||||
- void **set_sky_horizon_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sky_top_color:
|
||||
|
||||
- void **set_sky_top_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sun_angle_max:
|
||||
|
||||
- void **set_sun_angle_max** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sun_angle_min:
|
||||
|
||||
- void **set_sun_angle_min** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sun_color:
|
||||
|
||||
- void **set_sun_color** **(** :ref:`Color<class_color>` color **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sun_curve:
|
||||
|
||||
- void **set_sun_curve** **(** :ref:`float<class_float>` curve **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sun_energy:
|
||||
|
||||
- void **set_sun_energy** **(** :ref:`float<class_float>` energy **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sun_latitude:
|
||||
|
||||
- void **set_sun_latitude** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
.. _class_ProceduralSky_set_sun_longitude:
|
||||
|
||||
- void **set_sun_longitude** **(** :ref:`float<class_float>` degrees **)**
|
||||
|
||||
.. _class_ProceduralSky_set_texture_size:
|
||||
|
||||
- void **set_texture_size** **(** :ref:`int<class_int>` size **)**
|
||||
|
||||
|
||||
@@ -1,82 +0,0 @@
|
||||
.. 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_Quad:
|
||||
|
||||
Quad
|
||||
====
|
||||
|
||||
**Inherits:** :ref:`GeometryInstance<class_geometryinstance>` **<** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_axis<class_Quad_get_axis>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Quad_get_offset>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_Quad_get_size>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_centered<class_Quad_is_centered>` **(** **)** const |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_axis<class_Quad_set_axis>` **(** :ref:`int<class_int>` axis **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_centered<class_Quad_set_centered>` **(** :ref:`bool<class_bool>` centered **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_offset<class_Quad_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_size<class_Quad_set_size>` **(** :ref:`Vector2<class_vector2>` size **)** |
|
||||
+--------------------------------+---------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
- :ref:`int<class_int>` **axis**
|
||||
- :ref:`bool<class_bool>` **centered**
|
||||
- :ref:`Vector2<class_vector2>` **offset**
|
||||
- :ref:`Vector2<class_vector2>` **size**
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
|
||||
.. _class_Quad_get_axis:
|
||||
|
||||
- :ref:`int<class_int>` **get_axis** **(** **)** const
|
||||
|
||||
.. _class_Quad_get_offset:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
|
||||
|
||||
.. _class_Quad_get_size:
|
||||
|
||||
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
|
||||
|
||||
.. _class_Quad_is_centered:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_centered** **(** **)** const
|
||||
|
||||
.. _class_Quad_set_axis:
|
||||
|
||||
- void **set_axis** **(** :ref:`int<class_int>` axis **)**
|
||||
|
||||
.. _class_Quad_set_centered:
|
||||
|
||||
- void **set_centered** **(** :ref:`bool<class_bool>` centered **)**
|
||||
|
||||
.. _class_Quad_set_offset:
|
||||
|
||||
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
||||
|
||||
.. _class_Quad_set_size:
|
||||
|
||||
- void **set_size** **(** :ref:`Vector2<class_vector2>` size **)**
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user