Class ParallaxBackground

A node used to create a parallax scrolling background.

Inheritance

CanvasLayer

Node

Object

ParallaxBackground

Remarks

A ParallaxBackground uses one or more ParallaxLayer child nodes to create a parallax effect. Each ParallaxLayer can move at a different speed using 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 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

scroll_base_offset

The base position offset for all ParallaxLayer children.

var scroll_base_offset : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_scroll_base_offset(Vector2 value)
• Vector2 get_scroll_base_offset

scroll_base_scale

The base motion scale for all ParallaxLayer children.

var scroll_base_scale : Vector2 = Vector2(1, 1)

Property Value

Vector2

Remarks

• void set_scroll_base_scale(Vector2 value)
• Vector2 get_scroll_base_scale

scroll_ignore_camera_zoom

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

var scroll_ignore_camera_zoom : bool = false

Property Value

bool

Remarks

• void set_ignore_camera_zoom(bool value)
• bool is_ignore_camera_zoom

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.

var scroll_limit_begin : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_limit_begin(Vector2 value)
• Vector2 get_limit_begin

scroll_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.

var scroll_limit_end : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_limit_end(Vector2 value)
• Vector2 get_limit_end

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.

var scroll_offset : Vector2 = Vector2(0, 0)

Property Value

Vector2

Remarks

• void set_scroll_offset(Vector2 value)
• Vector2 get_scroll_offset