:github_url: hide .. _class_Light2D: Light2D ======= **Наследует:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Наследуется от:** :ref:`DirectionalLight2D`, :ref:`PointLight2D` Излучает свет в 2D-среде. .. rst-class:: classref-introduction-group Описание ---------------- Излучает свет в 2D-среде. Свет определяется цветом, значением энергии, режимом (см. константы) и различными другими параметрами (диапазоном и тенями). .. rst-class:: classref-introduction-group Обучающие материалы -------------------------------------- - :doc:`2D свет и тени <../tutorials/2d/2d_lights_and_shadows>` .. rst-class:: classref-reftable-group Свойства ---------------- .. 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 Методы ------------ .. table:: :widths: auto +---------------------------+----------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_height`\ (\ ) |const| | +---------------------------+----------------------------------------------------------------------------------------------+ | |void| | :ref:`set_height`\ (\ height\: :ref:`float`\ ) | +---------------------------+----------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Перечисления ------------------------ .. _enum_Light2D_ShadowFilter: .. rst-class:: classref-enumeration enum **ShadowFilter**: :ref:`🔗` .. _class_Light2D_constant_SHADOW_FILTER_NONE: .. rst-class:: classref-enumeration-constant :ref:`ShadowFilter` **SHADOW_FILTER_NONE** = ``0`` Фильтр не применяется к карте теней. Это обеспечивает жесткие края теней и является самым быстрым для рендеринга. См. :ref:`shadow_filter`. .. _class_Light2D_constant_SHADOW_FILTER_PCF5: .. rst-class:: classref-enumeration-constant :ref:`ShadowFilter` **SHADOW_FILTER_PCF5** = ``1`` Фильтрация сближения процентов (5 образцов) применяется к карте теней. Это медленнее по сравнению с жестким рендерингом теней. См. :ref:`shadow_filter`. .. _class_Light2D_constant_SHADOW_FILTER_PCF13: .. rst-class:: classref-enumeration-constant :ref:`ShadowFilter` **SHADOW_FILTER_PCF13** = ``2`` Фильтрация сближения процентов (13 образцов) применяется к карте теней. Это самый медленный режим фильтрации теней, и его следует использовать экономно. См. :ref:`shadow_filter`. .. rst-class:: classref-item-separator ---- .. _enum_Light2D_BlendMode: .. rst-class:: classref-enumeration enum **BlendMode**: :ref:`🔗` .. _class_Light2D_constant_BLEND_MODE_ADD: .. rst-class:: classref-enumeration-constant :ref:`BlendMode` **BLEND_MODE_ADD** = ``0`` Добавляет значение пикселей, соответствующих Light2D, к значениям пикселей под ним. Это обычное поведение света. .. _class_Light2D_constant_BLEND_MODE_SUB: .. rst-class:: classref-enumeration-constant :ref:`BlendMode` **BLEND_MODE_SUB** = ``1`` Вычитает значение пикселей, соответствующих Light2D, из значений пикселей под ним, что приводит к эффекту инвертированного света. .. _class_Light2D_constant_BLEND_MODE_MIX: .. rst-class:: classref-enumeration-constant :ref:`BlendMode` **BLEND_MODE_MIX** = ``2`` Смешиваем значения пикселей, соответствующих Light2D, со значениями пикселей под ним с помощью линейной интерполяции. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Описания свойств -------------------------------- .. _class_Light2D_property_blend_mode: .. rst-class:: classref-property :ref:`BlendMode` **blend_mode** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode`\ ) - :ref:`BlendMode` **get_blend_mode**\ (\ ) Режим смешивания Light2D. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) :ref:`Color` в Light2D. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_editor_only: .. rst-class:: classref-property :ref:`bool` **editor_only** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_editor_only**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_editor_only**\ (\ ) Если ``true``, Light2D будет отображаться только при редактировании сцены. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_enabled: .. rst-class:: classref-property :ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_enabled**\ (\ ) Если ``true``, Light2D будет излучать свет. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_energy: .. rst-class:: classref-property :ref:`float` **energy** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_energy**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_energy**\ (\ ) Значение энергии Light2D. Чем больше значение, тем сильнее свет. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_item_cull_mask: .. rst-class:: classref-property :ref:`int` **range_item_cull_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_item_cull_mask**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_item_cull_mask**\ (\ ) Маска слоя. Только объекты с соответствующим :ref:`CanvasItem.light_mask` будут затронуты Light2D. См. также :ref:`shadow_item_cull_mask`, который влияет на то, какие объекты могут отбрасывать тени. \ **Примечание:** :ref:`range_item_cull_mask` игнорируется :ref:`DirectionalLight2D`, который всегда будет освещать 2D-узел независимо от :ref:`CanvasItem.light_mask` 2D-узла. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_layer_max: .. rst-class:: classref-property :ref:`int` **range_layer_max** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_layer_range_max**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_layer_range_max**\ (\ ) Максимальное значение слоя объектов, на которые влияет Light2D. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_layer_min: .. rst-class:: classref-property :ref:`int` **range_layer_min** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_layer_range_min**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_layer_range_min**\ (\ ) Минимальное значение слоя объектов, на которые влияет Light2D. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_z_max: .. rst-class:: classref-property :ref:`int` **range_z_max** = ``1024`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_z_range_max**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_z_range_max**\ (\ ) Максимальное значение ``z`` объектов, на которые влияет Light2D. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_range_z_min: .. rst-class:: classref-property :ref:`int` **range_z_min** = ``-1024`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_z_range_min**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_z_range_min**\ (\ ) Минимальное значение ``z`` объектов, на которые влияет Light2D. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_color: .. rst-class:: classref-property :ref:`Color` **shadow_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_shadow_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_shadow_color**\ (\ ) :ref:`Color` теней, отбрасываемых Light2D. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_enabled: .. rst-class:: classref-property :ref:`bool` **shadow_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_shadow_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_shadow_enabled**\ (\ ) Если ``true``, Light2D будет отбрасывать тени. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_filter: .. rst-class:: classref-property :ref:`ShadowFilter` **shadow_filter** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_shadow_filter**\ (\ value\: :ref:`ShadowFilter`\ ) - :ref:`ShadowFilter` **get_shadow_filter**\ (\ ) Тип фильтра теней. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_filter_smooth: .. rst-class:: classref-property :ref:`float` **shadow_filter_smooth** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_shadow_smooth**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_shadow_smooth**\ (\ ) Значение сглаживания для теней. Более высокие значения приведут к более мягким теням за счет видимых полос, которые могут появиться при рендеринге теней. :ref:`shadow_filter_smooth` имеет эффект только в том случае, если :ref:`shadow_filter` равен :ref:`SHADOW_FILTER_PCF5` или :ref:`SHADOW_FILTER_PCF13`. .. rst-class:: classref-item-separator ---- .. _class_Light2D_property_shadow_item_cull_mask: .. rst-class:: classref-property :ref:`int` **shadow_item_cull_mask** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_item_shadow_cull_mask**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_item_shadow_cull_mask**\ (\ ) Маска тени. Используется с :ref:`LightOccluder2D` для отбрасывания теней. Только окклюдеры с соответствующим :ref:`CanvasItem.light_mask` будут отбрасывать тени. См. также :ref:`range_item_cull_mask`, который влияет на то, какие объекты могут *получать* свет. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Описания метода ------------------------------ .. _class_Light2D_method_get_height: .. rst-class:: classref-method :ref:`float` **get_height**\ (\ ) |const| :ref:`🔗` Возвращает высоту источника света, которая используется в 2D-нормальном отображении. См. :ref:`PointLight2D.height` и :ref:`DirectionalLight2D.height`. .. rst-class:: classref-item-separator ---- .. _class_Light2D_method_set_height: .. rst-class:: classref-method |void| **set_height**\ (\ height\: :ref:`float`\ ) :ref:`🔗` Устанавливает высоту света, которая используется в 2D-нормальном отображении. См. :ref:`PointLight2D.height` и :ref:`DirectionalLight2D.height`. .. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)` .. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)` .. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)` .. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)` .. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)` .. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)` .. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`