| github_url: | hide |
|---|
Inherits: :ref:`Node2D<class_Node2D>` < :ref:`CanvasItem<class_CanvasItem>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`
A parallax scrolling layer to be used with :ref:`ParallaxBackground<class_ParallaxBackground>`.
A ParallaxLayer must be the child of a :ref:`ParallaxBackground<class_ParallaxBackground>` node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the :ref:`ParallaxBackground.scroll_offset<class_ParallaxBackground_property_scroll_offset>` value.
This node's children will be affected by its scroll offset.
Note: Any changes to this node's position and scale made after it enters the scene will be ignored.
- :ref:`Vector2<class_Vector2>` motion_mirroring
| Default | Vector2( 0, 0 ) |
| Setter | set_mirroring(value) |
| Getter | get_mirroring() |
The ParallaxLayer's :ref:`Texture2D<class_Texture2D>` mirroring. Useful for creating an infinite scrolling background. If an axis is set to 0, the :ref:`Texture2D<class_Texture2D>` will not be mirrored.
- :ref:`Vector2<class_Vector2>` motion_offset
| Default | Vector2( 0, 0 ) |
| Setter | set_motion_offset(value) |
| Getter | get_motion_offset() |
The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset<class_ParallaxBackground_property_scroll_offset>`.
- :ref:`Vector2<class_Vector2>` motion_scale
| Default | Vector2( 1, 1 ) |
| Setter | set_motion_scale(value) |
| Getter | get_motion_scale() |
Multiplies the ParallaxLayer's motion. If an axis is set to 0, it will not scroll.