stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-11-07 11:11:44 +01:00
parent 79b6aa5254
commit e2662b0d0f
110 changed files with 1175 additions and 698 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_parallaxbackground.rst
+7 -7
View File
@@ -50,33 +50,33 @@ Member Variables
.. _class_ParallaxBackground_scroll_base_offset:
- :ref:`Vector2<class_vector2>` **scroll_base_offset**
- :ref:`Vector2<class_vector2>` **scroll_base_offset** - Base position offset of all :ref:`ParallaxLayer<class_parallaxlayer>` children.
.. _class_ParallaxBackground_scroll_base_scale:
- :ref:`Vector2<class_vector2>` **scroll_base_scale**
- :ref:`Vector2<class_vector2>` **scroll_base_scale** - Base motion scale of all :ref:`ParallaxLayer<class_parallaxlayer>` children.
.. _class_ParallaxBackground_scroll_ignore_camera_zoom:
- :ref:`bool<class_bool>` **scroll_ignore_camera_zoom**
- :ref:`bool<class_bool>` **scroll_ignore_camera_zoom** - If ``true`` elements in :ref:`ParallaxLayer<class_parallaxlayer>` child aren't affected by the zoom level of the camera.
.. _class_ParallaxBackground_scroll_limit_begin:
- :ref:`Vector2<class_vector2>` **scroll_limit_begin**
- :ref:`Vector2<class_vector2>` **scroll_limit_begin** - Top left limits for scrolling to begin. If the camera is outside of this limit the background will stop scrolling. Must be lower than :ref:`scroll_limit_end<class_ParallaxBackground_scroll_limit_end>` to work.
.. _class_ParallaxBackground_scroll_limit_end:
- :ref:`Vector2<class_vector2>` **scroll_limit_end**
- :ref:`Vector2<class_vector2>` **scroll_limit_end** - Right bottom limits for scrolling to end. If the camera is outside of this limit the background will stop scrolling. Must be higher than :ref:`scroll_limit_begin<class_ParallaxBackground_scroll_limit_begin>` to work.
.. _class_ParallaxBackground_scroll_offset:
- :ref:`Vector2<class_vector2>` **scroll_offset**
- :ref:`Vector2<class_vector2>` **scroll_offset** - The ParallaxBackground's scroll value. Calculated automatically when using a :ref:`Camera2D<class_camera2d>`, but can be used to manually manage scrolling when no camera is present.
Description
-----------
A ParallaxBackground will use one or more :ref:`ParallaxLayer<class_parallaxlayer>` nodes to create a parallax scrolling background. Each :ref:`ParallaxLayer<class_parallaxlayer>` can be set to move at different speeds relative to the camera movement, this can be used to create an illusion of depth in a 2D game.
A ParallaxBackground uses one or more :ref:`ParallaxLayer<class_parallaxlayer>` child nodes to create a parallax effect. Each :ref:`ParallaxLayer<class_parallaxlayer>` can move at a different speed using :ref:`ParallaxLayer.motion_offset<class_ParallaxLayer_motion_offset>`. This creates an illusion of depth in a 2D game. If not used with a :ref:`Camera2D<class_camera2d>`, you must manually calculate the :ref:`scroll_offset<class_ParallaxBackground_scroll_offset>`.
Member Function Description
---------------------------