mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
classref: Sync with current master branch (f87858a8f)
This commit is contained in:
Yuri Sizov
@@ -16,360 +16,435 @@ Light2D
|
||||
|
||||
Casts light in a 2D environment.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related).
|
||||
Casts light in a 2D environment. A light is defined as a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related).
|
||||
|
||||
\ **Note:** Light2D can also be used as a mask.
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Tutorials
|
||||
---------
|
||||
|
||||
- :doc:`2D lights and shadows <../tutorials/2d/2d_lights_and_shadows>`
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`BlendMode<enum_Light2D_BlendMode>` | :ref:`blend_mode<class_Light2D_property_blend_mode>` | ``0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_Light2D_property_color>` | ``Color(1, 1, 1, 1)`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_only<class_Light2D_property_editor_only>` | ``false`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`enabled<class_Light2D_property_enabled>` | ``true`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`energy<class_Light2D_property_energy>` | ``1.0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_item_cull_mask<class_Light2D_property_range_item_cull_mask>` | ``1`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_layer_max<class_Light2D_property_range_layer_max>` | ``0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_layer_min<class_Light2D_property_range_layer_min>` | ``0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_z_max<class_Light2D_property_range_z_max>` | ``1024`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_z_min<class_Light2D_property_range_z_min>` | ``-1024`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`shadow_color<class_Light2D_property_shadow_color>` | ``Color(0, 0, 0, 0)`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shadow_enabled<class_Light2D_property_shadow_enabled>` | ``false`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`ShadowFilter<enum_Light2D_ShadowFilter>` | :ref:`shadow_filter<class_Light2D_property_shadow_filter>` | ``0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`shadow_filter_smooth<class_Light2D_property_shadow_filter_smooth>` | ``0.0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shadow_item_cull_mask<class_Light2D_property_shadow_item_cull_mask>` | ``1`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`BlendMode<enum_Light2D_BlendMode>` | :ref:`blend_mode<class_Light2D_property_blend_mode>` | ``0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`color<class_Light2D_property_color>` | ``Color(1, 1, 1, 1)`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`editor_only<class_Light2D_property_editor_only>` | ``false`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`enabled<class_Light2D_property_enabled>` | ``true`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`energy<class_Light2D_property_energy>` | ``1.0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_item_cull_mask<class_Light2D_property_range_item_cull_mask>` | ``1`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_layer_max<class_Light2D_property_range_layer_max>` | ``0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_layer_min<class_Light2D_property_range_layer_min>` | ``0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_z_max<class_Light2D_property_range_z_max>` | ``1024`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`range_z_min<class_Light2D_property_range_z_min>` | ``-1024`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`shadow_color<class_Light2D_property_shadow_color>` | ``Color(0, 0, 0, 0)`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shadow_enabled<class_Light2D_property_shadow_enabled>` | ``false`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`ShadowFilter<enum_Light2D_ShadowFilter>` | :ref:`shadow_filter<class_Light2D_property_shadow_filter>` | ``0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`float<class_float>` | :ref:`shadow_filter_smooth<class_Light2D_property_shadow_filter_smooth>` | ``0.0`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
| :ref:`int<class_int>` | :ref:`shadow_item_cull_mask<class_Light2D_property_shadow_item_cull_mask>` | ``1`` |
|
||||
+------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_Light2D_method_get_height>` **(** **)** |const| |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_Light2D_method_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_height<class_Light2D_method_get_height>` **(** **)** |const| |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_height<class_Light2D_method_set_height>` **(** :ref:`float<class_float>` height **)** |
|
||||
+---------------------------+-------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_Light2D_ShadowFilter:
|
||||
|
||||
.. _class_Light2D_constant_SHADOW_FILTER_NONE:
|
||||
|
||||
.. _class_Light2D_constant_SHADOW_FILTER_PCF5:
|
||||
|
||||
.. _class_Light2D_constant_SHADOW_FILTER_PCF13:
|
||||
.. rst-class:: classref-enumeration
|
||||
|
||||
enum **ShadowFilter**:
|
||||
|
||||
- **SHADOW_FILTER_NONE** = **0** --- No filter applies to the shadow map. See :ref:`shadow_filter<class_Light2D_property_shadow_filter>`.
|
||||
.. _class_Light2D_constant_SHADOW_FILTER_NONE:
|
||||
|
||||
- **SHADOW_FILTER_PCF5** = **1** --- Percentage closer filtering (5 samples) applies to the shadow map. See :ref:`shadow_filter<class_Light2D_property_shadow_filter>`.
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
- **SHADOW_FILTER_PCF13** = **2** --- Percentage closer filtering (13 samples) applies to the shadow map. See :ref:`shadow_filter<class_Light2D_property_shadow_filter>`.
|
||||
:ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **SHADOW_FILTER_NONE** = ``0``
|
||||
|
||||
No filter applies to the shadow map. This provides hard shadow edges and is the fastest to render. See :ref:`shadow_filter<class_Light2D_property_shadow_filter>`.
|
||||
|
||||
.. _class_Light2D_constant_SHADOW_FILTER_PCF5:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **SHADOW_FILTER_PCF5** = ``1``
|
||||
|
||||
Percentage closer filtering (5 samples) applies to the shadow map. This is slower compared to hard shadow rendering. See :ref:`shadow_filter<class_Light2D_property_shadow_filter>`.
|
||||
|
||||
.. _class_Light2D_constant_SHADOW_FILTER_PCF13:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **SHADOW_FILTER_PCF13** = ``2``
|
||||
|
||||
Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtereing mode, and should be used sparingly. See :ref:`shadow_filter<class_Light2D_property_shadow_filter>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _enum_Light2D_BlendMode:
|
||||
|
||||
.. _class_Light2D_constant_BLEND_MODE_ADD:
|
||||
|
||||
.. _class_Light2D_constant_BLEND_MODE_SUB:
|
||||
|
||||
.. _class_Light2D_constant_BLEND_MODE_MIX:
|
||||
.. rst-class:: classref-enumeration
|
||||
|
||||
enum **BlendMode**:
|
||||
|
||||
- **BLEND_MODE_ADD** = **0** --- Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light.
|
||||
.. _class_Light2D_constant_BLEND_MODE_ADD:
|
||||
|
||||
- **BLEND_MODE_SUB** = **1** --- Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
- **BLEND_MODE_MIX** = **2** --- Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
|
||||
:ref:`BlendMode<enum_Light2D_BlendMode>` **BLEND_MODE_ADD** = ``0``
|
||||
|
||||
Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light.
|
||||
|
||||
.. _class_Light2D_constant_BLEND_MODE_SUB:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`BlendMode<enum_Light2D_BlendMode>` **BLEND_MODE_SUB** = ``1``
|
||||
|
||||
Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
|
||||
|
||||
.. _class_Light2D_constant_BLEND_MODE_MIX:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`BlendMode<enum_Light2D_BlendMode>` **BLEND_MODE_MIX** = ``2``
|
||||
|
||||
Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_Light2D_property_blend_mode:
|
||||
|
||||
- :ref:`BlendMode<enum_Light2D_BlendMode>` **blend_mode**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_blend_mode(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_blend_mode() |
|
||||
+-----------+-----------------------+
|
||||
:ref:`BlendMode<enum_Light2D_BlendMode>` **blend_mode** = ``0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_blend_mode** **(** :ref:`BlendMode<enum_Light2D_BlendMode>` value **)**
|
||||
- :ref:`BlendMode<enum_Light2D_BlendMode>` **get_blend_mode** **(** **)**
|
||||
|
||||
The Light2D's blend mode. See :ref:`BlendMode<enum_Light2D_BlendMode>` constants for values.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **color**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-----------------------+
|
||||
| *Default* | ``Color(1, 1, 1, 1)`` |
|
||||
+-----------+-----------------------+
|
||||
| *Setter* | set_color(value) |
|
||||
+-----------+-----------------------+
|
||||
| *Getter* | get_color() |
|
||||
+-----------+-----------------------+
|
||||
:ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_color** **(** :ref:`Color<class_Color>` value **)**
|
||||
- :ref:`Color<class_Color>` **get_color** **(** **)**
|
||||
|
||||
The Light2D's :ref:`Color<class_Color>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_editor_only:
|
||||
|
||||
- :ref:`bool<class_bool>` **editor_only**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_editor_only(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | is_editor_only() |
|
||||
+-----------+------------------------+
|
||||
:ref:`bool<class_bool>` **editor_only** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_editor_only** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_editor_only** **(** **)**
|
||||
|
||||
If ``true``, Light2D will only appear when editing the scene.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **enabled**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+--------------------+
|
||||
| *Default* | ``true`` |
|
||||
+-----------+--------------------+
|
||||
| *Setter* | set_enabled(value) |
|
||||
+-----------+--------------------+
|
||||
| *Getter* | is_enabled() |
|
||||
+-----------+--------------------+
|
||||
:ref:`bool<class_bool>` **enabled** = ``true``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_enabled** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_enabled** **(** **)**
|
||||
|
||||
If ``true``, Light2D will emit light.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_energy:
|
||||
|
||||
- :ref:`float<class_float>` **energy**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | ``1.0`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_energy(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_energy() |
|
||||
+-----------+-------------------+
|
||||
:ref:`float<class_float>` **energy** = ``1.0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_energy** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_energy** **(** **)**
|
||||
|
||||
The Light2D's energy value. The larger the value, the stronger the light.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_range_item_cull_mask:
|
||||
|
||||
- :ref:`int<class_int>` **range_item_cull_mask**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``1`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_item_cull_mask(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | get_item_cull_mask() |
|
||||
+-----------+---------------------------+
|
||||
:ref:`int<class_int>` **range_item_cull_mask** = ``1``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_item_cull_mask** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_item_cull_mask** **(** **)**
|
||||
|
||||
The layer mask. Only objects with a matching mask will be affected by the Light2D.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_range_layer_max:
|
||||
|
||||
- :ref:`int<class_int>` **range_layer_max**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_layer_range_max(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_layer_range_max() |
|
||||
+-----------+----------------------------+
|
||||
:ref:`int<class_int>` **range_layer_max** = ``0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_layer_range_max** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_layer_range_max** **(** **)**
|
||||
|
||||
Maximum layer value of objects that are affected by the Light2D.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_range_layer_min:
|
||||
|
||||
- :ref:`int<class_int>` **range_layer_min**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_layer_range_min(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_layer_range_min() |
|
||||
+-----------+----------------------------+
|
||||
:ref:`int<class_int>` **range_layer_min** = ``0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_layer_range_min** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_layer_range_min** **(** **)**
|
||||
|
||||
Minimum layer value of objects that are affected by the Light2D.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_range_z_max:
|
||||
|
||||
- :ref:`int<class_int>` **range_z_max**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``1024`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_z_range_max(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | get_z_range_max() |
|
||||
+-----------+------------------------+
|
||||
:ref:`int<class_int>` **range_z_max** = ``1024``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_z_range_max** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_z_range_max** **(** **)**
|
||||
|
||||
Maximum ``z`` value of objects that are affected by the Light2D.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_range_z_min:
|
||||
|
||||
- :ref:`int<class_int>` **range_z_min**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+------------------------+
|
||||
| *Default* | ``-1024`` |
|
||||
+-----------+------------------------+
|
||||
| *Setter* | set_z_range_min(value) |
|
||||
+-----------+------------------------+
|
||||
| *Getter* | get_z_range_min() |
|
||||
+-----------+------------------------+
|
||||
:ref:`int<class_int>` **range_z_min** = ``-1024``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_z_range_min** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_z_range_min** **(** **)**
|
||||
|
||||
Minimum ``z`` value of objects that are affected by the Light2D.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_shadow_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **shadow_color**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-------------------------+
|
||||
| *Default* | ``Color(0, 0, 0, 0)`` |
|
||||
+-----------+-------------------------+
|
||||
| *Setter* | set_shadow_color(value) |
|
||||
+-----------+-------------------------+
|
||||
| *Getter* | get_shadow_color() |
|
||||
+-----------+-------------------------+
|
||||
:ref:`Color<class_Color>` **shadow_color** = ``Color(0, 0, 0, 0)``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_shadow_color** **(** :ref:`Color<class_Color>` value **)**
|
||||
- :ref:`Color<class_Color>` **get_shadow_color** **(** **)**
|
||||
|
||||
:ref:`Color<class_Color>` of shadows cast by the Light2D.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_shadow_enabled:
|
||||
|
||||
- :ref:`bool<class_bool>` **shadow_enabled**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_shadow_enabled(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | is_shadow_enabled() |
|
||||
+-----------+---------------------------+
|
||||
:ref:`bool<class_bool>` **shadow_enabled** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_shadow_enabled** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_shadow_enabled** **(** **)**
|
||||
|
||||
If ``true``, the Light2D will cast shadows.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_shadow_filter:
|
||||
|
||||
- :ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **shadow_filter**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_shadow_filter(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_shadow_filter() |
|
||||
+-----------+--------------------------+
|
||||
:ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **shadow_filter** = ``0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_shadow_filter** **(** :ref:`ShadowFilter<enum_Light2D_ShadowFilter>` value **)**
|
||||
- :ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **get_shadow_filter** **(** **)**
|
||||
|
||||
Shadow filter type. See :ref:`ShadowFilter<enum_Light2D_ShadowFilter>` for possible values.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_shadow_filter_smooth:
|
||||
|
||||
- :ref:`float<class_float>` **shadow_filter_smooth**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``0.0`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_shadow_smooth(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | get_shadow_smooth() |
|
||||
+-----------+--------------------------+
|
||||
:ref:`float<class_float>` **shadow_filter_smooth** = ``0.0``
|
||||
|
||||
Smoothing value for shadows.
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_shadow_smooth** **(** :ref:`float<class_float>` value **)**
|
||||
- :ref:`float<class_float>` **get_shadow_smooth** **(** **)**
|
||||
|
||||
Smoothing value for shadows. Higher values will result in softer shadows, at the cost of visible streaks that can appear in shadow rendering. :ref:`shadow_filter_smooth<class_Light2D_property_shadow_filter_smooth>` only has an effect if :ref:`shadow_filter<class_Light2D_property_shadow_filter>` is :ref:`SHADOW_FILTER_PCF5<class_Light2D_constant_SHADOW_FILTER_PCF5>` or :ref:`SHADOW_FILTER_PCF13<class_Light2D_constant_SHADOW_FILTER_PCF13>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_property_shadow_item_cull_mask:
|
||||
|
||||
- :ref:`int<class_int>` **shadow_item_cull_mask**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``1`` |
|
||||
+-----------+----------------------------------+
|
||||
| *Setter* | set_item_shadow_cull_mask(value) |
|
||||
+-----------+----------------------------------+
|
||||
| *Getter* | get_item_shadow_cull_mask() |
|
||||
+-----------+----------------------------------+
|
||||
:ref:`int<class_int>` **shadow_item_cull_mask** = ``1``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_item_shadow_cull_mask** **(** :ref:`int<class_int>` value **)**
|
||||
- :ref:`int<class_int>` **get_item_shadow_cull_mask** **(** **)**
|
||||
|
||||
The shadow mask. Used with :ref:`LightOccluder2D<class_LightOccluder2D>` to cast shadows. Only occluders with a matching light mask will cast shadows.
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_Light2D_method_get_height:
|
||||
|
||||
- :ref:`float<class_float>` **get_height** **(** **)** |const|
|
||||
.. rst-class:: classref-method
|
||||
|
||||
.. container:: contribute
|
||||
:ref:`float<class_float>` **get_height** **(** **)** |const|
|
||||
|
||||
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||||
Returns the light's height, which is used in 2D normal mapping. See :ref:`PointLight2D.height<class_PointLight2D_property_height>` and :ref:`DirectionalLight2D.height<class_DirectionalLight2D_property_height>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_Light2D_method_set_height:
|
||||
|
||||
- void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
.. rst-class:: classref-method
|
||||
|
||||
.. container:: contribute
|
||||
void **set_height** **(** :ref:`float<class_float>` height **)**
|
||||
|
||||
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
|
||||
Sets the light's height, which is used in 2D normal mapping. See :ref:`PointLight2D.height<class_PointLight2D_property_height>` and :ref:`DirectionalLight2D.height<class_DirectionalLight2D_property_height>`.
|
||||
|
||||
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||||
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||||
|
||||
Reference in New Issue
Block a user