diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index d9144b774..7b1a15a6b 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -471,21 +471,19 @@ Numeric Constants - **TYPE_BASIS** = **12** --- Variable is of type :ref:`Basis`. - **TYPE_TRANSFORM** = **13** --- Variable is of type :ref:`Transform`. - **TYPE_COLOR** = **14** --- Variable is of type :ref:`Color`. -- **TYPE_IMAGE** = **15** --- Variable is of type :ref:`Image`. -- **TYPE_NODE_PATH** = **16** --- Variable is of type :ref:`NodePath`. -- **TYPE_RID** = **17** --- Variable is of type :ref:`RID`. -- **TYPE_OBJECT** = **18** --- Variable is of type :ref:`Object`. -- **TYPE_INPUT_EVENT** = **19** --- Variable is of type :ref:`InputEvent`. -- **TYPE_DICTIONARY** = **20** --- Variable is of type :ref:`Dictionary`. -- **TYPE_ARRAY** = **21** --- Variable is of type :ref:`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`. +- **TYPE_RID** = **16** --- Variable is of type :ref:`RID`. +- **TYPE_OBJECT** = **17** --- Variable is of type :ref:`Object`. +- **TYPE_DICTIONARY** = **18** --- Variable is of type :ref:`Dictionary`. +- **TYPE_ARRAY** = **19** --- Variable is of type :ref:`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 ----------- diff --git a/classes/class_@dlscript.rst b/classes/class_@native.rst similarity index 83% rename from classes/class_@dlscript.rst rename to classes/class_@native.rst index deea81995..172e3b12b 100644 --- a/classes/class_@dlscript.rst +++ b/classes/class_@native.rst @@ -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 diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 653c05d03..18081ab4e 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -44,7 +44,11 @@ Signals ------- - **confirmed** **(** **)** +Emitted when accepted. + - **custom_action** **(** :ref:`String` action **)** +Emitted with a custom button is added. + Member Variables ---------------- diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 2637ec4e5..0a53021fc 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -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 ---------------- diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index a705c0341..bb555c357 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -42,6 +42,8 @@ Signals ------- - **frame_changed** **(** **)** +Emitted when frame is changed. + Member Variables ---------------- diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index 9eb443aba..c42b896ea 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -100,8 +100,14 @@ Signals ------- - **animation_changed** **(** :ref:`String` old_name, :ref:`String` new_name **)** +If the currently being played animation changes, this signal will notify of such change. + - **animation_finished** **(** :ref:`String` name **)** +Notifies when an animation finished playing. + - **animation_started** **(** :ref:`String` name **)** +Notifies when an animation starts playing. + Member Variables ---------------- diff --git a/classes/class_area.rst b/classes/class_area.rst index 1c5be938f..23dd95660 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -18,89 +18,105 @@ General purpose area detection and influence for 3D physics. Member Functions ---------------- -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity_vector` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_priority` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Object` body **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_vector` **(** :ref:`Vector3` vector **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` layer_mask **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_priority` **(** :ref:`float` priority **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity_vector` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_priority` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Object` body **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_vector` **(** :ref:`Vector3` vector **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_priority` **(** :ref:`float` priority **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **area_entered** **(** :ref:`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` 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` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +This signal triggers only once when an area enters this area. The first parameter is the area's :ref:`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` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +This signal triggers only once when an area exits this area. The first parameter is the area's :ref:`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` 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` 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` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +This signal triggers only once when a body enters this area. The first parameter is the body's :ref:`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` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +This signal triggers only once when a body exits this area. The first parameter is the body's :ref:`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` **angular_damp** -- :ref:`int` **collision_layers** +- :ref:`int` **collision_layer** - :ref:`int` **collision_mask** - :ref:`float` **gravity** - :ref:`float` **gravity_distance_scale** @@ -126,6 +142,18 @@ Member Function Description Return the angular damp rate. +.. _class_Area_get_collision_layer: + +- :ref:`int` **get_collision_layer** **(** **)** const + +Return the physics layer this area is in. + +.. _class_Area_get_collision_layer_bit: + +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const + +Return an individual bit on the layer mask. + .. _class_Area_get_collision_mask: - :ref:`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`), this will be the attraction center. -.. _class_Area_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const - -Return the physics layer this area is in. - -.. _class_Area_get_layer_mask_bit: - -- :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` bit **)** const - -Return an individual bit on the layer mask. - .. _class_Area_get_linear_damp: - :ref:`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` 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`. + +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` bit, :ref:`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` 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`), this will be the attraction center. -.. _class_Area_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`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`. - -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` bit, :ref:`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` linear_damp **)** diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 36b874c6a..d2d115f1e 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -18,89 +18,105 @@ General purpose area detection and influence for 2D physics. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_gravity_vector` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_priority` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Object` body **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity_vector` **(** :ref:`Vector2` vector **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` layer_mask **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_priority` **(** :ref:`float` priority **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_angular_damp` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_gravity_distance_scale` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_gravity_vector` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_linear_damp` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_areas` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_overlapping_bodies` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_priority` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_monitorable` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_monitoring` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Object` body **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` collision_mask **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_distance_scale` **(** :ref:`float` distance_scale **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_is_point` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity_vector` **(** :ref:`Vector2` vector **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_linear_damp` **(** :ref:`float` linear_damp **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitorable` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_monitoring` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_priority` **(** :ref:`float` priority **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **area_entered** **(** :ref:`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` 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` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +This signal triggers only once when an area enters this area. The first parameter is the area's :ref:`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` area_id, :ref:`Object` area, :ref:`int` area_shape, :ref:`int` self_shape **)** +This signal triggers only once when an area exits this area. The first parameter is the area's :ref:`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` 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` 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` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +This signal triggers only once when a body enters this area. The first parameter is the body's :ref:`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` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` area_shape **)** +This signal triggers only once when a body exits this area. The first parameter is the body's :ref:`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` **angular_damp** -- :ref:`int` **collision_layers** +- :ref:`int` **collision_layer** - :ref:`int` **collision_mask** - :ref:`float` **gravity** - :ref:`float` **gravity_distance_scale** @@ -126,6 +142,18 @@ Member Function Description Return the angular damp rate. +.. _class_Area2D_get_collision_layer: + +- :ref:`int` **get_collision_layer** **(** **)** const + +Return the physics layer this area is in. + +.. _class_Area2D_get_collision_layer_bit: + +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const + +Return an individual bit on the layer mask. + .. _class_Area2D_get_collision_mask: - :ref:`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`), this will be the attraction center. -.. _class_Area2D_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const - -Return the physics layer this area is in. - -.. _class_Area2D_get_layer_mask_bit: - -- :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` bit **)** const - -Return an individual bit on the layer mask. - .. _class_Area2D_get_linear_damp: - :ref:`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` 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`. + +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` bit, :ref:`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` 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`), this will be the attraction center. -.. _class_Area2D_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`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`. - -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` bit, :ref:`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` linear_damp **)** diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst new file mode 100644 index 000000000..237a5ce91 --- /dev/null +++ b/classes/class_arraymesh.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`int` compress_flags=97792 **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`center_geometry` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_blend_shapes` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`regen_normalmaps` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`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` vertices). +- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`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` colors). +- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). +- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`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` name **)** + +.. _class_ArrayMesh_add_surface_from_arrays: + +- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`int` compress_flags=97792 **)** + +Create a new surface (:ref:`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` **get_blend_shape_count** **(** **)** const + +.. _class_ArrayMesh_get_blend_shape_mode: + +- :ref:`int` **get_blend_shape_mode** **(** **)** const + +.. _class_ArrayMesh_get_blend_shape_name: + +- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const + +.. _class_ArrayMesh_get_custom_aabb: + +- :ref:`Rect3` **get_custom_aabb** **(** **)** const + +.. _class_ArrayMesh_get_surface_count: + +- :ref:`int` **get_surface_count** **(** **)** const + +Return the amount of surfaces that the :ref:`ArrayMesh` holds. + +.. _class_ArrayMesh_regen_normalmaps: + +- void **regen_normalmaps** **(** **)** + +.. _class_ArrayMesh_set_blend_shape_mode: + +- void **set_blend_shape_mode** **(** :ref:`int` mode **)** + +.. _class_ArrayMesh_set_custom_aabb: + +- void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** + +.. _class_ArrayMesh_surface_get_array_index_len: + +- :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const + +Return the length in indices of the index array in the requested surface (see :ref:`add_surface`). + +.. _class_ArrayMesh_surface_get_array_len: + +- :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const + +Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface`). + +.. _class_ArrayMesh_surface_get_format: + +- :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const + +Return the format mask of the requested surface (see :ref:`add_surface`). + +.. _class_ArrayMesh_surface_get_material: + +- :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const + +Return a :ref:`Material` in a given surface. Surface is rendered using this material. + +.. _class_ArrayMesh_surface_get_name: + +- :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const + +.. _class_ArrayMesh_surface_get_primitive_type: + +- :ref:`int` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const + +Return the primitive type of the requested surface (see :ref:`add_surface`). + +.. _class_ArrayMesh_surface_remove: + +- void **surface_remove** **(** :ref:`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` surf_idx, :ref:`Material` material **)** + +.. _class_ArrayMesh_surface_set_name: + +- void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** + +Set a :ref:`Material` for a given surface. Surface will be rendered using this material. + + diff --git a/classes/class_astar.rst b/classes/class_astar.rst index c291ce1ee..742d808c6 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -18,37 +18,37 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_pos **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_closest_pos_in_segment` **(** :ref:`Vector3` to_pos **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` id **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` id **)** | -+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_compute_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_estimate_cost` **(** :ref:`int` from_id, :ref:`int` to_id **)** virtual | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`are_points_connected` **(** :ref:`int` id, :ref:`int` to_id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`connect_points` **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect_points` **(** :ref:`int` id, :ref:`int` to_id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_point_id` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_closest_point` **(** :ref:`Vector3` to_pos **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_closest_pos_in_segment` **(** :ref:`Vector3` to_pos **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_id_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_point_path` **(** :ref:`int` from_id, :ref:`int` to_id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_point_pos` **(** :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` id **)** | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -65,6 +65,8 @@ Member Function Description - void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`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` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const @@ -75,7 +77,7 @@ Member Function Description .. _class_AStar_connect_points: -- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id **)** +- void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** .. _class_AStar_disconnect_points: diff --git a/classes/class_bakedlight.rst b/classes/class_bakedlight.rst deleted file mode 100644 index 62310ae8c..000000000 --- a/classes/class_bakedlight.rst +++ /dev/null @@ -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` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`bake` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`bake_lights` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`bake_radiance` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`debug_mesh_albedo` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`debug_mesh_light` **(** **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_subdiv` **(** **)** const | -+------------------------+----------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_subdiv` **(** :ref:`int` steps **)** | -+------------------------+----------------------------------------------------------------------------------------------------+ - -Signals -------- - -- **baked_light_changed** **(** **)** - -Member Variables ----------------- - -- :ref:`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` **get_cell_subdiv** **(** **)** const - -.. _class_BakedLight_set_cell_subdiv: - -- void **set_cell_subdiv** **(** :ref:`int` steps **)** - - diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index c0e99037c..503fc8f0d 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -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` 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 ---------------- diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 97723e033..96b163d65 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -19,6 +19,8 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Quat` from **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` euler **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`Basis` **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis **)** | @@ -39,6 +41,12 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`scaled` **(** :ref:`Vector3` scale **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_axis_angle` **(** :ref:`Vector3` axis, :ref:`float` angle **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rotation_euler` **(** :ref:`Vector3` euler **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scale` **(** :ref:`Vector3` scale **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tdotx` **(** :ref:`Vector3` with **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`tdoty` **(** :ref:`Vector3` with **)** | @@ -77,6 +85,12 @@ Create a rotation matrix from the given quaternion. .. _class_Basis_Basis: +- :ref:`Basis` **Basis** **(** :ref:`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` **Basis** **(** :ref:`Vector3` axis, :ref:`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` **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` **rotated** **(** :ref:`Vector3` axis, :ref:`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`. 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`. 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_Basis_set_rotation_axis_angle: + +- void **set_rotation_axis_angle** **(** :ref:`Vector3` axis, :ref:`float` angle **)** + +Changes only the rotation part of the :ref:`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` euler **)** + +Changes only the rotation part of the :ref:`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` 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` **tdotx** **(** :ref:`Vector3` with **)** diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 545cb51db..3b522be45 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -21,7 +21,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create` **(** :ref:`Vector2` size **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_from_image_alpha` **(** :ref:`Image` image **)** | +| void | :ref:`create_from_image_alpha` **(** :ref:`Object` image **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` pos **)** const | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ @@ -48,7 +48,7 @@ Member Function Description .. _class_BitMap_create_from_image_alpha: -- void **create_from_image_alpha** **(** :ref:`Image` image **)** +- void **create_from_image_alpha** **(** :ref:`Object` image **)** .. _class_BitMap_get_bit: diff --git a/classes/class_buttonarray.rst b/classes/class_buttonarray.rst deleted file mode 100644 index dc260936c..000000000 --- a/classes/class_buttonarray.rst +++ /dev/null @@ -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` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Inherited By:** :ref:`HButtonArray`, :ref:`VButtonArray` - -**Category:** Core - -Brief Description ------------------ - -Array of Buttons. - -Member Functions ----------------- - -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`String` text, :ref:`String` tooltip="" **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_icon_button` **(** :ref:`Texture` icon, :ref:`String` text="", :ref:`String` tooltip="" **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_button` **(** :ref:`int` button_idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button_icon` **(** :ref:`int` button_idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_button_text` **(** :ref:`int` button_idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_button_tooltip` **(** :ref:`int` button_idx **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hovered` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_selected` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flat` **(** **)** const | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_icon` **(** :ref:`int` button_idx, :ref:`Texture` icon **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_text` **(** :ref:`int` button_idx, :ref:`String` text **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button_tooltip` **(** :ref:`int` button_idx, :ref:`String` text **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flat` **(** :ref:`bool` enabled **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selected` **(** :ref:`int` button_idx **)** | -+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Signals -------- - -- **button_selected** **(** :ref:`int` button_idx **)** - -Member Variables ----------------- - -- :ref:`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` text, :ref:`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` icon, :ref:`String` text="", :ref:`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` button_idx **)** - -Remove the specified button in the array. - -.. _class_ButtonArray_get_button_count: - -- :ref:`int` **get_button_count** **(** **)** const - -Return the amount of buttons in the array. - -.. _class_ButtonArray_get_button_icon: - -- :ref:`Texture` **get_button_icon** **(** :ref:`int` button_idx **)** const - -Return the icon of the specified button. - -.. _class_ButtonArray_get_button_text: - -- :ref:`String` **get_button_text** **(** :ref:`int` button_idx **)** const - -Return the text of the specified button. - -.. _class_ButtonArray_get_button_tooltip: - -- :ref:`String` **get_button_tooltip** **(** :ref:`int` button_idx **)** const - -Return the tooltip of the specified button. - -.. _class_ButtonArray_get_hovered: - -- :ref:`int` **get_hovered** **(** **)** const - -Return the index of the currently hovered button in the array. - -.. _class_ButtonArray_get_selected: - -- :ref:`int` **get_selected** **(** **)** const - -Return the index of the currently selected button in the array. - -.. _class_ButtonArray_is_flat: - -- :ref:`bool` **is_flat** **(** **)** const - -.. _class_ButtonArray_set_button_icon: - -- void **set_button_icon** **(** :ref:`int` button_idx, :ref:`Texture` icon **)** - -Set the icon of the specified button. - -.. _class_ButtonArray_set_button_text: - -- void **set_button_text** **(** :ref:`int` button_idx, :ref:`String` text **)** - -Define the text of the specified button. - -.. _class_ButtonArray_set_button_tooltip: - -- void **set_button_tooltip** **(** :ref:`int` button_idx, :ref:`String` text **)** - -Define the tooltip of the specified button. - -.. _class_ButtonArray_set_flat: - -- void **set_flat** **(** :ref:`bool` enabled **)** - -.. _class_ButtonArray_set_selected: - -- void **set_selected** **(** :ref:`int` button_idx **)** - -Select a button in the array based on the given index. - - diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 6ad5091f0..6373a6464 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -65,7 +65,7 @@ Member Functions +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_pos` **(** **)** const | +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -111,7 +111,7 @@ Member Functions +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** const | +| :ref:`Object` | :ref:`make_input_local` **(** :ref:`Object` event **)** const | +----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_toplevel` **(** :ref:`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` state **)** -Set the transform state of this CanvasItem. For :ref:`Node2D`, this is an :ref:`Array` with (in order) a :ref:`Vector2` for position, a float for rotation and another :ref:`Vector2` for scale. For :ref:`Control` this is a :ref:`Rect2` with the position and size. +Set the transform state of this CanvasItem. For :ref:`Node2D`, this is an :ref:`Array` with (in order) a :ref:`Vector2` for position, a float for rotation (radians) and another :ref:`Vector2` for scale. For :ref:`Control` this is a :ref:`Rect2` with the position and size. .. _class_CanvasItem_get_canvas: @@ -316,9 +324,9 @@ Return the canvas item RID used by :ref:`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` **get_global_mouse_pos** **(** **)** const +- :ref:`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` **make_input_local** **(** :ref:`InputEvent` event **)** const - -Takes a global input event and convert to this item's coordinate system. +- :ref:`Object` **make_input_local** **(** :ref:`Object` event **)** const .. _class_CanvasItem_set_as_toplevel: diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 85e6008b0..9f6ddd408 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -88,13 +88,13 @@ Return the base offset for this layer (helper). - :ref:`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` **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` 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` degrees **)** -Set rotation of the layer in degree. +Set the base rotation for this layer in degrees (helper). .. _class_CanvasLayer_set_scale: diff --git a/classes/class_capsulemesh.rst b/classes/class_capsulemesh.rst new file mode 100644 index 000000000..43c7985d4 --- /dev/null +++ b/classes/class_capsulemesh.rst @@ -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` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mid_height` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rings` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mid_height` **(** :ref:`float` mid_height **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_segments` **(** :ref:`int` segments **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` radius **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rings` **(** :ref:`int` rings **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **mid_height** +- :ref:`int` **radial_segments** +- :ref:`float` **radius** +- :ref:`int` **rings** + +Member Function Description +--------------------------- + +.. _class_CapsuleMesh_get_mid_height: + +- :ref:`float` **get_mid_height** **(** **)** const + +.. _class_CapsuleMesh_get_radial_segments: + +- :ref:`int` **get_radial_segments** **(** **)** const + +.. _class_CapsuleMesh_get_radius: + +- :ref:`float` **get_radius** **(** **)** const + +.. _class_CapsuleMesh_get_rings: + +- :ref:`int` **get_rings** **(** **)** const + +.. _class_CapsuleMesh_set_mid_height: + +- void **set_mid_height** **(** :ref:`float` mid_height **)** + +.. _class_CapsuleMesh_set_radial_segments: + +- void **set_radial_segments** **(** :ref:`int` segments **)** + +.. _class_CapsuleMesh_set_radius: + +- void **set_radius** **(** :ref:`float` radius **)** + +.. _class_CapsuleMesh_set_rings: + +- void **set_rings** **(** :ref:`int` rings **)** + + diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index ce607bd2f..369e4d060 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -31,6 +31,8 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`class_get_method_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`class_get_property` **(** :ref:`Object` object, :ref:`String` property **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`class_get_property_list` **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`class_get_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | @@ -43,6 +45,8 @@ Member Functions +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`class_has_signal` **(** :ref:`String` class, :ref:`String` signal **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Error | :ref:`class_set_property` **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_class_list` **(** **)** const | +------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_inheriters_from_class` **(** :ref:`String` class **)** const | @@ -83,6 +87,10 @@ Member Function Description - :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const +.. _class_ClassDB_class_get_property: + +- :ref:`Variant` **class_get_property** **(** :ref:`Object` object, :ref:`String` property **)** const + .. _class_ClassDB_class_get_property_list: - :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const @@ -107,6 +115,10 @@ Member Function Description - :ref:`bool` **class_has_signal** **(** :ref:`String` class, :ref:`String` signal **)** const +.. _class_ClassDB_class_set_property: + +- Error **class_set_property** **(** :ref:`Object` object, :ref:`String` property, :ref:`Variant` value **)** const + .. _class_ClassDB_get_class_list: - :ref:`PoolStringArray` **get_class_list** **(** **)** const diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 45c57b451..be18e7d2a 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -57,7 +57,7 @@ Member Functions Signals ------- -- **input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** +- **input_event** **(** :ref:`Object` camera, :ref:`Object` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** - **mouse_entered** **(** **)** - **mouse_exited** **(** **)** diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index b96dcb15f..4266b7122 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -53,9 +53,13 @@ Member Functions Signals ------- -- **input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** +- **input_event** **(** :ref:`Object` viewport, :ref:`Object` event, :ref:`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` viewport, :ref:`InputEvent` event, :ref:`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` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 1f8e6413e..410550f92 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -38,6 +38,8 @@ Signals ------- - **color_changed** **(** :ref:`Color` color **)** +Emitted when the color is changed. + Description ----------- diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 6f6334aee..e165e99e9 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -34,6 +34,8 @@ Signals ------- - **color_changed** **(** :ref:`Color` color **)** +Emitted when the color is changed. + Member Variables ---------------- diff --git a/classes/class_container.rst b/classes/class_container.rst index d4a8a59ad..9ed540849 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -8,7 +8,7 @@ Container **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer` +**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`CenterContainer`, :ref:`MarginContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer` **Category:** Core @@ -30,6 +30,8 @@ Signals ------- - **sort_children** **(** **)** +Emitted when sorting the children is needed. + Numeric Constants ----------------- diff --git a/classes/class_control.rst b/classes/class_control.rst index 0e534b9eb..2842dfcfb 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -8,7 +8,7 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`ButtonArray`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` +**Inherited By:** :ref:`TextureRect`, :ref:`ColorRect`, :ref:`Label`, :ref:`Tabs`, :ref:`GraphEdit`, :ref:`VideoPlayer`, :ref:`NinePatchRect`, :ref:`LineEdit`, :ref:`Container`, :ref:`TextEdit`, :ref:`BaseButton`, :ref:`Popup`, :ref:`Tree`, :ref:`Separator`, :ref:`ReferenceRect`, :ref:`Panel`, :ref:`TabContainer`, :ref:`Range`, :ref:`RichTextLabel`, :ref:`ItemList` **Category:** Core @@ -73,7 +73,7 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Font` | :ref:`get_font` **(** :ref:`String` name, :ref:`String` type="" **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_pos` **(** **)** const | +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,7 +91,7 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_parent_control` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_pos` **(** **)** const | +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_rect` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -171,7 +171,7 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_focus_neighbour` **(** :ref:`int` margin, :ref:`NodePath` neighbour **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_global_pos` **(** :ref:`Vector2` pos **)** | +| void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -179,7 +179,7 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pos` **(** :ref:`Vector2` pos **)** | +| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`float` radians **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -206,14 +206,28 @@ Signals ------- - **focus_entered** **(** **)** +Emitted when keyboard focus is gained. + - **focus_exited** **(** **)** -- **gui_input** **(** :ref:`InputEvent` ev **)** +Emitted when the keyboard focus is lost. + +- **gui_input** **(** :ref:`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` **mouse_filter** - :ref:`bool` **rect_clip_content** - :ref:`Vector2` **rect_min_size** -- :ref:`Vector2` **rect_pos** +- :ref:`Vector2` **rect_position** - :ref:`float` **rect_rotation** - :ref:`Vector2` **rect_scale** - :ref:`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`) are first sent to the root controls via the :ref:`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`. 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`), the control can accept it by calling :ref:`accept_event`. +Input device events are first sent to the root controls via the :ref:`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`. 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`), the control can accept it by calling :ref:`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`. 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` 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` **get_font** **(** :ref:`String` name, :ref:`String` type="" **)** const -.. _class_Control_get_global_pos: +.. _class_Control_get_global_position: -- :ref:`Vector2` **get_global_pos** **(** **)** const +- :ref:`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` **get_parent_control** **(** **)** const -.. _class_Control_get_pos: +.. _class_Control_get_position: -- :ref:`Vector2` **get_pos** **(** **)** const +- :ref:`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` **get_rotation** **(** **)** const +Return the rotation (in radians) + .. _class_Control_get_rotation_deg: - :ref:`float` **get_rotation_deg** **(** **)** const +Return the rotation (in degrees) + .. _class_Control_get_scale: - :ref:`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` pos **)** +- void **set_global_position** **(** :ref:`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`). @@ -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` pos **)** +- void **set_position** **(** :ref:`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`). @@ -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` radians **)** +Set the rotation (in radians). + .. _class_Control_set_rotation_deg: - void **set_rotation_deg** **(** :ref:`float` degrees **)** +Set the rotation (in degrees). + .. _class_Control_set_scale: - void **set_scale** **(** :ref:`Vector2` scale **)** diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index de1dfb955..f199032ce 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -18,27 +18,27 @@ Brief Description Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_flags` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_side` **(** :ref:`int` side **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_storage` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flags` **(** :ref:`int` flags **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_side` **(** :ref:`int` side, :ref:`Image` image **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_storage` **(** :ref:`int` mode **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_flags` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lossy_storage_quality` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_side` **(** :ref:`int` side **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_storage` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flags` **(** :ref:`int` flags **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_side` **(** :ref:`int` side, :ref:`Object` image **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_storage` **(** :ref:`int` mode **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -74,7 +74,7 @@ Member Function Description .. _class_CubeMap_get_side: -- :ref:`Image` **get_side** **(** :ref:`int` side **)** const +- :ref:`Object` **get_side** **(** :ref:`int` side **)** const .. _class_CubeMap_get_storage: @@ -94,7 +94,7 @@ Member Function Description .. _class_CubeMap_set_side: -- void **set_side** **(** :ref:`int` side, :ref:`Image` image **)** +- void **set_side** **(** :ref:`int` side, :ref:`Object` image **)** .. _class_CubeMap_set_storage: diff --git a/classes/class_cubemesh.rst b/classes/class_cubemesh.rst new file mode 100644 index 000000000..6da3d40f8 --- /dev/null +++ b/classes/class_cubemesh.rst @@ -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` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_height` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector3` size **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_depth` **(** :ref:`int` divisions **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_height` **(** :ref:`int` divisions **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_width` **(** :ref:`int` subdivide **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Vector2` **size** +- :ref:`int` **subdivide_depth** +- :ref:`int` **subdivide_height** +- :ref:`int` **subdivide_width** + +Member Function Description +--------------------------- + +.. _class_CubeMesh_get_size: + +- :ref:`Vector3` **get_size** **(** **)** const + +.. _class_CubeMesh_get_subdivide_depth: + +- :ref:`int` **get_subdivide_depth** **(** **)** const + +.. _class_CubeMesh_get_subdivide_height: + +- :ref:`int` **get_subdivide_height** **(** **)** const + +.. _class_CubeMesh_get_subdivide_width: + +- :ref:`int` **get_subdivide_width** **(** **)** const + +.. _class_CubeMesh_set_size: + +- void **set_size** **(** :ref:`Vector3` size **)** + +.. _class_CubeMesh_set_subdivide_depth: + +- void **set_subdivide_depth** **(** :ref:`int` divisions **)** + +.. _class_CubeMesh_set_subdivide_height: + +- void **set_subdivide_height** **(** :ref:`int` divisions **)** + +.. _class_CubeMesh_set_subdivide_width: + +- void **set_subdivide_width** **(** :ref:`int` subdivide **)** + + diff --git a/classes/class_cylindermesh.rst b/classes/class_cylindermesh.rst new file mode 100644 index 000000000..68edcb3e0 --- /dev/null +++ b/classes/class_cylindermesh.rst @@ -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` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bottom_radius` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rings` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_top_radius` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bottom_radius` **(** :ref:`float` radius **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` height **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_segments` **(** :ref:`int` segments **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rings` **(** :ref:`int` rings **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_top_radius` **(** :ref:`float` radius **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **bottom_radius** +- :ref:`float` **height** +- :ref:`int` **radial_segments** +- :ref:`int` **rings** +- :ref:`float` **top_radius** + +Member Function Description +--------------------------- + +.. _class_CylinderMesh_get_bottom_radius: + +- :ref:`float` **get_bottom_radius** **(** **)** const + +.. _class_CylinderMesh_get_height: + +- :ref:`float` **get_height** **(** **)** const + +.. _class_CylinderMesh_get_radial_segments: + +- :ref:`int` **get_radial_segments** **(** **)** const + +.. _class_CylinderMesh_get_rings: + +- :ref:`int` **get_rings** **(** **)** const + +.. _class_CylinderMesh_get_top_radius: + +- :ref:`float` **get_top_radius** **(** **)** const + +.. _class_CylinderMesh_set_bottom_radius: + +- void **set_bottom_radius** **(** :ref:`float` radius **)** + +.. _class_CylinderMesh_set_height: + +- void **set_height** **(** :ref:`float` height **)** + +.. _class_CylinderMesh_set_radial_segments: + +- void **set_radial_segments** **(** :ref:`int` segments **)** + +.. _class_CylinderMesh_set_rings: + +- void **set_rings** **(** :ref:`int` rings **)** + +.. _class_CylinderMesh_set_top_radius: + +- void **set_top_radius** **(** :ref:`float` radius **)** + + diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index 91b585790..dedeb22b8 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -31,7 +31,6 @@ Member Functions Member Variables ---------------- -- :ref:`float` **directional_shadow_bias_split_scale** - :ref:`bool` **directional_shadow_blend_splits** - :ref:`int` **directional_shadow_mode** - :ref:`float` **directional_shadow_normal_bias** diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 5101e73a5..829fbcbc2 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -40,7 +40,11 @@ Signals ------- - **filesystem_changed** **(** **)** +Emitted if the filesystem changed. + - **sources_changed** **(** :ref:`bool` exist **)** +Emitted if the source of any imported file changed. + Description ----------- diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst new file mode 100644 index 000000000..d8be7fd92 --- /dev/null +++ b/classes/class_editorimportplugin.rst @@ -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` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_preset_count` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_save_extension` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_EditorImportPlugin_get_import_options: + +- :ref:`Array` **get_import_options** **(** :ref:`int` preset **)** virtual + +.. _class_EditorImportPlugin_get_importer_name: + +- :ref:`String` **get_importer_name** **(** **)** virtual + +.. _class_EditorImportPlugin_get_option_visibility: + +- :ref:`bool` **get_option_visibility** **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual + +.. _class_EditorImportPlugin_get_preset_count: + +- :ref:`int` **get_preset_count** **(** **)** virtual + +.. _class_EditorImportPlugin_get_preset_name: + +- :ref:`String` **get_preset_name** **(** :ref:`int` preset **)** virtual + +.. _class_EditorImportPlugin_get_recognized_extensions: + +- :ref:`Array` **get_recognized_extensions** **(** **)** virtual + +.. _class_EditorImportPlugin_get_resource_type: + +- :ref:`String` **get_resource_type** **(** **)** virtual + +.. _class_EditorImportPlugin_get_save_extension: + +- :ref:`String` **get_save_extension** **(** **)** virtual + +.. _class_EditorImportPlugin_get_visible_name: + +- :ref:`String` **get_visible_name** **(** **)** virtual + +.. _class_EditorImportPlugin_import: + +- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual + + diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index af8272881..b6f499337 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -27,6 +27,8 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture` icon **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_import_plugin` **(** :ref:`Object` arg0 **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_tool_submenu_item` **(** :ref:`String` name, :ref:`PopupMenu` submenu **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`apply_changes` **(** **)** virtual | @@ -87,6 +89,8 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_import_plugin` **(** :ref:`Object` arg0 **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`save_external_data` **(** **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | @@ -162,6 +166,10 @@ You can use the :ref:`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` arg0 **)** + .. _class_EditorPlugin_add_tool_submenu_item: - void **add_tool_submenu_item** **(** :ref:`String` name, :ref:`PopupMenu` submenu **)** @@ -200,8 +208,6 @@ This function is used for plugins that edit specific object types (nodes or reso - :ref:`bool` **forward_canvas_gui_input** **(** :ref:`Transform2D` canvas_xform, :ref:`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` canvas_xform, :ref:`Control` canvas **)** virtual @@ -212,12 +218,6 @@ This function is called every time the 2D canvas editor draws (which overlays ov - :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`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` and the :ref:`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` **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_remove_import_plugin: + +- void **remove_import_plugin** **(** :ref:`Object` arg0 **)** + .. _class_EditorPlugin_save_external_data: - void **save_external_data** **(** **)** virtual diff --git a/classes/class_editorresourcepreview.rst b/classes/class_editorresourcepreview.rst index 26e89ad3c..24cf88f1c 100644 --- a/classes/class_editorresourcepreview.rst +++ b/classes/class_editorresourcepreview.rst @@ -34,6 +34,8 @@ Signals ------- - **preview_invalidated** **(** :ref:`String` path **)** +If a preview was invalidated (changed) this signal will emit (using the path of the preview) + Description ----------- diff --git a/classes/class_editorselection.rst b/classes/class_editorselection.rst index 07f7e6c7e..461211a0c 100644 --- a/classes/class_editorselection.rst +++ b/classes/class_editorselection.rst @@ -34,6 +34,8 @@ Signals ------- - **selection_changed** **(** **)** +Emitted when the selection changes. + Description ----------- diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index b54913426..1140a51ec 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -27,7 +27,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_lines` **(** :ref:`PoolVector3Array` lines, :ref:`Material` material, :ref:`bool` billboard=false **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_mesh` **(** :ref:`Mesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=RID() **)** | +| void | :ref:`add_mesh` **(** :ref:`Mesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=[RID] **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_unscaled_billboard` **(** :ref:`Material` material, :ref:`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` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=RID() **)** +- void **add_mesh** **(** :ref:`Mesh` mesh, :ref:`bool` billboard=false, :ref:`RID` skeleton=[RID] **)** Add a mesh to the gizmo, this is used for visualization. Call this function during :ref:`redraw`. diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 11ca1df58..d37769d60 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -35,6 +35,8 @@ Member Functions +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_version_info` **(** **)** const | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_fixed_frame` **(** **)** const | ++--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_iterations_per_second` **(** :ref:`int` iterations_per_second **)** | +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_target_fps` **(** :ref:`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` **is_in_fixed_frame** **(** **)** const + .. _class_Engine_set_iterations_per_second: - void **set_iterations_per_second** **(** :ref:`int` iterations_per_second **)** diff --git a/classes/class_environment.rst b/classes/class_environment.rst index c571a8a56..f60ea329c 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -31,7 +31,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ambient_light_energy` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ambient_light_skybox_contribution` **(** **)** const | +| :ref:`float` | :ref:`get_ambient_light_sky_contribution` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_background` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,6 +57,24 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_dof_blur_near_transition` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_fog_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_depth_begin` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_depth_curve` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_curve` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_max` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_height_min` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_sun_amount` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_fog_sun_color` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fog_transmit_curve` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_glow_blend_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_bloom` **(** **)** const | @@ -69,9 +87,9 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_strength` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CubeMap` | :ref:`get_skybox` **(** **)** const | +| :ref:`CubeMap` | :ref:`get_sky` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_skybox_scale` **(** **)** const | +| :ref:`float` | :ref:`get_sky_scale` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssao_bias` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -87,11 +105,11 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssao_radius2` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_accel` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssr_depth_tolerance` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_ssr_fade` **(** **)** const | +| :ref:`float` | :ref:`get_ssr_fade_in` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ssr_fade_out` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_ssr_max_steps` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -117,6 +135,14 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_dof_blur_near_enabled` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_depth_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_height_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_fog_transmit_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_glow_bicubic_upscale_enabled` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_glow_enabled` **(** **)** const | @@ -131,8 +157,6 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ssr_rough` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_ssr_smooth` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_adjustment_brightness` **(** :ref:`float` brightness **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_adjustment_color_correction` **(** :ref:`Object` color_correction **)** | @@ -147,7 +171,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ambient_light_energy` **(** :ref:`float` energy **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ambient_light_skybox_contribution` **(** :ref:`float` energy **)** | +| void | :ref:`set_ambient_light_sky_contribution` **(** :ref:`float` energy **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_background` **(** :ref:`int` mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -177,6 +201,32 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_near_transition` **(** :ref:`float` intensity **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_begin` **(** :ref:`float` distance **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_curve` **(** :ref:`float` curve **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_depth_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_curve` **(** :ref:`float` curve **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_max` **(** :ref:`float` height **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_height_min` **(** :ref:`float` height **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_sun_amount` **(** :ref:`float` amount **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_sun_color` **(** :ref:`Color` color **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_transmit_curve` **(** :ref:`float` curve **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fog_transmit_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_bicubic_upscale` **(** :ref:`bool` enabled **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_blend_mode` **(** :ref:`int` mode **)** | @@ -195,9 +245,9 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_skybox` **(** :ref:`CubeMap` skybox **)** | +| void | :ref:`set_sky` **(** :ref:`CubeMap` sky **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_skybox_scale` **(** :ref:`float` scale **)** | +| void | :ref:`set_sky_scale` **(** :ref:`float` scale **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_bias` **(** :ref:`float` bias **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -217,20 +267,18 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_radius2` **(** :ref:`float` radius **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_accel` **(** :ref:`float` accel **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_depth_tolerance` **(** :ref:`float` depth_tolerance **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_fade` **(** :ref:`float` fade **)** | +| void | :ref:`set_ssr_fade_in` **(** :ref:`float` fade_in **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ssr_fade_out` **(** :ref:`float` fade_out **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_max_steps` **(** :ref:`int` max_steps **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_rough` **(** :ref:`bool` rough **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_ssr_smooth` **(** :ref:`bool` smooth **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_auto_exposure` **(** :ref:`bool` auto_exposure **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_auto_exposure_grey` **(** :ref:`float` exposure_grey **)** | @@ -258,18 +306,18 @@ Member Variables - :ref:`float` **adjustment_saturation** - :ref:`Color` **ambient_light_color** - :ref:`float` **ambient_light_energy** -- :ref:`float` **ambient_light_skybox_contribution** -- :ref:`bool` **auto_expoure_enabled** -- :ref:`float` **auto_expoure_max_luma** -- :ref:`float` **auto_expoure_min_luma** -- :ref:`float` **auto_expoure_scale** -- :ref:`float` **auto_expoure_speed** +- :ref:`float` **ambient_light_sky_contribution** +- :ref:`bool` **auto_exposure_enabled** +- :ref:`float` **auto_exposure_max_luma** +- :ref:`float` **auto_exposure_min_luma** +- :ref:`float` **auto_exposure_scale** +- :ref:`float` **auto_exposure_speed** - :ref:`int` **background_canvas_max_layer** - :ref:`Color` **background_color** - :ref:`float` **background_energy** - :ref:`int` **background_mode** -- :ref:`SkyBox` **background_skybox** -- :ref:`float` **background_skybox_scale** +- :ref:`Sky` **background_sky** +- :ref:`float` **background_sky_scale** - :ref:`float` **dof_blur_far_amount** - :ref:`float` **dof_blur_far_distance** - :ref:`bool` **dof_blur_far_enabled** @@ -280,6 +328,19 @@ Member Variables - :ref:`bool` **dof_blur_near_enabled** - :ref:`int` **dof_blur_near_quality** - :ref:`float` **dof_blur_near_transition** +- :ref:`Color` **fog_color** +- :ref:`float` **fog_depth_begin** +- :ref:`float` **fog_depth_curve** +- :ref:`bool` **fog_depth_enabled** +- :ref:`bool` **fog_enabled** +- :ref:`float` **fog_height_curve** +- :ref:`bool` **fog_height_enabled** +- :ref:`float` **fog_height_max** +- :ref:`float` **fog_height_min** +- :ref:`float` **fog_sun_amount** +- :ref:`Color` **fog_sun_color** +- :ref:`float` **fog_transmit_curve** +- :ref:`bool` **fog_transmit_enabled** - :ref:`bool` **glow_bicubic_upscale** - :ref:`int` **glow_blend_mode** - :ref:`float` **glow_bloom** @@ -295,11 +356,10 @@ Member Variables - :ref:`bool` **glow_levels/6** - :ref:`bool` **glow_levels/7** - :ref:`float` **glow_strength** -- :ref:`float` **ss_reflections_accel** -- :ref:`bool` **ss_reflections_accel_smooth** - :ref:`float` **ss_reflections_depth_tolerance** - :ref:`bool` **ss_reflections_enabled** -- :ref:`float` **ss_reflections_fade** +- :ref:`float` **ss_reflections_fade_in** +- :ref:`float` **ss_reflections_fade_out** - :ref:`int` **ss_reflections_max_steps** - :ref:`bool` **ss_reflections_roughness** - :ref:`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` **get_ambient_light_energy** **(** **)** const -.. _class_Environment_get_ambient_light_skybox_contribution: +.. _class_Environment_get_ambient_light_sky_contribution: -- :ref:`float` **get_ambient_light_skybox_contribution** **(** **)** const +- :ref:`float` **get_ambient_light_sky_contribution** **(** **)** const .. _class_Environment_get_background: @@ -415,6 +475,42 @@ Member Function Description - :ref:`float` **get_dof_blur_near_transition** **(** **)** const +.. _class_Environment_get_fog_color: + +- :ref:`Color` **get_fog_color** **(** **)** const + +.. _class_Environment_get_fog_depth_begin: + +- :ref:`float` **get_fog_depth_begin** **(** **)** const + +.. _class_Environment_get_fog_depth_curve: + +- :ref:`float` **get_fog_depth_curve** **(** **)** const + +.. _class_Environment_get_fog_height_curve: + +- :ref:`float` **get_fog_height_curve** **(** **)** const + +.. _class_Environment_get_fog_height_max: + +- :ref:`float` **get_fog_height_max** **(** **)** const + +.. _class_Environment_get_fog_height_min: + +- :ref:`float` **get_fog_height_min** **(** **)** const + +.. _class_Environment_get_fog_sun_amount: + +- :ref:`float` **get_fog_sun_amount** **(** **)** const + +.. _class_Environment_get_fog_sun_color: + +- :ref:`Color` **get_fog_sun_color** **(** **)** const + +.. _class_Environment_get_fog_transmit_curve: + +- :ref:`float` **get_fog_transmit_curve** **(** **)** const + .. _class_Environment_get_glow_blend_mode: - :ref:`int` **get_glow_blend_mode** **(** **)** const @@ -439,13 +535,13 @@ Member Function Description - :ref:`float` **get_glow_strength** **(** **)** const -.. _class_Environment_get_skybox: +.. _class_Environment_get_sky: -- :ref:`CubeMap` **get_skybox** **(** **)** const +- :ref:`CubeMap` **get_sky** **(** **)** const -.. _class_Environment_get_skybox_scale: +.. _class_Environment_get_sky_scale: -- :ref:`float` **get_skybox_scale** **(** **)** const +- :ref:`float` **get_sky_scale** **(** **)** const .. _class_Environment_get_ssao_bias: @@ -475,17 +571,17 @@ Member Function Description - :ref:`float` **get_ssao_radius2** **(** **)** const -.. _class_Environment_get_ssr_accel: - -- :ref:`float` **get_ssr_accel** **(** **)** const - .. _class_Environment_get_ssr_depth_tolerance: - :ref:`float` **get_ssr_depth_tolerance** **(** **)** const -.. _class_Environment_get_ssr_fade: +.. _class_Environment_get_ssr_fade_in: -- :ref:`float` **get_ssr_fade** **(** **)** const +- :ref:`float` **get_ssr_fade_in** **(** **)** const + +.. _class_Environment_get_ssr_fade_out: + +- :ref:`float` **get_ssr_fade_out** **(** **)** const .. _class_Environment_get_ssr_max_steps: @@ -535,6 +631,22 @@ Member Function Description - :ref:`bool` **is_dof_blur_near_enabled** **(** **)** const +.. _class_Environment_is_fog_depth_enabled: + +- :ref:`bool` **is_fog_depth_enabled** **(** **)** const + +.. _class_Environment_is_fog_enabled: + +- :ref:`bool` **is_fog_enabled** **(** **)** const + +.. _class_Environment_is_fog_height_enabled: + +- :ref:`bool` **is_fog_height_enabled** **(** **)** const + +.. _class_Environment_is_fog_transmit_enabled: + +- :ref:`bool` **is_fog_transmit_enabled** **(** **)** const + .. _class_Environment_is_glow_bicubic_upscale_enabled: - :ref:`bool` **is_glow_bicubic_upscale_enabled** **(** **)** const @@ -563,10 +675,6 @@ Member Function Description - :ref:`bool` **is_ssr_rough** **(** **)** const -.. _class_Environment_is_ssr_smooth: - -- :ref:`bool` **is_ssr_smooth** **(** **)** const - .. _class_Environment_set_adjustment_brightness: - void **set_adjustment_brightness** **(** :ref:`float` brightness **)** @@ -595,9 +703,9 @@ Member Function Description - void **set_ambient_light_energy** **(** :ref:`float` energy **)** -.. _class_Environment_set_ambient_light_skybox_contribution: +.. _class_Environment_set_ambient_light_sky_contribution: -- void **set_ambient_light_skybox_contribution** **(** :ref:`float` energy **)** +- void **set_ambient_light_sky_contribution** **(** :ref:`float` energy **)** .. _class_Environment_set_background: @@ -655,6 +763,58 @@ Member Function Description - void **set_dof_blur_near_transition** **(** :ref:`float` intensity **)** +.. _class_Environment_set_fog_color: + +- void **set_fog_color** **(** :ref:`Color` color **)** + +.. _class_Environment_set_fog_depth_begin: + +- void **set_fog_depth_begin** **(** :ref:`float` distance **)** + +.. _class_Environment_set_fog_depth_curve: + +- void **set_fog_depth_curve** **(** :ref:`float` curve **)** + +.. _class_Environment_set_fog_depth_enabled: + +- void **set_fog_depth_enabled** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_fog_enabled: + +- void **set_fog_enabled** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_fog_height_curve: + +- void **set_fog_height_curve** **(** :ref:`float` curve **)** + +.. _class_Environment_set_fog_height_enabled: + +- void **set_fog_height_enabled** **(** :ref:`bool` enabled **)** + +.. _class_Environment_set_fog_height_max: + +- void **set_fog_height_max** **(** :ref:`float` height **)** + +.. _class_Environment_set_fog_height_min: + +- void **set_fog_height_min** **(** :ref:`float` height **)** + +.. _class_Environment_set_fog_sun_amount: + +- void **set_fog_sun_amount** **(** :ref:`float` amount **)** + +.. _class_Environment_set_fog_sun_color: + +- void **set_fog_sun_color** **(** :ref:`Color` color **)** + +.. _class_Environment_set_fog_transmit_curve: + +- void **set_fog_transmit_curve** **(** :ref:`float` curve **)** + +.. _class_Environment_set_fog_transmit_enabled: + +- void **set_fog_transmit_enabled** **(** :ref:`bool` enabled **)** + .. _class_Environment_set_glow_bicubic_upscale: - void **set_glow_bicubic_upscale** **(** :ref:`bool` enabled **)** @@ -691,13 +851,13 @@ Member Function Description - void **set_glow_strength** **(** :ref:`float` strength **)** -.. _class_Environment_set_skybox: +.. _class_Environment_set_sky: -- void **set_skybox** **(** :ref:`CubeMap` skybox **)** +- void **set_sky** **(** :ref:`CubeMap` sky **)** -.. _class_Environment_set_skybox_scale: +.. _class_Environment_set_sky_scale: -- void **set_skybox_scale** **(** :ref:`float` scale **)** +- void **set_sky_scale** **(** :ref:`float` scale **)** .. _class_Environment_set_ssao_bias: @@ -735,10 +895,6 @@ Member Function Description - void **set_ssao_radius2** **(** :ref:`float` radius **)** -.. _class_Environment_set_ssr_accel: - -- void **set_ssr_accel** **(** :ref:`float` accel **)** - .. _class_Environment_set_ssr_depth_tolerance: - void **set_ssr_depth_tolerance** **(** :ref:`float` depth_tolerance **)** @@ -747,9 +903,13 @@ Member Function Description - void **set_ssr_enabled** **(** :ref:`bool` enabled **)** -.. _class_Environment_set_ssr_fade: +.. _class_Environment_set_ssr_fade_in: -- void **set_ssr_fade** **(** :ref:`float` fade **)** +- void **set_ssr_fade_in** **(** :ref:`float` fade_in **)** + +.. _class_Environment_set_ssr_fade_out: + +- void **set_ssr_fade_out** **(** :ref:`float` fade_out **)** .. _class_Environment_set_ssr_max_steps: @@ -759,10 +919,6 @@ Member Function Description - void **set_ssr_rough** **(** :ref:`bool` rough **)** -.. _class_Environment_set_ssr_smooth: - -- void **set_ssr_smooth** **(** :ref:`bool` smooth **)** - .. _class_Environment_set_tonemap_auto_exposure: - void **set_tonemap_auto_exposure** **(** :ref:`bool` auto_exposure **)** diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 5bef340b7..820d1eefe 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -60,8 +60,14 @@ Signals ------- - **dir_selected** **(** :ref:`String` dir **)** +Event emitted when the user selects a directory. + - **file_selected** **(** :ref:`String` path **)** +Event emitted when the user selects a file (double clicks it or presses the OK button). + - **files_selected** **(** :ref:`PoolStringArray` paths **)** +Event emitted when the user selects multiple files. + Member Variables ---------------- diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index 6eee7fb0e..7a006aec2 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -18,11 +18,11 @@ State of a function call after yielding. Member Functions ---------------- -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=NULL **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** :ref:`bool` extended_check=false **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=NULL **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -34,10 +34,12 @@ Member Function Description .. _class_GDFunctionState_is_valid: -- :ref:`bool` **is_valid** **(** **)** const +- :ref:`bool` **is_valid** **(** :ref:`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`, 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` **resume** **(** :ref:`Variant` arg=NULL **)** diff --git a/classes/class_dllibrary.rst b/classes/class_gdnativelibrary.rst similarity index 59% rename from classes/class_dllibrary.rst rename to classes/class_gdnativelibrary.rst index 3c67df013..65abfb562 100644 --- a/classes/class_dllibrary.rst +++ b/classes/class_gdnativelibrary.rst @@ -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` **<** :ref:`Reference` **<** :ref:`Object` @@ -18,20 +18,20 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_platform_file` **(** :ref:`String` platform **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_platform_file` **(** :ref:`String` platform, :ref:`String` file **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_platform_file` **(** :ref:`String` platform **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_platform_file` **(** :ref:`String` platform, :ref:`String` file **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- -.. _class_DLLibrary_get_platform_file: +.. _class_GDNativeLibrary_get_platform_file: - :ref:`String` **get_platform_file** **(** :ref:`String` platform **)** const -.. _class_DLLibrary_set_platform_file: +.. _class_GDNativeLibrary_set_platform_file: - void **set_platform_file** **(** :ref:`String` platform, :ref:`String` file **)** diff --git a/classes/class_dlscript.rst b/classes/class_gdnativescript.rst similarity index 51% rename from classes/class_dlscript.rst rename to classes/class_gdnativescript.rst index fb3e6bd1f..71dd42eca 100644 --- a/classes/class_dlscript.rst +++ b/classes/class_gdnativescript.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` @@ -18,38 +18,44 @@ Brief Description Member Functions ---------------- -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_library` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_script_name` **(** **)** const | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_library` **(** :ref:`Object` library **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script_name` **(** :ref:`String` script_name **)** | -+------------------------------+--------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_library` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_script_name` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_library` **(** :ref:`Object` library **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script_name` **(** :ref:`String` script_name **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`DLLibrary` **library** +- :ref:`GDNativeLibrary` **library** - :ref:`String` **script_name** Member Function Description --------------------------- -.. _class_DLScript_get_library: +.. _class_GDNativeScript_get_library: - :ref:`Object` **get_library** **(** **)** const -.. _class_DLScript_get_script_name: +.. _class_GDNativeScript_get_script_name: - :ref:`String` **get_script_name** **(** **)** const -.. _class_DLScript_set_library: +.. _class_GDNativeScript_new: + +- :ref:`Object` **new** **(** **)** vararg + +.. _class_GDNativeScript_set_library: - void **set_library** **(** :ref:`Object` library **)** -.. _class_DLScript_set_script_name: +.. _class_GDNativeScript_set_script_name: - void **set_script_name** **(** :ref:`String` script_name **)** diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 6963e4973..2467469ef 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -8,7 +8,7 @@ GeometryInstance **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`MultiMeshInstance`, :ref:`SpriteBase3D`, :ref:`MeshInstance`, :ref:`Particles`, :ref:`Quad`, :ref:`TestCube`, :ref:`ImmediateGeometry` +**Inherited By:** :ref:`MultiMeshInstance`, :ref:`SpriteBase3D`, :ref:`MeshInstance`, :ref:`Particles`, :ref:`ImmediateGeometry` **Category:** Core diff --git a/classes/class_globalconfig.rst b/classes/class_globalconfig.rst index 33bb62d50..e25d3b39d 100644 --- a/classes/class_globalconfig.rst +++ b/classes/class_globalconfig.rst @@ -53,7 +53,7 @@ Member Functions Description ----------- -Contains global variables accessible from everywhere. Use the normal :ref:`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` 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 --------------------------- diff --git a/classes/class_colorramp.rst b/classes/class_gradient.rst similarity index 69% rename from classes/class_colorramp.rst rename to classes/class_gradient.rst index 067bc4e97..79cc02612 100644 --- a/classes/class_colorramp.rst +++ b/classes/class_gradient.rst @@ -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` **<** :ref:`Reference` **<** :ref:`Object` @@ -18,31 +18,31 @@ Color interpolator node Member Functions ---------------- -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_colors` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_offsets` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` offset **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_colors` **(** :ref:`PoolColorArray` colors **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offsets` **(** :ref:`PoolRealArray` offsets **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`get_colors` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`get_offsets` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_count` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` offset **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_colors` **(** :ref:`PoolColorArray` colors **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offsets` **(** :ref:`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` offset, :ref:`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` **get_color** **(** :ref:`int` point **)** const Returns the color of the ramp color at index *point* -.. _class_ColorRamp_get_colors: +.. _class_Gradient_get_colors: - :ref:`PoolColorArray` **get_colors** **(** **)** const Returns the colors in the ramp -.. _class_ColorRamp_get_offset: +.. _class_Gradient_get_offset: - :ref:`float` **get_offset** **(** :ref:`int` point **)** const Returns the offset of the ramp color at index *point* -.. _class_ColorRamp_get_offsets: +.. _class_Gradient_get_offsets: - :ref:`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` **get_point_count** **(** **)** const Returns the number of colors in the ramp -.. _class_ColorRamp_interpolate: +.. _class_Gradient_interpolate: - :ref:`Color` **interpolate** **(** :ref:`float` offset **)** Returns the interpolated color specified by *offset* -.. _class_ColorRamp_remove_point: +.. _class_Gradient_remove_point: - void **remove_point** **(** :ref:`int` offset **)** Removes the color at the index *offset* -.. _class_ColorRamp_set_color: +.. _class_Gradient_set_color: - void **set_color** **(** :ref:`int` point, :ref:`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` 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` point, :ref:`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` offsets **)** diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 54d2c89c9..8d54bcdc5 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -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` from, :ref:`int` from_slot, :ref:`String` to, :ref:`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` from, :ref:`int` from_slot, :ref:`Vector2` release_pos **)** - **delete_nodes_request** **(** **)** +Signal sent when a GraphNode is attempted to be removed from the GraphEdit. + - **disconnection_request** **(** :ref:`String` from, :ref:`int` from_slot, :ref:`String` to, :ref:`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` node **)** - **popup_request** **(** :ref:`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` ofs **)** Description diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index cd2b936d9..800bad917 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -86,9 +86,17 @@ Signals ------- - **close_request** **(** **)** +Signal sent on closing the GraphNode. + - **dragged** **(** :ref:`Vector2` from, :ref:`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` new_minsize **)** Member Variables diff --git a/classes/class_hbuttonarray.rst b/classes/class_hbuttonarray.rst deleted file mode 100644 index 400f256d0..000000000 --- a/classes/class_hbuttonarray.rst +++ /dev/null @@ -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` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Horizontal button array. - -Description ------------ - -Horizontal button array. See :ref:`ButtonArray`. - diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index f64a0395b..57d6a073a 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -50,6 +50,8 @@ Signals ------- - **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PoolStringArray` headers, :ref:`PoolByteArray` body **)** +This signal is emitted upon request completion. + Member Variables ---------------- diff --git a/classes/class_image.rst b/classes/class_image.rst index 3691df642..2674cc94b 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -6,7 +6,9 @@ Image ===== -**Category:** Built-In Types +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core Brief Description ----------------- @@ -16,71 +18,114 @@ Image datatype. Member Functions ---------------- -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`Image` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` mipmaps, :ref:`int` format **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dest=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`compressed` **(** :ref:`int` format=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`converted` **(** :ref:`int` format=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`decompressed` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`empty` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fix_alpha_edges` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_format` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` area=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`load` **(** :ref:`String` path=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`resized` **(** :ref:`int` x, :ref:`int` y, :ref:`int` interpolation=1 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save_png` **(** :ref:`String` path=0 **)** | -+--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_mipmaps` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compress` **(** :ref:`int` mode, :ref:`int` arg1, :ref:`float` arg2 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`convert` **(** :ref:`int` format **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`copy_from` **(** :ref:`Image` src **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_from_data` **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format, :ref:`PoolByteArray` data **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`crop` **(** :ref:`int` width, :ref:`int` height **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`decompress` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`detect_alpha` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`expand_x2_hq2x` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fix_alpha_edges` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`flip_x` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`flip_y` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`generate_mipmaps` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_data` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_format` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mipmap_offset` **(** :ref:`int` mipmap **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_pixel` **(** :ref:`int` x, :ref:`int` y **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`get_rect` **(** :ref:`Rect2` rect **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_used_rect` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_mipmaps` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_compressed` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_empty` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_invisible` **(** **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`load` **(** :ref:`String` path **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`normalmap_to_xy` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`premultiply_alpha` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize_to_po2` **(** :ref:`bool` square="false" **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_png` **(** :ref:`String` path **)** const | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shrink_x2` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`srgb_to_linear` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`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` **Image** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` mipmaps, :ref:`int` format **)** - -Create an empty image of a specific size and format. - .. _class_Image_blit_rect: -- void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dest=0 **)** +- void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Copy a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` on coordinates "dest". -.. _class_Image_compressed: +.. _class_Image_clear_mipmaps: -- :ref:`Image` **compressed** **(** :ref:`int` format=0 **)** +- void **clear_mipmaps** **(** **)** -Return a new compressed :ref:`Image` from this :ref:`Image` using one of :ref:`Image`.COMPRESS\_\*. +.. _class_Image_compress: -.. _class_Image_converted: +- :ref:`int` **compress** **(** :ref:`int` mode, :ref:`int` arg1, :ref:`float` arg2 **)** -- :ref:`Image` **converted** **(** :ref:`int` format=0 **)** +.. _class_Image_convert: -Return a new :ref:`Image` from this :ref:`Image` with a different format. +- void **convert** **(** :ref:`int` format **)** -.. _class_Image_decompressed: +.. _class_Image_copy_from: -- :ref:`Image` **decompressed** **(** **)** +- void **copy_from** **(** :ref:`Image` src **)** -Return a new decompressed :ref:`Image`. +.. _class_Image_create: -.. _class_Image_empty: +- void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format **)** -- :ref:`bool` **empty** **(** **)** +Create an empty image of a specific size and format. -Return whether this :ref:`Image` is empty(no data). +.. _class_Image_create_from_data: + +- void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`int` format, :ref:`PoolByteArray` data **)** + +.. _class_Image_crop: + +- void **crop** **(** :ref:`int` width, :ref:`int` height **)** + +.. _class_Image_decompress: + +- :ref:`int` **decompress** **(** **)** + +.. _class_Image_detect_alpha: + +- :ref:`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` **generate_mipmaps** **(** **)** + .. _class_Image_get_data: -- :ref:`PoolByteArray` **get_data** **(** **)** +- :ref:`PoolByteArray` **get_data** **(** **)** const Return the raw data of the :ref:`Image`. .. _class_Image_get_format: -- :ref:`int` **get_format** **(** **)** +- :ref:`int` **get_format** **(** **)** const Return the format of the :ref:`Image`, one of :ref:`Image`.FORMAT\_\*. .. _class_Image_get_height: -- :ref:`int` **get_height** **(** **)** +- :ref:`int` **get_height** **(** **)** const Return the height of the :ref:`Image`. +.. _class_Image_get_mipmap_offset: + +- :ref:`int` **get_mipmap_offset** **(** :ref:`int` mipmap **)** const + +.. _class_Image_get_pixel: + +- :ref:`Color` **get_pixel** **(** :ref:`int` x, :ref:`int` y **)** const + .. _class_Image_get_rect: -- :ref:`Image` **get_rect** **(** :ref:`Rect2` area=0 **)** +- :ref:`Image` **get_rect** **(** :ref:`Rect2` rect **)** const Return a new :ref:`Image` that is a copy of "area" in this :ref:`Image`. .. _class_Image_get_used_rect: -- :ref:`Rect2` **get_used_rect** **(** **)** +- :ref:`Rect2` **get_used_rect** **(** **)** const Return the area of this :ref:`Image` that is used/visibly colored/opaque. .. _class_Image_get_width: -- :ref:`int` **get_width** **(** **)** +- :ref:`int` **get_width** **(** **)** const Return the width of the :ref:`Image`. +.. _class_Image_has_mipmaps: + +- :ref:`bool` **has_mipmaps** **(** **)** const + +.. _class_Image_is_compressed: + +- :ref:`bool` **is_compressed** **(** **)** const + +.. _class_Image_is_empty: + +- :ref:`bool` **is_empty** **(** **)** const + +.. _class_Image_is_invisible: + +- :ref:`bool` **is_invisible** **(** **)** const + .. _class_Image_load: -- :ref:`int` **load** **(** :ref:`String` path=0 **)** +- :ref:`int` **load** **(** :ref:`String` path **)** Load an :ref:`Image`. -.. _class_Image_resized: +.. _class_Image_lock: -- :ref:`Image` **resized** **(** :ref:`int` x, :ref:`int` y, :ref:`int` interpolation=1 **)** +- void **lock** **(** **)** -Return a new :ref:`Image` from this :ref:`Image` that is resized to size "x,y" using :ref:`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` x, :ref:`int` y, :ref:`Color` color **)** + +.. _class_Image_resize: + +- void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** + +.. _class_Image_resize_to_po2: + +- void **resize_to_po2** **(** :ref:`bool` square="false" **)** .. _class_Image_save_png: -- :ref:`int` **save_png** **(** :ref:`String` path=0 **)** +- :ref:`int` **save_png** **(** :ref:`String` path **)** const Save this :ref:`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** **(** **)** + diff --git a/classes/class_imageskybox.rst b/classes/class_imageskybox.rst deleted file mode 100644 index 1fd25ca5f..000000000 --- a/classes/class_imageskybox.rst +++ /dev/null @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_image_path` **(** :ref:`int` image **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_image_path` **(** :ref:`int` image, :ref:`String` path **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`String` **image_path_negative_x** -- :ref:`String` **image_path_negative_y** -- :ref:`String` **image_path_negative_z** -- :ref:`String` **image_path_positive_x** -- :ref:`String` **image_path_positive_y** -- :ref:`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` **get_image_path** **(** :ref:`int` image **)** const - -.. _class_ImageSkyBox_set_image_path: - -- void **set_image_path** **(** :ref:`int` image, :ref:`String` path **)** - - diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 9a9a2d8ea..d4bb32dff 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -23,8 +23,6 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from_image` **(** :ref:`Image` image, :ref:`int` flags=7 **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fix_alpha_edges` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`get_data` **(** **)** const | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_format` **(** **)** const | @@ -35,10 +33,6 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`load` **(** :ref:`String` path **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`normal_to_xy` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`premultiply_alpha` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_data` **(** :ref:`Image` image **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_lossy_storage_quality` **(** :ref:`float` quality **)** | @@ -47,8 +41,6 @@ Member Functions +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_storage` **(** :ref:`int` mode **)** | +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shrink_x2_and_keep_size` **(** **)** | -+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -81,10 +73,6 @@ Create a new :ref:`ImageTexture` with "width" and "height". Create a new :ref:`ImageTexture` from an :ref:`Image` with "flags" from :ref:`Texture`.FLAG\_\*. -.. _class_ImageTexture_fix_alpha_edges: - -- void **fix_alpha_edges** **(** **)** - .. _class_ImageTexture_get_data: - :ref:`Image` **get_data** **(** **)** const @@ -115,14 +103,6 @@ Return the storage type. One of :ref:`ImageTexture`.STORAGE\ Load an :ref:`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` image **)** @@ -145,8 +125,4 @@ Set the storage quality in case of :ref:`ImageTexture`.STORA Set the storage type. One of :ref:`ImageTexture`.STORAGE\_\*. -.. _class_ImageTexture_shrink_x2_and_keep_size: - -- void **shrink_x2_and_keep_size** **(** **)** - diff --git a/classes/class_input.rst b/classes/class_input.rst index d70360414..c60286ad2 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -75,7 +75,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | +| void | :ref:`parse_input_event` **(** :ref:`Object` event **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -94,6 +94,8 @@ Signals ------- - **joy_connection_changed** **(** :ref:`int` index, :ref:`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` event **)** +- void **parse_input_event** **(** :ref:`Object` event **)** .. _class_Input_remove_joy_mapping: diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 9901beba6..342fb957a 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -6,92 +6,111 @@ InputEvent ========== -**Category:** Built-In Types +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers`, :ref:`InputEventScreenDrag`, :ref:`InputEventJoypadMotion`, :ref:`InputEventJoypadButton`, :ref:`InputEventAction` + +**Category:** Core Brief Description ----------------- -Built-in input event data. + Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`int` **device** - Device identifier. -- :ref:`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`). - -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` | :ref:`action_match` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`as_text` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_device` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_id` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_type` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_echo` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_pressed` **(** **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_device` **(** :ref:`int` device **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_id` **(** :ref:`int` id **)** | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2(0, 0) **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- +.. _class_InputEvent_action_match: + +- :ref:`bool` **action_match** **(** :ref:`InputEvent` event **)** const + +.. _class_InputEvent_as_text: + +- :ref:`String` **as_text** **(** **)** const + +.. _class_InputEvent_get_device: + +- :ref:`int` **get_device** **(** **)** const + +.. _class_InputEvent_get_id: + +- :ref:`int` **get_id** **(** **)** const + .. _class_InputEvent_is_action: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** +- :ref:`bool` **is_action** **(** :ref:`String` action **)** const Return if this input event matches a pre-defined action, no matter the type. .. _class_InputEvent_is_action_pressed: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +- :ref:`bool` **is_action_pressed** **(** :ref:`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` **is_action_released** **(** :ref:`String` action **)** +- :ref:`bool` **is_action_released** **(** :ref:`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` **is_action_type** **(** **)** const + .. _class_InputEvent_is_echo: -- :ref:`bool` **is_echo** **(** **)** +- :ref:`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` **is_pressed** **(** **)** +- :ref:`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` action, :ref:`bool` pressed **)** +- void **set_device** **(** :ref:`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` id **)** + +.. _class_InputEvent_xformed_by: + +- :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2(0, 0) **)** const diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 2c1881b84..505868fd9 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -6,92 +6,45 @@ InputEventAction ================ -**Category:** Built-In Types +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core Brief Description ----------------- -Built-in input event type for actions. +Input event type for actions. Member Functions ---------------- -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_action` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_action` **(** :ref:`String` action **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`int` **device** - Device identifier. -- :ref:`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`). - -Description ------------ - -Input event type for actions that extends the global :ref:`InputEvent` type. +- :ref:`String` **action** +- :ref:`bool` **pressed** Member Function Description --------------------------- -.. _class_InputEventAction_is_action: +.. _class_InputEventAction_get_action: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** +- :ref:`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` action **)** -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +.. _class_InputEventAction_set_pressed: -Return whether the given action is being pressed. - -.. _class_InputEventAction_is_action_released: - -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** - -Return whether the given action is released (i.e. not pressed). - -.. _class_InputEventAction_is_echo: - -- :ref:`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` **is_pressed** **(** **)** - -Return if this input event is pressed. - -.. _class_InputEventAction_set_as_action: - -- void **set_as_action** **(** :ref:`String` action, :ref:`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` pressed **)** diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 111eddf1e..587014e10 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -6,95 +6,58 @@ InputEventJoypadButton ====================== -**Category:** Built-In Types +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`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` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_index` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pressure` **(** **)** const | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_index` **(** :ref:`int` button_index **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressure` **(** :ref:`float` pressure **)** | ++----------------------------+-------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. - :ref:`int` **button_index** - Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. -- :ref:`int` **device** - Device identifier. - :ref:`bool` **pressed** - Pressed state of the joypad button. - :ref:`float` **pressure** - Intensity of the button pressure, ranges from 0 to 1.0. -- :ref:`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`). - -Description ------------ - -Input event type for joypad button events that extends the global :ref:`InputEvent` type. Member Function Description --------------------------- -.. _class_InputEventJoypadButton_is_action: +.. _class_InputEventJoypadButton_get_button_index: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** +- :ref:`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` **get_pressure** **(** **)** const -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +.. _class_InputEventJoypadButton_set_button_index: -Return whether the given action is being pressed. +- void **set_button_index** **(** :ref:`int` button_index **)** -.. _class_InputEventJoypadButton_is_action_released: +.. _class_InputEventJoypadButton_set_pressed: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** +- void **set_pressed** **(** :ref:`bool` pressed **)** -Return whether the given action is released (i.e. not pressed). +.. _class_InputEventJoypadButton_set_pressure: -.. _class_InputEventJoypadButton_is_echo: - -- :ref:`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` **is_pressed** **(** **)** - -Return if this input event is pressed. - -.. _class_InputEventJoypadButton_set_as_action: - -- void **set_as_action** **(** :ref:`String` action, :ref:`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` pressure **)** diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index f2e9e73b3..93740ea62 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -6,92 +6,51 @@ InputEventJoypadMotion ====================== -**Category:** Built-In Types +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`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` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_axis` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_axis_value` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis` **(** :ref:`int` axis **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_axis_value` **(** :ref:`float` axis_value **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. - :ref:`int` **axis** - Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. -- :ref:`int` **device** - Device identifier. -- :ref:`int` **type** - Type of event (one of the [InputEvent] constants). -- :ref:`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`). - -Description ------------ - -Input event type for joypad motion/axis events that extends the global :ref:`InputEvent` type. +- :ref:`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` **is_action** **(** :ref:`String` action **)** +- :ref:`int` **get_axis** **(** **)** const -.. _class_InputEventJoypadMotion_is_action_pressed: +.. _class_InputEventJoypadMotion_get_axis_value: -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +- :ref:`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` axis **)** -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** +.. _class_InputEventJoypadMotion_set_axis_value: -Return whether the given action is released (i.e. not pressed). - -.. _class_InputEventJoypadMotion_is_echo: - -- :ref:`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` **is_pressed** **(** **)** - -Return if this input event is pressed. - -.. _class_InputEventJoypadMotion_set_as_action: - -- void **set_as_action** **(** :ref:`String` action, :ref:`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` axis_value **)** diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index db3676b33..0ea341a3b 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -6,100 +6,71 @@ InputEventKey ============= -**Category:** Built-In Types +**Inherits:** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core Brief Description ----------------- -Built-in input event type for keyboard events. +Input event type for keyboard events. Member Functions ---------------- -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_scancode` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_scancode_with_modifiers` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_unicode` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_echo` **(** :ref:`bool` echo **)** | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scancode` **(** :ref:`int` scancode **)** | ++------------------------+--------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unicode` **(** :ref:`int` unicode **)** | ++------------------------+--------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`bool` **alt** - State of the Alt modifier. -- :ref:`bool` **control** - State of the Ctrl modifier. -- :ref:`int` **device** - Device identifier. -- :ref:`bool` **echo** - Echo state of the key, i.e. whether it's a repeat event or not. -- :ref:`bool` **meta** - State of the Meta modifier. +- :ref:`int` **echo** - Echo state of the key, i.e. whether it's a repeat event or not. - :ref:`bool` **pressed** - Pressed state of the key. - :ref:`int` **scancode** - Scancode of the key, one of the KEY_* constants in [@Global Scope]. -- :ref:`bool` **shift** - State of the Shift modifier. -- :ref:`int` **type** - Type of event (one of the [InputEvent] constants). - :ref:`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`). - -Description ------------ - -Input event type for keyboard events that extends the global :ref:`InputEvent` type. - Member Function Description --------------------------- -.. _class_InputEventKey_is_action: +.. _class_InputEventKey_get_scancode: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** +- :ref:`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` **get_scancode_with_modifiers** **(** **)** const -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +.. _class_InputEventKey_get_unicode: -Return whether the given action is being pressed. +- :ref:`int` **get_unicode** **(** **)** const -.. _class_InputEventKey_is_action_released: +.. _class_InputEventKey_set_echo: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** +- void **set_echo** **(** :ref:`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` pressed **)** -- :ref:`bool` **is_echo** **(** **)** +.. _class_InputEventKey_set_scancode: -Return if this input event is an echo event. +- void **set_scancode** **(** :ref:`int` scancode **)** -.. _class_InputEventKey_is_pressed: +.. _class_InputEventKey_set_unicode: -- :ref:`bool` **is_pressed** **(** **)** - -Return if this input event is pressed. - -.. _class_InputEventKey_set_as_action: - -- void **set_as_action** **(** :ref:`String` action, :ref:`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` unicode **)** diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst new file mode 100644 index 000000000..43f27ef03 --- /dev/null +++ b/classes/class_inputeventmouse.rst @@ -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` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`InputEventMouseMotion`, :ref:`InputEventMouseButton` + +**Category:** Core + +Brief Description +----------------- + +Base input event type for mouse events. + +Member Functions +---------------- + ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_mask` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_position` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_mask` **(** :ref:`int` button_mask **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_global_position` **(** :ref:`Vector2` global_position **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. +- :ref:`Vector2` **global_position** - Global position of the mouse click. +- :ref:`Vector2` **position** - Local position of the mouse click. + +Member Function Description +--------------------------- + +.. _class_InputEventMouse_get_button_mask: + +- :ref:`int` **get_button_mask** **(** **)** const + +.. _class_InputEventMouse_get_global_position: + +- :ref:`Vector2` **get_global_position** **(** **)** const + +.. _class_InputEventMouse_get_position: + +- :ref:`Vector2` **get_position** **(** **)** const + +.. _class_InputEventMouse_set_button_mask: + +- void **set_button_mask** **(** :ref:`int` button_mask **)** + +.. _class_InputEventMouse_set_global_position: + +- void **set_global_position** **(** :ref:`Vector2` global_position **)** + +.. _class_InputEventMouse_set_position: + +- void **set_position** **(** :ref:`Vector2` position **)** + + diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 5a8e4b80f..1f09e28b2 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -6,106 +6,71 @@ InputEventMouseButton ===================== -**Category:** Built-In Types +**Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`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` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_index` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_factor` **(** **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_doubleclick` **(** **)** const | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button_index` **(** :ref:`int` button_index **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_doubleclick` **(** :ref:`bool` doubleclick **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_factor` **(** :ref:`float` factor **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++----------------------------+------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`bool` **alt** - State of the Alt modifier. - :ref:`int` **button_index** - Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. -- :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. -- :ref:`bool` **control** - State of the Control modifier. -- :ref:`int` **device** - Device identifier. - :ref:`bool` **doubleclick** - Whether the event is a double-click. -- :ref:`Vector2` **global_pos** - Global position of the mouse click. -- :ref:`float` **global_x** - Global X coordinate of the mouse click. -- :ref:`float` **global_y** - Global Y coordinate of the mouse click. -- :ref:`bool` **meta** - State of the Meta modifier. -- :ref:`Vector2` **pos** - Local position of the mouse click. +- :ref:`float` **factor** - :ref:`bool` **pressed** - Pressed state of the mouse button. -- :ref:`bool` **shift** - State of the Shift modifier. -- :ref:`int` **type** - Type of event (one of the [InputEvent] constants). -- :ref:`float` **x** - Local X coordinate of the mouse click. -- :ref:`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`). - -Description ------------ - -Input event type for mouse button events that extends the global :ref:`InputEvent` type. Member Function Description --------------------------- -.. _class_InputEventMouseButton_is_action: +.. _class_InputEventMouseButton_get_button_index: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** +- :ref:`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` **get_factor** **(** **)** -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +.. _class_InputEventMouseButton_is_doubleclick: -Return whether the given action is being pressed. +- :ref:`bool` **is_doubleclick** **(** **)** const -.. _class_InputEventMouseButton_is_action_released: +.. _class_InputEventMouseButton_set_button_index: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** +- void **set_button_index** **(** :ref:`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` doubleclick **)** -- :ref:`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` factor **)** -.. _class_InputEventMouseButton_is_pressed: +.. _class_InputEventMouseButton_set_pressed: -- :ref:`bool` **is_pressed** **(** **)** - -Return if this input event is pressed. - -.. _class_InputEventMouseButton_set_as_action: - -- void **set_as_action** **(** :ref:`String` action, :ref:`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` pressed **)** diff --git a/classes/class_inputeventmousemotion.rst b/classes/class_inputeventmousemotion.rst index 68952ca88..87ceaca64 100644 --- a/classes/class_inputeventmousemotion.rst +++ b/classes/class_inputeventmousemotion.rst @@ -6,109 +6,51 @@ InputEventMouseMotion ===================== -**Category:** Built-In Types +**Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`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` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_relative` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_speed` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_relative` **(** :ref:`Vector2` relative **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed` **(** :ref:`Vector2` speed **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`bool` **alt** - State of the Alt modifier. -- :ref:`int` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. -- :ref:`bool` **control** - State of the Ctrl modifier. -- :ref:`int` **device** - Device identifier. -- :ref:`Vector2` **global_pos** - Global position of the mouse pointer. -- :ref:`float` **global_x** - Global X coordinate of the mouse pointer. -- :ref:`float` **global_y** - Global Y coordinate of the mouse pointer. -- :ref:`bool` **meta** - State of the Meta modifier. -- :ref:`Vector2` **pos** - Local position of the mouse pointer. -- :ref:`Vector2` **relative_pos** - Position of the mouse pointer relative to the previous mouse position. -- :ref:`float` **relative_x** - X coordinate of the mouse pointer relative to the previous mouse position. -- :ref:`float` **relative_y** - Y coordinate of the mouse pointer relative to the previous mouse position. -- :ref:`bool` **shift** - State of the Shift modifier. +- :ref:`Vector2` **relative** - Position of the mouse pointer relative to the previous mouse position. - :ref:`Vector2` **speed** - Speed of the mouse pointer. -- :ref:`float` **speed_x** - Speed of the mouse pointer on the X axis. -- :ref:`float` **speed_y** - Speed of the mouse pointer on the Y axis. -- :ref:`int` **type** - Type of event (one of the [InputEvent] constants). -- :ref:`float` **x** - Local X coordinate of the mouse pointer. -- :ref:`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`). - -Description ------------ - -Input event type for mouse motion events that extends the global :ref:`InputEvent` type. Member Function Description --------------------------- -.. _class_InputEventMouseMotion_is_action: +.. _class_InputEventMouseMotion_get_relative: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** +- :ref:`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` **get_speed** **(** **)** const -- :ref:`bool` **is_action_pressed** **(** :ref:`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` relative **)** -.. _class_InputEventMouseMotion_is_action_released: +.. _class_InputEventMouseMotion_set_speed: -- :ref:`bool` **is_action_released** **(** :ref:`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` is true. - -.. _class_InputEventMouseMotion_is_echo: - -- :ref:`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` **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` action, :ref:`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` speed **)** diff --git a/classes/class_inputeventscreendrag.rst b/classes/class_inputeventscreendrag.rst index 1b6256985..2b1f42ed8 100644 --- a/classes/class_inputeventscreendrag.rst +++ b/classes/class_inputeventscreendrag.rst @@ -6,102 +6,77 @@ InputEventScreenDrag ==================== -**Category:** Built-In Types +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`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` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_relative` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_speed` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`int` index **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` position **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_relative` **(** :ref:`Vector2` relative **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed` **(** :ref:`Vector2` speed **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`int` **device** - Device identifier. - :ref:`int` **index** - Drag event index in the case of a multi-drag event. -- :ref:`Vector2` **pos** - Position of the drag event. -- :ref:`Vector2` **relative_pos** - Position of the drag event relative to its start position. -- :ref:`float` **relative_x** - X coordinate of the drag event relative to its start position. -- :ref:`float` **relative_y** - Y coordinate of the drag event relative to its start position. +- :ref:`Vector2` **position** - Position of the drag event. +- :ref:`Vector2` **relative** - Position of the drag event relative to its start position. - :ref:`Vector2` **speed** - Speed of the drag event. -- :ref:`float` **speed_x** - Speed of the drag event on the X axis. -- :ref:`float` **speed_y** - Speed of the drag event on the Y axis. -- :ref:`int` **type** - Type of event (one of the [InputEvent] constants). -- :ref:`float` **x** - X coordinate of the drag event. -- :ref:`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`). - -Description ------------ - -Input event type for screen drag events that extends the global :ref:`InputEvent` type. Member Function Description --------------------------- -.. _class_InputEventScreenDrag_is_action: +.. _class_InputEventScreenDrag_get_index: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** +- :ref:`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` **get_position** **(** **)** const -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +.. _class_InputEventScreenDrag_get_relative: -Return whether the given action is being pressed. Not relevant for SCREEN_DRAG events, always false. +- :ref:`Vector2` **get_relative** **(** **)** const -.. _class_InputEventScreenDrag_is_action_released: +.. _class_InputEventScreenDrag_get_speed: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** +- :ref:`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` is true. +.. _class_InputEventScreenDrag_set_index: -.. _class_InputEventScreenDrag_is_echo: +- void **set_index** **(** :ref:`int` index **)** -- :ref:`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` position **)** -.. _class_InputEventScreenDrag_is_pressed: +.. _class_InputEventScreenDrag_set_relative: -- :ref:`bool` **is_pressed** **(** **)** +- void **set_relative** **(** :ref:`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` action, :ref:`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` speed **)** diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index f77619400..c86f5850f 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -6,97 +6,58 @@ InputEventScreenTouch ===================== -**Category:** Built-In Types +**Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`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` | :ref:`is_action` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_released` **(** :ref:`String` action **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_echo` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_pressed` **(** **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_action` **(** :ref:`String` action, :ref:`bool` pressed **)** | -+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_index` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_position` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`int` index **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pressed` **(** :ref:`bool` pressed **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **ID** - Event identifier, positive integer increased at each new event. -- :ref:`int` **device** - Device identifier. - :ref:`int` **index** - Touch event index in the case of a multi-touch event. -- :ref:`Vector2` **pos** - Position of the touch event. +- :ref:`Vector2` **position** - Position of the touch event. - :ref:`bool` **pressed** - Pressed state of the touch event. -- :ref:`int` **type** - Type of event (one of the [InputEvent] constants). -- :ref:`float` **x** - X coordinate of the touch event. -- :ref:`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`). - -Description ------------ - -Input event type for touchscreen drag events that extends the global :ref:`InputEvent` type. Member Function Description --------------------------- -.. _class_InputEventScreenTouch_is_action: +.. _class_InputEventScreenTouch_get_index: -- :ref:`bool` **is_action** **(** :ref:`String` action **)** +- :ref:`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` **get_position** **(** **)** const -- :ref:`bool` **is_action_pressed** **(** :ref:`String` action **)** +.. _class_InputEventScreenTouch_set_index: -Return whether the given action is being pressed. +- void **set_index** **(** :ref:`int` index **)** -.. _class_InputEventScreenTouch_is_action_released: +.. _class_InputEventScreenTouch_set_position: -- :ref:`bool` **is_action_released** **(** :ref:`String` action **)** +- void **set_position** **(** :ref:`Vector2` pos **)** -Return whether the given action is released (i.e. not pressed). +.. _class_InputEventScreenTouch_set_pressed: -.. _class_InputEventScreenTouch_is_echo: - -- :ref:`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` **is_pressed** **(** **)** - -Return if this input event is pressed. - -.. _class_InputEventScreenTouch_set_as_action: - -- void **set_as_action** **(** :ref:`String` action, :ref:`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` pressed **)** diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst new file mode 100644 index 000000000..f1e008539 --- /dev/null +++ b/classes/class_inputeventwithmodifiers.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`InputEventKey`, :ref:`InputEventMouse` + +**Category:** Core + +Brief Description +----------------- + +Base class for input events with modifiers. + +Member Functions +---------------- + ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_alt` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_command` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_control` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_metakey` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_shift` **(** **)** const | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_alt` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_command` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_control` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metakey` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shift` **(** :ref:`bool` enable **)** | ++--------------------------+------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`bool` **alt** - State of the Alt modifier. +- :ref:`bool` **command** - State of the Command modifier. +- :ref:`bool` **control** - State of the Ctrl modifier. +- :ref:`bool` **meta** - State of the Meta modifier. +- :ref:`bool` **shift** - State of the Shift modifier. + +Member Function Description +--------------------------- + +.. _class_InputEventWithModifiers_get_alt: + +- :ref:`bool` **get_alt** **(** **)** const + +.. _class_InputEventWithModifiers_get_command: + +- :ref:`bool` **get_command** **(** **)** const + +.. _class_InputEventWithModifiers_get_control: + +- :ref:`bool` **get_control** **(** **)** const + +.. _class_InputEventWithModifiers_get_metakey: + +- :ref:`bool` **get_metakey** **(** **)** const + +.. _class_InputEventWithModifiers_get_shift: + +- :ref:`bool` **get_shift** **(** **)** const + +.. _class_InputEventWithModifiers_set_alt: + +- void **set_alt** **(** :ref:`bool` enable **)** + +.. _class_InputEventWithModifiers_set_command: + +- void **set_command** **(** :ref:`bool` enable **)** + +.. _class_InputEventWithModifiers_set_control: + +- void **set_control** **(** :ref:`bool` enable **)** + +.. _class_InputEventWithModifiers_set_metakey: + +- void **set_metakey** **(** :ref:`bool` enable **)** + +.. _class_InputEventWithModifiers_set_shift: + +- void **set_shift** **(** :ref:`bool` enable **)** + + diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index d9e37886a..de0353b85 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -18,55 +18,46 @@ Singleton that manages actions. Member Functions ---------------- -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_add_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`InputEvent` event **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_action` **(** :ref:`String` action **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_action` **(** :ref:`String` action **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`event_is_action` **(** :ref:`InputEvent` event, :ref:`String` action **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_action_from_id` **(** :ref:`int` id **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_action_id` **(** :ref:`String` action **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_actions` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`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` **(** :ref:`String` action, :ref:`Object` event **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_erase_event` **(** :ref:`String` action, :ref:`Object` event **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`action_has_event` **(** :ref:`String` action, :ref:`Object` event **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_action` **(** :ref:`String` action **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_action` **(** :ref:`String` action **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`event_is_action` **(** :ref:`Object` event, :ref:`String` action **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_action_list` **(** :ref:`String` action **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_actions` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_action` **(** :ref:`String` action **)** const | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`load_from_globals` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- .. _class_InputMap_action_add_event: -- void **action_add_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- void **action_add_event** **(** :ref:`String` action, :ref:`Object` event **)** Add an :ref:`InputEvent` to an action. This :ref:`InputEvent` will trigger the action. .. _class_InputMap_action_erase_event: -- void **action_erase_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- void **action_erase_event** **(** :ref:`String` action, :ref:`Object` event **)** Remove an :ref:`InputEvent` from an action. .. _class_InputMap_action_has_event: -- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`InputEvent` event **)** +- :ref:`bool` **action_has_event** **(** :ref:`String` action, :ref:`Object` event **)** Whether an action has an :ref:`InputEvent` associated with it. @@ -84,22 +75,10 @@ Remove an action from the :ref:`InputMap`. .. _class_InputMap_event_is_action: -- :ref:`bool` **event_is_action** **(** :ref:`InputEvent` event, :ref:`String` action **)** const +- :ref:`bool` **event_is_action** **(** :ref:`Object` event, :ref:`String` action **)** const Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given :ref:`InputEvent` is not pressed (for proper release detection). See :ref:`action_has_event` if you don't want this behavior. -.. _class_InputMap_get_action_from_id: - -- :ref:`String` **get_action_from_id** **(** :ref:`int` id **)** const - -Return the action corresponding to the identifier. - -.. _class_InputMap_get_action_id: - -- :ref:`int` **get_action_id** **(** :ref:`String` action **)** const - -Return the identifier of the given action. - .. _class_InputMap_get_action_list: - :ref:`Array` **get_action_list** **(** :ref:`String` action **)** diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index b25ae0faa..20b007f37 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -122,9 +122,21 @@ Signals ------- - **item_activated** **(** :ref:`int` index **)** +Fired when specified list item is activated via double click or Enter. + - **item_rmb_selected** **(** :ref:`int` index, :ref:`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` index **)** +Fired when specified item has been selected. + - **multi_selected** **(** :ref:`int` index, :ref:`bool` selected **)** +Fired when a multiple selection is altered on a list allowing mutliple selection. + Numeric Constants ----------------- diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index 018743aab..f9c576710 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -18,45 +18,59 @@ Kinematic body 3D node. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_collide_with_character_bodies` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_collide_with_kinematic_bodies` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_collide_with_rigid_bodies` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_collide_with_static_bodies` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_teleport_to` **(** :ref:`Vector3` position **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_pos` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move` **(** :ref:`Vector3` rel_vec **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_to` **(** :ref:`Vector3` position **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collide_with_character_bodies` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collide_with_kinematic_bodies` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collide_with_rigid_bodies` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collide_with_static_bodies` **(** :ref:`bool` enable **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_collide_with_character_bodies` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_collide_with_kinematic_bodies` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_collide_with_rigid_bodies` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_collide_with_static_bodies` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_teleport_to` **(** :ref:`Vector3` position **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_collider` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collider_velocity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_pos` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_move_and_slide_colliders` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_travel` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_colliding` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_ceiling` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_floor` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_move_and_slide_on_wall` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move` **(** :ref:`Vector3` rel_vec **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3(0, 0, 0), :ref:`Vector3` ceil_normal=Vector3(0, 0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398, :ref:`float` ceil_max_angle=0.785398 **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_to` **(** :ref:`Vector3` position **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`revert_motion` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collide_with_character_bodies` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collide_with_kinematic_bodies` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collide_with_rigid_bodies` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collide_with_static_bodies` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_margin` **(** :ref:`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_get_move_and_slide_colliders: + +- :ref:`Array` **get_move_and_slide_colliders** **(** **)** const + +.. _class_KinematicBody_get_travel: + +- :ref:`Vector3` **get_travel** **(** **)** const + .. _class_KinematicBody_is_colliding: - :ref:`bool` **is_colliding** **(** **)** const Return whether the body is colliding with another. +.. _class_KinematicBody_is_move_and_slide_on_ceiling: + +- :ref:`bool` **is_move_and_slide_on_ceiling** **(** **)** const + +.. _class_KinematicBody_is_move_and_slide_on_floor: + +- :ref:`bool` **is_move_and_slide_on_floor** **(** **)** const + +.. _class_KinematicBody_is_move_and_slide_on_wall: + +- :ref:`bool` **is_move_and_slide_on_wall** **(** **)** const + .. _class_KinematicBody_move: - :ref:`Vector3` **move** **(** :ref:`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` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3(0, 0, 0), :ref:`Vector3` ceil_normal=Vector3(0, 0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398, :ref:`float` ceil_max_angle=0.785398 **)** + .. _class_KinematicBody_move_to: - :ref:`Vector3` **move_to** **(** :ref:`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` enable **)** diff --git a/classes/class_light.rst b/classes/class_light.rst index fc45449f4..88d789a86 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -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 ----------- diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 9ccb9ae6f..3201185a3 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -43,6 +43,8 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_shadow_gradient_length` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_shadow_smooth` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_texture` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | @@ -89,6 +91,8 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shadow_gradient_length` **(** :ref:`float` multiplier **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shadow_smooth` **(** :ref:`float` smooth **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`Object` texture **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | @@ -120,6 +124,7 @@ Member Variables - :ref:`Color` **shadow_color** - :ref:`bool` **shadow_enabled** - :ref:`float` **shadow_filter** +- :ref:`float` **shadow_filter_smooth** - :ref:`float` **shadow_gradient_length** - :ref:`int` **shadow_item_cull_mask** - :ref:`Texture` **texture** @@ -204,6 +209,10 @@ Return the color of casted shadows for this Light2D. - :ref:`float` **get_shadow_gradient_length** **(** **)** const +.. _class_Light2D_get_shadow_smooth: + +- :ref:`float` **get_shadow_smooth** **(** **)** const + .. _class_Light2D_get_texture: - :ref:`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` multiplier **)** +.. _class_Light2D_set_shadow_smooth: + +- void **set_shadow_smooth** **(** :ref:`float` smooth **)** + .. _class_Light2D_set_texture: - void **set_texture** **(** :ref:`Object` texture **)** diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index 0e706ae09..d05d20a84 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -80,7 +80,7 @@ Member Variables - :ref:`int` **begin_cap_mode** - :ref:`Color` **default_color** - :ref:`int` **end_cap_mode** -- :ref:`ColorRamp` **gradient** +- :ref:`Gradient` **gradient** - :ref:`int` **joint_mode** - :ref:`PoolVector2Array` **points** - :ref:`int` **round_precision** diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index dc1890b86..95f076496 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -80,7 +80,11 @@ Signals ------- - **text_changed** **(** :ref:`String` text **)** +When the text changes, this signal is emitted. + - **text_entered** **(** :ref:`String` text **)** +This signal is emitted when the user presses KEY_ENTER on the :ref:`LineEdit`. This signal is often used as an alternate confirmation mechanism in dialogs. + Member Variables ---------------- diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index d6ae04c2b..c99922e75 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -41,7 +41,7 @@ Member Functions +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`init` **(** **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input_event` **(** :ref:`InputEvent` ev **)** | +| void | :ref:`input_event` **(** :ref:`Object` ev **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`input_text` **(** :ref:`String` text **)** | +--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -109,7 +109,7 @@ Member Function Description .. _class_MainLoop_input_event: -- void **input_event** **(** :ref:`InputEvent` ev **)** +- void **input_event** **(** :ref:`Object` ev **)** .. _class_MainLoop_input_text: diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index ed9d4db85..7b69cffae 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -8,7 +8,7 @@ Mesh **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`QuadMesh` +**Inherited By:** :ref:`ArrayMesh`, :ref:`PrimitiveMesh` **Category:** Core @@ -20,80 +20,17 @@ A :ref:`Resource` that contains vertex-array based geometry. Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=Array(), :ref:`int` compress_flags=97792 **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`center_geometry` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_blend_shapes` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_mode` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regen_normalmaps` **(** **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_shape_mode` **(** :ref:`int` mode **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`surface_get_material` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_remove` **(** :ref:`int` surf_idx **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_material` **(** :ref:`int` surf_idx, :ref:`Material` material **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`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` vertices). -- **ARRAY_NORMAL** = **1** --- Normal array (array of :ref:`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` colors). -- **ARRAY_TEX_UV** = **4** --- UV array (array of :ref:`Vector3` UVs or float array of groups of 2 floats (u,v)). -- **ARRAY_TEX_UV2** = **5** --- Second UV array (array of :ref:`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` | :ref:`create_convex_shape` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`ArrayMesh` | :ref:`create_outline` **(** :ref:`float` margin **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Shape` | :ref:`create_trimesh_shape` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ Description ----------- @@ -103,110 +40,24 @@ Mesh is a type of :ref:`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` name **)** +- :ref:`Shape` **create_convex_shape** **(** **)** const -.. _class_Mesh_add_surface_from_arrays: +.. _class_Mesh_create_outline: -- void **add_surface_from_arrays** **(** :ref:`int` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=Array(), :ref:`int` compress_flags=97792 **)** +- :ref:`ArrayMesh` **create_outline** **(** :ref:`float` margin **)** const -Create a new surface (:ref:`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` **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` **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` **get_blend_shape_count** **(** **)** const - -.. _class_Mesh_get_blend_shape_mode: - -- :ref:`int` **get_blend_shape_mode** **(** **)** const - -.. _class_Mesh_get_blend_shape_name: - -- :ref:`String` **get_blend_shape_name** **(** :ref:`int` index **)** const - -.. _class_Mesh_get_custom_aabb: - -- :ref:`Rect3` **get_custom_aabb** **(** **)** const - -.. _class_Mesh_get_surface_count: - -- :ref:`int` **get_surface_count** **(** **)** const - -Return the amount of surfaces that the :ref:`Mesh` holds. - -.. _class_Mesh_regen_normalmaps: - -- void **regen_normalmaps** **(** **)** - -.. _class_Mesh_set_blend_shape_mode: - -- void **set_blend_shape_mode** **(** :ref:`int` mode **)** - -.. _class_Mesh_set_custom_aabb: - -- void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** - -.. _class_Mesh_surface_get_array_index_len: - -- :ref:`int` **surface_get_array_index_len** **(** :ref:`int` surf_idx **)** const - -Return the length in indices of the index array in the requested surface (see :ref:`add_surface`). - -.. _class_Mesh_surface_get_array_len: - -- :ref:`int` **surface_get_array_len** **(** :ref:`int` surf_idx **)** const - -Return the length in vertices of the vertex array in the requested surface (see :ref:`add_surface`). - -.. _class_Mesh_surface_get_format: - -- :ref:`int` **surface_get_format** **(** :ref:`int` surf_idx **)** const - -Return the format mask of the requested surface (see :ref:`add_surface`). - -.. _class_Mesh_surface_get_material: - -- :ref:`Material` **surface_get_material** **(** :ref:`int` surf_idx **)** const - -Return a :ref:`Material` in a given surface. Surface is rendered using this material. - -.. _class_Mesh_surface_get_name: - -- :ref:`String` **surface_get_name** **(** :ref:`int` surf_idx **)** const - -.. _class_Mesh_surface_get_primitive_type: - -- :ref:`int` **surface_get_primitive_type** **(** :ref:`int` surf_idx **)** const - -Return the primitive type of the requested surface (see :ref:`add_surface`). - -.. _class_Mesh_surface_remove: - -- void **surface_remove** **(** :ref:`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` surf_idx, :ref:`Material` material **)** - -Set a :ref:`Material` for a given surface. Surface will be rendered using this material. - -.. _class_Mesh_surface_set_name: - -- void **surface_set_name** **(** :ref:`int` surf_idx, :ref:`String` name **)** +- :ref:`PoolVector3Array` **get_faces** **(** **)** const diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index b6725019f..f99a1a23c 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -39,6 +39,7 @@ Numeric Constants - **COMPRESS_RANGE_CODER** = **1** - **COMPRESS_FASTLZ** = **2** - **COMPRESS_ZLIB** = **3** +- **COMPRESS_ZSTD** = **4** Description ----------- diff --git a/classes/class_nil.rst b/classes/class_nil.rst index 6081f9dd0..c6093bcc0 100644 --- a/classes/class_nil.rst +++ b/classes/class_nil.rst @@ -35,16 +35,12 @@ Member Functions +-------+----------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`Dictionary` from **)** | +-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`InputEvent` from **)** | -+-------+----------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`Object` from **)** | +-------+----------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`RID` from **)** | +-------+----------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`NodePath` from **)** | +-------+----------------------------------------------------------------------------------------------+ -| void | :ref:`Nil` **(** :ref:`Image` from **)** | -+-------+----------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`Color` from **)** | +-------+----------------------------------------------------------------------------------------------+ | void | :ref:`Nil` **(** :ref:`Transform` from **)** | @@ -115,10 +111,6 @@ Member Function Description .. _class_Nil_Nil: -- void **Nil** **(** :ref:`InputEvent` from **)** - -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Object` from **)** .. _class_Nil_Nil: @@ -131,10 +123,6 @@ Member Function Description .. _class_Nil_Nil: -- void **Nil** **(** :ref:`Image` from **)** - -.. _class_Nil_Nil: - - void **Nil** **(** :ref:`Color` from **)** .. _class_Nil_Nil: diff --git a/classes/class_node.rst b/classes/class_node.rst index eb457e2e4..08bcc0305 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -35,7 +35,7 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_unhandled_input` **(** :ref:`InputEvent` event **)** virtual | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_unhandled_key_input` **(** :ref:`InputEvent` key_event **)** virtual | +| void | :ref:`_unhandled_key_input` **(** :ref:`InputEventKey` event **)** virtual | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_child` **(** :ref:`Node` node, :ref:`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` event **)** virtual -Called for every input event. - -It has to be enabled with :ref:`set_process_input` or the corresponding property in the inspector. - .. _class_Node__process: - void **_process** **(** :ref:`float` delta **)** virtual @@ -322,17 +320,9 @@ Corresponds to the NOTIFICATION_READY notification in :ref:`Object._notification - void **_unhandled_input** **(** :ref:`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` or the corresponding property in the inspector. - .. _class_Node__unhandled_key_input: -- void **_unhandled_key_input** **(** :ref:`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` or the corresponding property in the inspector. +- void **_unhandled_key_input** **(** :ref:`InputEventKey` event **)** virtual .. _class_Node_add_child: diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 53844fd8c..759c2b594 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -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` 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: diff --git a/classes/class_object.rst b/classes/class_object.rst index 9d4551e17..52bec384f 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -18,87 +18,87 @@ Base class for all non built-in types. Member Functions ---------------- -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`XL_MESSAGE` **(** :ref:`String` message **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_get` **(** :ref:`String` property **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_init` **(** **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=Array() **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=Array(), :ref:`int` flags=0 **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_class` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_instance_ID` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_method_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_property_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Script` | :ref:`get_script` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_list_changed_notify` **(** **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_script` **(** :ref:`Script` script **)** | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tr` **(** :ref:`String` message **)** const | -+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`XL_MESSAGE` **(** :ref:`String` message **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_get` **(** :ref:`String` property **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`_get_property_list` **(** **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_notification` **(** :ref:`int` what **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set` **(** :ref:`String` property, :ref:`Variant` value **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_user_signal` **(** :ref:`String` signal, :ref:`Array` arguments=[] **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`call` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_deferred` **(** :ref:`String` method **)** vararg | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`callv` **(** :ref:`String` method, :ref:`Array` arg_array **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_translate_messages` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`connect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[], :ref:`int` flags=0 **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disconnect` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`emit_signal` **(** :ref:`String` signal **)** vararg | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get` **(** :ref:`String` property **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_class` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_instance_ID` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_method_list` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_property_list` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_script` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_connection_list` **(** :ref:`String` signal **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_signal_list` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_meta` **(** :ref:`String` name **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_method` **(** :ref:`String` method **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_user_signal` **(** :ref:`String` signal **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_blocking_signals` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class` **(** :ref:`String` type **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_connected` **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_queued_for_deletion` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notification` **(** :ref:`int` what, :ref:`bool` reversed=false **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`property_list_changed_notify` **(** **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`String` property, :ref:`Variant` value **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_block_signals` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_message_translation` **(** :ref:`bool` enable **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta` **(** :ref:`String` name, :ref:`Variant` value **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_script` **(** :ref:`Script` script **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tr` **(** :ref:`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` signal, :ref:`Array` arguments=Array() **)** +- void **add_user_signal** **(** :ref:`String` signal, :ref:`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` TYPE\_\*). @@ -190,7 +190,7 @@ Return true if this object can translate strings. .. _class_Object_connect: -- :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=Array(), :ref:`int` flags=0 **)** +- :ref:`int` **connect** **(** :ref:`String` signal, :ref:`Object` target, :ref:`String` method, :ref:`Array` binds=[], :ref:`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` to check. diff --git a/classes/class_omnilight.rst b/classes/class_omnilight.rst index a3732fddf..05db18e9d 100644 --- a/classes/class_omnilight.rst +++ b/classes/class_omnilight.rst @@ -39,7 +39,7 @@ Member Variables Description ----------- -An OmniDirectional light is a type of :ref:`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`. TODO: Image of an omnilight. +An OmniDirectional light is a type of :ref:`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`. Member Function Description --------------------------- diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 664570e42..8c996ffac 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -64,6 +64,8 @@ Signals ------- - **item_selected** **(** :ref:`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 ---------------- diff --git a/classes/class_os.rst b/classes/class_os.rst index 9383b43e4..331b57ca9 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -33,7 +33,7 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`dump_resources_to_file` **(** :ref:`String` file **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=Array() **)** | +| :ref:`int` | :ref:`execute` **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=[] **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`find_scancode_from_string` **(** :ref:`String` string **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -177,7 +177,7 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_exit_code` **(** :ref:`int` code **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Image` icon **)** | +| void | :ref:`set_icon` **(** :ref:`Object` icon **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_keep_screen_on` **(** :ref:`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` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`Array` output=Array() **)** +- :ref:`int` **execute** **(** :ref:`String` path, :ref:`PoolStringArray` arguments, :ref:`bool` blocking, :ref:`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` **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` icon **)** +- void **set_icon** **(** :ref:`Object` icon **)** .. _class_OS_set_keep_screen_on: diff --git a/classes/class_packedscene.rst b/classes/class_packedscene.rst index e8032feeb..036fa5546 100644 --- a/classes/class_packedscene.rst +++ b/classes/class_packedscene.rst @@ -18,15 +18,15 @@ Brief Description Member Functions ---------------- -+--------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_instance` **(** **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`SceneState` | :ref:`get_state` **(** **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`instance` **(** :ref:`int` edit_state=false **)** const | -+--------------------------------------+--------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`pack` **(** :ref:`Node` path **)** | -+--------------------------------------+--------------------------------------------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_instance` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`SceneState` | :ref:`get_state` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`instance` **(** :ref:`int` edit_state=0 **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`pack` **(** :ref:`Node` path **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -58,7 +58,7 @@ Member Function Description .. _class_PackedScene_instance: -- :ref:`Node` **instance** **(** :ref:`int` edit_state=false **)** const +- :ref:`Node` **instance** **(** :ref:`int` edit_state=0 **)** const .. _class_PackedScene_pack: diff --git a/classes/class_panoramasky.rst b/classes/class_panoramasky.rst new file mode 100644 index 000000000..68f188869 --- /dev/null +++ b/classes/class_panoramasky.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_panorama` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_panorama` **(** :ref:`Texture` texture **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Texture` **panorama** + +Member Function Description +--------------------------- + +.. _class_PanoramaSky_get_panorama: + +- :ref:`Texture` **get_panorama** **(** **)** const + +.. _class_PanoramaSky_set_panorama: + +- void **set_panorama** **(** :ref:`Texture` texture **)** + + diff --git a/classes/class_particles.rst b/classes/class_particles.rst index a27738ad0..ad22bfba0 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_amount` **(** **)** const | +| :ref:`Rect3` | :ref:`capture_aabb` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect3` | :ref:`get_custom_aabb` **(** **)** const | +| :ref:`int` | :ref:`get_amount` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_draw_order` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -35,8 +35,6 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_lifetime` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | @@ -45,14 +43,16 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect3` | :ref:`get_visibility_aabb` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_emitting` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_amount` **(** :ref:`int` amount **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`Rect3` aabb **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_draw_order` **(** :ref:`int` order **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_draw_pass_mesh` **(** :ref:`int` pass, :ref:`Mesh` mesh **)** | @@ -67,8 +67,6 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`Vector3` accel_vec **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | @@ -77,14 +75,17 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` scale **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visibility_aabb` **(** :ref:`Rect3` aabb **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`int` **amount** -- :ref:`Rect3` **custom_aabb** - :ref:`int` **draw_order** - :ref:`Mesh` **draw_pass_1** - :ref:`Mesh` **draw_pass_2** @@ -95,12 +96,13 @@ Member Variables - :ref:`float` **explosiveness** - :ref:`int` **fixed_fps** - :ref:`bool` **fract_delta** -- :ref:`Vector3` **gravity** - :ref:`float` **lifetime** - :ref:`bool` **local_coords** - :ref:`float` **preprocess** - ParticlesMaterial,ShaderMaterial **process_material** - :ref:`float` **randomness** +- :ref:`float` **speed_scale** +- :ref:`Rect3` **visibility_aabb** Numeric Constants ----------------- @@ -113,14 +115,14 @@ Numeric Constants Member Function Description --------------------------- +.. _class_Particles_capture_aabb: + +- :ref:`Rect3` **capture_aabb** **(** **)** const + .. _class_Particles_get_amount: - :ref:`int` **get_amount** **(** **)** const -.. _class_Particles_get_custom_aabb: - -- :ref:`Rect3` **get_custom_aabb** **(** **)** const - .. _class_Particles_get_draw_order: - :ref:`int` **get_draw_order** **(** **)** const @@ -145,10 +147,6 @@ Member Function Description - :ref:`bool` **get_fractional_delta** **(** **)** const -.. _class_Particles_get_gravity: - -- :ref:`Vector3` **get_gravity** **(** **)** const - .. _class_Particles_get_lifetime: - :ref:`float` **get_lifetime** **(** **)** const @@ -165,10 +163,18 @@ Member Function Description - :ref:`float` **get_randomness_ratio** **(** **)** const +.. _class_Particles_get_speed_scale: + +- :ref:`float` **get_speed_scale** **(** **)** const + .. _class_Particles_get_use_local_coordinates: - :ref:`bool` **get_use_local_coordinates** **(** **)** const +.. _class_Particles_get_visibility_aabb: + +- :ref:`Rect3` **get_visibility_aabb** **(** **)** const + .. _class_Particles_is_emitting: - :ref:`bool` **is_emitting** **(** **)** const @@ -177,10 +183,6 @@ Member Function Description - void **set_amount** **(** :ref:`int` amount **)** -.. _class_Particles_set_custom_aabb: - -- void **set_custom_aabb** **(** :ref:`Rect3` aabb **)** - .. _class_Particles_set_draw_order: - void **set_draw_order** **(** :ref:`int` order **)** @@ -209,10 +211,6 @@ Member Function Description - void **set_fractional_delta** **(** :ref:`bool` enable **)** -.. _class_Particles_set_gravity: - -- void **set_gravity** **(** :ref:`Vector3` accel_vec **)** - .. _class_Particles_set_lifetime: - void **set_lifetime** **(** :ref:`float` secs **)** @@ -229,8 +227,16 @@ Member Function Description - void **set_randomness_ratio** **(** :ref:`float` ratio **)** +.. _class_Particles_set_speed_scale: + +- void **set_speed_scale** **(** :ref:`float` scale **)** + .. _class_Particles_set_use_local_coordinates: - void **set_use_local_coordinates** **(** :ref:`bool` enable **)** +.. _class_Particles_set_visibility_aabb: + +- void **set_visibility_aabb** **(** :ref:`Rect3` aabb **)** + diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 26e7c4d85..999b74bff 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -29,8 +29,6 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_color_phases` **(** **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ColorRamp` | :ref:`get_color_ramp` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_emission_half_extents` **(** **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector2Array` | :ref:`get_emission_points` **(** **)** const | @@ -41,6 +39,8 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_explosiveness` **(** **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_h_frames` **(** **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_initial_velocity` **(** **)** const | @@ -83,8 +83,6 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color_phases` **(** :ref:`int` phases **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ColorRamp` | :ref:`set_color_ramp` **(** :ref:`Object` color_ramp **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_half_extents` **(** :ref:`Vector2` extents **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_points` **(** :ref:`PoolVector2Array` points **)** | @@ -101,6 +99,8 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flip_v` **(** :ref:`bool` enable **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`set_gradient` **(** :ref:`Object` gradient **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_h_frames` **(** :ref:`int` enable **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_initial_velocity` **(** :ref:`Vector2` velocity **)** | @@ -133,7 +133,7 @@ Member Variables ---------------- - :ref:`Color` **color/color** -- :ref:`ColorRamp` **color/color_ramp** +- :ref:`Gradient` **color/color_ramp** - :ref:`int` **color_phases/count** - :ref:`int` **config/amount** - :ref:`float` **config/emit_timeout** @@ -247,12 +247,6 @@ Returns the tint color for each particle. - :ref:`int` **get_color_phases** **(** **)** const -.. _class_Particles2D_get_color_ramp: - -- :ref:`ColorRamp` **get_color_ramp** **(** **)** const - -Returns the :ref:`ColorRamp` used to tint each particle - .. _class_Particles2D_get_emission_half_extents: - :ref:`Vector2` **get_emission_half_extents** **(** **)** const @@ -279,6 +273,12 @@ Returns the amount of seconds during which the emitter will spawn particles - :ref:`float` **get_explosiveness** **(** **)** const +.. _class_Particles2D_get_gradient: + +- :ref:`Gradient` **get_gradient** **(** **)** const + +Returns the :ref:`Gradient` used to tint each particle. + .. _class_Particles2D_get_h_frames: - :ref:`int` **get_h_frames** **(** **)** const @@ -379,12 +379,6 @@ Set the tint color for each particle. - void **set_color_phases** **(** :ref:`int` phases **)** -.. _class_Particles2D_set_color_ramp: - -- :ref:`ColorRamp` **set_color_ramp** **(** :ref:`Object` color_ramp **)** - -Sets the :ref:`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` 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` enable **)** +.. _class_Particles2D_set_gradient: + +- :ref:`Gradient` **set_gradient** **(** :ref:`Object` gradient **)** + +Sets the :ref:`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` enable **)** diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index a5f38e5d9..a6b10d768 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -39,6 +39,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_flatness` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param_randomness` **(** :ref:`int` param **)** const | @@ -73,6 +75,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flatness` **(** :ref:`float` amount **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gravity` **(** :ref:`Vector3` accel_vec **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_param_randomness` **(** :ref:`int` param, :ref:`float` randomness **)** | @@ -117,6 +121,7 @@ Member Variables - :ref:`bool` **flag_align_y** - :ref:`bool` **flag_rotate_y** - :ref:`float` **flatness** +- :ref:`Vector3` **gravity** - :ref:`float` **hue_variation** - :ref:`CurveTexture` **hue_variation_curve** - :ref:`float` **hue_variation_random** @@ -210,6 +215,10 @@ Member Function Description - :ref:`float` **get_flatness** **(** **)** const +.. _class_ParticlesMaterial_get_gravity: + +- :ref:`Vector3` **get_gravity** **(** **)** const + .. _class_ParticlesMaterial_get_param: - :ref:`float` **get_param** **(** :ref:`int` param **)** const @@ -278,6 +287,10 @@ Member Function Description - void **set_flatness** **(** :ref:`float` amount **)** +.. _class_ParticlesMaterial_set_gravity: + +- void **set_gravity** **(** :ref:`Vector3` accel_vec **)** + .. _class_ParticlesMaterial_set_param: - void **set_param** **(** :ref:`int` param, :ref:`float` value **)** diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index 89322080a..b3165177b 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -25,9 +25,9 @@ Member Functions +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`Physics2DShapeQueryParameters` shape **)** | +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=Array(), :ref:`int` layer_mask=2147483647, :ref:`int` type_mask=15 **)** | +| :ref:`Array` | :ref:`intersect_point` **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=Array(), :ref:`int` layer_mask=2147483647, :ref:`int` type_mask=15 **)** | +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | +--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`intersect_shape` **(** :ref:`Physics2DShapeQueryParameters` shape, :ref:`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` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=Array(), :ref:`int` layer_mask=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Array` **intersect_point** **(** :ref:`Vector2` point, :ref:`int` max_results=32, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`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`s .. _class_Physics2DDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=Array(), :ref:`int` layer_mask=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** Intersect a ray in a given space. The returned object is a dictionary with the following fields: diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index ddf5a868d..c5429dfce 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -47,9 +47,9 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_layer_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -79,12 +79,12 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`body_create` **(** :ref:`int` mode=2, :ref:`bool` init_sleeping=false **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_layer_mask` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_mode` **(** :ref:`RID` body **)** const | @@ -119,14 +119,14 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_layer_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | @@ -153,7 +153,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin=0.08, :ref:`Physics2DTestMotionResult` result=NULL **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | +| :ref:`RID` | :ref:`damped_spring_joint_create` **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=[RID] **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`damped_string_joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -163,7 +163,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_process_info` **(** :ref:`int` process_info **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** | +| :ref:`RID` | :ref:`groove_joint_create` **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=[RID], :ref:`RID` body_b=[RID] **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`joint_get_param` **(** :ref:`RID` joint, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -171,7 +171,7 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`joint_set_param` **(** :ref:`RID` joint, :ref:`int` param, :ref:`float` value **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** | +| :ref:`RID` | :ref:`pin_joint_create` **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=[RID] **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_active` **(** :ref:`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` area, :ref:`int` layer **)** + +Assign the area to one or many physics layers. + .. _class_Physics2DServer_area_set_collision_mask: - void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** Set which physics layers the area will monitor. -.. _class_Physics2DServer_area_set_layer_mask: - -- void **area_set_layer_mask** **(** :ref:`RID` area, :ref:`int` mask **)** - -Assign the area to one or many physics layers. - .. _class_Physics2DServer_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`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` **body_get_collision_layer** **(** :ref:`RID` body **)** const + +Return the physics layer or layers a body belongs to. + .. _class_Physics2DServer_body_get_collision_mask: - :ref:`int` **body_get_collision_mask** **(** :ref:`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` **body_get_layer_mask** **(** :ref:`RID` body **)** const - -Return the physics layer or layers a body belongs to. - .. _class_Physics2DServer_body_get_max_contacts_reported: - :ref:`int` **body_get_max_contacts_reported** **(** :ref:`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` body, :ref:`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` body, :ref:`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_layer_mask: - -- void **body_set_layer_mask** **(** :ref:`RID` body, :ref:`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` body, :ref:`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` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** +- :ref:`RID` **damped_spring_joint_create** **(** :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`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` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=RID(), :ref:`RID` body_b=RID() **)** +- :ref:`RID` **groove_joint_create** **(** :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a=[RID], :ref:`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` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=RID() **)** +- :ref:`RID` **pin_joint_create** **(** :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b=[RID] **)** Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index 8f6ef3a21..a19106719 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_exclude` **(** **)** const | +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | +| :ref:`Array` | :ref:`get_exclude` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_margin` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ @@ -33,9 +33,9 @@ Member Functions +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` layer_mask **)** | +| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_margin` **(** :ref:`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` **get_collision_layer** **(** **)** const + +Return the physics layer the shape belongs to. + .. _class_Physics2DShapeQueryParameters_get_exclude: - :ref:`Array` **get_exclude** **(** **)** const Return the list of objects, or object :ref:`RID`s, that will be excluded from collisions. -.. _class_Physics2DShapeQueryParameters_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const - -Return the physics layer(s) the shape belongs to. - .. _class_Physics2DShapeQueryParameters_get_margin: - :ref:`float` **get_margin** **(** **)** const @@ -100,18 +100,18 @@ Return the :ref:`RID` of the shape queried. Return the transform matrix of the shape queried. +.. _class_Physics2DShapeQueryParameters_set_collision_layer: + +- void **set_collision_layer** **(** :ref:`int` collision_layer **)** + +Set the physics layer the shape belongs to. + .. _class_Physics2DShapeQueryParameters_set_exclude: - void **set_exclude** **(** :ref:`Array` exclude **)** Set the list of objects, or object :ref:`RID`s, that will be excluded from collisions. -.. _class_Physics2DShapeQueryParameters_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`int` layer_mask **)** - -Set the physics layer(s) the shape belongs to. - .. _class_Physics2DShapeQueryParameters_set_margin: - void **set_margin** **(** :ref:`float` margin **)** diff --git a/classes/class_physicsbody.rst b/classes/class_physicsbody.rst index 371dcbe19..8bfdde908 100644 --- a/classes/class_physicsbody.rst +++ b/classes/class_physicsbody.rst @@ -8,7 +8,7 @@ PhysicsBody **Inherits:** :ref:`CollisionObject` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`VehicleBody`, :ref:`StaticBody`, :ref:`KinematicBody`, :ref:`RigidBody` +**Inherited By:** :ref:`RigidBody`, :ref:`VehicleBody`, :ref:`StaticBody`, :ref:`KinematicBody` **Category:** Core diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 75cc09c91..85d37f5b4 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -37,7 +37,7 @@ Member Functions +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` mask **)** | +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | +--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`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` mask **)** +- void **set_collision_layer** **(** :ref:`int` layer **)** Set the physics layers this area is in. diff --git a/classes/class_physicsdirectspacestate.rst b/classes/class_physicsdirectspacestate.rst index 9928f7648..323dc585f 100644 --- a/classes/class_physicsdirectspacestate.rst +++ b/classes/class_physicsdirectspacestate.rst @@ -25,7 +25,7 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_rest_info` **(** :ref:`PhysicsShapeQueryParameters` shape **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=Array(), :ref:`int` layer_mask=2147483647, :ref:`int` type_mask=15 **)** | +| :ref:`Dictionary` | :ref:`intersect_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`intersect_shape` **(** :ref:`PhysicsShapeQueryParameters` shape, :ref:`int` max_results=32 **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,7 +57,7 @@ Member Function Description .. _class_PhysicsDirectSpaceState_intersect_ray: -- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=Array(), :ref:`int` layer_mask=2147483647, :ref:`int` type_mask=15 **)** +- :ref:`Dictionary` **intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`Array` exclude=[], :ref:`int` collision_layer=2147483647, :ref:`int` type_mask=15 **)** .. _class_PhysicsDirectSpaceState_intersect_shape: diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 16097912a..230df49b9 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -49,9 +49,9 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +| void | :ref:`area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`area_set_layer_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +| void | :ref:`area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -85,9 +85,9 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_axis_lock` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body, :ref:`int` arg1 **)** const | +| :ref:`int` | :ref:`body_get_collision_layer` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`body_get_layer_mask` **(** :ref:`RID` body, :ref:`int` arg1 **)** const | +| :ref:`int` | :ref:`body_get_collision_mask` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_max_contacts_reported` **(** :ref:`RID` body **)** const | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,14 +121,14 @@ Member Functions +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** | ++----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_enable_continuous_collision_detection` **(** :ref:`RID` body, :ref:`bool` enable **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_layer_mask` **(** :ref:`RID` body, :ref:`int` mask **)** | -+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** | +----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_mode` **(** :ref:`RID` body, :ref:`int` mode **)** | @@ -395,14 +395,14 @@ Member Function Description - void **area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** +.. _class_PhysicsServer_area_set_collision_layer: + +- void **area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** + .. _class_PhysicsServer_area_set_collision_mask: - void **area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** -.. _class_PhysicsServer_area_set_layer_mask: - -- void **area_set_layer_mask** **(** :ref:`RID` area, :ref:`int` mask **)** - .. _class_PhysicsServer_area_set_monitor_callback: - void **area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Object` receiver, :ref:`String` method **)** @@ -467,13 +467,13 @@ Member Function Description - :ref:`int` **body_get_axis_lock** **(** :ref:`RID` body **)** const +.. _class_PhysicsServer_body_get_collision_layer: + +- :ref:`int` **body_get_collision_layer** **(** :ref:`RID` body **)** const + .. _class_PhysicsServer_body_get_collision_mask: -- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body, :ref:`int` arg1 **)** const - -.. _class_PhysicsServer_body_get_layer_mask: - -- :ref:`int` **body_get_layer_mask** **(** :ref:`RID` body, :ref:`int` arg1 **)** const +- :ref:`int` **body_get_collision_mask** **(** :ref:`RID` body **)** const .. _class_PhysicsServer_body_get_max_contacts_reported: @@ -539,6 +539,10 @@ Member Function Description - void **body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** +.. _class_PhysicsServer_body_set_collision_layer: + +- void **body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** + .. _class_PhysicsServer_body_set_collision_mask: - void **body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** @@ -551,10 +555,6 @@ Member Function Description - void **body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Object` receiver, :ref:`String` method, :ref:`Variant` userdata=NULL **)** -.. _class_PhysicsServer_body_set_layer_mask: - -- void **body_set_layer_mask** **(** :ref:`RID` body, :ref:`int` mask **)** - .. _class_PhysicsServer_body_set_max_contacts_reported: - void **body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** diff --git a/classes/class_physicsshapequeryparameters.rst b/classes/class_physicsshapequeryparameters.rst index 2c9864178..364a386cf 100644 --- a/classes/class_physicsshapequeryparameters.rst +++ b/classes/class_physicsshapequeryparameters.rst @@ -19,9 +19,9 @@ Member Functions ---------------- +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_exclude` **(** **)** const | +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | +| :ref:`Array` | :ref:`get_exclude` **(** **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_margin` **(** **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ @@ -31,9 +31,9 @@ Member Functions +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_transform` **(** **)** const | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | +| void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` layer_mask **)** | +| void | :ref:`set_exclude` **(** :ref:`Array` exclude **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_margin` **(** :ref:`float` margin **)** | +------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ @@ -49,14 +49,14 @@ Member Functions Member Function Description --------------------------- +.. _class_PhysicsShapeQueryParameters_get_collision_layer: + +- :ref:`int` **get_collision_layer** **(** **)** const + .. _class_PhysicsShapeQueryParameters_get_exclude: - :ref:`Array` **get_exclude** **(** **)** const -.. _class_PhysicsShapeQueryParameters_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const - .. _class_PhysicsShapeQueryParameters_get_margin: - :ref:`float` **get_margin** **(** **)** const @@ -73,14 +73,14 @@ Member Function Description - :ref:`Transform` **get_transform** **(** **)** const +.. _class_PhysicsShapeQueryParameters_set_collision_layer: + +- void **set_collision_layer** **(** :ref:`int` collision_layer **)** + .. _class_PhysicsShapeQueryParameters_set_exclude: - void **set_exclude** **(** :ref:`Array` exclude **)** -.. _class_PhysicsShapeQueryParameters_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`int` layer_mask **)** - .. _class_PhysicsShapeQueryParameters_set_margin: - void **set_margin** **(** :ref:`float` margin **)** diff --git a/classes/class_planemesh.rst b/classes/class_planemesh.rst new file mode 100644 index 000000000..215f91539 --- /dev/null +++ b/classes/class_planemesh.rst @@ -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` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_depth` **(** :ref:`int` subdivide **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_width` **(** :ref:`int` subdivide **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Vector2` **size** +- :ref:`int` **subdivide_depth** +- :ref:`int` **subdivide_width** + +Member Function Description +--------------------------- + +.. _class_PlaneMesh_get_size: + +- :ref:`Vector2` **get_size** **(** **)** const + +.. _class_PlaneMesh_get_subdivide_depth: + +- :ref:`int` **get_subdivide_depth** **(** **)** const + +.. _class_PlaneMesh_get_subdivide_width: + +- :ref:`int` **get_subdivide_width** **(** **)** const + +.. _class_PlaneMesh_set_size: + +- void **set_size** **(** :ref:`Vector2` size **)** + +.. _class_PlaneMesh_set_subdivide_depth: + +- void **set_subdivide_depth** **(** :ref:`int` subdivide **)** + +.. _class_PlaneMesh_set_subdivide_width: + +- void **set_subdivide_width** **(** :ref:`int` subdivide **)** + + diff --git a/classes/class_popup.rst b/classes/class_popup.rst index dcb47d89b..fd53566df 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -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` 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 ---------------- diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 0c8cf2435..f06d6d7f3 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -106,7 +106,11 @@ Signals ------- - **id_pressed** **(** :ref:`int` ID **)** +This event is emitted when an item of some id is pressed or its accelerator is activated. + - **index_pressed** **(** :ref:`int` index **)** +This event is emitted when an item of some index is pressed or its accelerator is activated. + Member Variables ---------------- diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst new file mode 100644 index 000000000..b39041320 --- /dev/null +++ b/classes/class_primitivemesh.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`PlaneMesh`, :ref:`CubeMesh`, :ref:`SphereMesh`, :ref:`CylinderMesh`, :ref:`CapsuleMesh`, :ref:`QuadMesh`, :ref:`PrismMesh` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------------+--------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Material` **material** + +Member Function Description +--------------------------- + +.. _class_PrimitiveMesh_get_material: + +- :ref:`Material` **get_material** **(** **)** const + +.. _class_PrimitiveMesh_set_material: + +- void **set_material** **(** :ref:`Material` material **)** + + diff --git a/classes/class_prismmesh.rst b/classes/class_prismmesh.rst new file mode 100644 index 000000000..952128672 --- /dev/null +++ b/classes/class_prismmesh.rst @@ -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` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_left_to_right` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_size` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_depth` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_height` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_subdivide_width` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_left_to_right` **(** :ref:`float` left_to_right **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_size` **(** :ref:`Vector3` size **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_depth` **(** :ref:`int` segments **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_height` **(** :ref:`int` segments **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_subdivide_width` **(** :ref:`int` segments **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **left_to_right** +- :ref:`Vector2` **size** +- :ref:`int` **subdivide_depth** +- :ref:`int` **subdivide_height** +- :ref:`int` **subdivide_width** + +Member Function Description +--------------------------- + +.. _class_PrismMesh_get_left_to_right: + +- :ref:`float` **get_left_to_right** **(** **)** const + +.. _class_PrismMesh_get_size: + +- :ref:`Vector3` **get_size** **(** **)** const + +.. _class_PrismMesh_get_subdivide_depth: + +- :ref:`int` **get_subdivide_depth** **(** **)** const + +.. _class_PrismMesh_get_subdivide_height: + +- :ref:`int` **get_subdivide_height** **(** **)** const + +.. _class_PrismMesh_get_subdivide_width: + +- :ref:`int` **get_subdivide_width** **(** **)** const + +.. _class_PrismMesh_set_left_to_right: + +- void **set_left_to_right** **(** :ref:`float` left_to_right **)** + +.. _class_PrismMesh_set_size: + +- void **set_size** **(** :ref:`Vector3` size **)** + +.. _class_PrismMesh_set_subdivide_depth: + +- void **set_subdivide_depth** **(** :ref:`int` segments **)** + +.. _class_PrismMesh_set_subdivide_height: + +- void **set_subdivide_height** **(** :ref:`int` segments **)** + +.. _class_PrismMesh_set_subdivide_width: + +- void **set_subdivide_width** **(** :ref:`int` segments **)** + + diff --git a/classes/class_proceduralsky.rst b/classes/class_proceduralsky.rst new file mode 100644 index 000000000..e4d3bff3e --- /dev/null +++ b/classes/class_proceduralsky.rst @@ -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` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ground_bottom_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ground_curve` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_ground_energy` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_ground_horizon_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sky_curve` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sky_energy` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_sky_horizon_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_sky_top_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_angle_max` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_angle_min` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_sun_color` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_curve` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_energy` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_latitude` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_sun_longitude` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_texture_size` **(** **)** const | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ground_bottom_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ground_curve` **(** :ref:`float` curve **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ground_energy` **(** :ref:`float` energy **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ground_horizon_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_curve` **(** :ref:`float` curve **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_energy` **(** :ref:`float` energy **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_horizon_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sky_top_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_angle_max` **(** :ref:`float` degrees **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_angle_min` **(** :ref:`float` degrees **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_color` **(** :ref:`Color` color **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_curve` **(** :ref:`float` curve **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_energy` **(** :ref:`float` energy **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_latitude` **(** :ref:`float` degrees **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_sun_longitude` **(** :ref:`float` degrees **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture_size` **(** :ref:`int` size **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Color` **ground_bottom_color** +- :ref:`float` **ground_curve** +- :ref:`float` **ground_energy** +- :ref:`Color` **ground_horizon_color** +- :ref:`float` **sky_curve** +- :ref:`float` **sky_energy** +- :ref:`Color` **sky_horizon_color** +- :ref:`Color` **sky_top_color** +- :ref:`float` **sun_angle_max** +- :ref:`float` **sun_angle_min** +- :ref:`Color` **sun_color** +- :ref:`float` **sun_curve** +- :ref:`float` **sun_energy** +- :ref:`float` **sun_latitude** +- :ref:`float` **sun_longitude** +- :ref:`int` **texture_size** + +Member Function Description +--------------------------- + +.. _class_ProceduralSky_get_ground_bottom_color: + +- :ref:`Color` **get_ground_bottom_color** **(** **)** const + +.. _class_ProceduralSky_get_ground_curve: + +- :ref:`float` **get_ground_curve** **(** **)** const + +.. _class_ProceduralSky_get_ground_energy: + +- :ref:`float` **get_ground_energy** **(** **)** const + +.. _class_ProceduralSky_get_ground_horizon_color: + +- :ref:`Color` **get_ground_horizon_color** **(** **)** const + +.. _class_ProceduralSky_get_sky_curve: + +- :ref:`float` **get_sky_curve** **(** **)** const + +.. _class_ProceduralSky_get_sky_energy: + +- :ref:`float` **get_sky_energy** **(** **)** const + +.. _class_ProceduralSky_get_sky_horizon_color: + +- :ref:`Color` **get_sky_horizon_color** **(** **)** const + +.. _class_ProceduralSky_get_sky_top_color: + +- :ref:`Color` **get_sky_top_color** **(** **)** const + +.. _class_ProceduralSky_get_sun_angle_max: + +- :ref:`float` **get_sun_angle_max** **(** **)** const + +.. _class_ProceduralSky_get_sun_angle_min: + +- :ref:`float` **get_sun_angle_min** **(** **)** const + +.. _class_ProceduralSky_get_sun_color: + +- :ref:`Color` **get_sun_color** **(** **)** const + +.. _class_ProceduralSky_get_sun_curve: + +- :ref:`float` **get_sun_curve** **(** **)** const + +.. _class_ProceduralSky_get_sun_energy: + +- :ref:`float` **get_sun_energy** **(** **)** const + +.. _class_ProceduralSky_get_sun_latitude: + +- :ref:`float` **get_sun_latitude** **(** **)** const + +.. _class_ProceduralSky_get_sun_longitude: + +- :ref:`float` **get_sun_longitude** **(** **)** const + +.. _class_ProceduralSky_get_texture_size: + +- :ref:`int` **get_texture_size** **(** **)** const + +.. _class_ProceduralSky_set_ground_bottom_color: + +- void **set_ground_bottom_color** **(** :ref:`Color` color **)** + +.. _class_ProceduralSky_set_ground_curve: + +- void **set_ground_curve** **(** :ref:`float` curve **)** + +.. _class_ProceduralSky_set_ground_energy: + +- void **set_ground_energy** **(** :ref:`float` energy **)** + +.. _class_ProceduralSky_set_ground_horizon_color: + +- void **set_ground_horizon_color** **(** :ref:`Color` color **)** + +.. _class_ProceduralSky_set_sky_curve: + +- void **set_sky_curve** **(** :ref:`float` curve **)** + +.. _class_ProceduralSky_set_sky_energy: + +- void **set_sky_energy** **(** :ref:`float` energy **)** + +.. _class_ProceduralSky_set_sky_horizon_color: + +- void **set_sky_horizon_color** **(** :ref:`Color` color **)** + +.. _class_ProceduralSky_set_sky_top_color: + +- void **set_sky_top_color** **(** :ref:`Color` color **)** + +.. _class_ProceduralSky_set_sun_angle_max: + +- void **set_sun_angle_max** **(** :ref:`float` degrees **)** + +.. _class_ProceduralSky_set_sun_angle_min: + +- void **set_sun_angle_min** **(** :ref:`float` degrees **)** + +.. _class_ProceduralSky_set_sun_color: + +- void **set_sun_color** **(** :ref:`Color` color **)** + +.. _class_ProceduralSky_set_sun_curve: + +- void **set_sun_curve** **(** :ref:`float` curve **)** + +.. _class_ProceduralSky_set_sun_energy: + +- void **set_sun_energy** **(** :ref:`float` energy **)** + +.. _class_ProceduralSky_set_sun_latitude: + +- void **set_sun_latitude** **(** :ref:`float` degrees **)** + +.. _class_ProceduralSky_set_sun_longitude: + +- void **set_sun_longitude** **(** :ref:`float` degrees **)** + +.. _class_ProceduralSky_set_texture_size: + +- void **set_texture_size** **(** :ref:`int` size **)** + + diff --git a/classes/class_quad.rst b/classes/class_quad.rst deleted file mode 100644 index d709f08ea..000000000 --- a/classes/class_quad.rst +++ /dev/null @@ -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` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+--------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_axis` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------+ -| void | :ref:`set_axis` **(** :ref:`int` axis **)** | -+--------------------------------+---------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+--------------------------------+---------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+---------------------------------------------------------------------------------------------+ -| void | :ref:`set_size` **(** :ref:`Vector2` size **)** | -+--------------------------------+---------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`int` **axis** -- :ref:`bool` **centered** -- :ref:`Vector2` **offset** -- :ref:`Vector2` **size** - -Member Function Description ---------------------------- - -.. _class_Quad_get_axis: - -- :ref:`int` **get_axis** **(** **)** const - -.. _class_Quad_get_offset: - -- :ref:`Vector2` **get_offset** **(** **)** const - -.. _class_Quad_get_size: - -- :ref:`Vector2` **get_size** **(** **)** const - -.. _class_Quad_is_centered: - -- :ref:`bool` **is_centered** **(** **)** const - -.. _class_Quad_set_axis: - -- void **set_axis** **(** :ref:`int` axis **)** - -.. _class_Quad_set_centered: - -- void **set_centered** **(** :ref:`bool` centered **)** - -.. _class_Quad_set_offset: - -- void **set_offset** **(** :ref:`Vector2` offset **)** - -.. _class_Quad_set_size: - -- void **set_size** **(** :ref:`Vector2` size **)** - - diff --git a/classes/class_quadmesh.rst b/classes/class_quadmesh.rst index 0d8204cdc..d08ab2634 100644 --- a/classes/class_quadmesh.rst +++ b/classes/class_quadmesh.rst @@ -6,7 +6,7 @@ QuadMesh ======== -**Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core @@ -15,29 +15,3 @@ Brief Description -Member Functions ----------------- - -+----------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_material` **(** **)** const | -+----------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+----------------------------------+---------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`Material` **material** - -Member Function Description ---------------------------- - -.. _class_QuadMesh_get_material: - -- :ref:`Material` **get_material** **(** **)** const - -.. _class_QuadMesh_set_material: - -- void **set_material** **(** :ref:`Material` material **)** - - diff --git a/classes/class_quat.rst b/classes/class_quat.rst index 1eddd027c..bff251afa 100644 --- a/classes/class_quat.rst +++ b/classes/class_quat.rst @@ -29,6 +29,8 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Quat` | :ref:`inverse` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | @@ -90,6 +92,12 @@ Returns the dot product of two quaternions. Returns the inverse of the quaternion. +.. _class_Quat_is_normalized: + +- :ref:`bool` **is_normalized** **(** **)** + +Returns whether the quaternion is normalized or not. + .. _class_Quat_length: - :ref:`float` **length** **(** **)** diff --git a/classes/class_range.rst b/classes/class_range.rst index e92a0baea..7070a7b83 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -62,7 +62,11 @@ Signals ------- - **changed** **(** **)** +This signal is emitted when min, max, range or step change. + - **value_changed** **(** :ref:`float` value **)** +This signal is emitted when value changes. + Member Variables ---------------- diff --git a/classes/class_raycast.rst b/classes/class_raycast.rst index ac9a4a07c..bc55f061a 100644 --- a/classes/class_raycast.rst +++ b/classes/class_raycast.rst @@ -33,12 +33,12 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_collision_point` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_type_mask` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_colliding` **(** **)** const | @@ -51,9 +51,9 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cast_to` **(** :ref:`Vector3` local_point **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | +| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------+ | void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------+ @@ -62,8 +62,8 @@ Member Variables ---------------- - :ref:`Vector3` **cast_to** +- :ref:`int` **collision_layer** - :ref:`bool` **enabled** -- :ref:`int` **layer_mask** - :ref:`int` **type_mask** Description @@ -126,6 +126,12 @@ Return the closest object the ray is pointing to. Note that this does not consid Returns the collision shape of the closest object the ray is pointing to. +.. _class_RayCast_get_collision_layer: + +- :ref:`int` **get_collision_layer** **(** **)** const + +Returns the collision layer for this ray. + .. _class_RayCast_get_collision_normal: - :ref:`Vector3` **get_collision_normal** **(** **)** const @@ -138,12 +144,6 @@ Returns the normal of the intersecting object shape face containing the collisio Returns collision point. This point is in **global** coordinate system. -.. _class_RayCast_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const - -Returns the layer mask for this ray. - .. _class_RayCast_get_type_mask: - :ref:`int` **get_type_mask** **(** **)** const @@ -178,18 +178,18 @@ Removes a collision exception so the ray does report collisions with the specifi Sets to which point ray should be casted. This point is in **local** coordinate system. +.. _class_RayCast_set_collision_layer: + +- void **set_collision_layer** **(** :ref:`int` layer **)** + +Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + .. _class_RayCast_set_enabled: - void **set_enabled** **(** :ref:`bool` enabled **)** Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. -.. _class_RayCast_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`int` mask **)** - -Set the mask to filter objects. Only objects with at least the same mask element set will be detected. - .. _class_RayCast_set_type_mask: - void **set_type_mask** **(** :ref:`int` mask **)** diff --git a/classes/class_raycast2d.rst b/classes/class_raycast2d.rst index 823ff1688..0fa709464 100644 --- a/classes/class_raycast2d.rst +++ b/classes/class_raycast2d.rst @@ -33,14 +33,14 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collider_shape` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_collision_point` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_exclude_parent_body` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_layer_mask` **(** **)** const | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_type_mask` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_colliding` **(** **)** const | @@ -53,12 +53,12 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cast_to` **(** :ref:`Vector2` local_point **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_exclude_parent_body` **(** :ref:`bool` mask **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_layer_mask` **(** :ref:`int` mask **)** | -+--------------------------------+--------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_type_mask` **(** :ref:`int` mask **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------+ @@ -66,9 +66,9 @@ Member Variables ---------------- - :ref:`Vector2` **cast_to** +- :ref:`int` **collision_layer** - :ref:`bool` **enabled** - :ref:`bool` **exclude_parent** -- :ref:`int` **layer_mask** - :ref:`int` **type_mask** Description @@ -131,6 +131,12 @@ Return the closest object the ray is pointing to. Note that this does not consid Returns the collision shape of the closest object the ray is pointing to. +.. _class_RayCast2D_get_collision_layer: + +- :ref:`int` **get_collision_layer** **(** **)** const + +Returns the collision layer for this ray. + .. _class_RayCast2D_get_collision_normal: - :ref:`Vector2` **get_collision_normal** **(** **)** const @@ -149,12 +155,6 @@ Returns the collision point in which the ray intersects the closest object. This Returns whether this ray should hit your parent node, if it's a body. -.. _class_RayCast2D_get_layer_mask: - -- :ref:`int` **get_layer_mask** **(** **)** const - -Returns the layer mask for this ray. - .. _class_RayCast2D_get_type_mask: - :ref:`int` **get_type_mask** **(** **)** const @@ -189,6 +189,12 @@ Removes a collision exception so the ray does report collisions with the specifi Sets the ray destination point, so that the ray will test from the ray's origin to ``local_point`` +.. _class_RayCast2D_set_collision_layer: + +- void **set_collision_layer** **(** :ref:`int` layer **)** + +Set the mask to filter objects. Only objects with at least the same mask element set will be detected. + .. _class_RayCast2D_set_enabled: - void **set_enabled** **(** :ref:`bool` enabled **)** @@ -201,12 +207,6 @@ Enables the RayCast2D. Only enabled raycasts will be able to query the space and Toggle whether this ray should hit your parent node, if it's a body. -.. _class_RayCast2D_set_layer_mask: - -- void **set_layer_mask** **(** :ref:`int` mask **)** - -Set the mask to filter objects. Only objects with at least the same mask element set will be detected. - .. _class_RayCast2D_set_type_mask: - void **set_type_mask** **(** :ref:`int` mask **)** diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index b5c45c129..bf539abe7 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -16,35 +16,39 @@ Brief Description Member Functions ---------------- -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` pos, :ref:`Vector2` size **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_area` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`grow` **(** :ref:`float` by **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** | -+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`Vector2` pos, :ref:`Vector2` size **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`Rect2` **(** :ref:`float` x, :ref:`float` y, :ref:`float` width, :ref:`float` height **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`clip` **(** :ref:`Rect2` b **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`encloses` **(** :ref:`Rect2` b **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`expand` **(** :ref:`Vector2` to **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_area` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow` **(** :ref:`float` by **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow_individual` **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`grow_margin` **(** :ref:`int` margin, :ref:`float` by **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_no_area` **(** **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`intersects` **(** :ref:`Rect2` b **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`merge` **(** :ref:`Rect2` b **)** | ++----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`Vector2` **end** - Ending corner. -- :ref:`Vector2` **pos** - Position (starting corner). +- :ref:`Vector2` **position** - :ref:`Vector2` **size** - Size from position to end. Description @@ -97,6 +101,14 @@ Get the area of the :ref:`Rect2`. Return a copy of the :ref:`Rect2` grown a given amount of units towards all the sides. +.. _class_Rect2_grow_individual: + +- :ref:`Rect2` **grow_individual** **(** :ref:`float` left, :ref:`float` top, :ref:`float` right, :ref:`float` bottom **)** + +.. _class_Rect2_grow_margin: + +- :ref:`Rect2` **grow_margin** **(** :ref:`int` margin, :ref:`float` by **)** + .. _class_Rect2_has_no_area: - :ref:`bool` **has_no_area** **(** **)** diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 7088c73ff..1fa2225ab 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -8,7 +8,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`GDFunctionState`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`GDFunctionState`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 0c868a043..8b1e1b124 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -8,7 +8,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`RegEx`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Shader`, :ref:`ColorRamp`, :ref:`StyleBox`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`PackedScene`, :ref:`Texture`, :ref:`Script`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`PolygonPathFinder`, :ref:`SkyBox`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`AudioEffect`, :ref:`DLLibrary`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`StyleBox`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`Texture`, :ref:`PackedScene`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`Script`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`RegEx`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`InputEvent`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core @@ -23,7 +23,7 @@ Member Functions +------------------------------+-----------------------------------------------------------------------------------------------------------+ | void | :ref:`_setup_local_to_scene` **(** **)** virtual | +------------------------------+-----------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** | +| :ref:`Object` | :ref:`duplicate` **(** :ref:`bool` subresources=false **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_local_scene` **(** **)** const | +------------------------------+-----------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ Member Function Description .. _class_Resource_duplicate: -- :ref:`Object` **duplicate** **(** :ref:`bool` subresources=false **)** +- :ref:`Object` **duplicate** **(** :ref:`bool` subresources=false **)** const .. _class_Resource_get_local_scene: diff --git a/classes/class_resourceinteractiveloader.rst b/classes/class_resourceinteractiveloader.rst index 621a8eb60..53a15ee45 100644 --- a/classes/class_resourceinteractiveloader.rst +++ b/classes/class_resourceinteractiveloader.rst @@ -60,7 +60,7 @@ Return the total amount of stages (calls to :ref:`poll` **poll** **(** **)** -Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. +Poll the load. If OK is returned, this means poll will have to be called again. If ERR_FILE_EOF is returned, them the load has finished and the resource can be obtained by calling :ref:`get_resource`. .. _class_ResourceInteractiveLoader_wait: diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 49ccc5a2d..dafe1b78a 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -100,10 +100,24 @@ Signals ------- - **body_entered** **(** :ref:`Object` body **)** +Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + - **body_exited** **(** :ref:`Object` body **)** +Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + +This signal not only receives the body that collided with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. + - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + +This signal not only receives the body that stopped colliding with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. + - **sleeping_state_changed** **(** **)** +Emitted when the body changes its sleeping state. Either by sleeping or waking up. + Member Variables ---------------- diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 71f62f24a..7abfcb6b0 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -112,10 +112,24 @@ Signals ------- - **body_entered** **(** :ref:`Object` body **)** +Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + - **body_exited** **(** :ref:`Object` body **)** +Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + - **body_shape_entered** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + +This signal not only receives the body that collided with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. + - **body_shape_exited** **(** :ref:`int` body_id, :ref:`Object` body, :ref:`int` body_shape, :ref:`int` local_shape **)** +Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + +This signal not only receives the body that stopped colliding with this one, but also its :ref:`RID` (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. + - **sleeping_state_changed** **(** **)** +Emitted when the body changes its sleeping state. Either by sleeping or waking up. + Member Variables ---------------- diff --git a/classes/class_script.rst b/classes/class_script.rst index 3afc4e52e..6dc9555c3 100644 --- a/classes/class_script.rst +++ b/classes/class_script.rst @@ -8,7 +8,7 @@ Script **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`DLScript` +**Inherited By:** :ref:`VisualScript`, :ref:`GDScript`, :ref:`GDNativeScript` **Category:** Core diff --git a/classes/class_skybox.rst b/classes/class_sky.rst similarity index 62% rename from classes/class_skybox.rst rename to classes/class_sky.rst index b5e61a740..c4ac8d76c 100644 --- a/classes/class_skybox.rst +++ b/classes/class_sky.rst @@ -1,14 +1,14 @@ .. 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_SkyBox: +.. _class_Sky: -SkyBox -====== +Sky +=== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`ImageSkyBox` +**Inherited By:** :ref:`PanoramaSky`, :ref:`ProceduralSky` **Category:** Core @@ -20,11 +20,11 @@ Brief Description Member Functions ---------------- -+------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_radiance_size` **(** **)** const | -+------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radiance_size` **(** :ref:`int` size **)** | -+------------------------+---------------------------------------------------------------------------------------------------+ ++------------------------+------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radiance_size` **(** **)** const | ++------------------------+------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radiance_size` **(** :ref:`int` size **)** | ++------------------------+------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -43,11 +43,11 @@ Numeric Constants Member Function Description --------------------------- -.. _class_SkyBox_get_radiance_size: +.. _class_Sky_get_radiance_size: - :ref:`int` **get_radiance_size** **(** **)** const -.. _class_SkyBox_set_radiance_size: +.. _class_Sky_set_radiance_size: - void **set_radiance_size** **(** :ref:`int` size **)** diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index 9a0691d53..c7f32dcc3 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -154,10 +154,14 @@ Return the parent :ref:`Spatial`, or an empty :ref:`Object` **get_rotation** **(** **)** const +Return the rotation (in radians). + .. _class_Spatial_get_rotation_deg: - :ref:`Vector3` **get_rotation_deg** **(** **)** const +Return the rotation (in degrees). + .. _class_Spatial_get_scale: - :ref:`Vector3` **get_scale** **(** **)** const @@ -270,10 +274,14 @@ Set the transform globally, relative to worldspace. - void **set_rotation** **(** :ref:`Vector3` rotation_rad **)** +Set the rotation (in radians). + .. _class_Spatial_set_rotation_deg: - void **set_rotation_deg** **(** :ref:`Vector3` rotation_deg **)** +Set the rotation (in degrees). + .. _class_Spatial_set_scale: - void **set_scale** **(** :ref:`Vector3` scale **)** diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 82f225a61..007998d78 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -33,8 +33,14 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cull_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_depth_deep_parallax_max_layers` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_depth_deep_parallax_min_layers` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_depth_draw_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_depth_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_detail_blend_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_detail_uv` **(** **)** const | @@ -49,11 +55,9 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag` **(** :ref:`int` arg0 **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_height_scale` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_line_width` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_metalness` **(** **)** const | +| :ref:`float` | :ref:`get_metallic` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_normal_scale` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -67,17 +71,13 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_refraction` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_refraction_roughness` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rim` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_rim_tint` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_roughness` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_specular` **(** **)** const | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_specular_mode` **(** **)** const | +| :ref:`float` | :ref:`get_specular` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_subsurface_scattering_strength` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,6 +91,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_uv2_scale` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_depth_deep_parallax_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_albedo` **(** :ref:`Color` albedo **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_anisotropy` **(** :ref:`float` anisotropy **)** | @@ -105,8 +107,16 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cull_mode` **(** :ref:`int` cull_mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_deep_parallax` **(** :ref:`bool` enable **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_deep_parallax_max_layers` **(** :ref:`int` layer **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_deep_parallax_min_layers` **(** :ref:`int` layer **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_depth_draw_mode` **(** :ref:`int` depth_draw_mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_depth_scale` **(** :ref:`float` depth_scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_detail_blend_mode` **(** :ref:`int` detail_blend_mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_detail_uv` **(** :ref:`int` detail_uv **)** | @@ -121,11 +131,9 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_height_scale` **(** :ref:`float` height_scale **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_line_width` **(** :ref:`float` line_width **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metalness` **(** :ref:`float` metalness **)** | +| void | :ref:`set_metallic` **(** :ref:`float` metallic **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_normal_scale` **(** :ref:`float` normal_scale **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -139,17 +147,13 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_refraction` **(** :ref:`float` refraction **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_refraction_roughness` **(** :ref:`float` refraction_roughness **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rim` **(** :ref:`float` rim **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rim_tint` **(** :ref:`float` rim_tint **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_roughness` **(** :ref:`float` roughness **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_specular` **(** :ref:`Color` specular **)** | -+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_specular_mode` **(** :ref:`int` specular_mode **)** | +| void | :ref:`set_specular` **(** :ref:`float` specular **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_subsurface_scattering_strength` **(** :ref:`float` strength **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -178,6 +182,12 @@ Member Variables - :ref:`bool` **clearcoat_enabled** - :ref:`float` **clearcoat_gloss** - :ref:`Texture` **clearcoat_texture** +- :ref:`bool` **depth_deep_parallax** +- :ref:`bool` **depth_enabled** +- :ref:`int` **depth_max_layers** +- :ref:`int` **depth_min_layers** +- :ref:`float` **depth_scale** +- :ref:`Texture` **depth_texture** - :ref:`Texture` **detail_albedo** - :ref:`int` **detail_blend_mode** - :ref:`bool` **detail_enabled** @@ -193,9 +203,9 @@ Member Variables - :ref:`bool` **flags_transparent** - :ref:`bool` **flags_unshaded** - :ref:`bool` **flags_use_point_size** -- :ref:`bool` **height_enabled** -- :ref:`float` **height_scale** -- :ref:`Texture` **height_texture** +- :ref:`float` **metallic_amount** +- :ref:`float` **metallic_specular** +- :ref:`Texture` **metallic_texture** - :ref:`bool` **normal_enabled** - :ref:`float` **normal_scale** - :ref:`Texture` **normal_texture** @@ -209,19 +219,15 @@ Member Variables - :ref:`int` **particles_anim_h_frames** - :ref:`bool` **particles_anim_loop** - :ref:`int` **particles_anim_v_frames** -- :ref:`float` **refraction_displacement** - :ref:`bool` **refraction_enabled** -- :ref:`float` **refraction_roughness** +- :ref:`float` **refraction_scale** - :ref:`Texture` **refraction_texture** - :ref:`float` **rim_amount** - :ref:`bool` **rim_enabled** - :ref:`Texture` **rim_texture** - :ref:`float` **rim_tint** -- :ref:`Color` **specular_color** -- :ref:`float` **specular_metalness** -- :ref:`int` **specular_mode** -- :ref:`float` **specular_roughness** -- :ref:`Texture` **specular_texture** +- :ref:`float` **roughness_amount** +- :ref:`Texture` **roughness_texture** - :ref:`bool` **subsurf_scatter_enabled** - :ref:`float` **subsurf_scatter_strength** - :ref:`Texture` **subsurf_scatter_texture** @@ -236,17 +242,17 @@ Numeric Constants ----------------- - **TEXTURE_ALBEDO** = **0** -- **TEXTURE_SPECULAR** = **1** -- **TEXTURE_EMISSION** = **2** -- **TEXTURE_NORMAL** = **3** -- **TEXTURE_RIM** = **4** -- **TEXTURE_CLEARCOAT** = **5** -- **TEXTURE_FLOWMAP** = **6** -- **TEXTURE_AMBIENT_OCCLUSION** = **7** -- **TEXTURE_HEIGHT** = **8** -- **TEXTURE_SUBSURFACE_SCATTERING** = **9** -- **TEXTURE_REFRACTION** = **10** -- **TEXTURE_REFRACTION_ROUGHNESS** = **11** +- **TEXTURE_METALLIC** = **1** +- **TEXTURE_ROUGHNESS** = **2** +- **TEXTURE_EMISSION** = **3** +- **TEXTURE_NORMAL** = **4** +- **TEXTURE_RIM** = **5** +- **TEXTURE_CLEARCOAT** = **6** +- **TEXTURE_FLOWMAP** = **7** +- **TEXTURE_AMBIENT_OCCLUSION** = **8** +- **TEXTURE_DEPTH** = **9** +- **TEXTURE_SUBSURFACE_SCATTERING** = **10** +- **TEXTURE_REFRACTION** = **11** - **TEXTURE_DETAIL_MASK** = **12** - **TEXTURE_DETAIL_ALBEDO** = **13** - **TEXTURE_DETAIL_NORMAL** = **14** @@ -260,7 +266,7 @@ Numeric Constants - **FEATURE_CLEARCOAT** = **4** - **FEATURE_ANISOTROPY** = **5** - **FEATURE_AMBIENT_OCCLUSION** = **6** -- **FEATURE_HEIGHT_MAPPING** = **7** +- **FEATURE_DEPTH_MAPPING** = **7** - **FEATURE_SUBSURACE_SCATTERING** = **8** - **FEATURE_REFRACTION** = **9** - **FEATURE_DETAIL** = **10** @@ -284,11 +290,9 @@ Numeric Constants - **FLAG_FIXED_SIZE** = **5** - **FLAG_MAX** = **6** - **DIFFUSE_LAMBERT** = **0** -- **DIFFUSE_LAMBERT_WRAP** = **1** +- **DIFFUSE_HALF_LAMBERT** = **1** - **DIFFUSE_OREN_NAYAR** = **2** - **DIFFUSE_BURLEY** = **3** -- **SPECULAR_MODE_METALLIC** = **0** -- **SPECULAR_MODE_SPECULAR** = **1** - **BILLBOARD_DISABLED** = **0** - **BILLBOARD_ENABLED** = **1** - **BILLBOARD_FIXED_Y** = **2** @@ -325,10 +329,22 @@ Member Function Description - :ref:`int` **get_cull_mode** **(** **)** const +.. _class_SpatialMaterial_get_depth_deep_parallax_max_layers: + +- :ref:`int` **get_depth_deep_parallax_max_layers** **(** **)** const + +.. _class_SpatialMaterial_get_depth_deep_parallax_min_layers: + +- :ref:`int` **get_depth_deep_parallax_min_layers** **(** **)** const + .. _class_SpatialMaterial_get_depth_draw_mode: - :ref:`int` **get_depth_draw_mode** **(** **)** const +.. _class_SpatialMaterial_get_depth_scale: + +- :ref:`float` **get_depth_scale** **(** **)** const + .. _class_SpatialMaterial_get_detail_blend_mode: - :ref:`int` **get_detail_blend_mode** **(** **)** const @@ -357,17 +373,13 @@ Member Function Description - :ref:`bool` **get_flag** **(** :ref:`int` arg0 **)** const -.. _class_SpatialMaterial_get_height_scale: - -- :ref:`float` **get_height_scale** **(** **)** const - .. _class_SpatialMaterial_get_line_width: - :ref:`float` **get_line_width** **(** **)** const -.. _class_SpatialMaterial_get_metalness: +.. _class_SpatialMaterial_get_metallic: -- :ref:`float` **get_metalness** **(** **)** const +- :ref:`float` **get_metallic** **(** **)** const .. _class_SpatialMaterial_get_normal_scale: @@ -393,10 +405,6 @@ Member Function Description - :ref:`float` **get_refraction** **(** **)** const -.. _class_SpatialMaterial_get_refraction_roughness: - -- :ref:`float` **get_refraction_roughness** **(** **)** const - .. _class_SpatialMaterial_get_rim: - :ref:`float` **get_rim** **(** **)** const @@ -411,11 +419,7 @@ Member Function Description .. _class_SpatialMaterial_get_specular: -- :ref:`Color` **get_specular** **(** **)** const - -.. _class_SpatialMaterial_get_specular_mode: - -- :ref:`int` **get_specular_mode** **(** **)** const +- :ref:`float` **get_specular** **(** **)** const .. _class_SpatialMaterial_get_subsurface_scattering_strength: @@ -441,6 +445,10 @@ Member Function Description - :ref:`Vector2` **get_uv2_scale** **(** **)** const +.. _class_SpatialMaterial_is_depth_deep_parallax_enabled: + +- :ref:`bool` **is_depth_deep_parallax_enabled** **(** **)** const + .. _class_SpatialMaterial_set_albedo: - void **set_albedo** **(** :ref:`Color` albedo **)** @@ -469,10 +477,26 @@ Member Function Description - void **set_cull_mode** **(** :ref:`int` cull_mode **)** +.. _class_SpatialMaterial_set_depth_deep_parallax: + +- void **set_depth_deep_parallax** **(** :ref:`bool` enable **)** + +.. _class_SpatialMaterial_set_depth_deep_parallax_max_layers: + +- void **set_depth_deep_parallax_max_layers** **(** :ref:`int` layer **)** + +.. _class_SpatialMaterial_set_depth_deep_parallax_min_layers: + +- void **set_depth_deep_parallax_min_layers** **(** :ref:`int` layer **)** + .. _class_SpatialMaterial_set_depth_draw_mode: - void **set_depth_draw_mode** **(** :ref:`int` depth_draw_mode **)** +.. _class_SpatialMaterial_set_depth_scale: + +- void **set_depth_scale** **(** :ref:`float` depth_scale **)** + .. _class_SpatialMaterial_set_detail_blend_mode: - void **set_detail_blend_mode** **(** :ref:`int` detail_blend_mode **)** @@ -501,17 +525,13 @@ Member Function Description - void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** -.. _class_SpatialMaterial_set_height_scale: - -- void **set_height_scale** **(** :ref:`float` height_scale **)** - .. _class_SpatialMaterial_set_line_width: - void **set_line_width** **(** :ref:`float` line_width **)** -.. _class_SpatialMaterial_set_metalness: +.. _class_SpatialMaterial_set_metallic: -- void **set_metalness** **(** :ref:`float` metalness **)** +- void **set_metallic** **(** :ref:`float` metallic **)** .. _class_SpatialMaterial_set_normal_scale: @@ -537,10 +557,6 @@ Member Function Description - void **set_refraction** **(** :ref:`float` refraction **)** -.. _class_SpatialMaterial_set_refraction_roughness: - -- void **set_refraction_roughness** **(** :ref:`float` refraction_roughness **)** - .. _class_SpatialMaterial_set_rim: - void **set_rim** **(** :ref:`float` rim **)** @@ -555,11 +571,7 @@ Member Function Description .. _class_SpatialMaterial_set_specular: -- void **set_specular** **(** :ref:`Color` specular **)** - -.. _class_SpatialMaterial_set_specular_mode: - -- void **set_specular_mode** **(** :ref:`int` specular_mode **)** +- void **set_specular** **(** :ref:`float` specular **)** .. _class_SpatialMaterial_set_subsurface_scattering_strength: diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst new file mode 100644 index 000000000..05d23c37b --- /dev/null +++ b/classes/class_spheremesh.rst @@ -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_SphereMesh: + +SphereMesh +========== + +**Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_height` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_is_hemisphere` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_radial_segments` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_radius` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rings` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_height` **(** :ref:`float` height **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_is_hemisphere` **(** :ref:`bool` is_hemisphere **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radial_segments` **(** :ref:`int` radial_segments **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_radius` **(** :ref:`float` radius **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_rings` **(** :ref:`int` rings **)** | ++----------------------------+----------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`float` **height** +- :ref:`bool` **is_hemisphere** +- :ref:`int` **radial_segments** +- :ref:`float` **radius** +- :ref:`int` **rings** + +Member Function Description +--------------------------- + +.. _class_SphereMesh_get_height: + +- :ref:`float` **get_height** **(** **)** const + +.. _class_SphereMesh_get_is_hemisphere: + +- :ref:`bool` **get_is_hemisphere** **(** **)** const + +.. _class_SphereMesh_get_radial_segments: + +- :ref:`int` **get_radial_segments** **(** **)** const + +.. _class_SphereMesh_get_radius: + +- :ref:`float` **get_radius** **(** **)** const + +.. _class_SphereMesh_get_rings: + +- :ref:`int` **get_rings** **(** **)** const + +.. _class_SphereMesh_set_height: + +- void **set_height** **(** :ref:`float` height **)** + +.. _class_SphereMesh_set_is_hemisphere: + +- void **set_is_hemisphere** **(** :ref:`bool` is_hemisphere **)** + +.. _class_SphereMesh_set_radial_segments: + +- void **set_radial_segments** **(** :ref:`int` radial_segments **)** + +.. _class_SphereMesh_set_radius: + +- void **set_radius** **(** :ref:`float` radius **)** + +.. _class_SphereMesh_set_rings: + +- void **set_rings** **(** :ref:`int` rings **)** + + diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 761315273..d9e64db3f 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -38,6 +38,8 @@ Signals ------- - **dragged** **(** :ref:`int` offset **)** +Emitted when the dragger is dragged by user. + Member Variables ---------------- diff --git a/classes/class_string.rst b/classes/class_string.rst index 664f02566..2724d023b 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -47,8 +47,6 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`RID` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`String` **(** :ref:`InputEvent` from **)** | -+------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Dictionary` from **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`String` **(** :ref:`Array` from **)** | @@ -264,10 +262,6 @@ Member Function Description .. _class_String_String: -- :ref:`String` **String** **(** :ref:`InputEvent` from **)** - -.. _class_String_String: - - :ref:`String` **String** **(** :ref:`Dictionary` from **)** .. _class_String_String: diff --git a/classes/class_surfacetool.rst b/classes/class_surfacetool.rst index 01e606b27..5ed414058 100644 --- a/classes/class_surfacetool.rst +++ b/classes/class_surfacetool.rst @@ -18,48 +18,60 @@ Helper tool to create geometry. Member Functions ---------------- -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_color` **(** :ref:`Color` color **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_index` **(** :ref:`int` index **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`PoolColorArray` colors=PoolColorArray([PoolColorArray]), :ref:`PoolVector2Array` uv2s=PoolVector2Array([]), :ref:`PoolVector3Array` normals=PoolVector3Array([]), :ref:`Array` tangents=Array() **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`begin` **(** :ref:`int` primitive **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`commit` **(** :ref:`Mesh` existing=NULL **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deindex` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_normals` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`index` **(** **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`Material` material **)** | -+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bones` **(** :ref:`PoolIntArray` bones **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_color` **(** :ref:`Color` color **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_index` **(** :ref:`int` index **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_normal` **(** :ref:`Vector3` normal **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_smooth_group` **(** :ref:`bool` smooth **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_tangent` **(** :ref:`Plane` tangent **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_triangle_fan` **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`PoolColorArray` colors=PoolColorArray([PoolColorArray]), :ref:`PoolVector2Array` uv2s=PoolVector2Array([]), :ref:`PoolVector3Array` normals=PoolVector3Array([]), :ref:`Array` tangents=[] **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv` **(** :ref:`Vector2` uv **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_uv2` **(** :ref:`Vector2` uv2 **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_vertex` **(** :ref:`Vector3` vertex **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_weights` **(** :ref:`PoolRealArray` weights **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`begin` **(** :ref:`int` primitive **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`commit` **(** :ref:`Mesh` existing=NULL **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deindex` **(** **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_normals` **(** **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`index` **(** **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- -Helper tool to create geometry. +The :ref:`SurfaceTool` is used to construct a :ref:`Mesh` by specifying vertex attributes individually. It can be used to construct a :ref:`Mesh` from script. All properties except index need to be added before a call to :ref:`add_vertex`. For example adding vertex colors and UVs looks like + +:: + + var st = SurfaceTool.new() + st.begin(Mesh.PRIMITIVE_TRIANGLES) + st.add_color(Color(1, 0, 0)) + st.add_uv(Vector2(0, 0)) + st.add_vertex(Vector3(0, 0, 0)) + +The :ref:`SurfaceTool` now contains one vertex of a triangle which has a UV coordinate and a specified :ref:`Color`. If another vertex were added without calls to :ref:`add_uv` or :ref:`add_color` then the last values would be used. + +It is very important that vertex attributes are passed **before** the call to :ref:`add_vertex`, failure to do this will result in an error when committing the vertex information to a mesh. Member Function Description --------------------------- @@ -68,72 +80,108 @@ Member Function Description - void **add_bones** **(** :ref:`PoolIntArray` bones **)** +Add an array of bones for the next Vertex to use. + .. _class_SurfaceTool_add_color: - void **add_color** **(** :ref:`Color` color **)** +Specify a :ref:`Color` for the next Vertex to use. + .. _class_SurfaceTool_add_index: - void **add_index** **(** :ref:`int` index **)** +Adds an index to index array if you are using indexed Vertices. Does not need to be called before adding Vertex. + .. _class_SurfaceTool_add_normal: - void **add_normal** **(** :ref:`Vector3` normal **)** +Specify a normal for the next Vertex to use. + .. _class_SurfaceTool_add_smooth_group: - void **add_smooth_group** **(** :ref:`bool` smooth **)** +Specify whether current Vertex (if using only Vertex arrays) or current index (if also using index arrays) should utilize smooth normals for normal calculation. + .. _class_SurfaceTool_add_tangent: - void **add_tangent** **(** :ref:`Plane` tangent **)** +Specify a Tangent for the next Vertex to use. + .. _class_SurfaceTool_add_triangle_fan: -- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`PoolColorArray` colors=PoolColorArray([PoolColorArray]), :ref:`PoolVector2Array` uv2s=PoolVector2Array([]), :ref:`PoolVector3Array` normals=PoolVector3Array([]), :ref:`Array` tangents=Array() **)** +- void **add_triangle_fan** **(** :ref:`PoolVector3Array` vertexes, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`PoolColorArray` colors=PoolColorArray([PoolColorArray]), :ref:`PoolVector2Array` uv2s=PoolVector2Array([]), :ref:`PoolVector3Array` normals=PoolVector3Array([]), :ref:`Array` tangents=[] **)** + +Insert a triangle fan made of array data into :ref:`Mesh` being constructed. .. _class_SurfaceTool_add_uv: - void **add_uv** **(** :ref:`Vector2` uv **)** +Specify UV Coordinate for next Vertex to use. + .. _class_SurfaceTool_add_uv2: - void **add_uv2** **(** :ref:`Vector2` uv2 **)** +Specify an optional second set of UV coordinates for next Vertex to use. + .. _class_SurfaceTool_add_vertex: - void **add_vertex** **(** :ref:`Vector3` vertex **)** +Specify position of current Vertex. Should be called after specifying other vertex properties (e.g. Color, UV). + .. _class_SurfaceTool_add_weights: - void **add_weights** **(** :ref:`PoolRealArray` weights **)** +Specify weight value for next Vertex to use. + .. _class_SurfaceTool_begin: - void **begin** **(** :ref:`int` primitive **)** +Called before adding any Vertices. Takes the primitive type as an argument (e.g. Mesh.PRIMITIVE_TRIANGLES). + .. _class_SurfaceTool_clear: - void **clear** **(** **)** +Clear all information passed into the surface tool so far. + .. _class_SurfaceTool_commit: - :ref:`Mesh` **commit** **(** :ref:`Mesh` existing=NULL **)** +Returns a constructed :ref:`Mesh` from current information passed in. If an existing :ref:`Mesh` is passed in as an argument, will add an extra surface to the existing :ref:`Mesh`. + .. _class_SurfaceTool_deindex: - void **deindex** **(** **)** +Removes index array by expanding Vertex array. + .. _class_SurfaceTool_generate_normals: - void **generate_normals** **(** **)** +Generates normals from Vertices so you do not have to do it manually. + .. _class_SurfaceTool_index: - void **index** **(** **)** +Shrinks Vertex array by creating an index array. Avoids reusing Vertices. + .. _class_SurfaceTool_set_material: - void **set_material** **(** :ref:`Material` material **)** +Sets :ref:`Material` to be used by the :ref:`Mesh` you are constructing. + diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 175cc8ff1..5f28b1347 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -61,7 +61,11 @@ Signals - **pre_popup_pressed** **(** **)** - **tab_changed** **(** :ref:`int` tab **)** +Emitted only when the current tab changes. + - **tab_selected** **(** :ref:`int` tab **)** +Emitted when a tab is being selected, even if it is the same tab. + Member Variables ---------------- diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index a00c754bd..80311fcf3 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -54,6 +54,7 @@ Signals - **right_button_pressed** **(** :ref:`int` tab **)** - **tab_changed** **(** :ref:`int` tab **)** - **tab_close** **(** :ref:`int` tab **)** +- **tab_hover** **(** :ref:`int` tab **)** Member Variables ---------------- diff --git a/classes/class_testcube.rst b/classes/class_testcube.rst deleted file mode 100644 index aaab67813..000000000 --- a/classes/class_testcube.rst +++ /dev/null @@ -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_TestCube: - -TestCube -======== - -**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -A simple cube used for testing in 3D. - -Description ------------ - -The TestCube is a simple 2x2x2 cube with a basic texture. It can be used as a placeholder, to verify how the lighting looks, to test shaders, or any other task you may need a textured model to test with. - diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 375c4247a..07730f4f6 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -45,9 +45,9 @@ Member Functions +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cursor_set_block_mode` **(** :ref:`bool` enable **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=false **)** | +| void | :ref:`cursor_set_column` **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=false **)** | +| void | :ref:`cursor_set_line` **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cut` **(** **)** | +------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -114,10 +114,16 @@ Signals ------- - **breakpoint_toggled** **(** :ref:`int` row **)** +Emitted when a breakpoint is placed via the breakpoint gutter. + - **cursor_changed** **(** **)** +Emitted when the cursor changes. + - **request_completion** **(** **)** - **symbol_lookup** **(** :ref:`String` symbol, :ref:`int` row, :ref:`int` column **)** - **text_changed** **(** **)** +Emitted when the text changes. + Member Variables ---------------- @@ -231,11 +237,11 @@ Set the text editor caret to block mode. .. _class_TextEdit_cursor_set_column: -- void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=false **)** +- void **cursor_set_column** **(** :ref:`int` column, :ref:`bool` adjust_viewport=true **)** .. _class_TextEdit_cursor_set_line: -- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=false **)** +- void **cursor_set_line** **(** :ref:`int` line, :ref:`bool` adjust_viewport=true **)** .. _class_TextEdit_cut: diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index afb9251fe..da00fd994 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -37,8 +37,12 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_layer` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_mask` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_use_kinematic` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_custom_transform` **(** **)** const | @@ -83,10 +87,14 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_friction` **(** :ref:`float` value **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` mask **)** | +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_use_kinematic` **(** :ref:`bool` use_kinematic **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_transform` **(** :ref:`Transform2D` custom_transform **)** | @@ -112,6 +120,8 @@ Signals ------- - **settings_changed** **(** **)** +Signal indicating that a tilemap setting has changed. + Member Variables ---------------- @@ -124,7 +134,7 @@ Member Variables - :ref:`bool` **cell_y_sort** - :ref:`float` **collision_bounce** - :ref:`float` **collision_friction** -- :ref:`int` **collision_layers** +- :ref:`int` **collision_layer** - :ref:`int` **collision_mask** - :ref:`bool` **collision_use_kinematic** - :ref:`int` **mode** @@ -210,12 +220,20 @@ Return the collision friction parameter. Return the collision layer. +.. _class_TileMap_get_collision_layer_bit: + +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const + .. _class_TileMap_get_collision_mask: - :ref:`int` **get_collision_mask** **(** **)** const Return the collision mask. +.. _class_TileMap_get_collision_mask_bit: + +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const + .. _class_TileMap_get_collision_use_kinematic: - :ref:`bool` **get_collision_use_kinematic** **(** **)** const @@ -356,12 +374,16 @@ Set the collision friction parameter. Allowable values range from 0 to 1. .. _class_TileMap_set_collision_layer: -- void **set_collision_layer** **(** :ref:`int` mask **)** +- void **set_collision_layer** **(** :ref:`int` layer **)** Set the collision layer. Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. +.. _class_TileMap_set_collision_layer_bit: + +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + .. _class_TileMap_set_collision_mask: - void **set_collision_mask** **(** :ref:`int` mask **)** @@ -370,6 +392,10 @@ Set the collision masks. Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. +.. _class_TileMap_set_collision_mask_bit: + +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + .. _class_TileMap_set_collision_use_kinematic: - void **set_collision_use_kinematic** **(** :ref:`bool` use_kinematic **)** diff --git a/classes/class_timer.rst b/classes/class_timer.rst index ab88e0dc7..422de54ca 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -52,6 +52,8 @@ Signals ------- - **timeout** **(** **)** +Emitted when the time runs out. + Member Variables ---------------- diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index fc53a7c01..38d0c8bd6 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -101,6 +101,8 @@ Return the inverse of the matrix. - :ref:`float` **get_rotation** **(** **)** +Return the rotation (in radians). + .. _class_Transform2D_get_scale: - :ref:`Vector2` **get_scale** **(** **)** diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 6cd8aaa15..518f79e18 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -92,15 +92,35 @@ Signals ------- - **button_pressed** **(** :ref:`Object` item, :ref:`int` column, :ref:`int` id **)** +Emitted when a button on the tree was pressed (see :ref:`TreeItem.add_button`). + - **cell_selected** **(** **)** +Emitted when a cell is selected. + +- **column_title_pressed** **(** :ref:`int` column **)** - **custom_popup_edited** **(** :ref:`bool` arrow_clicked **)** +Emitted when a cell with the ``CELL_MODE_CUSTOM`` is clicked to be edited. + - **empty_tree_rmb_selected** **(** :ref:`Vector2` pos **)** +Emitted when the right mouse button is pressed if RMB selection is active and the tree is empty. + - **item_activated** **(** **)** +Emitted when an item is activated (double-clicked). + - **item_collapsed** **(** :ref:`Object` item **)** +Emitted when an item is collapsed by a click on the folding arrow. + +- **item_custom_button_pressed** **(** **)** - **item_double_clicked** **(** **)** - **item_edited** **(** **)** +Emitted when an item is editted. + - **item_rmb_selected** **(** :ref:`Vector2` pos **)** +Emitted when an item is selected with right mouse button. + - **item_selected** **(** **)** +Emitted when an item is selected with right mouse button. + - **multi_selected** **(** :ref:`Object` item, :ref:`int` column, :ref:`bool` selected **)** Numeric Constants diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index e35a57ecc..0dd9d1bb1 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -18,107 +18,111 @@ Brief Description Member Functions ---------------- -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`deselect` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_children` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_metadata` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_collapsed` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_bottom` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_to_top` **(** **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`TreeItem` | :ref:`remove_child` **(** :ref:`Object` child **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select` **(** :ref:`int` column **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | -+--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_button` **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_bg_color` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_custom_color` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`deselect` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_button` **(** :ref:`int` column, :ref:`int` button_idx **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_button` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_button_count` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_cell_mode` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_children` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_icon_region` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_metadata` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_next_visible` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_parent` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`get_prev_visible` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_range` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`get_range_config` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_checked` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_collapsed` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_custom_set_as_button` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_bottom` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_top` **(** **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TreeItem` | :ref:`remove_child` **(** :ref:`Object` child **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`select` **(** :ref:`int` column **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_button` **(** :ref:`int` column, :ref:`int` button_idx, :ref:`Texture` button **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cell_mode` **(** :ref:`int` column, :ref:`int` mode **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_checked` **(** :ref:`int` column, :ref:`bool` checked **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collapsed` **(** :ref:`bool` enable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_as_button` **(** :ref:`int` column, :ref:`bool` enable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_bg_color` **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_color` **(** :ref:`int` column, :ref:`Color` color **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon_region` **(** :ref:`int` column, :ref:`Rect2` region **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_metadata` **(** :ref:`int` column, :ref:`Variant` meta **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range` **(** :ref:`int` column, :ref:`float` value **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_range_config` **(** :ref:`int` column, :ref:`float` min, :ref:`float` max, :ref:`float` step, :ref:`bool` expr=false **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selectable` **(** :ref:`int` column, :ref:`bool` selectable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -135,7 +139,7 @@ Member Function Description .. _class_TreeItem_add_button: -- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false **)** +- void **add_button** **(** :ref:`int` column, :ref:`Texture` button, :ref:`int` button_idx=-1, :ref:`bool` disabled=false, :ref:`String` tooltip="" **)** .. _class_TreeItem_clear_custom_bg_color: @@ -237,6 +241,10 @@ Member Function Description - :ref:`bool` **is_collapsed** **(** **)** +.. _class_TreeItem_is_custom_set_as_button: + +- :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** const + .. _class_TreeItem_is_editable: - :ref:`bool` **is_editable** **(** :ref:`int` column **)** @@ -281,6 +289,10 @@ Member Function Description - void **set_collapsed** **(** :ref:`bool` enable **)** +.. _class_TreeItem_set_custom_as_button: + +- void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** + .. _class_TreeItem_set_custom_bg_color: - void **set_custom_bg_color** **(** :ref:`int` column, :ref:`Color` color, :ref:`bool` just_outline=false **)** diff --git a/classes/class_tween.rst b/classes/class_tween.rst index fcf5ff368..be5105567 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -80,8 +80,14 @@ Signals ------- - **tween_completed** **(** :ref:`Object` object, :ref:`String` key **)** +This signal is emitted when a tween ends. + - **tween_started** **(** :ref:`Object` object, :ref:`String` key **)** +This signal is emitted when a tween starts. + - **tween_step** **(** :ref:`Object` object, :ref:`String` key, :ref:`float` elapsed, :ref:`Object` value **)** +This signal is emitted each step of the tweening. + Member Variables ---------------- diff --git a/classes/class_vbuttonarray.rst b/classes/class_vbuttonarray.rst deleted file mode 100644 index bc7aa46c6..000000000 --- a/classes/class_vbuttonarray.rst +++ /dev/null @@ -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_VButtonArray: - -VButtonArray -============ - -**Inherits:** :ref:`ButtonArray` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Vertical button array. - -Description ------------ - -Vertical button array. See :ref:`ButtonArray`. - diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index aa660448c..63dba3231 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -43,6 +43,8 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`floor` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | @@ -154,6 +156,12 @@ Returns the dot product with vector "b". Remove the fractional part of x and y. +.. _class_Vector2_is_normalized: + +- :ref:`bool` **is_normalized** **(** **)** + +Returns whether the vector is normalized or not. + .. _class_Vector2_length: - :ref:`float` **length** **(** **)** diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 4c3891c83..f4bdfc171 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -41,6 +41,8 @@ Member Functions +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`inverse` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_normalized` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** | @@ -158,6 +160,12 @@ Returns a new vector with all components rounded down. Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) +.. _class_Vector3_is_normalized: + +- :ref:`bool` **is_normalized** **(** **)** + +Returns whether the vector is normalized or not. + .. _class_Vector3_length: - :ref:`float` **length** **(** **)** diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index 74feafec6..17645f9fc 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -85,6 +85,8 @@ Returns the VehicleBody's velocity vector. To get the absolute speed in scalar v - :ref:`float` **get_steering** **(** **)** const +Return the steering angle (in radians). + .. _class_VehicleBody_set_brake: - void **set_brake** **(** :ref:`float` brake **)** @@ -105,4 +107,6 @@ Returns the VehicleBody's velocity vector. To get the absolute speed in scalar v - void **set_steering** **(** :ref:`float` steering **)** +Set the steering angle (in radians). + diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index c2cb3472c..9cb918d1b 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -27,6 +27,8 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_radius` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_roll_influence` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_suspension_max_force` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_suspension_rest_length` **(** **)** const | @@ -35,6 +37,8 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_suspension_travel` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_in_contact` **(** **)** const | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_used_as_steering` **(** **)** const | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_used_as_traction` **(** **)** const | @@ -47,6 +51,8 @@ Member Functions +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_radius` **(** :ref:`float` length **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_roll_influence` **(** :ref:`float` roll_influence **)** | ++----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_suspension_max_force` **(** :ref:`float` length **)** | +----------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_suspension_rest_length` **(** :ref:`float` length **)** | @@ -73,6 +79,7 @@ Member Variables - :ref:`float` **wheel_friction_slip** - :ref:`float` **wheel_radius** - :ref:`float` **wheel_rest_length** +- :ref:`float` **wheel_roll_influence** Member Function Description --------------------------- @@ -93,6 +100,10 @@ Member Function Description - :ref:`float` **get_radius** **(** **)** const +.. _class_VehicleWheel_get_roll_influence: + +- :ref:`float` **get_roll_influence** **(** **)** const + .. _class_VehicleWheel_get_suspension_max_force: - :ref:`float` **get_suspension_max_force** **(** **)** const @@ -109,6 +120,10 @@ Member Function Description - :ref:`float` **get_suspension_travel** **(** **)** const +.. _class_VehicleWheel_is_in_contact: + +- :ref:`bool` **is_in_contact** **(** **)** const + .. _class_VehicleWheel_is_used_as_steering: - :ref:`bool` **is_used_as_steering** **(** **)** const @@ -133,6 +148,10 @@ Member Function Description - void **set_radius** **(** :ref:`float` length **)** +.. _class_VehicleWheel_set_roll_influence: + +- void **set_roll_influence** **(** :ref:`float` roll_influence **)** + .. _class_VehicleWheel_set_suspension_max_force: - void **set_suspension_max_force** **(** :ref:`float` length **)** diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 9703a6ad7..c7b5bb22a 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -31,19 +31,21 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_clear_on_new_frame` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_debug_draw` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_final_transform` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform2D` | :ref:`get_global_canvas_transform` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_hdr` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_mouse_pos` **(** **)** const | +| :ref:`Vector2` | :ref:`get_mouse_position` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_msaa` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_physics_object_picking` **(** **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`get_screen_capture` **(** **)** const | +| :ref:`int` | :ref:`get_render_info` **(** :ref:`int` info **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_shadow_atlas_quadrant_subdiv` **(** :ref:`int` quadrant **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,6 +59,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_update_mode` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_usage` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_vflip` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_viewport_rid` **(** **)** const | @@ -73,7 +77,7 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_transparent_background` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`input` **(** :ref:`InputEvent` local_event **)** | +| void | :ref:`input` **(** :ref:`Object` local_event **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_3d_disabled` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -89,8 +93,6 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_using_own_world` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_screen_capture` **(** **)** | -+------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_audio_listener` **(** :ref:`bool` enable **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_as_audio_listener_2d` **(** :ref:`bool` enable **)** | @@ -101,6 +103,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_clear_on_new_frame` **(** :ref:`bool` enable **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_draw` **(** :ref:`int` debug_draw **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_disable_3d` **(** :ref:`bool` disable **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_disable_input` **(** :ref:`bool` disable **)** | @@ -127,6 +131,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_update_mode` **(** :ref:`int` mode **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_usage` **(** :ref:`int` usage **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_use_own_world` **(** :ref:`bool` enable **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_vflip` **(** :ref:`bool` enable **)** | @@ -135,7 +141,7 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_world_2d` **(** :ref:`World2D` world_2d **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unhandled_input` **(** :ref:`InputEvent` local_event **)** | +| void | :ref:`unhandled_input` **(** :ref:`Object` local_event **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_worlds` **(** **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -146,12 +152,15 @@ Signals ------- - **size_changed** **(** **)** +Emitted when the size of the viewport is changed, whether by :ref:`set_size_override`, resize of window, or some other means. + Member Variables ---------------- - :ref:`bool` **audio_listener_enable_2d** - :ref:`bool` **audio_listener_enable_3d** +- :ref:`int` **debug_draw** - :ref:`bool` **disable_3d** - :ref:`bool` **gui_disable_input** - :ref:`bool` **hdr** @@ -168,6 +177,7 @@ Member Variables - :ref:`int` **shadow_atlas_size** - :ref:`Rect2` **size** - :ref:`bool` **transparent_bg** +- :ref:`int` **usage** - :ref:`World` **world** Numeric Constants @@ -185,6 +195,17 @@ Numeric Constants - **SHADOW_ATLAS_QUADRANT_SUBDIV_256** = **5** - **SHADOW_ATLAS_QUADRANT_SUBDIV_1024** = **6** - **SHADOW_ATLAS_QUADRANT_SUBDIV_MAX** = **7** +- **RENDER_INFO_OBJECTS_IN_FRAME** = **0** +- **RENDER_INFO_VERTICES_IN_FRAME** = **1** +- **RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2** +- **RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3** +- **RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4** +- **RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5** +- **RENDER_INFO_MAX** = **6** +- **DEBUG_DRAW_DISABLED** = **0** +- **DEBUG_DRAW_UNSHADED** = **1** +- **DEBUG_DRAW_OVERDRAW** = **2** +- **DEBUG_DRAW_WIREFRAME** = **3** - **MSAA_DISABLED** = **0** - **MSAA_2X** = **1** - **MSAA_4X** = **2** @@ -245,6 +266,10 @@ Get the canvas transform of the viewport. Return whether automatic clearing of the render target on each frame is enabled. +.. _class_Viewport_get_debug_draw: + +- :ref:`int` **get_debug_draw** **(** **)** const + .. _class_Viewport_get_final_transform: - :ref:`Transform2D` **get_final_transform** **(** **)** const @@ -263,9 +288,9 @@ Get the global canvas transform of the viewport. Get whether the rendered texture has filters enabled. -.. _class_Viewport_get_mouse_pos: +.. _class_Viewport_get_mouse_position: -- :ref:`Vector2` **get_mouse_pos** **(** **)** const +- :ref:`Vector2` **get_mouse_position** **(** **)** const Get the mouse position, relative to the viewport. @@ -279,11 +304,9 @@ Get the mouse position, relative to the viewport. Get whether picking for all physics objects inside the viewport is enabled. -.. _class_Viewport_get_screen_capture: +.. _class_Viewport_get_render_info: -- :ref:`Image` **get_screen_capture** **(** **)** const - -Return the captured screenshot after :ref:`queue_screen_capture`. You might need to check more than one frame until the right image is returned. +- :ref:`int` **get_render_info** **(** :ref:`int` info **)** .. _class_Viewport_get_shadow_atlas_quadrant_subdiv: @@ -317,6 +340,10 @@ Get the viewport's texture, for use with various objects that you want to textur Get when the viewport would be updated, will be one of the ``UPDATE\_\*`` constants. +.. _class_Viewport_get_usage: + +- :ref:`int` **get_usage** **(** **)** const + .. _class_Viewport_get_vflip: - :ref:`bool` **get_vflip** **(** **)** const @@ -367,7 +394,7 @@ Return whether the viewport lets whatever is behind it to show. .. _class_Viewport_input: -- void **input** **(** :ref:`InputEvent` local_event **)** +- void **input** **(** :ref:`Object` local_event **)** .. _class_Viewport_is_3d_disabled: @@ -409,12 +436,6 @@ Get the enabled status of the size strech override set with :ref:`set_size_overr Return whether the viewport is using a world separate from the parent viewport's world. -.. _class_Viewport_queue_screen_capture: - -- void **queue_screen_capture** **(** **)** - -Queue a multithreaded screenshot, you can retrive it at a later frame via :ref:`get_screen_capture`. - .. _class_Viewport_set_as_audio_listener: - void **set_as_audio_listener** **(** :ref:`bool` enable **)** @@ -441,6 +462,10 @@ Set the canvas transform of the viewport, useful for changing the on-screen posi - void **set_clear_on_new_frame** **(** :ref:`bool` enable **)** +.. _class_Viewport_set_debug_draw: + +- void **set_debug_draw** **(** :ref:`int` debug_draw **)** + .. _class_Viewport_set_disable_3d: - void **set_disable_3d** **(** :ref:`bool` disable **)** @@ -509,6 +534,10 @@ If this viewport is a child of another viewport, keep the previously drawn backg Set when the render target would be updated, using the ``UPDATE\_\*`` constants +.. _class_Viewport_set_usage: + +- void **set_usage** **(** :ref:`int` usage **)** + .. _class_Viewport_set_use_own_world: - void **set_use_own_world** **(** :ref:`bool` enable **)** @@ -533,7 +562,7 @@ Change the 3D world of the viewport. .. _class_Viewport_unhandled_input: -- void **unhandled_input** **(** :ref:`InputEvent` local_event **)** +- void **unhandled_input** **(** :ref:`Object` local_event **)** .. _class_Viewport_update_worlds: diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 48c07c9e7..a7aadc843 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -32,9 +32,17 @@ Signals ------- - **camera_entered** **(** :ref:`Object` camera **)** +Emitted when the VisibilityNotifier enters a :ref:`Camera`'s view. + - **camera_exited** **(** :ref:`Object` camera **)** +Emitted when the VisibilityNotifier exits a :ref:`Camera`'s view. + - **screen_entered** **(** **)** +Emitted when the VisibilityNotifier enters the screen. + - **screen_exited** **(** **)** +Emitted when the VisibilityNotifier exits the screen. + Member Variables ---------------- diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index cb8cb37df..c46491004 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -32,9 +32,17 @@ Signals ------- - **screen_entered** **(** **)** +Emitted when the VisibilityNotifier2D enters the screen. + - **screen_exited** **(** **)** +Emitted when the VisibilityNotifier2D exits the screen. + - **viewport_entered** **(** :ref:`Object` viewport **)** +Emitted when the VisibilityNotifier2D enters a :ref:`Viewport`'s view. + - **viewport_exited** **(** :ref:`Object` viewport **)** +Emitted when the VisibilityNotifier2D exits a :ref:`Viewport`'s view. + Member Variables ---------------- diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index 2874039b6..fcf1f5e96 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -8,7 +8,7 @@ VisualInstance **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BakedLight`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`Room`, :ref:`GIProbe`, :ref:`Portal`, :ref:`GeometryInstance` +**Inherited By:** :ref:`Light`, :ref:`ReflectionProbe`, :ref:`Room`, :ref:`GIProbe`, :ref:`Portal`, :ref:`GeometryInstance` **Category:** Core diff --git a/classes/class_visualscriptdeconstruct.rst b/classes/class_visualscriptdeconstruct.rst index 30a84f0d9..626ac4676 100644 --- a/classes/class_visualscriptdeconstruct.rst +++ b/classes/class_visualscriptdeconstruct.rst @@ -18,38 +18,25 @@ Brief Description Member Functions ---------------- -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_deconstruct_input_type` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_deconstruct_type` **(** **)** const | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_deconstruct_input_type` **(** :ref:`int` input_type **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_deconstruct_type` **(** :ref:`int` type **)** | -+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_deconstruct_type` **(** **)** const | ++------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_deconstruct_type` **(** :ref:`int` type **)** | ++------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`Array` **elem_cache** -- :ref:`int` **input_type** - :ref:`int` **type** Member Function Description --------------------------- -.. _class_VisualScriptDeconstruct_get_deconstruct_input_type: - -- :ref:`int` **get_deconstruct_input_type** **(** **)** const - .. _class_VisualScriptDeconstruct_get_deconstruct_type: - :ref:`int` **get_deconstruct_type** **(** **)** const -.. _class_VisualScriptDeconstruct_set_deconstruct_input_type: - -- void **set_deconstruct_input_type** **(** :ref:`int` input_type **)** - .. _class_VisualScriptDeconstruct_set_deconstruct_type: - void **set_deconstruct_type** **(** :ref:`int` type **)** diff --git a/classes/class_visualscriptinputfilter.rst b/classes/class_visualscriptinputfilter.rst deleted file mode 100644 index ecba76f4c..000000000 --- a/classes/class_visualscriptinputfilter.rst +++ /dev/null @@ -1,17 +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_VisualScriptInputFilter: - -VisualScriptInputFilter -======================= - -**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 668d4a8f5..3fbcc121b 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -8,7 +8,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptSequence`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptPreload`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptInputFilter`, :ref:`VisualScriptFunction` +**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload` **Category:** Core diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 1cd1d4675..45ef31a00 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -29,8 +29,6 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_call_mode` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_event_type` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_property` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | @@ -43,8 +41,6 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_event_type` **(** :ref:`int` event_type **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_property` **(** :ref:`String` property **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ @@ -54,7 +50,6 @@ Member Variables - :ref:`String` **property/base_script** - :ref:`String` **property/base_type** - :ref:`int` **property/basic_type** -- :ref:`int` **property/event_type** - :ref:`NodePath` **property/node_path** - :ref:`String` **property/property** - :ref:`int` **property/set_mode** @@ -90,10 +85,6 @@ Member Function Description - :ref:`int` **get_call_mode** **(** **)** const -.. _class_VisualScriptPropertyGet_get_event_type: - -- :ref:`int` **get_event_type** **(** **)** const - .. _class_VisualScriptPropertyGet_get_property: - :ref:`String` **get_property** **(** **)** const @@ -118,10 +109,6 @@ Member Function Description - void **set_call_mode** **(** :ref:`int` mode **)** -.. _class_VisualScriptPropertyGet_set_event_type: - -- void **set_event_type** **(** :ref:`int` event_type **)** - .. _class_VisualScriptPropertyGet_set_property: - void **set_property** **(** :ref:`String` property **)** diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index 485beb3e1..ab1fc3f31 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -29,8 +29,6 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_call_mode` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_event_type` **(** **)** const | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_property` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | @@ -43,8 +41,6 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_event_type` **(** :ref:`int` event_type **)** | -+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_property` **(** :ref:`String` property **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ @@ -54,7 +50,6 @@ Member Variables - :ref:`String` **property/base_script** - :ref:`String` **property/base_type** - :ref:`int` **property/basic_type** -- :ref:`int` **property/event_type** - :ref:`NodePath` **property/node_path** - :ref:`String` **property/property** - :ref:`int` **property/set_mode** @@ -90,10 +85,6 @@ Member Function Description - :ref:`int` **get_call_mode** **(** **)** const -.. _class_VisualScriptPropertySet_get_event_type: - -- :ref:`int` **get_event_type** **(** **)** const - .. _class_VisualScriptPropertySet_get_property: - :ref:`String` **get_property** **(** **)** const @@ -118,10 +109,6 @@ Member Function Description - void **set_call_mode** **(** :ref:`int` mode **)** -.. _class_VisualScriptPropertySet_set_event_type: - -- void **set_event_type** **(** :ref:`int` event_type **)** - .. _class_VisualScriptPropertySet_set_property: - void **set_property** **(** :ref:`String` property **)** diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index f52e39ab6..ad1bc6dc7 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -18,21 +18,21 @@ Server for anything visible. Member Functions ---------------- -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create` **(** **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Image` arg0, :ref:`int` arg1=7 **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` arg0 **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` arg0 **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` arg0 **)** const | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_flags` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | -+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create` **(** **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_create_from_image` **(** :ref:`Object` arg0, :ref:`int` arg1=7 **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_flags` **(** :ref:`RID` arg0 **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_height` **(** :ref:`RID` arg0 **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`texture_get_width` **(** :ref:`RID` arg0 **)** const | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_flags` **(** :ref:`RID` arg0, :ref:`int` arg1 **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_shrink_all_x2_on_set_data` **(** :ref:`bool` shrink **)** | ++------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -50,7 +50,7 @@ Member Function Description .. _class_VisualServer_texture_create_from_image: -- :ref:`RID` **texture_create_from_image** **(** :ref:`Image` arg0, :ref:`int` arg1=7 **)** +- :ref:`RID` **texture_create_from_image** **(** :ref:`Object` arg0, :ref:`int` arg1=7 **)** .. _class_VisualServer_texture_get_flags: diff --git a/classes/class_world.rst b/classes/class_world.rst index 09dd3ed45..c77086eb9 100644 --- a/classes/class_world.rst +++ b/classes/class_world.rst @@ -18,22 +18,27 @@ Class that has everything pertaining to a world. Member Functions ---------------- -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`get_environment` **(** **)** const | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_scenario` **(** **)** const | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_space` **(** **)** const | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | -+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`get_environment` **(** **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`get_fallback_environment` **(** **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_scenario` **(** **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_space` **(** **)** const | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_environment` **(** :ref:`Environment` env **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fallback_environment` **(** :ref:`Environment` env **)** | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`Environment` **environment** +- :ref:`Environment` **fallback_environment** Description ----------- @@ -51,6 +56,10 @@ Member Function Description - :ref:`Environment` **get_environment** **(** **)** const +.. _class_World_get_fallback_environment: + +- :ref:`Environment` **get_fallback_environment** **(** **)** const + .. _class_World_get_scenario: - :ref:`RID` **get_scenario** **(** **)** const @@ -63,4 +72,8 @@ Member Function Description - void **set_environment** **(** :ref:`Environment` env **)** +.. _class_World_set_fallback_environment: + +- void **set_fallback_environment** **(** :ref:`Environment` env **)** + diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 834991008..c55acba34 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -13,7 +13,7 @@ WorldEnvironment Brief Description ----------------- - +Sets environment properties for the entire scene Member Functions ---------------- @@ -29,6 +29,11 @@ Member Variables - :ref:`Environment` **environment** +Description +----------- + +The :ref:`WorldEnvironment` node can be added to a scene in order to set default :ref:`Environment` variables for the scene. The :ref:`WorldEnvironment` can be overridden by an :ref:`Environment` node set on the current :ref:`Camera`. Additionally, only one :ref:`WorldEnvironment` may be instanced in a given scene at a time. The :ref:`WorldEnvironment` allows the user to specify default lighting parameters (e.g. ambient lighting), various post-processing effects (e.g. SSAO, DOF, Tonemapping), and how to draw the background (e.g. solid color, skybox). + Member Function Description --------------------------- @@ -36,8 +41,12 @@ Member Function Description - :ref:`Environment` **get_environment** **(** **)** const +Return the :ref:`Environment` currently bound. + .. _class_WorldEnvironment_set_environment: - void **set_environment** **(** :ref:`Environment` env **)** +Set the currently bound :ref:`Environment` to the one specified. +