صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
Godot
/
godot-docs
mirrorاز https://github.com/godotengine/godot-docs.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
شاخه: classref/sync-cb7cd81
شاخه‌ها تگ‌ها
godot-docs
/
classes
/
class_parallaxlayer.rst

class_parallaxlayer.rst 7.2 KB
لینک دائمی تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ParallaxLayer.xml.
    7. 

  7. 

  8. .. _class_ParallaxLayer:
    9. 

  9. 

  10. ParallaxLayer
    11. 

  11. =============
    12. 

  12. 

  13. **Deprecated:** Use the :ref:`Parallax2D<class_Parallax2D>` node instead.
    14. 

  14. 

  15. **Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    16. 

  16. 

  17. A parallax scrolling layer to be used with :ref:`ParallaxBackground<class_ParallaxBackground>`.
    18. 

  18. 

  19. .. rst-class:: classref-introduction-group
    20. 

  20. 

  21. Description
    22. 

  22. -----------
    23. 

  23. 

  24. A ParallaxLayer must be the child of a :ref:`ParallaxBackground<class_ParallaxBackground>` node. Each ParallaxLayer can be set to move at different speeds relative to the camera movement or the :ref:`ParallaxBackground.scroll_offset<class_ParallaxBackground_property_scroll_offset>` value.
    25. 

  25. 

  26. This node's children will be affected by its scroll offset.
    27. 

  27. 

  28. \ **Note:** Any changes to this node's position and scale made after it enters the scene will be ignored.
    29. 

  29. 

  30. .. rst-class:: classref-reftable-group
    31. 

  31. 

  32. Properties
    33. 

  33. ----------
    34. 

  34. 

  35. .. table::
    36. 

  36.    :widths: auto
    37. 

  37. 

  38.    +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    39. 

  39.    | :ref:`Vector2<class_Vector2>`                                       | :ref:`motion_mirroring<class_ParallaxLayer_property_motion_mirroring>` | ``Vector2(0, 0)``                                                             |
    40. 

  40.    +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    41. 

  41.    | :ref:`Vector2<class_Vector2>`                                       | :ref:`motion_offset<class_ParallaxLayer_property_motion_offset>`       | ``Vector2(0, 0)``                                                             |
    42. 

  42.    +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    43. 

  43.    | :ref:`Vector2<class_Vector2>`                                       | :ref:`motion_scale<class_ParallaxLayer_property_motion_scale>`         | ``Vector2(1, 1)``                                                             |
    44. 

  44.    +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    45. 

  45.    | :ref:`PhysicsInterpolationMode<enum_Node_PhysicsInterpolationMode>` | physics_interpolation_mode                                             | ``2`` (overrides :ref:`Node<class_Node_property_physics_interpolation_mode>`) |
    46. 

  46.    +---------------------------------------------------------------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    47. 

  47. 

  48. .. rst-class:: classref-section-separator
    49. 

  49. 

  50. ----
    51. 

  51. 

  52. .. rst-class:: classref-descriptions-group
    53. 

  53. 

  54. Property Descriptions
    55. 

  55. ---------------------
    56. 

  56. 

  57. .. _class_ParallaxLayer_property_motion_mirroring:
    58. 

  58. 

  59. .. rst-class:: classref-property
    60. 

  60. 

  61. :ref:`Vector2<class_Vector2>` **motion_mirroring** = ``Vector2(0, 0)`` :ref:`🔗<class_ParallaxLayer_property_motion_mirroring>`
    62. 

  62. 

  63. .. rst-class:: classref-property-setget
    64. 

  64. 

  65. - |void| **set_mirroring**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
    66. 

  66. - :ref:`Vector2<class_Vector2>` **get_mirroring**\ (\ )
    67. 

  67. 

  68. The interval, in pixels, at which the **ParallaxLayer** is drawn repeatedly. Useful for creating an infinitely scrolling background. If an axis is set to ``0``, the **ParallaxLayer** will be drawn only once along that direction.
    69. 

  69. 

  70. \ **Note:** If you want the repetition to pixel-perfect match a :ref:`Texture2D<class_Texture2D>` displayed by a child node, you should account for any scale applied to the texture when defining this interval. For example, if you use a child :ref:`Sprite2D<class_Sprite2D>` scaled to ``0.5`` to display a 600x600 texture, and want this sprite to be repeated continuously horizontally, you should set the mirroring to ``Vector2(300, 0)``.
    71. 

  71. 

  72. \ **Note:** 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 layer at any given time. The visibility window is calculated from the parent :ref:`ParallaxBackground<class_ParallaxBackground>`'s position, not the layer's own position. So, if you use mirroring, **do not** change the **ParallaxLayer** position relative to its parent. Instead, if you need to adjust the background's position, set the :ref:`CanvasLayer.offset<class_CanvasLayer_property_offset>` property in the parent :ref:`ParallaxBackground<class_ParallaxBackground>`.
    73. 

  73. 

  74. \ **Note:** Despite the name, the layer will not be mirrored, it will only be repeated.
    75. 

  75. 

  76. .. rst-class:: classref-item-separator
    77. 

  77. 

  78. ----
    79. 

  79. 

  80. .. _class_ParallaxLayer_property_motion_offset:
    81. 

  81. 

  82. .. rst-class:: classref-property
    83. 

  83. 

  84. :ref:`Vector2<class_Vector2>` **motion_offset** = ``Vector2(0, 0)`` :ref:`🔗<class_ParallaxLayer_property_motion_offset>`
    85. 

  85. 

  86. .. rst-class:: classref-property-setget
    87. 

  87. 

  88. - |void| **set_motion_offset**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
    89. 

  89. - :ref:`Vector2<class_Vector2>` **get_motion_offset**\ (\ )
    90. 

  90. 

  91. The ParallaxLayer's offset relative to the parent ParallaxBackground's :ref:`ParallaxBackground.scroll_offset<class_ParallaxBackground_property_scroll_offset>`.
    92. 

  92. 

  93. .. rst-class:: classref-item-separator
    94. 

  94. 

  95. ----
    96. 

  96. 

  97. .. _class_ParallaxLayer_property_motion_scale:
    98. 

  98. 

  99. .. rst-class:: classref-property
    100. 

  100. 

  101. :ref:`Vector2<class_Vector2>` **motion_scale** = ``Vector2(1, 1)`` :ref:`🔗<class_ParallaxLayer_property_motion_scale>`
    102. 

  102. 

  103. .. rst-class:: classref-property-setget
    104. 

  104. 

  105. - |void| **set_motion_scale**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
    106. 

  106. - :ref:`Vector2<class_Vector2>` **get_motion_scale**\ (\ )
    107. 

  107. 

  108. Multiplies the ParallaxLayer's motion. If an axis is set to ``0``, it will not scroll.
    109. 

  109. 

  110. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    111. 

  111. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
    112. 

  112. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    113. 

  113. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    114. 

  114. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    115. 

  115. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    116. 

  116. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    117. 

  117. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    118. 

  118. .. |void| replace:: :abbr:`void (No return value.)`
    119.