Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Light2D

Успадковує: Node2D < CanvasItem < Node < Object

Успадковано від: DirectionalLight2D, PointLight2D

Заготівля світла в середовищі 2D.

Опис

Заготовки світла в середовищі 2D. Світло визначаються як колір, енергетична цінність, режим (див. константи), так і різні інші параметри (посередник і тіні пов'язані).

Посібники

Властивості

BlendMode

blend_mode

0

Color

color

Color(1, 1, 1, 1)

bool

editor_only

false

bool

enabled

true

float

energy

1.0

int

range_item_cull_mask

1

int

range_layer_max

0

int

range_layer_min

0

int

range_z_max

1024

int

range_z_min

-1024

Color

shadow_color

Color(0, 0, 0, 0)

bool

shadow_enabled

false

ShadowFilter

shadow_filter

0

float

shadow_filter_smooth

0.0

int

shadow_item_cull_mask

1

Методи

float

get_height() const

void

set_height(height: float)

Переліки

enum ShadowFilter: 🔗

ShadowFilter SHADOW_FILTER_NONE = 0

Немає фільтра відноситься до shadow map. Це забезпечує жорсткі тіні краї і є найшвидшим для рендерингу. Див. shadow_filter.

ShadowFilter SHADOW_FILTER_PCF5 = 1

Приблизний фільтр (5 зразків) застосовується до shadow map. Це повільніше порівняно з твердою тіньою рендерингом. Див. shadow_filter.

ShadowFilter SHADOW_FILTER_PCF13 = 2

Приблизний фільтруючий (13 зразків) застосовується до shadow map. Це повільний режим фільтрації тіней, і слід використовувати неприпустимо. Див. shadow_filter.

enum BlendMode: 🔗

BlendMode BLEND_MODE_ADD = 0

Додає значення пікселів, що відповідають Light2D значенням пікселів під ним. Це загальна поведінка світла.

BlendMode BLEND_MODE_SUB = 1

Відстежує значення пікселів, що відповідають Light2D значенням пікселів під ним, що призводить до порушення ефекту світла.

BlendMode BLEND_MODE_MIX = 2

Змішайте значення пікселів, що відповідають Light2D значенням пікселів під ним лінійним інтерполяціям.

Описи властивостей

BlendMode blend_mode = 0 🔗

Режим змішування Light2D.

Color color = Color(1, 1, 1, 1) 🔗

Color у Light2D.

bool editor_only = false 🔗

  • void set_editor_only(value: bool)

  • bool is_editor_only()

Якщо true, Light2 Д з'явиться тільки при редагуванні сцени.

bool enabled = true 🔗

  • void set_enabled(value: bool)

  • bool is_enabled()

Якщо true, Light2 D буде випромінювати світло.

float energy = 1.0 🔗

  • void set_energy(value: float)

  • float get_energy()

Енергетична цінність Light2D. Чим більше значення, тим сильніше світла.

int range_item_cull_mask = 1 🔗

  • void set_item_cull_mask(value: int)

  • int get_item_cull_mask()

Маска шара. Тільки об'єкти з відповідним CanvasItem.light_mask будуть уражені Light2D. Дивись також shadow_item_cull_mask, що впливає на те, які об'єкти можна відлити тіні.

Note: range_item_cull_mask ігнорується DirectionalLight2D, який завжди світить вузол 2D незалежно від вузла 2D пам'ятний CanvasItem.light_mask.

int range_layer_max = 0 🔗

  • void set_layer_range_max(value: int)

  • int get_layer_range_max()

Максимальне значення шару об'єктів, які впливають на Light2D.

int range_layer_min = 0 🔗

  • void set_layer_range_min(value: int)

  • int get_layer_range_min()

Мінімальне значення шару об'єктів, які впливають на Light2D.

int range_z_max = 1024 🔗

  • void set_z_range_max(value: int)

  • int get_z_range_max()

Максимальна z значення об'єктів, які впливають на Light2D.

int range_z_min = -1024 🔗

  • void set_z_range_min(value: int)

  • int get_z_range_min()

Мінімальна z значення об'єктів, які впливають на Light2D.

Color shadow_color = Color(0, 0, 0, 0) 🔗

  • void set_shadow_color(value: Color)

  • Color get_shadow_color()

Color тіней, які відливаються Light2D.

bool shadow_enabled = false 🔗

  • void set_shadow_enabled(value: bool)

  • bool is_shadow_enabled()

Якщо true, Light2D буде пролити тіні.

ShadowFilter shadow_filter = 0 🔗

Тип тіньового фільтра.

float shadow_filter_smooth = 0.0 🔗

  • void set_shadow_smooth(value: float)

  • float get_shadow_smooth()

Гладке значення для тіней. Більшість значень призведе до м'якших тіней, за вартістю видимих пасусів, які можуть з'явитися в тіньовому рендерингу. shadow_filter_smooth має ефект, якщо shadow_filter constantant SHADOW_FILTER_PCF5 або SHADOW_FILTER_PCF13.

int shadow_item_cull_mask = 1 🔗

  • void set_item_shadow_cull_mask(value: int)

  • int get_item_shadow_cull_mask()

Тіней маска. Використовується з LightOccluder2D для лиття тіней. Тільки оклюмери з відповідним CanvasItem.light_mask будуть вилити тіні. Дивись також range_item_cull_mask, який впливає на які об'єкти можна receive світло.

Описи методів

float get_height() const 🔗

Повертає висоту світла, яка використовується в 2D нормальному картографуванні. PointLight2D.height і DirectionalLight2D.height.

void set_height(height: float) 🔗

Встановлює висоту світла, яка використовується в 2D-карті нормалей. Див. PointLight2D.height та DirectionalLight2D.height.