virtualx-engine/doc/classes/ParallaxLayer.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ParallaxLayer" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A parallax scrolling layer to be used with [ParallaxBackground].
	</brief_description>
	<description>
		A ParallaxLayer must be the child of a [ParallaxBackground] node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the [member ParallaxBackground.scroll_offset] value.
		This node's children will be affected by its scroll offset.
		[b]Note:[/b] Any changes to this node's position and scale made after it enters the scene will be ignored.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="motion_mirroring" type="Vector2" setter="set_mirroring" getter="get_mirroring" default="Vector2(0, 0)">
			The ParallaxLayer's [Texture2D] repeating. Useful for creating an infinite scrolling background. If an axis is set to [code]0[/code], the [Texture2D] will not be repeated.
			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 texture at any given time.
			[b]Note:[/b] Despite its name, the texture will not be mirrored, it will simply be repeated.
		</member>
		<member name="motion_offset" type="Vector2" setter="set_motion_offset" getter="get_motion_offset" default="Vector2(0, 0)">
			The ParallaxLayer's offset relative to the parent ParallaxBackground's [member ParallaxBackground.scroll_offset].
		</member>
		<member name="motion_scale" type="Vector2" setter="set_motion_scale" getter="get_motion_scale" default="Vector2(1, 1)">
			Multiplies the ParallaxLayer's motion. If an axis is set to [code]0[/code], it will not scroll.
		</member>
	</members>
</class>