Camera2D Properties

The Camera2D's anchor point. See Camera2DAnchorModeEnum constants.

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.

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

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

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

If true, the camera only moves when reaching the horizontal drag margins. If false, the camera moves horizontally regardless of margins.

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

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

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

If true, the camera only moves when reaching the vertical drag margins. If false, the camera moves vertically regardless of margins.

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

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

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

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

Global position.

Global rotation in radians.

Global rotation in degrees.

Global scale.

Global Transform2D.

The rendering layers in which this CanvasItem responds to Light2D nodes.

Bottom scroll limit in pixels. The camera stops moving when reaching this value.

Left scroll limit in pixels. The camera stops moving when reaching this value.

Right scroll limit in pixels. The camera stops moving when reaching this value.

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

Top scroll limit in pixels. The camera stops moving when reaching this value.

The material applied to textures on this CanvasItem.

The color applied to textures on this CanvasItem.

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

The camera's offset, useful for looking around or camera shake animations.

The horizontal offset of the camera, relative to the drag margins.

Note: Offset H is used only to force offset relative to margins. It's not updated in any way if drag margins are enabled and can be used to set initial offset.

The vertical offset of the camera, relative to the drag margins.

Note: Used the same as OffsetH.

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

Pause mode. How the node will behave if the SceneTree is paused.

Position, relative to the node's parent.

The camera's process callback. See Camera2DCamera2DProcessMode.

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

If true, the camera rotates with the target.

Rotation in radians, relative to the node's parent.

Rotation in degrees, relative to the node's parent.

The node's scale. Unscaled value: (1, 1).

The color applied to textures on this CanvasItem. This is not inherited by children CanvasItems.

If true, the object draws behind its parent.

If true, the object draws on top of its parent.

If true, the camera smoothly moves towards the target at SmoothingSpeed.

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

Local Transform2D.

If true, the parent CanvasItem's Material property is used as this one's material.

If true, this CanvasItem is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true).

Note: For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

If true, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

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 2× zoom-in, and Vector2(4, 4) for a 4× zoom-out.