Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_spotlight3d.rst

class_spotlight3d.rst 8.9 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 
  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/SpotLight3D.xml.
    7. 

  7. 

  8. .. _class_SpotLight3D:
    9. 

  9. 

  10. SpotLight3D
    11. 

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

  12. 

  13. **Inherits:** :ref:`Light3D<class_Light3D>` **<** :ref:`VisualInstance3D<class_VisualInstance3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A spotlight, such as a reflector spotlight or a lantern.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. A Spotlight is a type of :ref:`Light3D<class_Light3D>` node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance. This attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light3D<class_Light3D>`.
    23. 

  23. 

  24. \ **Note:** When using the Mobile rendering method, only 8 spot lights can be displayed on each mesh resource. Attempting to display more than 8 spot lights on a single mesh resource will result in spot lights flickering in and out as the camera moves. When using the Compatibility rendering method, only 8 spot lights can be displayed on each mesh resource by default, but this can be increased by adjusting :ref:`ProjectSettings.rendering/limits/opengl/max_lights_per_object<class_ProjectSettings_property_rendering/limits/opengl/max_lights_per_object>`.
    25. 

  25. 

  26. \ **Note:** When using the Mobile or Compatibility rendering methods, spot lights will only correctly affect meshes whose visibility AABB intersects with the light's AABB. If using a shader to deform the mesh in a way that makes it go outside its AABB, :ref:`GeometryInstance3D.extra_cull_margin<class_GeometryInstance3D_property_extra_cull_margin>` must be increased on the mesh. Otherwise, the light may not be visible on the mesh.
    27. 

  27. 

  28. .. rst-class:: classref-introduction-group
    29. 

  29. 

  30. Tutorials
    31. 

  31. ---------
    32. 

  32. 

  33. - :doc:`3D lights and shadows <../tutorials/3d/lights_and_shadows>`
    34. 

  34. 

  35. - :doc:`Faking global illumination <../tutorials/3d/global_illumination/faking_global_illumination>`
    36. 

  36. 

  37. - `Third Person Shooter (TPS) Demo <https://godotengine.org/asset-library/asset/2710>`__
    38. 

  38. 

  39. .. rst-class:: classref-reftable-group
    40. 

  40. 

  41. Properties
    42. 

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

  43. 

  44. .. table::
    45. 

  45.    :widths: auto
    46. 

  46. 

  47.    +---------------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    48. 

  48.    | :ref:`float<class_float>` | shadow_bias                                                                      | ``0.03`` (overrides :ref:`Light3D<class_Light3D_property_shadow_bias>`)       |
    49. 

  49.    +---------------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    50. 

  50.    | :ref:`float<class_float>` | shadow_normal_bias                                                               | ``1.0`` (overrides :ref:`Light3D<class_Light3D_property_shadow_normal_bias>`) |
    51. 

  51.    +---------------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    52. 

  52.    | :ref:`float<class_float>` | :ref:`spot_angle<class_SpotLight3D_property_spot_angle>`                         | ``45.0``                                                                      |
    53. 

  53.    +---------------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    54. 

  54.    | :ref:`float<class_float>` | :ref:`spot_angle_attenuation<class_SpotLight3D_property_spot_angle_attenuation>` | ``1.0``                                                                       |
    55. 

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

  56.    | :ref:`float<class_float>` | :ref:`spot_attenuation<class_SpotLight3D_property_spot_attenuation>`             | ``1.0``                                                                       |
    57. 

  57.    +---------------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    58. 

  58.    | :ref:`float<class_float>` | :ref:`spot_range<class_SpotLight3D_property_spot_range>`                         | ``5.0``                                                                       |
    59. 

  59.    +---------------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    60. 

  60. 

  61. .. rst-class:: classref-section-separator
    62. 

  62. 

  63. ----
    64. 

  64. 

  65. .. rst-class:: classref-descriptions-group
    66. 

  66. 

  67. Property Descriptions
    68. 

  68. ---------------------
    69. 

  69. 

  70. .. _class_SpotLight3D_property_spot_angle:
    71. 

  71. 

  72. .. rst-class:: classref-property
    73. 

  73. 

  74. :ref:`float<class_float>` **spot_angle** = ``45.0`` :ref:`🔗<class_SpotLight3D_property_spot_angle>`
    75. 

  75. 

  76. .. rst-class:: classref-property-setget
    77. 

  77. 

  78. - |void| **set_param**\ (\ value\: :ref:`float<class_float>`\ )
    79. 

  79. - :ref:`float<class_float>` **get_param**\ (\ )
    80. 

  80. 

  81. The spotlight's angle in degrees.
    82. 

  82. 

  83. \ **Note:** :ref:`spot_angle<class_SpotLight3D_property_spot_angle>` is not affected by :ref:`Node3D.scale<class_Node3D_property_scale>` (the light's scale or its parent's scale).
    84. 

  84. 

  85. .. rst-class:: classref-item-separator
    86. 

  86. 

  87. ----
    88. 

  88. 

  89. .. _class_SpotLight3D_property_spot_angle_attenuation:
    90. 

  90. 

  91. .. rst-class:: classref-property
    92. 

  92. 

  93. :ref:`float<class_float>` **spot_angle_attenuation** = ``1.0`` :ref:`🔗<class_SpotLight3D_property_spot_angle_attenuation>`
    94. 

  94. 

  95. .. rst-class:: classref-property-setget
    96. 

  96. 

  97. - |void| **set_param**\ (\ value\: :ref:`float<class_float>`\ )
    98. 

  98. - :ref:`float<class_float>` **get_param**\ (\ )
    99. 

  99. 

  100. The spotlight's *angular* attenuation curve. See also :ref:`spot_attenuation<class_SpotLight3D_property_spot_attenuation>`.
    101. 

  101. 

  102. .. rst-class:: classref-item-separator
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_SpotLight3D_property_spot_attenuation:
    107. 

  107. 

  108. .. rst-class:: classref-property
    109. 

  109. 

  110. :ref:`float<class_float>` **spot_attenuation** = ``1.0`` :ref:`🔗<class_SpotLight3D_property_spot_attenuation>`
    111. 

  111. 

  112. .. rst-class:: classref-property-setget
    113. 

  113. 

  114. - |void| **set_param**\ (\ value\: :ref:`float<class_float>`\ )
    115. 

  115. - :ref:`float<class_float>` **get_param**\ (\ )
    116. 

  116. 

  117. Controls the distance attenuation function for spotlights.
    118. 

  118. 

  119. A value of ``0.0`` will maintain a constant brightness through most of the range, but smoothly attenuate the light at the edge of the range. Use a value of ``2.0`` for physically accurate lights as it results in the proper inverse square attenutation.
    120. 

  120. 

  121. \ **Note:** Setting attenuation to ``2.0`` or higher may result in distant objects receiving minimal light, even within range. For example, with a range of ``4096``, an object at ``100`` units is attenuated by a factor of ``0.0001``. With a default brightness of ``1``, the light would not be visible at that distance.
    122. 

  122. 

  123. \ **Note:** Using negative or values higher than ``10.0`` may lead to unexpected results.
    124. 

  124. 

  125. .. rst-class:: classref-item-separator
    126. 

  126. 

  127. ----
    128. 

  128. 

  129. .. _class_SpotLight3D_property_spot_range:
    130. 

  130. 

  131. .. rst-class:: classref-property
    132. 

  132. 

  133. :ref:`float<class_float>` **spot_range** = ``5.0`` :ref:`🔗<class_SpotLight3D_property_spot_range>`
    134. 

  134. 

  135. .. rst-class:: classref-property-setget
    136. 

  136. 

  137. - |void| **set_param**\ (\ value\: :ref:`float<class_float>`\ )
    138. 

  138. - :ref:`float<class_float>` **get_param**\ (\ )
    139. 

  139. 

  140. The maximal range that can be reached by the spotlight. Note that the effectively lit area may appear to be smaller depending on the :ref:`spot_attenuation<class_SpotLight3D_property_spot_attenuation>` in use. No matter the :ref:`spot_attenuation<class_SpotLight3D_property_spot_attenuation>` in use, the light will never reach anything outside this range.
    141. 

  141. 

  142. \ **Note:** :ref:`spot_range<class_SpotLight3D_property_spot_range>` is not affected by :ref:`Node3D.scale<class_Node3D_property_scale>` (the light's scale or its parent's scale).
    143. 

  143. 

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

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

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

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

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

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

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

  151. .. |void| replace:: :abbr:`void (No return value.)`
    152. 

  152.