ParallaxBackground Properties

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

The custom Viewport node assigned to the CanvasLayer. If null, uses the default viewport instead.

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

Sets the layer to follow the viewport in order to simulate a pseudo 3D effect.

Scales the layer when using FollowViewportEnable. Layers moving into the foreground should have increasing scales, while layers moving into the background should have decreasing scales.

Layer index for draw order. Lower values are drawn first.

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

The layer's base offset.

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

Pause mode. How the node will behave if the SceneTree is paused.

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

The layer's rotation in radians.

The layer's rotation in degrees.

The layer's scale.

The base position offset for all ParallaxLayer children.

The base motion scale for all ParallaxLayer children.

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

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

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

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

The layer's transform.