Class reference
ParallaxBackground
Inherits CanvasLayer
Use the Parallax2D node instead.
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. Note: Each ParallaxBackground is drawn on one specific Viewport and cannot be shared between multiple Viewports, see CanvasLayer.custom_viewport. When using multiple Viewports, for example in a split-screen game, you need create an individual ParallaxBackground for each Viewport you want it to be drawn on.
Properties
int layer = -100
int layer = -100Vector2 scroll_base_offset = Vector2(0, 0)
Vector2 scroll_base_offset = Vector2(0, 0)The base position offset for all ParallaxLayer children.
Vector2 scroll_base_scale = Vector2(1, 1)
Vector2 scroll_base_scale = Vector2(1, 1)The base motion scale for all ParallaxLayer children.
bool scroll_ignore_camera_zoom = false
bool scroll_ignore_camera_zoom = falseIf true, elements in ParallaxLayer child aren't affected by the zoom level of the camera.
Vector2 scroll_limit_begin = Vector2(0, 0)
Vector2 scroll_limit_begin = Vector2(0, 0)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.
Vector2 scroll_limit_end = Vector2(0, 0)
Vector2 scroll_limit_end = Vector2(0, 0)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.
Vector2 scroll_offset = Vector2(0, 0)
Vector2 scroll_offset = Vector2(0, 0)The ParallaxBackground's scroll value. Calculated automatically when using a Camera2D, but can be used to manually manage scrolling when no camera is present.