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

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2017-11-27 08:32:15 +01:00
parent 33f109ea70
commit 5bf33731b6
303 changed files with 2187 additions and 18408 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_parallaxbackground.rst
-101
View File
@@ -16,35 +16,6 @@ Brief Description
A node used to create a parallax scrolling background.
Member Functions
----------------
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_limit_begin<class_ParallaxBackground_get_limit_begin>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_limit_end<class_ParallaxBackground_get_limit_end>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scroll_base_offset<class_ParallaxBackground_get_scroll_base_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scroll_base_scale<class_ParallaxBackground_get_scroll_base_scale>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scroll_offset<class_ParallaxBackground_get_scroll_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ignore_camera_zoom<class_ParallaxBackground_is_ignore_camera_zoom>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ignore_camera_zoom<class_ParallaxBackground_set_ignore_camera_zoom>` **(** :ref:`bool<class_bool>` ignore **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_limit_begin<class_ParallaxBackground_set_limit_begin>` **(** :ref:`Vector2<class_vector2>` ofs **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_limit_end<class_ParallaxBackground_set_limit_end>` **(** :ref:`Vector2<class_vector2>` ofs **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scroll_base_offset<class_ParallaxBackground_set_scroll_base_offset>` **(** :ref:`Vector2<class_vector2>` ofs **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scroll_base_scale<class_ParallaxBackground_set_scroll_base_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scroll_offset<class_ParallaxBackground_set_scroll_offset>` **(** :ref:`Vector2<class_vector2>` ofs **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
@@ -78,75 +49,3 @@ Description
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
---------------------------
.. _class_ParallaxBackground_get_limit_begin:
- :ref:`Vector2<class_vector2>` **get_limit_begin** **(** **)** const
Return the beginning limit.
.. _class_ParallaxBackground_get_limit_end:
- :ref:`Vector2<class_vector2>` **get_limit_end** **(** **)** const
Return the ending limit.
.. _class_ParallaxBackground_get_scroll_base_offset:
- :ref:`Vector2<class_vector2>` **get_scroll_base_offset** **(** **)** const
Return the base offset.
.. _class_ParallaxBackground_get_scroll_base_scale:
- :ref:`Vector2<class_vector2>` **get_scroll_base_scale** **(** **)** const
Return the base motion scale.
.. _class_ParallaxBackground_get_scroll_offset:
- :ref:`Vector2<class_vector2>` **get_scroll_offset** **(** **)** const
.. _class_ParallaxBackground_is_ignore_camera_zoom:
- :ref:`bool<class_bool>` **is_ignore_camera_zoom** **(** **)**
Return ignoring camera zoom.
.. _class_ParallaxBackground_set_ignore_camera_zoom:
- void **set_ignore_camera_zoom** **(** :ref:`bool<class_bool>` ignore **)**
Set to true for all child :ref:`ParallaxLayer<class_parallaxlayer>` nodes to not be affected by the zoom level of the camera.
.. _class_ParallaxBackground_set_limit_begin:
- void **set_limit_begin** **(** :ref:`Vector2<class_vector2>` ofs **)**
Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis.
.. _class_ParallaxBackground_set_limit_end:
- void **set_limit_end** **(** :ref:`Vector2<class_vector2>` ofs **)**
Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis.
.. _class_ParallaxBackground_set_scroll_base_offset:
- void **set_scroll_base_offset** **(** :ref:`Vector2<class_vector2>` ofs **)**
Set the base offset in pixels of all children :ref:`ParallaxLayer<class_parallaxlayer>` nodes.
.. _class_ParallaxBackground_set_scroll_base_scale:
- void **set_scroll_base_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
Set the base motion scale of all children :ref:`ParallaxLayer<class_parallaxlayer>` nodes.
.. _class_ParallaxBackground_set_scroll_offset:
- void **set_scroll_offset** **(** :ref:`Vector2<class_vector2>` ofs **)**