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

Eredita: Node2D < CanvasItem < Node < Object

Ereditato da: DirectionalLight2D, PointLight2D

Proietta luce in un ambiente 2D.

Descrizione

Proietta luce in un ambiente 2D. Una luce è definita come un colore, un valore di energia, una modalità (vedi le costanti) e vari altri parametri (relativi alla portata e alle ombre).

Tutorial

Luci e ombre 2D

Proprietà

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`

Metodi

float	get_height() const
void	set_height(height: float)

Enumerazioni

enum ShadowFilter: 🔗

ShadowFilter SHADOW_FILTER_NONE = 0

Nessun filtro è applicato alla mappa delle ombre. Ciò fornisce bordi d'ombra netti ed è il più veloce da renderizzare. Vedi shadow_filter.

ShadowFilter SHADOW_FILTER_PCF5 = 1

Il filtraggio percentuale più vicino (5 campioni) è applicato alla mappa delle ombre. È più lento rispetto al rendering netto di ombre. Vedi shadow_filter.

ShadowFilter SHADOW_FILTER_PCF13 = 2

Il filtraggio percentuale più vicino (13 campioni) è applicato alla mappa delle ombre. Questa è la modalità di filtraggio di ombre più lenta e dovrebbe essere usata con moderazione. Vedi shadow_filter.

enum BlendMode: 🔗

BlendMode BLEND_MODE_ADD = 0

Aggiunge il valore dei pixel corrispondenti al Light2D ai valori dei pixel sottostanti. Questo è il comportamento comune di una luce.

BlendMode BLEND_MODE_SUB = 1

Sottrae il valore dei pixel corrispondenti al Light2D ai valori dei pixel sottostanti, ottenendo un effetto di luce invertito.

BlendMode BLEND_MODE_MIX = 2

Mischia i valori dei pixel corrispondenti al Light2D con i valori dei pixel sottostanti tramite un interpolazione lineare.

Descrizioni delle proprietà

BlendMode blend_mode = 0 🔗

void set_blend_mode(value: BlendMode)
BlendMode get_blend_mode()

La modalità di fusione del Light2D.

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

void set_color(value: Color)
Color get_color()

Il Color del Light2D.

bool editor_only = false 🔗

void set_editor_only(value: bool)
bool is_editor_only()

Se true, il Light2D apparirà solo durante la modifica della scena.

bool enabled = true 🔗

void set_enabled(value: bool)
bool is_enabled()

Se true, il Light2D proietterà luce.

float energy = 1.0 🔗

void set_energy(value: float)
float get_energy()

L'energia del Light2D. Più grande è il valore, più forte è la luce.

int range_item_cull_mask = 1 🔗

void set_item_cull_mask(value: int)
int get_item_cull_mask()

La maschera di strati. Solo gli oggetti con un CanvasItem.light_mask corrispondente saranno illuminati dal Light2D. Vedi anche shadow_item_cull_mask, che influenza quali oggetti possono proiettare ombre.

Nota: range_item_cull_mask è ignorato da DirectionalLight2D, che illuminerà sempre un nodo 2D indipendentemente dal CanvasItem.light_mask del nodo 2D.

int range_layer_max = 0 🔗

void set_layer_range_max(value: int)
int get_layer_range_max()

Valore di livello massimo degli oggetti influenzati dal Light2D.

int range_layer_min = 0 🔗

void set_layer_range_min(value: int)
int get_layer_range_min()

Valore di livello minimo degli oggetti influenzati dal Light2D.

int range_z_max = 1024 🔗

void set_z_range_max(value: int)
int get_z_range_max()

Valore z massimo degli oggetti influenzati dal Light2D.

int range_z_min = -1024 🔗

void set_z_range_min(value: int)
int get_z_range_min()

Valore z minimo degli oggetti influenzati dal Light2D.

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

void set_shadow_color(value: Color)
Color get_shadow_color()

Il Color delle ombre proiettate dal Light2D.

bool shadow_enabled = false 🔗

void set_shadow_enabled(value: bool)
bool is_shadow_enabled()

Se true, il Light2D proietterà ombre.

ShadowFilter shadow_filter = 0 🔗

void set_shadow_filter(value: ShadowFilter)
ShadowFilter get_shadow_filter()

Il tipo di filtro delle ombre.

float shadow_filter_smooth = 0.0 🔗

void set_shadow_smooth(value: float)
float get_shadow_smooth()

Valore di attenuazione delle ombre. Valori più alti risulteranno in ombre più morbide, a scapito di strisce visibili che possono apparire nel rendering delle ombre. shadow_filter_smooth ha effetto solo se shadow_filter è SHADOW_FILTER_PCF5 o SHADOW_FILTER_PCF13.

int shadow_item_cull_mask = 1 🔗

void set_item_shadow_cull_mask(value: int)
int get_item_shadow_cull_mask()

La maschera d'ombra. Utilizzata con LightOccluder2D per proiettare ombre. Solo gli occlusori con un CanvasItem.light_mask corrispondente proietteranno ombre. Vedi anche range_item_cull_mask, che influenza quali oggetti possono ricevere la luce.

Descrizioni dei metodi

float get_height() const 🔗

Restituisce l'altezza della luce, che è utilizzata nella mappatura normale 2D. Vedi PointLight2D.height e DirectionalLight2D.height.

void set_height(height: float) 🔗

Imposta l'altezza della luce, che è utilizzata nella mappatura normale 2D. Vedi PointLight2D.height e DirectionalLight2D.height.