godot-docs/classes/class_camera2d.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Camera2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Camera2D:

Camera2D
========

**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Camera node for 2D scenes.

Member Functions
----------------

+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`align<class_Camera2D_align>` **(** **)**                                                              |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)**                                              |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)**                                  |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`  | :ref:`get_camera_position<class_Camera2D_get_camera_position>` **(** **)** const                            |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>`  | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const                  |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_node>`        | :ref:`get_custom_viewport<class_Camera2D_get_custom_viewport>` **(** **)** const                            |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const                                          |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const                                          |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`make_current<class_Camera2D_make_current>` **(** **)**                                                |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`reset_smoothing<class_Camera2D_reset_smoothing>` **(** **)**                                          |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_custom_viewport<class_Camera2D_set_custom_viewport>` **(** :ref:`Node<class_node>` viewport **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)**                  |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)**                  |
+--------------------------------+-------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

  .. _class_Camera2D_anchor_mode:

- :ref:`int<class_int>` **anchor_mode** - The Camera2D's anchor point. See ``ANCHOR_MODE\_\*`` constants.

  .. _class_Camera2D_current:

- :ref:`bool<class_bool>` **current** - If ``true`` the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one.

  .. _class_Camera2D_drag_margin_bottom:

- :ref:`float<class_float>` **drag_margin_bottom** - Bottom margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.

  .. _class_Camera2D_drag_margin_h_enabled:

- :ref:`bool<class_bool>` **drag_margin_h_enabled** - If ``true`` the camera only moves when reaching the horizontal drag margins. If ``false`` the camera moves horizontally regardless of margins. Default value: ``true``.

  .. _class_Camera2D_drag_margin_left:

- :ref:`float<class_float>` **drag_margin_left** - Left margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.

  .. _class_Camera2D_drag_margin_right:

- :ref:`float<class_float>` **drag_margin_right** - Right margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.

  .. _class_Camera2D_drag_margin_top:

- :ref:`float<class_float>` **drag_margin_top** - Top margin needed to drag the camera. A value of ``1`` makes the camera move only when reaching the edge of the screen.

  .. _class_Camera2D_drag_margin_v_enabled:

- :ref:`bool<class_bool>` **drag_margin_v_enabled** - If ``true`` the camera only moves when reaching the vertical drag margins. If ``false`` the camera moves vertically regardless of margins. Default value: ``true``.

  .. _class_Camera2D_editor_draw_drag_margin:

- :ref:`bool<class_bool>` **editor_draw_drag_margin** - If ``true`` draws the camera's drag margin rectangle in the editor. Default value: ``false``

  .. _class_Camera2D_editor_draw_limits:

- :ref:`bool<class_bool>` **editor_draw_limits** - If ``true`` draws the camera's limits rectangle in the editor. Default value: ``true``

  .. _class_Camera2D_editor_draw_screen:

- :ref:`bool<class_bool>` **editor_draw_screen** - If ``true`` draws the camera's screen rectangle in the editor. Default value: ``false``

  .. _class_Camera2D_limit_bottom:

- :ref:`int<class_int>` **limit_bottom** - Bottom scroll limit in pixels. The camera stops moving when reaching this value.

  .. _class_Camera2D_limit_left:

- :ref:`int<class_int>` **limit_left** - Left scroll limit in pixels. The camera stops moving when reaching this value.

  .. _class_Camera2D_limit_right:

- :ref:`int<class_int>` **limit_right** - Right scroll limit in pixels. The camera stops moving when reaching this value.

  .. _class_Camera2D_limit_smoothed:

- :ref:`bool<class_bool>` **limit_smoothed** - If ``true`` the camera smoothly stops when reaches its limits. Default value: ``false``

  .. _class_Camera2D_limit_top:

- :ref:`int<class_int>` **limit_top** - Top scroll limit in pixels. The camera stops moving when reaching this value.

  .. _class_Camera2D_offset:

- :ref:`Vector2<class_vector2>` **offset** - The camera's offset, useful for looking around or camera shake animations.

  .. _class_Camera2D_rotating:

- :ref:`bool<class_bool>` **rotating** - If ``true`` the camera rotates with the target. Default value: ``false``

  .. _class_Camera2D_smoothing_enabled:

- :ref:`bool<class_bool>` **smoothing_enabled** - If ``true`` the camera smoothly moves towards the target at :ref:`smoothing_speed<class_Camera2D_smoothing_speed>`. Default value: ``false``

  .. _class_Camera2D_smoothing_speed:

- :ref:`float<class_float>` **smoothing_speed** - Speed in pixels per second of the camera's smoothing effect when :ref:`smoothing_enabled<class_Camera2D_smoothing_enabled>` is ``true``

  .. _class_Camera2D_zoom:

- :ref:`Vector2<class_vector2>` **zoom** - The camera's zoom relative to the viewport. Values larger than ``Vector2(1, 1)`` zoom out and smaller values zoom in. For an example, use ``Vector2(0.5, 0.5)`` for a 2x zoom in, and ``Vector2(4, 4)`` for a 4x zoom out.


Numeric Constants
-----------------

- **ANCHOR_MODE_FIXED_TOP_LEFT** = **0** --- The camera's position is fixed so that the top-left corner is always at the origin.
- **ANCHOR_MODE_DRAG_CENTER** = **1** --- The camera's position takes into account vertical/horizontal offsets and the screen size.

Description
-----------

Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of :ref:`CanvasItem<class_canvasitem>` based nodes.

This node is intended to be a simple helper to get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from :ref:`Node2D<class_node2d>` and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in :ref:`Viewport<class_viewport>`.

Member Function Description
---------------------------

.. _class_Camera2D_align:

- void **align** **(** **)**

Align the camera to the tracked node

.. _class_Camera2D_clear_current:

- void **clear_current** **(** **)**

Removes any ``Camera2D`` from the ancestor :ref:`Viewport<class_viewport>`'s internal currently-assigned camera.

.. _class_Camera2D_force_update_scroll:

- void **force_update_scroll** **(** **)**

Force the camera to update scroll immediately.

.. _class_Camera2D_get_camera_position:

- :ref:`Vector2<class_vector2>` **get_camera_position** **(** **)** const

Return the camera position.

.. _class_Camera2D_get_camera_screen_center:

- :ref:`Vector2<class_vector2>` **get_camera_screen_center** **(** **)** const

Returns the location of the ``Camera2D``'s screen-center, relative to the origin.

.. _class_Camera2D_get_custom_viewport:

- :ref:`Node<class_node>` **get_custom_viewport** **(** **)** const

Returns the :ref:`Viewport<class_viewport>` used by the camera if it is not using the default viewport.

.. _class_Camera2D_get_h_offset:

- :ref:`float<class_float>` **get_h_offset** **(** **)** const

Returns the horizontal offset of the camera.

.. _class_Camera2D_get_v_offset:

- :ref:`float<class_float>` **get_v_offset** **(** **)** const

Returns the vertical offset of the camera.

.. _class_Camera2D_make_current:

- void **make_current** **(** **)**

Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.

.. _class_Camera2D_reset_smoothing:

- void **reset_smoothing** **(** **)**

Set the camera's position immediately to its current smoothing destination.

This has no effect if smoothing is disabled.

.. _class_Camera2D_set_custom_viewport:

- void **set_custom_viewport** **(** :ref:`Node<class_node>` viewport **)**

Assigns a custom :ref:`Viewport<class_viewport>` node to the ``Camera2D``. If ``viewport`` is not a :ref:`Viewport<class_viewport>`, it re-assigns the default viewport instead.

.. _class_Camera2D_set_h_offset:

- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**

The camera's horizontal offset is set to ``ofs``.

.. _class_Camera2D_set_v_offset:

- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**

The camera's vertical offset is set to ``ofs``.