Skip to content
Download
API reference

Camera2D

Inherits: Spatial2D < CanvasItem < Actor < Object

Camera actor for 2D scenes.

Camera actor for 2D scenes. It forces the screen (current layer) to scroll following this actor. This makes it easier (and faster) to program scrollable scenes than manually changing the position of CanvasItem-based actors.

Cameras register themselves in the nearest Viewport actor (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 actor 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 actor, inherit it from Spatial2D and change the transform of the canvas by setting Viewport.canvas_transform in Viewport (you can obtain the current Viewport by using Actor.get_viewport()).

Note that the Camera2D actor’s Spatial2D.global_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. Same for the actor’s Spatial2D.global_rotation which may be different due to applied rotation smoothing. You can use get_screen_rotation() to get the current rotation of the screen.

TypeNameDefault
Camera2D.AnchorModeanchor_mode1
Actorcustom_viewport
floatdrag_bottom_margin0.2
booldrag_horizontal_enabledfalse
floatdrag_horizontal_offset0.0
floatdrag_left_margin0.2
floatdrag_right_margin0.2
floatdrag_top_margin0.2
booldrag_vertical_enabledfalse
floatdrag_vertical_offset0.0
booleditor_draw_drag_marginfalse
booleditor_draw_limitsfalse
booleditor_draw_screentrue
boolenabledtrue
boolignore_rotationtrue
intlimit_bottom10000000
boollimit_enabledtrue
intlimit_left-10000000
intlimit_right10000000
boollimit_smoothedfalse
intlimit_top-10000000
Vector2offsetVector2(0, 0)
boolposition_smoothing_enabledfalse
floatposition_smoothing_speed5.0
Camera2D.Camera2DProcessCallbackprocess_callback0
boolrotation_smoothing_enabledfalse
floatrotation_smoothing_speed5.0
Vector2zoomVector2(1, 1)
ReturnsMethod
voidalign()
voidforce_update_scroll()
floatget_drag_margin(margin)
intget_limit(margin)
Vector2get_screen_center_position()
floatget_screen_rotation()
Vector2get_target_position()
boolis_current()
voidmake_current()
voidreset_smoothing()
voidset_drag_margin(margin, drag_margin)
voidset_limit(margin, limit)

  • 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.

Camera2D.AnchorMode anchor_mode = 1

Setter/getter: set_anchor_mode(), get_anchor_mode()

The Camera2D’s anchor point.

Actor custom_viewport

Setter/getter: set_custom_viewport(), get_custom_viewport()

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

float drag_bottom_margin = 0.2

Setter/getter: set_drag_margin(), get_drag_margin()

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

Setter/getter: set_drag_horizontal_enabled(), 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

Setter/getter: set_drag_horizontal_offset(), 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

Setter/getter: set_drag_margin(), get_drag_margin()

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

Setter/getter: set_drag_margin(), get_drag_margin()

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

Setter/getter: set_drag_margin(), get_drag_margin()

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

Setter/getter: set_drag_vertical_enabled(), 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

Setter/getter: set_drag_vertical_offset(), 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

Setter/getter: set_margin_drawing_enabled(), is_margin_drawing_enabled()

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

bool editor_draw_limits = false

Setter/getter: set_limit_drawing_enabled(), is_limit_drawing_enabled()

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

bool editor_draw_screen = true

Setter/getter: set_screen_drawing_enabled(), is_screen_drawing_enabled()

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

bool enabled = true

Setter/getter: set_enabled(), is_enabled()

Controls whether the camera can be active or not. If true, the Camera2D will become the main camera when it enters the scene tree and there is no active camera currently (see Viewport.get_camera_2d()).

When the camera is currently active and enabled is set to false, the next enabled Camera2D in the scene tree will become active.

bool ignore_rotation = true

Setter/getter: set_ignore_rotation(), is_ignoring_rotation()

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

int limit_bottom = 10000000

Setter/getter: set_limit(), get_limit()

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

bool limit_enabled = true

Setter/getter: set_limit_enabled(), is_limit_enabled()

If true, the limits will be enabled. Disabling this will allow the camera to focus anywhere, when the four limit_* properties will not work.

int limit_left = -10000000

Setter/getter: set_limit(), get_limit()

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

Setter/getter: set_limit(), get_limit()

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

Setter/getter: set_limit_smoothing_enabled(), 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

Setter/getter: set_limit(), get_limit()

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)

Setter/getter: set_offset(), get_offset()

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

Setter/getter: set_position_smoothing_enabled(), 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

Setter/getter: set_position_smoothing_speed(), get_position_smoothing_speed()

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

Camera2D.Camera2DProcessCallback process_callback = 0

Setter/getter: set_process_callback(), get_process_callback()

The camera’s process callback.

bool rotation_smoothing_enabled = false

Setter/getter: set_rotation_smoothing_enabled(), 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

Setter/getter: set_rotation_smoothing_speed(), 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)

Setter/getter: set_zoom(), get_zoom()

The camera’s zoom. Higher values are more zoomed in. For example, a zoom of Vector2(2.0, 2.0) will be twice as zoomed in on each axis (the view covers an area four times smaller). In contrast, a zoom of Vector2(0.5, 0.5) will be twice as zoomed out on each axis (the view covers an area four times larger). The X and Y components should generally always be set to the same value, unless you wish to stretch the camera view.

Note: FontFile.oversampling does not take Camera2D zoom into account. This means that zooming in/out will cause bitmap fonts and rasterized (non-MSDF) dynamic fonts to appear blurry or pixelated unless the font is part of a CanvasLayer that makes it ignore camera zoom. To ensure text remains crisp regardless of zoom, you can enable MSDF font rendering by enabling ProjectSettings.gui/theme/default_font_multichannel_signed_distance_field (applies to the default project font only), or enabling Multichannel Signed Distance Field in the import options of a DynamicFont for custom fonts. On system fonts, SystemFont.multichannel_signed_distance_field can be enabled in the inspector.

void align()

Aligns the camera to the tracked actor.

Note: Calling force_update_scroll() after this method is not required.

void force_update_scroll()

Forces the camera to update scroll immediately.

float get_drag_margin(margin: Side) 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(margin: Side) 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().

float get_screen_rotation() const

Returns the current screen rotation from this camera’s point of view.

Note: The screen rotation can be different from Spatial2D.global_rotation if the camera is rotating smoothly due to rotation_smoothing_enabled.

Vector2 get_target_position() const

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

Note: The returned value is not the same as Spatial2D.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()).

bool is_current() const

Returns true if this Camera2D is the active camera (see Viewport.get_camera_2d()).

void make_current()

Forces this Camera2D to become the current active one. enabled must be true.

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(margin: Side, drag_margin: float)

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

void set_limit(margin: Side, limit: int)

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