mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
76 lines
3.7 KiB
ReStructuredText
76 lines
3.7 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _class_ParallaxLayer:
|
|
|
|
ParallaxLayer
|
|
=============
|
|
|
|
**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A parallax scrolling layer to be used with :ref:`ParallaxBackground<class_parallaxbackground>`.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_mirroring<class_ParallaxLayer_get_mirroring>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_motion_offset<class_ParallaxLayer_get_motion_offset>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Vector2<class_vector2>` | :ref:`get_motion_scale<class_ParallaxLayer_get_motion_scale>` **(** **)** const |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_mirroring<class_ParallaxLayer_set_mirroring>` **(** :ref:`Vector2<class_vector2>` mirror **)** |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_motion_offset<class_ParallaxLayer_set_motion_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_motion_scale<class_ParallaxLayer_set_motion_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
|
|
+--------------------------------+--------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
A ParallaxLayer must be the child of a :ref:`ParallaxBackground<class_parallaxbackground>` node. All child nodes will be affected by the parallax scrolling of this layer.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_ParallaxLayer_get_mirroring:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_mirroring** **(** **)** const
|
|
|
|
Return the mirroring of the ParallaxLayer.
|
|
|
|
.. _class_ParallaxLayer_get_motion_offset:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_motion_offset** **(** **)** const
|
|
|
|
.. _class_ParallaxLayer_get_motion_scale:
|
|
|
|
- :ref:`Vector2<class_vector2>` **get_motion_scale** **(** **)** const
|
|
|
|
Return the motion scale of the ParallaxLayer.
|
|
|
|
.. _class_ParallaxLayer_set_mirroring:
|
|
|
|
- void **set_mirroring** **(** :ref:`Vector2<class_vector2>` mirror **)**
|
|
|
|
Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring.
|
|
|
|
.. _class_ParallaxLayer_set_motion_offset:
|
|
|
|
- void **set_motion_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
|
|
|
|
.. _class_ParallaxLayer_set_motion_scale:
|
|
|
|
- void **set_motion_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
|
|
|
|
Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera.
|
|
|
|
|