Light2D

Hereda: Node2D < CanvasItem < Node < Object

Heredado por: DirectionalLight2D, PointLight2D

Emite luz en un entorno 2D.

Descripción

Emite luz en un entorno 2D. Una luz se define por un color, un valor de energía, un modo (ver constantes) y varios otros parámetros (rango y relacionados con las sombras).

Tutoriales

2D lights and shadows

Propiedades

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`

Métodos

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

Enumeraciones

enum ShadowFilter: 🔗

ShadowFilter SHADOW_FILTER_NONE = 0

No se aplica ningún filtro al mapa de sombras. Esto proporciona bordes de sombra duros y es lo más rápido de renderizar. Véase shadow_filter.

ShadowFilter SHADOW_FILTER_PCF5 = 1

El filtrado de porcentaje más cercano (5 muestras) se aplica al mapa de sombras. Esto es más lento en comparación con el renderizado de sombras duras. Véase shadow_filter.

ShadowFilter SHADOW_FILTER_PCF13 = 2

El filtrado de porcentaje más cercano (13 muestras) se aplica al mapa de sombras. Este es el modo de filtrado de sombras más lento y debe usarse con moderación. Véase shadow_filter.

enum BlendMode: 🔗

BlendMode BLEND_MODE_ADD = 0

Añade el valor de los píxeles correspondientes a Light2D a los valores de los píxeles que están debajo de él. Este es el comportamiento común de una luz.

BlendMode BLEND_MODE_SUB = 1

Resta el valor de los píxeles correspondientes a Light2D a los valores de los píxeles que están debajo de él, lo que resulta en un efecto de luz invertida.

BlendMode BLEND_MODE_MIX = 2

Mezcla el valor de los píxeles correspondientes a Light2D con los valores de los píxeles que están debajo de él por interpolación lineal.

Descripciones de Propiedades

BlendMode blend_mode = 0 🔗

void set_blend_mode(value: BlendMode)
BlendMode get_blend_mode()

El modo de fusión de Light2D.

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

void set_color(value: Color)
Color get_color()

El Color de la Light2D.

bool editor_only = false 🔗

void set_editor_only(value: bool)
bool is_editor_only()

Si es true, Light2D sólo aparecerá cuando se edite la escena.

bool enabled = true 🔗

void set_enabled(value: bool)
bool is_enabled()

Si es true, Light2D emitirá luz.

float energy = 1.0 🔗

void set_energy(value: float)
float get_energy()

El valor energético de Light2D. Cuanto mayor sea el valor, más fuerte es la luz.

int range_item_cull_mask = 1 🔗

void set_item_cull_mask(value: int)
int get_item_cull_mask()

La máscara de capa. Solo los objetos con una CanvasItem.light_mask coincidente se verán afectados por la Light2D. Véase también shadow_item_cull_mask, que afecta a qué objetos pueden proyectar sombras.

Nota: range_item_cull_mask es ignorado por DirectionalLight2D, que siempre iluminará un nodo 2D independientemente de la CanvasItem.light_mask del nodo 2D.

int range_layer_max = 0 🔗

void set_layer_range_max(value: int)
int get_layer_range_max()

Valor máximo de la capa de los objetos afectados por Light2D.

int range_layer_min = 0 🔗

void set_layer_range_min(value: int)
int get_layer_range_min()

Valor mínimo de la capa de los objetos afectados por Light2D.

int range_z_max = 1024 🔗

void set_z_range_max(value: int)
int get_z_range_max()

Valor máximo de z de los objetos afectados por Light2D.

int range_z_min = -1024 🔗

void set_z_range_min(value: int)
int get_z_range_min()

Valor mínimo de z de los objetos afectados por Light2D.

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

void set_shadow_color(value: Color)
Color get_shadow_color()

Color de las sombras proyectadas por el Light2D.

bool shadow_enabled = false 🔗

void set_shadow_enabled(value: bool)
bool is_shadow_enabled()

Si es true, Light2D proyectará sombras.

ShadowFilter shadow_filter = 0 🔗

void set_shadow_filter(value: ShadowFilter)
ShadowFilter get_shadow_filter()

Tipo de filtro de sombra.

float shadow_filter_smooth = 0.0 🔗

void set_shadow_smooth(value: float)
float get_shadow_smooth()

Valor de suavizado para las sombras. Los valores más altos resultarán en sombras más suaves, a costa de rayas visibles que pueden aparecer en el renderizado de sombras. shadow_filter_smooth solo tiene un efecto si shadow_filter es 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 máscara de sombra. Se usa con LightOccluder2D para proyectar sombras. Solo los oclusores con una CanvasItem.light_mask coincidente proyectarán sombras. Véase también range_item_cull_mask, que afecta a qué objetos pueden recibir la luz.

Descripciones de Métodos

float get_height() const 🔗

Devuelve la altura de la luz, que se utiliza en el mapeo normal 2D. Ver PointLight2D.height y DirectionalLight2D.height.

void set_height(height: float) 🔗

Establece la altura de la luz, que se utiliza en el mapeo normal 2D. Ver PointLight2D.height y DirectionalLight2D.height.