A node used to create a parallax scrolling background.
class Parallax2DA Parallax2D is used to create a parallax effect. It can move at a different speed relative to the camera movement using scrollScale. This creates an illusion of depth in a 2D game. If manual scrolling is desired, the Camera2D position can be ignored with ignoreCameraScroll.
import SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
final var scrollScale: Vector2 { get set }Multiplier to the final Parallax2D’s offset. Can be used to simulate distance from the camera.
class Camera2DCamera node for 2D scenes.
final var ignoreCameraScroll: Bool { get set }If true, Parallax2D’s position is not affected by the position of the camera.
final var screenOffset: Vector2 { get set }Offset used to scroll this Parallax2D. This value is updated automatically unless ignoreCameraScroll is true.
class Node2DA 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable : VariantStorableTypes that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, 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.
override class var godotClassName: StringName { get }final var autoscroll: Vector2 { get set }Velocity at which the offset scrolls automatically, in pixels per second.
final var followViewport: Bool { get set }If true, this Parallax2D is offset by the current camera’s position. If the Parallax2D is in a CanvasLayer separate from the current camera, it may be desired to match the value with followViewportEnabled.
final var limitBegin: Vector2 { get set }Top-left limits for scrolling to begin. If the camera is outside of this limit, the Parallax2D stops scrolling. Must be lower than limitEnd minus the viewport size to work.
final var limitEnd: Vector2 { get set }Bottom-right limits for scrolling to end. If the camera is outside of this limit, the Parallax2D will stop scrolling. Must be higher than limitBegin and the viewport size combined to work.
final var repeatSize: Vector2 { get set }Repeats the Texture2D of each of this node’s children and offsets them by this value. When scrolling, the node’s position loops, giving the illusion of an infinite scrolling background if the values are larger than the screen size. If an axis is set to 0, the Texture2D will not be repeated.
final var repeatTimes: Int32 { get set }Overrides the amount of times the texture repeats. Each texture copy spreads evenly from the original by repeatSize. Useful for when zooming out with a camera.
final var scrollOffset: Vector2 { get set }The Parallax2D’s offset. Similar to screenOffset and position, but will not be overridden.