ParallaxBackground¶
Inherits: CanvasLayer < Node < Object
Category: Core
Brief Description¶
A node used to create a parallax scrolling background.
Member Variables¶
- Vector2 scroll_base_offset - Base position offset of all ParallaxLayer children.
- Vector2 scroll_base_scale - Base motion scale of all ParallaxLayer children.
- bool scroll_ignore_camera_zoom - If
trueelements in ParallaxLayer child aren’t affected by the zoom level of the camera. - Vector2 scroll_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.
- Vector2 scroll_limit_end - Right bottom 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 - The ParallaxBackground’s scroll value. Calculated automatically when using a Camera2D, but can be used to manually manage scrolling when no camera is present.
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.