| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the LightOccluder2D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_LightOccluder2D:
- LightOccluder2D
- ===============
- **Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- Occludes light cast by a Light2D, casting shadows.
- Member Functions
- ----------------
- +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_occluder_light_mask<class_LightOccluder2D_get_occluder_light_mask>` **(** **)** const |
- +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`OccluderPolygon2D<class_occluderpolygon2d>` | :ref:`get_occluder_polygon<class_LightOccluder2D_get_occluder_polygon>` **(** **)** const |
- +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_occluder_light_mask<class_LightOccluder2D_set_occluder_light_mask>` **(** :ref:`int<class_int>` mask **)** |
- +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_occluder_polygon<class_LightOccluder2D_set_occluder_polygon>` **(** :ref:`OccluderPolygon2D<class_occluderpolygon2d>` polygon **)** |
- +----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- - :ref:`int<class_int>` **light_mask** - The LightOccluder2D's light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s).
- - :ref:`OccluderPolygon2D<class_occluderpolygon2d>` **occluder** - The [OccluderPolygon2D] used to compute the shadow.
- 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.
- Member Function Description
- ---------------------------
- .. _class_LightOccluder2D_get_occluder_light_mask:
- - :ref:`int<class_int>` **get_occluder_light_mask** **(** **)** const
- Return the light mask of the LightOccluder2D.
- .. _class_LightOccluder2D_get_occluder_polygon:
- - :ref:`OccluderPolygon2D<class_occluderpolygon2d>` **get_occluder_polygon** **(** **)** const
- Return the OccluderPolygon2D that defines the LightOccluder2D.
- .. _class_LightOccluder2D_set_occluder_light_mask:
- - void **set_occluder_light_mask** **(** :ref:`int<class_int>` mask **)**
- Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s).
- .. _class_LightOccluder2D_set_occluder_polygon:
- - void **set_occluder_polygon** **(** :ref:`OccluderPolygon2D<class_occluderpolygon2d>` polygon **)**
- Set the OccluderPolygon2D that defines the LightOccluder2D.
|
