Camera2D
Camera node for 2D scenes.
Camera2D.swift:18class Camera2DCamera 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 canvasTransform in Viewport (you can obtain the current Viewport by using getViewport).
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 getScreenCenterPosition to get the real position.
Superclasses
class Node2DA 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Types
Type members
Instance members
var anchorMode: Camera2D.AnchorModeThe Camera2D’s anchor point. See
AnchorModeconstants.var customViewport: Node?The custom
Viewportnode attached to theCamera2D. Ifnullor not aViewport, uses the default viewport instead.var dragBottomMargin: DoubleBottom margin needed to drag the camera. A value of
1makes the camera move only when reaching the bottom edge of the screen.var dragHorizontalEnabled: BoolIf
true, the camera only moves when reaching the horizontal (left and right) drag margins. Iffalse, the camera moves horizontally regardless of margins.var dragHorizontalOffset: DoubleThe relative horizontal drag offset of the camera between the right (
-1) and left (1) drag margins.var dragLeftMargin: DoubleLeft margin needed to drag the camera. A value of
1makes the camera move only when reaching the left edge of the screen.var dragRightMargin: DoubleRight margin needed to drag the camera. A value of
1makes the camera move only when reaching the right edge of the screen.var dragTopMargin: DoubleTop margin needed to drag the camera. A value of
1makes the camera move only when reaching the top edge of the screen.var dragVerticalEnabled: BoolIf
true, the camera only moves when reaching the vertical (top and bottom) drag margins. Iffalse, the camera moves vertically regardless of the drag margins.var dragVerticalOffset: DoubleThe relative vertical drag offset of the camera between the bottom (
-1) and top (1) drag margins.var editorDrawDragMargin: BoolIf
true, draws the camera’s drag margin rectangle in the editor.var editorDrawLimits: BoolIf
true, draws the camera’s limits rectangle in the editor.var editorDrawScreen: BoolIf
true, draws the camera’s screen rectangle in the editor.var enabled: BoolControls whether the camera can be active or not. If
true, theCamera2Dwill become the main camera when it enters the scene tree and there is no active camera currently (seegetCamera2d).var ignoreRotation: BoolIf
true, the camera’s rendered view is not affected by itsrotationandglobalRotation.var limitBottom: Int32Bottom scroll limit in pixels. The camera stops moving when reaching this value, but
offsetcan push the view past the limit.var limitLeft: Int32Left scroll limit in pixels. The camera stops moving when reaching this value, but
offsetcan push the view past the limit.var limitRight: Int32Right scroll limit in pixels. The camera stops moving when reaching this value, but
offsetcan push the view past the limit.var limitSmoothed: BoolIf
true, the camera smoothly stops when reaches its limits.var limitTop: Int32Top scroll limit in pixels. The camera stops moving when reaching this value, but
offsetcan push the view past the limit.var offset: Vector2The camera’s relative offset. Useful for looking around or camera shake animations. The offsetted camera can go past the limits defined in
limitTop,limitBottom,limitLeftandlimitRight.var positionSmoothingEnabled: BoolIf
true, the camera’s view smoothly moves towards its target position atpositionSmoothingSpeed.var positionSmoothingSpeed: DoubleSpeed in pixels per second of the camera’s smoothing effect when
positionSmoothingEnabledistrue.var processCallback: Camera2D.Camera2DProcessCallbackThe camera’s process callback. See
Camera2DProcessCallback.var rotationSmoothingEnabled: BoolIf
true, the camera’s view smoothly rotates, via asymptotic smoothing, to align with its target rotation atrotationSmoothingSpeed.var rotationSmoothingSpeed: DoubleThe angular, asymptotic speed of the camera’s rotation smoothing effect when
rotationSmoothingEnabledistrue.var zoom: Vector2The camera’s zoom. A zoom of
Vector(2, 2)doubles the size seen in the viewport. A zoom ofVector(0.5, 0.5)halves the size seen in the viewport.func align() Aligns the camera to the tracked node.
func forceUpdateScroll() Forces the camera to update scroll immediately.
func getScreenCenterPosition() -> Vector2 Returns the center of the screen from this camera’s point of view, in global coordinates.
func getTargetPosition() -> Vector2 Returns this camera’s target position, in global coordinates.
func isCurrent() -> Bool Returns
trueif thisCamera2Dis the active camera (seegetCamera2d).func makeCurrent() Forces this
Camera2Dto become the current active one.enabledmust betrue.func resetSmoothing() Sets the camera’s position immediately to its current smoothing destination.