godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
classes/class_lightoccluder2d.rst
View File

@@ -14,71 +14,89 @@ LightOccluder2D
Occludes light cast by a Light2D, casting shadows.
.. rst-class:: classref-introduction-group
Description
-----------
Occludes light cast by a Light2D, casting shadows. The LightOccluder2D must be provided with an :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` in order for the shadow to be computed.
.. rst-class:: classref-introduction-group
Tutorials
---------
- :doc:`2D lights and shadows <../tutorials/2d/2d_lights_and_shadows>`
.. rst-class:: classref-reftable-group
Properties
----------
+---------------------------------------------------+--------------------------------------------------------------------------------+----------+
| :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` | :ref:`occluder<class_LightOccluder2D_property_occluder>` | |
+---------------------------------------------------+--------------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`occluder_light_mask<class_LightOccluder2D_property_occluder_light_mask>` | ``1`` |
+---------------------------------------------------+--------------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`sdf_collision<class_LightOccluder2D_property_sdf_collision>` | ``true`` |
+---------------------------------------------------+--------------------------------------------------------------------------------+----------+
.. table::
:widths: auto
+---------------------------------------------------+--------------------------------------------------------------------------------+----------+
| :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` | :ref:`occluder<class_LightOccluder2D_property_occluder>` | |
+---------------------------------------------------+--------------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`occluder_light_mask<class_LightOccluder2D_property_occluder_light_mask>` | ``1`` |
+---------------------------------------------------+--------------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`sdf_collision<class_LightOccluder2D_property_sdf_collision>` | ``true`` |
+---------------------------------------------------+--------------------------------------------------------------------------------+----------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_LightOccluder2D_property_occluder:
- :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` **occluder**
.. rst-class:: classref-property
+----------+-----------------------------+
| *Setter* | set_occluder_polygon(value) |
+----------+-----------------------------+
| *Getter* | get_occluder_polygon() |
+----------+-----------------------------+
:ref:`OccluderPolygon2D<class_OccluderPolygon2D>` **occluder**
.. rst-class:: classref-property-setget
- void **set_occluder_polygon** **(** :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` value **)**
- :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` **get_occluder_polygon** **(** **)**
The :ref:`OccluderPolygon2D<class_OccluderPolygon2D>` used to compute the shadow.
.. rst-class:: classref-item-separator
----
.. _class_LightOccluder2D_property_occluder_light_mask:
- :ref:`int<class_int>` **occluder_light_mask**
.. rst-class:: classref-property
+-----------+--------------------------------+
| *Default* | ``1`` |
+-----------+--------------------------------+
| *Setter* | set_occluder_light_mask(value) |
+-----------+--------------------------------+
| *Getter* | get_occluder_light_mask() |
+-----------+--------------------------------+
:ref:`int<class_int>` **occluder_light_mask** = ``1``
.. rst-class:: classref-property-setget
- void **set_occluder_light_mask** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_occluder_light_mask** **(** **)**
The LightOccluder2D's occluder light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s).
.. rst-class:: classref-item-separator
----
.. _class_LightOccluder2D_property_sdf_collision:
- :ref:`bool<class_bool>` **sdf_collision**
.. rst-class:: classref-property
+-----------+-----------------------------+
| *Default* | ``true`` |
+-----------+-----------------------------+
| *Setter* | set_as_sdf_collision(value) |
+-----------+-----------------------------+
| *Getter* | is_set_as_sdf_collision() |
+-----------+-----------------------------+
:ref:`bool<class_bool>` **sdf_collision** = ``true``
.. rst-class:: classref-property-setget
- void **set_as_sdf_collision** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_set_as_sdf_collision** **(** **)**
.. container:: contribute