Light2D¶

Inherits: Node2D < CanvasItem < Node < Object

Emite luz en un entorno 2D.

Descripción¶

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

Nota: Light2D también puede ser usado como una máscara.

Tutoriales¶

Luces 2D y sombras

Propiedades¶

Color	color	`Color( 1, 1, 1, 1 )`
bool	editor_only	`false`
bool	enabled	`true`
float	energy	`1.0`
Mode	mode	`0`
Vector2	offset	`Vector2( 0, 0 )`
float	range_height	`0.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`
int	shadow_buffer_size	`2048`
Color	shadow_color	`Color( 0, 0, 0, 0 )`
bool	shadow_enabled	`false`
ShadowFilter	shadow_filter	`0`
float	shadow_filter_smooth	`0.0`
float	shadow_gradient_length	`0.0`
int	shadow_item_cull_mask	`1`
Texture	texture
float	texture_scale	`1.0`

Enumeraciones¶

enum Mode:

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.
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.
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.
MODE_MASK = 3 --- La textura de luz de Light2D se utiliza como una máscara, ocultando o revelando partes de la pantalla debajo dependiendo del valor de cada píxel de la textura de luz (máscara).

enum ShadowFilter:

SHADOW_FILTER_NONE = 0 --- No se aplica ningún filtro al mapa de sombras. Ver shadow_filter.
SHADOW_FILTER_PCF3 = 1 --- Percentage closer filtering (3 samples) applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF5 = 2 --- El porcentaje de filtrado más cercano (5 muestras) se aplica al mapa de sombras. Ver shadow_filter.
SHADOW_FILTER_PCF7 = 3 --- Percentage closer filtering (7 samples) applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF9 = 4 --- Percentage closer filtering (9 samples) applies to the shadow map. See shadow_filter.
SHADOW_FILTER_PCF13 = 5 --- El porcentaje de filtrado más cercano (5 muestras) se aplica al mapa de sombras. Ver shadow_filter.

Descripciones de Propiedades¶

Color color

Default	`Color( 1, 1, 1, 1 )`
Setter	set_color(value)
Getter	get_color()

El Color de la Light2D.

bool editor_only

Default	`false`
Setter	set_editor_only(value)
Getter	is_editor_only()

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

bool enabled

Default	`true`
Setter	set_enabled(value)
Getter	is_enabled()

Si true, Light2D emitirá luz.

float energy

Default	`1.0`
Setter	set_energy(value)
Getter	get_energy()

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

Mode mode

Default	`0`
Setter	set_mode(value)
Getter	get_mode()

El modo de Light2D. Vea las constantes Mode para los valores.

Vector2 offset

Default	`Vector2( 0, 0 )`
Setter	set_texture_offset(value)
Getter	get_texture_offset()

El desplazamiento de la texture de Light2D.

float range_height

Default	`0.0`
Setter	set_height(value)
Getter	get_height()

La altura de Light2D. Usado con el mapeo de normales 2D.

int range_item_cull_mask

Default	`1`
Setter	set_item_cull_mask(value)
Getter	get_item_cull_mask()

La máscara de la capa. Sólo los objetos con una máscara adecuada se verán afectados por Light2D.

int range_layer_max

Default	`0`
Setter	set_layer_range_max(value)
Getter	get_layer_range_max()

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

int range_layer_min

Default	`0`
Setter	set_layer_range_min(value)
Getter	get_layer_range_min()

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

int range_z_max

Default	`1024`
Setter	set_z_range_max(value)
Getter	get_z_range_max()

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

int range_z_min

Default	`-1024`
Setter	set_z_range_min(value)
Getter	get_z_range_min()

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

int shadow_buffer_size

Default	`2048`
Setter	set_shadow_buffer_size(value)
Getter	get_shadow_buffer_size()

El tamaño del buffer de la sombra.

Color shadow_color

Default	`Color( 0, 0, 0, 0 )`
Setter	set_shadow_color(value)
Getter	get_shadow_color()

Color de las sombras proyectadas por el Light2D.

bool shadow_enabled

Default	`false`
Setter	set_shadow_enabled(value)
Getter	is_shadow_enabled()

Si true, Light2D proyectará sombras.

ShadowFilter shadow_filter

Default	`0`
Setter	set_shadow_filter(value)
Getter	get_shadow_filter()

Tipo de filtro de sombra. Ver ShadowFilter para los posibles valores.

float shadow_filter_smooth

Default	`0.0`
Setter	set_shadow_smooth(value)
Getter	get_shadow_smooth()

Suavizar el valor de las sombras.

float shadow_gradient_length

Default	`0.0`
Setter	set_shadow_gradient_length(value)
Getter	get_shadow_gradient_length()

Smooth shadow gradient length.

int shadow_item_cull_mask

Default	`1`
Setter	set_item_shadow_cull_mask(value)
Getter	get_item_shadow_cull_mask()

La máscara de sombra. Se usa con LightOccluder2D para proyectar sombras. Sólo los oclusores con una máscara de luz pueden proyectar sombras.

Texture texture

Setter	set_texture(value)
Getter	get_texture()

Texture used for the Light2D's appearance.

float texture_scale

Default	`1.0`
Setter	set_texture_scale(value)
Getter	get_texture_scale()

El factor de escala de la texture.