ParallaxBackground

Inherits: CanvasLayer < Node < Object

A node used to create a parallax scrolling background.

Description

A ParallaxBackground uses one or more ParallaxLayer child nodes to create a parallax effect. Each ParallaxLayer can move at a different speed using ParallaxLayer.motion_offset. This creates an illusion of depth in a 2D game. If not used with a Camera2D, you must manually calculate the scroll_offset.

Properties

intlayerO: -100
Vector2scroll_base_offsetVector2( 0, 0 )
Vector2scroll_base_scaleVector2( 1, 1 )
boolscroll_ignore_camera_zoomfalse
Vector2scroll_limit_beginVector2( 0, 0 )
Vector2scroll_limit_endVector2( 0, 0 )
Vector2scroll_offsetVector2( 0, 0 )

Property Descriptions

DefaultVector2( 0, 0 )
Setterset_scroll_base_offset(value)
Getterget_scroll_base_offset()

The base position offset for all ParallaxLayer children.


DefaultVector2( 1, 1 )
Setterset_scroll_base_scale(value)
Getterget_scroll_base_scale()

The base motion scale for all ParallaxLayer children.


  • bool scroll_ignore_camera_zoom
Defaultfalse
Setterset_ignore_camera_zoom(value)
Getteris_ignore_camera_zoom()

If true, elements in ParallaxLayer child aren’t affected by the zoom level of the camera.


DefaultVector2( 0, 0 )
Setterset_limit_begin(value)
Getterget_limit_begin()

Top-left limits for scrolling to begin. If the camera is outside of this limit, the background will stop scrolling. Must be lower than scroll_limit_end to work.


DefaultVector2( 0, 0 )
Setterset_limit_end(value)
Getterget_limit_end()

Bottom-right limits for scrolling to end. If the camera is outside of this limit, the background will stop scrolling. Must be higher than scroll_limit_begin to work.


DefaultVector2( 0, 0 )
Setterset_scroll_offset(value)
Getterget_scroll_offset()

The ParallaxBackground’s scroll value. Calculated automatically when using a Camera2D, but can be used to manually manage scrolling when no camera is present.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.