Camera2D

Inherits: Node2D < CanvasItem < Node < Object

Camera node for 2D scenes.

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 CanvasItem-based nodes.

Cameras register themselves in the nearest Viewport node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the camera will register in the global viewport.

This node is intended to be a simple helper to get things going quickly, but more functionality may be desired to change how the camera works. To make your own custom camera node, inherit it from Node2D and change the transform of the canvas by setting Viewport.canvas_transform in Viewport (you can obtain the current Viewport by using Node.get_viewport).

Note that the Camera2D node's position doesn't represent the actual position of the screen, which may differ due to applied smoothing or limits. You can use get_screen_center_position to get the real position.

Tutorials

Properties

AnchorMode

anchor_mode

1

bool

current

false

Node

custom_viewport

float

drag_bottom_margin

0.2

bool

drag_horizontal_enabled

false

float

drag_horizontal_offset

0.0

float

drag_left_margin

0.2

float

drag_right_margin

0.2

float

drag_top_margin

0.2

bool

drag_vertical_enabled

false

float

drag_vertical_offset

0.0

bool

editor_draw_drag_margin

false

bool

editor_draw_limits

false

bool

editor_draw_screen

true

bool

ignore_rotation

true

int

limit_bottom

10000000

int

limit_left

-10000000

int

limit_right

10000000

bool

limit_smoothed

false

int

limit_top

-10000000

Vector2

offset

Vector2(0, 0)

bool

position_smoothing_enabled

false

float

position_smoothing_speed

5.0

Camera2DProcessCallback

process_callback

1

bool

rotation_smoothing_enabled

false

float

rotation_smoothing_speed

5.0

Vector2

zoom

Vector2(1, 1)

Methods

void

align ( )

void

force_update_scroll ( )

float

get_drag_margin ( Side margin ) const

int

get_limit ( Side margin ) const

Vector2

get_screen_center_position ( ) const

Vector2

get_target_position ( ) const

void

reset_smoothing ( )

void

set_drag_margin ( Side margin, float drag_margin )

void

set_limit ( Side margin, int limit )


Enumerations

enum AnchorMode:

AnchorMode ANCHOR_MODE_FIXED_TOP_LEFT = 0

The camera's position is fixed so that the top-left corner is always at the origin.

AnchorMode ANCHOR_MODE_DRAG_CENTER = 1

The camera's position takes into account vertical/horizontal offsets and the screen size.


enum Camera2DProcessCallback:

Camera2DProcessCallback CAMERA2D_PROCESS_PHYSICS = 0

The camera updates with the _physics_process callback.

Camera2DProcessCallback CAMERA2D_PROCESS_IDLE = 1

The camera updates with the _process callback.


Property Descriptions

AnchorMode anchor_mode = 1

The Camera2D's anchor point. See AnchorMode constants.


bool current = false

  • void set_current ( bool value )

  • bool is_current ( )

If true, the camera acts as the active camera for its Viewport ancestor. Only one camera can be current in a given viewport, so setting a different camera in the same viewport current will disable whatever camera was already active in that viewport.


Node custom_viewport

  • void set_custom_viewport ( Node value )

  • Node get_custom_viewport ( )

The custom Viewport node attached to the Camera2D. If null or not a Viewport, uses the default viewport instead.


float drag_bottom_margin = 0.2

  • void set_drag_margin ( Side margin, float drag_margin )

  • float get_drag_margin ( Side margin ) const

Bottom margin needed to drag the camera. A value of 1 makes the camera move only when reaching the bottom edge of the screen.


bool drag_horizontal_enabled = false

  • void set_drag_horizontal_enabled ( bool value )

  • bool is_drag_horizontal_enabled ( )

If true, the camera only moves when reaching the horizontal (left and right) drag margins. If false, the camera moves horizontally regardless of margins.


float drag_horizontal_offset = 0.0

  • void set_drag_horizontal_offset ( float value )

  • float get_drag_horizontal_offset ( )

The relative horizontal drag offset of the camera between the right (-1) and left (1) drag margins.

Note: Used to set the initial horizontal drag offset; determine the current offset; or force the current offset. It's not automatically updated when drag_horizontal_enabled is true or the drag margins are changed.


float drag_left_margin = 0.2

  • void set_drag_margin ( Side margin, float drag_margin )

  • float get_drag_margin ( Side margin ) const

Left margin needed to drag the camera. A value of 1 makes the camera move only when reaching the left edge of the screen.


float drag_right_margin = 0.2

  • void set_drag_margin ( Side margin, float drag_margin )

  • float get_drag_margin ( Side margin ) const

Right margin needed to drag the camera. A value of 1 makes the camera move only when reaching the right edge of the screen.


float drag_top_margin = 0.2

  • void set_drag_margin ( Side margin, float drag_margin )

  • float get_drag_margin ( Side margin ) const

Top margin needed to drag the camera. A value of 1 makes the camera move only when reaching the top edge of the screen.


bool drag_vertical_enabled = false

  • void set_drag_vertical_enabled ( bool value )

  • bool is_drag_vertical_enabled ( )

If true, the camera only moves when reaching the vertical (top and bottom) drag margins. If false, the camera moves vertically regardless of the drag margins.


float drag_vertical_offset = 0.0

  • void set_drag_vertical_offset ( float value )

  • float get_drag_vertical_offset ( )

The relative vertical drag offset of the camera between the bottom (-1) and top (1) drag margins.

Note: Used to set the initial vertical drag offset; determine the current offset; or force the current offset. It's not automatically updated when drag_vertical_enabled is true or the drag margins are changed.


bool editor_draw_drag_margin = false

  • void set_margin_drawing_enabled ( bool value )

  • bool is_margin_drawing_enabled ( )

If true, draws the camera's drag margin rectangle in the editor.


bool editor_draw_limits = false

  • void set_limit_drawing_enabled ( bool value )

  • bool is_limit_drawing_enabled ( )

If true, draws the camera's limits rectangle in the editor.


bool editor_draw_screen = true

  • void set_screen_drawing_enabled ( bool value )

  • bool is_screen_drawing_enabled ( )

If true, draws the camera's screen rectangle in the editor.


bool ignore_rotation = true

  • void set_ignore_rotation ( bool value )

  • bool is_ignoring_rotation ( )

If true, the camera's rendered view is not affected by its Node2D.rotation and Node2D.global_rotation.


int limit_bottom = 10000000

  • void set_limit ( Side margin, int limit )

  • int get_limit ( Side margin ) const

Bottom scroll limit in pixels. The camera stops moving when reaching this value, but offset can push the view past the limit.


int limit_left = -10000000

  • void set_limit ( Side margin, int limit )

  • int get_limit ( Side margin ) const

Left scroll limit in pixels. The camera stops moving when reaching this value, but offset can push the view past the limit.


int limit_right = 10000000

  • void set_limit ( Side margin, int limit )

  • int get_limit ( Side margin ) const

Right scroll limit in pixels. The camera stops moving when reaching this value, but offset can push the view past the limit.


bool limit_smoothed = false

  • void set_limit_smoothing_enabled ( bool value )

  • bool is_limit_smoothing_enabled ( )

If true, the camera smoothly stops when reaches its limits.

This property has no effect if position_smoothing_enabled is false.

Note: To immediately update the camera's position to be within limits without smoothing, even with this setting enabled, invoke reset_smoothing.


int limit_top = -10000000

  • void set_limit ( Side margin, int limit )

  • int get_limit ( Side margin ) const

Top scroll limit in pixels. The camera stops moving when reaching this value, but offset can push the view past the limit.


Vector2 offset = Vector2(0, 0)

The camera's relative offset. Useful for looking around or camera shake animations. The offsetted camera can go past the limits defined in limit_top, limit_bottom, limit_left and limit_right.


bool position_smoothing_enabled = false

  • void set_position_smoothing_enabled ( bool value )

  • bool is_position_smoothing_enabled ( )

If true, the camera's view smoothly moves towards its target position at position_smoothing_speed.


float position_smoothing_speed = 5.0

  • void set_position_smoothing_speed ( float value )

  • float get_position_smoothing_speed ( )

Speed in pixels per second of the camera's smoothing effect when position_smoothing_enabled is true.


Camera2DProcessCallback process_callback = 1

The camera's process callback. See Camera2DProcessCallback.


bool rotation_smoothing_enabled = false

  • void set_rotation_smoothing_enabled ( bool value )

  • bool is_rotation_smoothing_enabled ( )

If true, the camera's view smoothly rotates, via asymptotic smoothing, to align with its target rotation at rotation_smoothing_speed.

Note: This property has no effect if ignore_rotation is true.


float rotation_smoothing_speed = 5.0

  • void set_rotation_smoothing_speed ( float value )

  • float get_rotation_smoothing_speed ( )

The angular, asymptotic speed of the camera's rotation smoothing effect when rotation_smoothing_enabled is true.


Vector2 zoom = Vector2(1, 1)

The camera's zoom. A zoom of Vector(2, 2) doubles the size seen in the viewport. A zoom of Vector(0.5, 0.5) halves the size seen in the viewport.


Method Descriptions

void align ( )

Aligns the camera to the tracked node.


void force_update_scroll ( )

Forces the camera to update scroll immediately.


float get_drag_margin ( Side margin ) const

Returns the specified Side's margin. See also drag_bottom_margin, drag_top_margin, drag_left_margin, and drag_right_margin.


int get_limit ( Side margin ) const

Returns the camera limit for the specified Side. See also limit_bottom, limit_top, limit_left, and limit_right.


Vector2 get_screen_center_position ( ) const

Returns the center of the screen from this camera's point of view, in global coordinates.

Note: The exact targeted position of the camera may be different. See get_target_position.


Vector2 get_target_position ( ) const

Returns this camera's target position, in global coordinates.

Note: The returned value is not the same as Node2D.global_position, as it is affected by the drag properties. It is also not the same as the current position if position_smoothing_enabled is true (see get_screen_center_position).


void reset_smoothing ( )

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

This method has no effect if position_smoothing_enabled is false.


void set_drag_margin ( Side margin, float drag_margin )

Sets the specified Side's margin. See also drag_bottom_margin, drag_top_margin, drag_left_margin, and drag_right_margin.


void set_limit ( Side margin, int limit )

Sets the camera limit for the specified Side. See also limit_bottom, limit_top, limit_left, and limit_right.