godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
fa00c829f02c31f07aa983c81a2811f4e577b834
godot-docs/classes/class_light2d.rst
Rémi Verschelde fa00c829f0 Add inheritance path 
Also fix parsing of [method (Class.)name]
2016-02-08 18:31:35 +01:00

248 lines
16 KiB
ReStructuredText
Raw Blame History

.. _class_Light2D:
Light2D
=======
**Inherits:** :ref:`Node2D<class_node2d>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enabled<class_Light2D_set_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_enabled<class_Light2D_is_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_Light2D_set_texture>` **(** :ref:`Object<class_object>` texture **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_texture<class_Light2D_get_texture>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_offset<class_Light2D_set_texture_offset>` **(** :ref:`Vector2<class_vector2>` texture_offset **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_texture_offset<class_Light2D_get_texture_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_Light2D_set_color>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_Light2D_get_color>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_height<class_Light2D_set_height>` **(** :ref:`float<class_float>` height **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_Light2D_get_height>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_energy<class_Light2D_set_energy>` **(** :ref:`float<class_float>` energy **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_energy<class_Light2D_get_energy>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture_scale<class_Light2D_set_texture_scale>` **(** :ref:`float<class_float>` texture_scale **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_texture_scale<class_Light2D_get_texture_scale>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_z_range_min<class_Light2D_set_z_range_min>` **(** :ref:`int<class_int>` z **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_z_range_min<class_Light2D_get_z_range_min>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_z_range_max<class_Light2D_set_z_range_max>` **(** :ref:`int<class_int>` z **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_z_range_max<class_Light2D_get_z_range_max>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_range_min<class_Light2D_set_layer_range_min>` **(** :ref:`int<class_int>` layer **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layer_range_min<class_Light2D_get_layer_range_min>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_range_max<class_Light2D_set_layer_range_max>` **(** :ref:`int<class_int>` layer **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layer_range_max<class_Light2D_get_layer_range_max>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_mask<class_Light2D_set_item_mask>` **(** :ref:`int<class_int>` item_mask **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_mask<class_Light2D_get_item_mask>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_item_shadow_mask<class_Light2D_set_item_shadow_mask>` **(** :ref:`int<class_int>` item_shadow_mask **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_item_shadow_mask<class_Light2D_get_item_shadow_mask>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mode<class_Light2D_set_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_Light2D_get_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shadow_enabled<class_Light2D_set_shadow_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_shadow_enabled<class_Light2D_is_shadow_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shadow_buffer_size<class_Light2D_set_shadow_buffer_size>` **(** :ref:`int<class_int>` size **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shadow_buffer_size<class_Light2D_get_shadow_buffer_size>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shadow_esm_multiplier<class_Light2D_set_shadow_esm_multiplier>` **(** :ref:`float<class_float>` multiplier **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_shadow_esm_multiplier<class_Light2D_get_shadow_esm_multiplier>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shadow_color<class_Light2D_set_shadow_color>` **(** :ref:`Color<class_color>` shadow_color **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_shadow_color<class_Light2D_get_shadow_color>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **MODE_ADD** = **0**
- **MODE_SUB** = **1**
- **MODE_MIX** = **2**
- **MODE_MASK** = **3**
Member Function Description
---------------------------
.. _class_Light2D_set_enabled:
- void **set_enabled** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Light2D_is_enabled:
- :ref:`bool<class_bool>` **is_enabled** **(** **)** const
.. _class_Light2D_set_texture:
- void **set_texture** **(** :ref:`Object<class_object>` texture **)**
.. _class_Light2D_get_texture:
- :ref:`Object<class_object>` **get_texture** **(** **)** const
.. _class_Light2D_set_texture_offset:
- void **set_texture_offset** **(** :ref:`Vector2<class_vector2>` texture_offset **)**
.. _class_Light2D_get_texture_offset:
- :ref:`Vector2<class_vector2>` **get_texture_offset** **(** **)** const
.. _class_Light2D_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
.. _class_Light2D_get_color:
- :ref:`Color<class_color>` **get_color** **(** **)** const
.. _class_Light2D_set_height:
- void **set_height** **(** :ref:`float<class_float>` height **)**
.. _class_Light2D_get_height:
- :ref:`float<class_float>` **get_height** **(** **)** const
.. _class_Light2D_set_energy:
- void **set_energy** **(** :ref:`float<class_float>` energy **)**
.. _class_Light2D_get_energy:
- :ref:`float<class_float>` **get_energy** **(** **)** const
.. _class_Light2D_set_texture_scale:
- void **set_texture_scale** **(** :ref:`float<class_float>` texture_scale **)**
.. _class_Light2D_get_texture_scale:
- :ref:`float<class_float>` **get_texture_scale** **(** **)** const
.. _class_Light2D_set_z_range_min:
- void **set_z_range_min** **(** :ref:`int<class_int>` z **)**
.. _class_Light2D_get_z_range_min:
- :ref:`int<class_int>` **get_z_range_min** **(** **)** const
.. _class_Light2D_set_z_range_max:
- void **set_z_range_max** **(** :ref:`int<class_int>` z **)**
.. _class_Light2D_get_z_range_max:
- :ref:`int<class_int>` **get_z_range_max** **(** **)** const
.. _class_Light2D_set_layer_range_min:
- void **set_layer_range_min** **(** :ref:`int<class_int>` layer **)**
.. _class_Light2D_get_layer_range_min:
- :ref:`int<class_int>` **get_layer_range_min** **(** **)** const
.. _class_Light2D_set_layer_range_max:
- void **set_layer_range_max** **(** :ref:`int<class_int>` layer **)**
.. _class_Light2D_get_layer_range_max:
- :ref:`int<class_int>` **get_layer_range_max** **(** **)** const
.. _class_Light2D_set_item_mask:
- void **set_item_mask** **(** :ref:`int<class_int>` item_mask **)**
.. _class_Light2D_get_item_mask:
- :ref:`int<class_int>` **get_item_mask** **(** **)** const
.. _class_Light2D_set_item_shadow_mask:
- void **set_item_shadow_mask** **(** :ref:`int<class_int>` item_shadow_mask **)**
.. _class_Light2D_get_item_shadow_mask:
- :ref:`int<class_int>` **get_item_shadow_mask** **(** **)** const
.. _class_Light2D_set_mode:
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_Light2D_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
.. _class_Light2D_set_shadow_enabled:
- void **set_shadow_enabled** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Light2D_is_shadow_enabled:
- :ref:`bool<class_bool>` **is_shadow_enabled** **(** **)** const
.. _class_Light2D_set_shadow_buffer_size:
- void **set_shadow_buffer_size** **(** :ref:`int<class_int>` size **)**
.. _class_Light2D_get_shadow_buffer_size:
- :ref:`int<class_int>` **get_shadow_buffer_size** **(** **)** const
.. _class_Light2D_set_shadow_esm_multiplier:
- void **set_shadow_esm_multiplier** **(** :ref:`float<class_float>` multiplier **)**
.. _class_Light2D_get_shadow_esm_multiplier:
- :ref:`float<class_float>` **get_shadow_esm_multiplier** **(** **)** const
.. _class_Light2D_set_shadow_color:
- void **set_shadow_color** **(** :ref:`Color<class_color>` shadow_color **)**
.. _class_Light2D_get_shadow_color:
- :ref:`Color<class_color>` **get_shadow_color** **(** **)** const
Reference in New Issue View Git Blame Copy Permalink