diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 73368cce094..561d62649d3 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -17751,266 +17751,314 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) + Node that casts light in a 2D environment. + Node that casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. + Switches the Light2D on or off, depending on the 'enabled' parameter. + Return true if the Light2D is enabled, false if it is not. + Set the texture of the Light2D. + Return the texture of the Light2D. + Set the offset of the light texture. + Return the offset of the light texture. + Set the color of the Light2D. + Return the color of the Light2D. + Set the height of the Light2D. Used with 2D normalmapping. + Return the height of the Light2D. Used with 2D normalmapping. + Set the energy value of the Light2D. The bigger the value, the stronger the light. + Return the energy value of the Light2D. + Set the scale value of the light texture. + Return the scale value of the light texture. + Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. + Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. + Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. + Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. + Set the minimum layer value of objects of the scene that are affected by the Light2D. + Get the minimum layer value of objects of the scene that are affected by the Light2D. + Set the maximum layer value of objects of the scene that are affected by the Light2D. + Set the maximum layer value of objects of the scene that are affected by the Light2D. + Set the item mask of the Light2D to 'item_mask' value. + Return the item mask of the Light2D. + Set the item shadow mask to 'item_shadow_mask' value. + Return the item shadow mask of the Light2D. + Set the behaviour mode of the Light2D. Use constants defined in the constants section. + Return the current mode set to the Light2D. + Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. + Return true if shadow casting is enabled for this Light2D, else return false. + Set the shadow buffer size. + Return the shadow buffer size. + Set the Exponential Shadow Multiplier (ESM) value of the Light2D. + Return the Exponential Shadow Multiplier (ESM) value of the Light2D. + Set the color of casted shadows for this Light2D. + Return the color of casted shadows for this Light2D. + Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. + Substract the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. + Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. + The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture. + Occludes light cast by a Light2D, thus casting shadows. + Occludes light cast by a Light2D, thus casting shadows. The LightOccluder2D must be provided with a shape (see OccluderPolygon2D) that allows the shadow to be computed. This shape affects the resulting shadow, while the shape of the representating asset shadowed does not actually affect shadows. + Set the OccluderPolygon2D that defines the LightOccluder2D. + Return the OccluderPolygon2D that defines the LightOccluder2D. + Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s). + Return the light mask of the LightOccluder2D.