:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ParallaxLayer.xml. .. _class_ParallaxLayer: ParallaxLayer ============= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` A parallax scrolling layer to be used with :ref:`ParallaxBackground`. .. rst-class:: classref-introduction-group Description ----------- A ParallaxLayer must be the child of a :ref:`ParallaxBackground` node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the :ref:`ParallaxBackground.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. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`motion_mirroring` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`motion_offset` | ``Vector2(0, 0)`` | +-------------------------------+------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`motion_scale` | ``Vector2(1, 1)`` | +-------------------------------+------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ParallaxLayer_property_motion_mirroring: .. rst-class:: classref-property :ref:`Vector2` **motion_mirroring** = ``Vector2(0, 0)`` .. rst-class:: classref-property-setget - void **set_mirroring** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_mirroring** **(** **)** The interval, in pixels, at which the **ParallaxLayer** is drawn repeatedly. Useful for creating an infinitely scrolling background. If an axis is set to ``0``, the **ParallaxLayer** will be drawn only once along that direction. \ **Note:** If you want the repetition to pixel-perfect match a :ref:`Texture2D` displayed by a child node, you should account for any scale applied to the texture when defining this interval. For example, if you use a child :ref:`Sprite2D` scaled to ``0.5`` to display a 600x600 texture, and want this sprite to be repeated continuously horizontally, you should set the mirroring to ``Vector2(300, 0)``. \ **Note:** If the length of the viewport axis is bigger than twice the repeated axis size, it will not repeat infinitely, as the parallax layer only draws 2 instances of the layer at any given time. The visibility window is calculated from the parent :ref:`ParallaxBackground`'s position, not the layer's own position. So, if you use mirroring, **do not** change the **ParallaxLayer** position relative to its parent. Instead, if you need to adjust the background's position, set the :ref:`CanvasLayer.offset` property in the parent :ref:`ParallaxBackground`. \ **Note:** Despite the name, the layer will not be mirrored, it will only be repeated. .. rst-class:: classref-item-separator ---- .. _class_ParallaxLayer_property_motion_offset: .. rst-class:: classref-property :ref:`Vector2` **motion_offset** = ``Vector2(0, 0)`` .. rst-class:: classref-property-setget - void **set_motion_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_motion_offset** **(** **)** The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset`. .. rst-class:: classref-item-separator ---- .. _class_ParallaxLayer_property_motion_scale: .. rst-class:: classref-property :ref:`Vector2` **motion_scale** = ``Vector2(1, 1)`` .. rst-class:: classref-property-setget - void **set_motion_scale** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_motion_scale** **(** **)** Multiplies the ParallaxLayer's motion. If an axis is set to ``0``, it will not scroll. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`