mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Sync with current master branch (bbac8198f)
This commit is contained in:
Rémi Verschelde
@@ -37,57 +37,61 @@ Tutorials
|
||||
Properties
|
||||
----------
|
||||
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_property_anchor_mode>` | ``1`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_property_current>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_Camera2D_property_custom_viewport>` | |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_bottom_margin<class_Camera2D_property_drag_bottom_margin>` | ``0.2`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_horizontal_enabled<class_Camera2D_property_drag_horizontal_enabled>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_horizontal_offset<class_Camera2D_property_drag_horizontal_offset>` | ``0.0`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_left_margin<class_Camera2D_property_drag_left_margin>` | ``0.2`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_right_margin<class_Camera2D_property_drag_right_margin>` | ``0.2`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_top_margin<class_Camera2D_property_drag_top_margin>` | ``0.2`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_vertical_enabled<class_Camera2D_property_drag_vertical_enabled>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_vertical_offset<class_Camera2D_property_drag_vertical_offset>` | ``0.0`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_property_editor_draw_drag_margin>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_property_editor_draw_limits>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_property_editor_draw_screen>` | ``true`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_property_limit_bottom>` | ``10000000`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_property_limit_left>` | ``-10000000`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_property_limit_right>` | ``10000000`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_property_limit_smoothed>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_property_limit_top>` | ``-10000000`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_property_offset>` | ``Vector2(0, 0)`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`Camera2DProcessCallback<enum_Camera2D_Camera2DProcessCallback>` | :ref:`process_callback<class_Camera2D_property_process_callback>` | ``1`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`rotating<class_Camera2D_property_rotating>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>` | ``5.0`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_property_zoom>` | ``Vector2(1, 1)`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------+-------------------+
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`AnchorMode<enum_Camera2D_AnchorMode>` | :ref:`anchor_mode<class_Camera2D_property_anchor_mode>` | ``1`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`current<class_Camera2D_property_current>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`Node<class_Node>` | :ref:`custom_viewport<class_Camera2D_property_custom_viewport>` | |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_bottom_margin<class_Camera2D_property_drag_bottom_margin>` | ``0.2`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_horizontal_enabled<class_Camera2D_property_drag_horizontal_enabled>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_horizontal_offset<class_Camera2D_property_drag_horizontal_offset>` | ``0.0`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_left_margin<class_Camera2D_property_drag_left_margin>` | ``0.2`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_right_margin<class_Camera2D_property_drag_right_margin>` | ``0.2`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_top_margin<class_Camera2D_property_drag_top_margin>` | ``0.2`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`drag_vertical_enabled<class_Camera2D_property_drag_vertical_enabled>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`drag_vertical_offset<class_Camera2D_property_drag_vertical_offset>` | ``0.0`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_drag_margin<class_Camera2D_property_editor_draw_drag_margin>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_limits<class_Camera2D_property_editor_draw_limits>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_draw_screen<class_Camera2D_property_editor_draw_screen>` | ``true`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`ignore_rotation<class_Camera2D_property_ignore_rotation>` | ``true`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_bottom<class_Camera2D_property_limit_bottom>` | ``10000000`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_left<class_Camera2D_property_limit_left>` | ``-10000000`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_right<class_Camera2D_property_limit_right>` | ``10000000`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`limit_smoothed<class_Camera2D_property_limit_smoothed>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`int<class_int>` | :ref:`limit_top<class_Camera2D_property_limit_top>` | ``-10000000`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Camera2D_property_offset>` | ``Vector2(0, 0)`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`Camera2DProcessCallback<enum_Camera2D_Camera2DProcessCallback>` | :ref:`process_callback<class_Camera2D_property_process_callback>` | ``1`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`rotation_smoothing_enabled<class_Camera2D_property_rotation_smoothing_enabled>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`rotation_smoothing_speed<class_Camera2D_property_rotation_smoothing_speed>` | ``5.0`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`smoothing_enabled<class_Camera2D_property_smoothing_enabled>` | ``false`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`float<class_float>` | :ref:`smoothing_speed<class_Camera2D_property_smoothing_speed>` | ``5.0`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
| :ref:`Vector2<class_Vector2>` | :ref:`zoom<class_Camera2D_property_zoom>` | ``Vector2(1, 1)`` |
|
||||
+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -370,6 +374,22 @@ If ``true``, draws the camera's screen rectangle in the editor.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Camera2D_property_ignore_rotation:
|
||||
|
||||
- :ref:`bool<class_bool>` **ignore_rotation**
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``true`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_ignore_rotation(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | is_ignoring_rotation() |
|
||||
+-----------+----------------------------+
|
||||
|
||||
If ``true``, the camera's rendered view is not affected by its :ref:`Node2D.rotation<class_Node2D_property_rotation>` and :ref:`Node2D.global_rotation<class_Node2D_property_global_rotation>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Camera2D_property_limit_bottom:
|
||||
|
||||
- :ref:`int<class_int>` **limit_bottom**
|
||||
@@ -486,19 +506,37 @@ The camera's process callback. See :ref:`Camera2DProcessCallback<enum_Camera2D_C
|
||||
|
||||
----
|
||||
|
||||
.. _class_Camera2D_property_rotating:
|
||||
.. _class_Camera2D_property_rotation_smoothing_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **rotating**
|
||||
- :ref:`bool<class_bool>` **rotation_smoothing_enabled**
|
||||
|
||||
+-----------+---------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------+
|
||||
| *Setter* | set_rotating(value) |
|
||||
+-----------+---------------------+
|
||||
| *Getter* | is_rotating() |
|
||||
+-----------+---------------------+
|
||||
+-----------+---------------------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------------------+
|
||||
| *Setter* | set_rotation_smoothing_enabled(value) |
|
||||
+-----------+---------------------------------------+
|
||||
| *Getter* | is_rotation_smoothing_enabled() |
|
||||
+-----------+---------------------------------------+
|
||||
|
||||
If ``true``, the camera view rotates with the target.
|
||||
If ``true``, the camera's view smoothly rotates, via asymptotic smoothing, to align with its target rotation at :ref:`rotation_smoothing_speed<class_Camera2D_property_rotation_smoothing_speed>`.
|
||||
|
||||
\ **Note:** This property has no effect if :ref:`ignore_rotation<class_Camera2D_property_ignore_rotation>` is ``true``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_Camera2D_property_rotation_smoothing_speed:
|
||||
|
||||
- :ref:`float<class_float>` **rotation_smoothing_speed**
|
||||
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | ``5.0`` |
|
||||
+-----------+-------------------------------------+
|
||||
| *Setter* | set_rotation_smoothing_speed(value) |
|
||||
+-----------+-------------------------------------+
|
||||
| *Getter* | get_rotation_smoothing_speed() |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
The angular, asymptotic speed of the camera's rotation smoothing effect when :ref:`rotation_smoothing_enabled<class_Camera2D_property_rotation_smoothing_enabled>` is ``true``.
|
||||
|
||||
----
|
||||
|
||||
|
||||
Reference in New Issue
Block a user