.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_Light2D: Light2D ======= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Node that casts light in a 2D environment. Member Functions ---------------- +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_color` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_energy` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_height` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_mask` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_shadow_mask` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_layer_range_max` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_layer_range_min` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_mode` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_shadow_buffer_size` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_shadow_color` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_shadow_esm_multiplier` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_texture` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_texture_offset` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_texture_scale` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_z_range_max` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_z_range_min` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editor_only` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_enabled` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_shadow_enabled` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_color` **(** :ref:`Color` color **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editor_only` **(** :ref:`bool` editor_only **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_energy` **(** :ref:`float` energy **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_height` **(** :ref:`float` height **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_mask` **(** :ref:`int` item_mask **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_shadow_mask` **(** :ref:`int` item_shadow_mask **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_layer_range_max` **(** :ref:`int` layer **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_layer_range_min` **(** :ref:`int` layer **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mode` **(** :ref:`int` mode **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shadow_buffer_size` **(** :ref:`int` size **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shadow_color` **(** :ref:`Color` shadow_color **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shadow_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_shadow_esm_multiplier` **(** :ref:`float` multiplier **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`Object` texture **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_offset` **(** :ref:`Vector2` texture_offset **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture_scale` **(** :ref:`float` texture_scale **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_z_range_max` **(** :ref:`int` z **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_z_range_min` **(** :ref:`int` z **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- - **MODE_ADD** = **0** --- Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. - **MODE_SUB** = **1** --- Subtract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. - **MODE_MIX** = **2** --- Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. - **MODE_MASK** = **3** --- The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. Description ----------- Node that 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). Note that Light2D can be used as a mask. Member Function Description --------------------------- .. _class_Light2D_get_color: - :ref:`Color` **get_color** **(** **)** const Return the color of the Light2D. .. _class_Light2D_get_energy: - :ref:`float` **get_energy** **(** **)** const Return the energy value of the Light2D. .. _class_Light2D_get_height: - :ref:`float` **get_height** **(** **)** const Return the height of the Light2D. Used with 2D normalmapping. .. _class_Light2D_get_item_cull_mask: - :ref:`int` **get_item_cull_mask** **(** **)** const .. _class_Light2D_get_item_shadow_cull_mask: - :ref:`int` **get_item_shadow_cull_mask** **(** **)** const .. _class_Light2D_get_layer_range_max: - :ref:`int` **get_layer_range_max** **(** **)** const Set the maximum layer value of objects of the scene that are affected by the Light2D. .. _class_Light2D_get_layer_range_min: - :ref:`int` **get_layer_range_min** **(** **)** const Get the minimum layer value of objects of the scene that are affected by the Light2D. .. _class_Light2D_get_mode: - :ref:`int` **get_mode** **(** **)** const Return the current mode set to the Light2D. .. _class_Light2D_get_shadow_buffer_size: - :ref:`int` **get_shadow_buffer_size** **(** **)** const Return the shadow buffer size. .. _class_Light2D_get_shadow_color: - :ref:`Color` **get_shadow_color** **(** **)** const Return the color of casted shadows for this Light2D. .. _class_Light2D_get_shadow_filter: - :ref:`int` **get_shadow_filter** **(** **)** const .. _class_Light2D_get_shadow_gradient_length: - :ref:`float` **get_shadow_gradient_length** **(** **)** const .. _class_Light2D_get_shadow_smooth: - :ref:`float` **get_shadow_smooth** **(** **)** const .. _class_Light2D_get_texture: - :ref:`Texture` **get_texture** **(** **)** const Return the texture of the Light2D. .. _class_Light2D_get_texture_offset: - :ref:`Vector2` **get_texture_offset** **(** **)** const Return the offset of the light texture. .. _class_Light2D_get_texture_scale: - :ref:`float` **get_texture_scale** **(** **)** const Return the scale value of the light texture. .. _class_Light2D_get_z_range_max: - :ref:`int` **get_z_range_max** **(** **)** const Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. .. _class_Light2D_get_z_range_min: - :ref:`int` **get_z_range_min** **(** **)** const Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. .. _class_Light2D_is_editor_only: - :ref:`bool` **is_editor_only** **(** **)** const .. _class_Light2D_is_enabled: - :ref:`bool` **is_enabled** **(** **)** const Return true if the Light2D is enabled, false if it is not. .. _class_Light2D_is_shadow_enabled: - :ref:`bool` **is_shadow_enabled** **(** **)** const Return true if shadow casting is enabled for this Light2D, else return false. .. _class_Light2D_set_color: - void **set_color** **(** :ref:`Color` color **)** Set the color of the Light2D. .. _class_Light2D_set_editor_only: - void **set_editor_only** **(** :ref:`bool` editor_only **)** .. _class_Light2D_set_enabled: - void **set_enabled** **(** :ref:`bool` enabled **)** Switches the Light2D on or off, depending on the 'enabled' parameter. .. _class_Light2D_set_energy: - void **set_energy** **(** :ref:`float` energy **)** Set the energy value of the Light2D. The bigger the value, the stronger the light. .. _class_Light2D_set_height: - void **set_height** **(** :ref:`float` height **)** Set the height of the Light2D. Used with 2D normalmapping. .. _class_Light2D_set_item_cull_mask: - void **set_item_cull_mask** **(** :ref:`int` item_cull_mask **)** Set the item mask of the Light2D to 'item_mask' value. .. _class_Light2D_set_item_shadow_cull_mask: - void **set_item_shadow_cull_mask** **(** :ref:`int` item_shadow_cull_mask **)** Set the item shadow mask to 'item_shadow_mask' value. .. _class_Light2D_set_layer_range_max: - void **set_layer_range_max** **(** :ref:`int` layer **)** Set the maximum layer value of objects of the scene that are affected by the Light2D. .. _class_Light2D_set_layer_range_min: - void **set_layer_range_min** **(** :ref:`int` layer **)** Set the minimum layer value of objects of the scene that are affected by the Light2D. .. _class_Light2D_set_mode: - void **set_mode** **(** :ref:`int` mode **)** Set the behaviour mode of the Light2D. Use constants defined in the constants section. .. _class_Light2D_set_shadow_buffer_size: - void **set_shadow_buffer_size** **(** :ref:`int` size **)** Set the shadow buffer size. .. _class_Light2D_set_shadow_color: - void **set_shadow_color** **(** :ref:`Color` shadow_color **)** Set the color of casted shadows for this Light2D. .. _class_Light2D_set_shadow_enabled: - void **set_shadow_enabled** **(** :ref:`bool` enabled **)** Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. .. _class_Light2D_set_shadow_filter: - void **set_shadow_filter** **(** :ref:`int` filter **)** .. _class_Light2D_set_shadow_gradient_length: - void **set_shadow_gradient_length** **(** :ref:`float` multiplier **)** .. _class_Light2D_set_shadow_smooth: - void **set_shadow_smooth** **(** :ref:`float` smooth **)** .. _class_Light2D_set_texture: - void **set_texture** **(** :ref:`Texture` texture **)** Set the texture of the Light2D. .. _class_Light2D_set_texture_offset: - void **set_texture_offset** **(** :ref:`Vector2` texture_offset **)** Set the offset of the light texture. .. _class_Light2D_set_texture_scale: - void **set_texture_scale** **(** :ref:`float` texture_scale **)** Set the scale value of the light texture. .. _class_Light2D_set_z_range_max: - void **set_z_range_max** **(** :ref:`int` z **)** Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. .. _class_Light2D_set_z_range_min: - void **set_z_range_min** **(** :ref:`int` z **)** Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D.