Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: d8dd399304
Branches Tags
godot-docs
/
classes
/
class_spotlight3d.rst

class_spotlight3d.rst 7.7 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141 
  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. - `Third Person Shooter Demo <https://godotengine.org/asset-library/asset/678>`__
    36. 

  36. 

  37. .. rst-class:: classref-reftable-group
    38. 

  38. 

  39. Properties
    40. 

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

  41. 

  42. .. table::
    43. 

  43.    :widths: auto
    44. 

  44. 

  45.    +---------------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------+
    46. 

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

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

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

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

  50.    | :ref:`float<class_float>` | :ref:`spot_angle<class_SpotLight3D_property_spot_angle>`                         | ``45.0``                                                                      |
    51. 

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

  52.    | :ref:`float<class_float>` | :ref:`spot_angle_attenuation<class_SpotLight3D_property_spot_angle_attenuation>` | ``1.0``                                                                       |
    53. 

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

  54.    | :ref:`float<class_float>` | :ref:`spot_attenuation<class_SpotLight3D_property_spot_attenuation>`             | ``1.0``                                                                       |
    55. 

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

  56.    | :ref:`float<class_float>` | :ref:`spot_range<class_SpotLight3D_property_spot_range>`                         | ``5.0``                                                                       |
    57. 

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

  58. 

  59. .. rst-class:: classref-section-separator
    60. 

  60. 

  61. ----
    62. 

  62. 

  63. .. rst-class:: classref-descriptions-group
    64. 

  64. 

  65. Property Descriptions
    66. 

  66. ---------------------
    67. 

  67. 

  68. .. _class_SpotLight3D_property_spot_angle:
    69. 

  69. 

  70. .. rst-class:: classref-property
    71. 

  71. 

  72. :ref:`float<class_float>` **spot_angle** = ``45.0``
    73. 

  73. 

  74. .. rst-class:: classref-property-setget
    75. 

  75. 

  76. - void **set_param** **(** :ref:`float<class_float>` value **)**
    77. 

  77. - :ref:`float<class_float>` **get_param** **(** **)**
    78. 

  78. 

  79. The spotlight's angle in degrees.
    80. 

  80. 

  81. \ **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).
    82. 

  82. 

  83. .. rst-class:: classref-item-separator
    84. 

  84. 

  85. ----
    86. 

  86. 

  87. .. _class_SpotLight3D_property_spot_angle_attenuation:
    88. 

  88. 

  89. .. rst-class:: classref-property
    90. 

  90. 

  91. :ref:`float<class_float>` **spot_angle_attenuation** = ``1.0``
    92. 

  92. 

  93. .. rst-class:: classref-property-setget
    94. 

  94. 

  95. - void **set_param** **(** :ref:`float<class_float>` value **)**
    96. 

  96. - :ref:`float<class_float>` **get_param** **(** **)**
    97. 

  97. 

  98. The spotlight's angular attenuation curve.
    99. 

  99. 

  100. .. rst-class:: classref-item-separator
    101. 

  101. 

  102. ----
    103. 

  103. 

  104. .. _class_SpotLight3D_property_spot_attenuation:
    105. 

  105. 

  106. .. rst-class:: classref-property
    107. 

  107. 

  108. :ref:`float<class_float>` **spot_attenuation** = ``1.0``
    109. 

  109. 

  110. .. rst-class:: classref-property-setget
    111. 

  111. 

  112. - void **set_param** **(** :ref:`float<class_float>` value **)**
    113. 

  113. - :ref:`float<class_float>` **get_param** **(** **)**
    114. 

  114. 

  115. The spotlight's light energy attenuation curve.
    116. 

  116. 

  117. .. rst-class:: classref-item-separator
    118. 

  118. 

  119. ----
    120. 

  120. 

  121. .. _class_SpotLight3D_property_spot_range:
    122. 

  122. 

  123. .. rst-class:: classref-property
    124. 

  124. 

  125. :ref:`float<class_float>` **spot_range** = ``5.0``
    126. 

  126. 

  127. .. rst-class:: classref-property-setget
    128. 

  128. 

  129. - void **set_param** **(** :ref:`float<class_float>` value **)**
    130. 

  130. - :ref:`float<class_float>` **get_param** **(** **)**
    131. 

  131. 

  132. 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.
    133. 

  133. 

  134. \ **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).
    135. 

  135. 

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

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

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

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

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

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