f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
29 lines
1.5 KiB
XML
29 lines
1.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ParallaxLayer" inherits="Node2D" category="Core" version="3.2">
|
|
<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>
|
|
<methods>
|
|
</methods>
|
|
<members>
|
|
<member name="motion_mirroring" type="Vector2" setter="set_mirroring" getter="get_mirroring">
|
|
The ParallaxLayer's [Texture] mirroring. Useful for creating an infinite scrolling background. If an axis is set to [code]0[/code], the [Texture] will not be mirrored. Default value: [code](0, 0)[/code].
|
|
</member>
|
|
<member name="motion_offset" type="Vector2" setter="set_motion_offset" getter="get_motion_offset">
|
|
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">
|
|
Multiplies the ParallaxLayer's motion. If an axis is set to [code]0[/code], it will not scroll.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|