Sync classref with current source

This commit is contained in:
Rémi Verschelde
2019-01-07 10:08:00 +01:00
parent 756bef81e1
commit 4f5d503b25
61 changed files with 632 additions and 301 deletions

View File

@@ -19,55 +19,57 @@ Camera node for 2D scenes.
Properties
----------
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_anchor_mode>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_current>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_Camera2D_custom_viewport>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_bottom<class_Camera2D_drag_margin_bottom>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`drag_margin_h_enabled<class_Camera2D_drag_margin_h_enabled>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_left<class_Camera2D_drag_margin_left>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_right<class_Camera2D_drag_margin_right>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_top<class_Camera2D_drag_margin_top>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`drag_margin_v_enabled<class_Camera2D_drag_margin_v_enabled>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_editor_draw_drag_margin>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_editor_draw_limits>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_editor_draw_screen>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_limit_bottom>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_limit_left>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_limit_right>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_limit_smoothed>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_limit_top>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_offset>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`offset_h<class_Camera2D_offset_h>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`offset_v<class_Camera2D_offset_v>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rotating<class_Camera2D_rotating>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_smoothing_enabled>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_smoothing_speed>` |
+---------------------------------------------+------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_zoom>` |
+---------------------------------------------+------------------------------------------------------------------------+
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_anchor_mode>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_current>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_Camera2D_custom_viewport>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_bottom<class_Camera2D_drag_margin_bottom>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`drag_margin_h_enabled<class_Camera2D_drag_margin_h_enabled>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_left<class_Camera2D_drag_margin_left>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_right<class_Camera2D_drag_margin_right>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`drag_margin_top<class_Camera2D_drag_margin_top>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`drag_margin_v_enabled<class_Camera2D_drag_margin_v_enabled>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_editor_draw_drag_margin>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_editor_draw_limits>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_editor_draw_screen>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_limit_bottom>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_limit_left>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_limit_right>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_limit_smoothed>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_limit_top>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_offset>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`offset_h<class_Camera2D_offset_h>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`offset_v<class_Camera2D_offset_v>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` | :ref:`process_mode<class_Camera2D_process_mode>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rotating<class_Camera2D_rotating>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_smoothing_enabled>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_smoothing_speed>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_zoom>` |
+---------------------------------------------------------------+------------------------------------------------------------------------+
Methods
-------
@@ -99,6 +101,14 @@ enum **AnchorMode**:
- **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size.
.. _enum_Camera2D_Camera2DProcessMode:
enum **Camera2DProcessMode**:
- **CAMERA2D_PROCESS_PHYSICS** = **0**
- **CAMERA2D_PROCESS_IDLE** = **1**
Description
-----------
@@ -347,6 +357,16 @@ The horizontal offset of the camera, relative to the drag margins. Default value
The vertical offset of the camera, relative to the drag margins. Default value: ``0``
.. _class_Camera2D_process_mode:
- :ref:`Camera2DProcessMode<enum_Camera2D_Camera2DProcessMode>` **process_mode**
+----------+-------------------------+
| *Setter* | set_process_mode(value) |
+----------+-------------------------+
| *Getter* | get_process_mode() |
+----------+-------------------------+
.. _class_Camera2D_rotating:
- :ref:`bool<class_bool>` **rotating**