Files
godot-docs-l10n/classes/uk/class_light2d.rst

455 lines
20 KiB
ReStructuredText
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_Light2D:
Light2D
=======
**Успадковує:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Успадковано від:** :ref:`DirectionalLight2D<class_DirectionalLight2D>`, :ref:`PointLight2D<class_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<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
Методи
------------
.. 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>`\ (\ height\: :ref:`float<class_float>`\ ) |
+---------------------------+----------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Переліки
----------------
.. _enum_Light2D_ShadowFilter:
.. rst-class:: classref-enumeration
enum **ShadowFilter**: :ref:`🔗<enum_Light2D_ShadowFilter>`
.. _class_Light2D_constant_SHADOW_FILTER_NONE:
.. rst-class:: classref-enumeration-constant
:ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **SHADOW_FILTER_NONE** = ``0``
Немає фільтра відноситься до shadow map. Це забезпечує жорсткі тіні краї і є найшвидшим для рендерингу. Див. :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``
Приблизний фільтр (5 зразків) застосовується до shadow map. Це повільніше порівняно з твердою тіньою рендерингом. Див. :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``
Приблизний фільтруючий (13 зразків) застосовується до shadow map. Це повільний режим фільтрації тіней, і слід використовувати неприпустимо. Див. :ref:`shadow_filter<class_Light2D_property_shadow_filter>`.
.. rst-class:: classref-item-separator
----
.. _enum_Light2D_BlendMode:
.. rst-class:: classref-enumeration
enum **BlendMode**: :ref:`🔗<enum_Light2D_BlendMode>`
.. _class_Light2D_constant_BLEND_MODE_ADD:
.. rst-class:: classref-enumeration-constant
:ref:`BlendMode<enum_Light2D_BlendMode>` **BLEND_MODE_ADD** = ``0``
Додає значення пікселів, що відповідають Light2D значенням пікселів під ним. Це загальна поведінка світла.
.. _class_Light2D_constant_BLEND_MODE_SUB:
.. rst-class:: classref-enumeration-constant
:ref:`BlendMode<enum_Light2D_BlendMode>` **BLEND_MODE_SUB** = ``1``
Відстежує значення пікселів, що відповідають Light2D значенням пікселів під ним, що призводить до порушення ефекту світла.
.. _class_Light2D_constant_BLEND_MODE_MIX:
.. rst-class:: classref-enumeration-constant
:ref:`BlendMode<enum_Light2D_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<enum_Light2D_BlendMode>` **blend_mode** = ``0`` :ref:`🔗<class_Light2D_property_blend_mode>`
.. rst-class:: classref-property-setget
- |void| **set_blend_mode**\ (\ value\: :ref:`BlendMode<enum_Light2D_BlendMode>`\ )
- :ref:`BlendMode<enum_Light2D_BlendMode>` **get_blend_mode**\ (\ )
Режим змішування Light2D.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Light2D_property_color>`
.. rst-class:: classref-property-setget
- |void| **set_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_color**\ (\ )
:ref:`Color<class_Color>` у Light2D.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_editor_only:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **editor_only** = ``false`` :ref:`🔗<class_Light2D_property_editor_only>`
.. rst-class:: classref-property-setget
- |void| **set_editor_only**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_editor_only**\ (\ )
Якщо ``true``, Light2 Д з'явиться тільки при редагуванні сцени.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **enabled** = ``true`` :ref:`🔗<class_Light2D_property_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_enabled**\ (\ )
Якщо ``true``, Light2 D буде випромінювати світло.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_energy:
.. rst-class:: classref-property
:ref:`float<class_float>` **energy** = ``1.0`` :ref:`🔗<class_Light2D_property_energy>`
.. rst-class:: classref-property-setget
- |void| **set_energy**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_energy**\ (\ )
Енергетична цінність Light2D. Чим більше значення, тим сильніше світла.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_range_item_cull_mask:
.. rst-class:: classref-property
:ref:`int<class_int>` **range_item_cull_mask** = ``1`` :ref:`🔗<class_Light2D_property_range_item_cull_mask>`
.. rst-class:: classref-property-setget
- |void| **set_item_cull_mask**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_item_cull_mask**\ (\ )
Маска шара. Тільки об'єкти з відповідним :ref:`CanvasItem.light_mask<class_CanvasItem_property_light_mask>` будуть уражені Light2D. Дивись також :ref:`shadow_item_cull_mask<class_Light2D_property_shadow_item_cull_mask>`, що впливає на те, які об'єкти можна відлити тіні.
\ **Note:** :ref:`range_item_cull_mask<class_Light2D_property_range_item_cull_mask>` ігнорується :ref:`DirectionalLight2D<class_DirectionalLight2D>`, який завжди світить вузол 2D незалежно від вузла 2D ``пам'ятний CanvasItem.light_mask``.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_range_layer_max:
.. rst-class:: classref-property
:ref:`int<class_int>` **range_layer_max** = ``0`` :ref:`🔗<class_Light2D_property_range_layer_max>`
.. rst-class:: classref-property-setget
- |void| **set_layer_range_max**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_layer_range_max**\ (\ )
Максимальне значення шару об'єктів, які впливають на Light2D.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_range_layer_min:
.. rst-class:: classref-property
:ref:`int<class_int>` **range_layer_min** = ``0`` :ref:`🔗<class_Light2D_property_range_layer_min>`
.. rst-class:: classref-property-setget
- |void| **set_layer_range_min**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_layer_range_min**\ (\ )
Мінімальне значення шару об'єктів, які впливають на Light2D.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_range_z_max:
.. rst-class:: classref-property
:ref:`int<class_int>` **range_z_max** = ``1024`` :ref:`🔗<class_Light2D_property_range_z_max>`
.. rst-class:: classref-property-setget
- |void| **set_z_range_max**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_z_range_max**\ (\ )
Максимальна ``z`` значення об'єктів, які впливають на Light2D.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_range_z_min:
.. rst-class:: classref-property
:ref:`int<class_int>` **range_z_min** = ``-1024`` :ref:`🔗<class_Light2D_property_range_z_min>`
.. rst-class:: classref-property-setget
- |void| **set_z_range_min**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_z_range_min**\ (\ )
Мінімальна ``z`` значення об'єктів, які впливають на Light2D.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_shadow_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **shadow_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗<class_Light2D_property_shadow_color>`
.. rst-class:: classref-property-setget
- |void| **set_shadow_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_shadow_color**\ (\ )
:ref:`Color<class_Color>` тіней, які відливаються Light2D.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_shadow_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **shadow_enabled** = ``false`` :ref:`🔗<class_Light2D_property_shadow_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_shadow_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_shadow_enabled**\ (\ )
Якщо ``true``, Light2D буде пролити тіні.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_shadow_filter:
.. rst-class:: classref-property
:ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **shadow_filter** = ``0`` :ref:`🔗<class_Light2D_property_shadow_filter>`
.. rst-class:: classref-property-setget
- |void| **set_shadow_filter**\ (\ value\: :ref:`ShadowFilter<enum_Light2D_ShadowFilter>`\ )
- :ref:`ShadowFilter<enum_Light2D_ShadowFilter>` **get_shadow_filter**\ (\ )
Тип тіньового фільтра.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_shadow_filter_smooth:
.. rst-class:: classref-property
:ref:`float<class_float>` **shadow_filter_smooth** = ``0.0`` :ref:`🔗<class_Light2D_property_shadow_filter_smooth>`
.. rst-class:: classref-property-setget
- |void| **set_shadow_smooth**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_shadow_smooth**\ (\ )
Гладке значення для тіней. Більшість значень призведе до м'якших тіней, за вартістю видимих пасусів, які можуть з'явитися в тіньовому рендерингу. :ref:`shadow_filter_smooth<class_Light2D_property_shadow_filter_smooth>` має ефект, якщо :ref:`shadow_filter<class_Light2D_property_shadow_filter>` ``constantant SHADOW_FILTER_PCF5`` або :ref:`SHADOW_FILTER_PCF13<class_Light2D_constant_SHADOW_FILTER_PCF13>`.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_property_shadow_item_cull_mask:
.. rst-class:: classref-property
:ref:`int<class_int>` **shadow_item_cull_mask** = ``1`` :ref:`🔗<class_Light2D_property_shadow_item_cull_mask>`
.. rst-class:: classref-property-setget
- |void| **set_item_shadow_cull_mask**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_item_shadow_cull_mask**\ (\ )
Тіней маска. Використовується з :ref:`LightOccluder2D<class_LightOccluder2D>` для лиття тіней. Тільки оклюмери з відповідним :ref:`CanvasItem.light_mask<class_CanvasItem_property_light_mask>` будуть вилити тіні. Дивись також :ref:`range_item_cull_mask<class_Light2D_property_range_item_cull_mask>`, який впливає на які об'єкти можна *receive* світло.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Описи методів
--------------------------
.. _class_Light2D_method_get_height:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_height**\ (\ ) |const| :ref:`🔗<class_Light2D_method_get_height>`
Повертає висоту світла, яка використовується в 2D нормальному картографуванні. :ref:`PointLight2D.height<class_PointLight2D_property_height>` і :ref:`DirectionalLight2D.height<class_DirectionalLight2D_property_height>`.
.. rst-class:: classref-item-separator
----
.. _class_Light2D_method_set_height:
.. rst-class:: classref-method
|void| **set_height**\ (\ height\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Light2D_method_set_height>`
Встановлює висоту світла, яка використовується в 2D-карті нормалей. Див. :ref:`PointLight2D.height<class_PointLight2D_property_height>` та :ref:`DirectionalLight2D.height<class_DirectionalLight2D_property_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 (Значення не повертається.)`