.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/Light2D.xml. .. _class_Light2D: Light2D ======= **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`DirectionalLight2D`, :ref:`PointLight2D` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`BlendMode` | :ref:`blend_mode` | ``0`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`editor_only` | ``false`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`enabled` | ``true`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`energy` | ``1.0`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`range_item_cull_mask` | ``1`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`range_layer_max` | ``0`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`range_layer_min` | ``0`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`range_z_max` | ``1024`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`range_z_min` | ``-1024`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`shadow_color` | ``Color(0, 0, 0, 0)`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`shadow_enabled` | ``false`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`ShadowFilter` | :ref:`shadow_filter` | ``0`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`shadow_filter_smooth` | ``0.0`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`shadow_item_cull_mask` | ``1`` | +------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+-------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_height` **(** **)** |const| | +---------------------------+-------------------------------------------------------------------------------------------------+ | void | :ref:`set_height` **(** :ref:`float` height **)** | +---------------------------+-------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_Light2D_ShadowFilter: .. rst-class:: classref-enumeration enum **ShadowFilter**: .. _class_Light2D_constant_SHADOW_FILTER_NONE: .. rst-class:: classref-enumeration-constant :ref:`ShadowFilter` **SHADOW_FILTER_NONE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light2D_constant_SHADOW_FILTER_PCF5: .. rst-class:: classref-enumeration-constant :ref:`ShadowFilter` **SHADOW_FILTER_PCF5** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light2D_constant_SHADOW_FILTER_PCF13: .. rst-class:: classref-enumeration-constant :ref:`ShadowFilter` **SHADOW_FILTER_PCF13** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_Light2D_BlendMode: .. rst-class:: classref-enumeration enum **BlendMode**: .. _class_Light2D_constant_BLEND_MODE_ADD: .. rst-class:: classref-enumeration-constant :ref:`BlendMode` **BLEND_MODE_ADD** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light2D_constant_BLEND_MODE_SUB: .. rst-class:: classref-enumeration-constant :ref:`BlendMode` **BLEND_MODE_SUB** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_Light2D_constant_BLEND_MODE_MIX: .. rst-class:: classref-enumeration-constant :ref:`BlendMode` **BLEND_MODE_MIX** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Light2D_property_blend_mode: .. rst-class:: classref-property :ref:`BlendMode` **blend_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_blend_mode** **(** :ref:`BlendMode` value **)** - :ref:`BlendMode` **get_blend_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color(1, 1, 1, 1)`` .. rst-class:: classref-property-setget - void **set_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_color** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_editor_only: .. rst-class:: classref-property :ref:`bool` **editor_only** = ``false`` .. rst-class:: classref-property-setget - void **set_editor_only** **(** :ref:`bool` value **)** - :ref:`bool` **is_editor_only** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_enabled: .. rst-class:: classref-property :ref:`bool` **enabled** = ``true`` .. rst-class:: classref-property-setget - void **set_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_energy: .. rst-class:: classref-property :ref:`float` **energy** = ``1.0`` .. rst-class:: classref-property-setget - void **set_energy** **(** :ref:`float` value **)** - :ref:`float` **get_energy** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_item_cull_mask: .. rst-class:: classref-property :ref:`int` **range_item_cull_mask** = ``1`` .. rst-class:: classref-property-setget - void **set_item_cull_mask** **(** :ref:`int` value **)** - :ref:`int` **get_item_cull_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_layer_max: .. rst-class:: classref-property :ref:`int` **range_layer_max** = ``0`` .. rst-class:: classref-property-setget - void **set_layer_range_max** **(** :ref:`int` value **)** - :ref:`int` **get_layer_range_max** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_layer_min: .. rst-class:: classref-property :ref:`int` **range_layer_min** = ``0`` .. rst-class:: classref-property-setget - void **set_layer_range_min** **(** :ref:`int` value **)** - :ref:`int` **get_layer_range_min** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_z_max: .. rst-class:: classref-property :ref:`int` **range_z_max** = ``1024`` .. rst-class:: classref-property-setget - void **set_z_range_max** **(** :ref:`int` value **)** - :ref:`int` **get_z_range_max** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_z_min: .. rst-class:: classref-property :ref:`int` **range_z_min** = ``-1024`` .. rst-class:: classref-property-setget - void **set_z_range_min** **(** :ref:`int` value **)** - :ref:`int` **get_z_range_min** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_color: .. rst-class:: classref-property :ref:`Color` **shadow_color** = ``Color(0, 0, 0, 0)`` .. rst-class:: classref-property-setget - void **set_shadow_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_shadow_color** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_enabled: .. rst-class:: classref-property :ref:`bool` **shadow_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_shadow_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_shadow_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_filter: .. rst-class:: classref-property :ref:`ShadowFilter` **shadow_filter** = ``0`` .. rst-class:: classref-property-setget - void **set_shadow_filter** **(** :ref:`ShadowFilter` value **)** - :ref:`ShadowFilter` **get_shadow_filter** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_filter_smooth: .. rst-class:: classref-property :ref:`float` **shadow_filter_smooth** = ``0.0`` .. rst-class:: classref-property-setget - void **set_shadow_smooth** **(** :ref:`float` value **)** - :ref:`float` **get_shadow_smooth** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_item_cull_mask: .. rst-class:: classref-property :ref:`int` **shadow_item_cull_mask** = ``1`` .. rst-class:: classref-property-setget - void **set_item_shadow_cull_mask** **(** :ref:`int` value **)** - :ref:`int` **get_item_shadow_cull_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Light2D_method_get_height: .. rst-class:: classref-method :ref:`float` **get_height** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_Light2D_method_set_height: .. rst-class:: classref-method void **set_height** **(** :ref:`float` height **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`