virtualx-engine/doc/classes/PointLight2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PointLight2D" inherits="Light2D" keywords="omni, spot" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Positional 2D light source.
	</brief_description>
	<description>
		Casts light in a 2D environment. This light's shape is defined by a (usually grayscale) texture.
	</description>
	<tutorials>
		<link title="2D lights and shadows">$DOCS_URL/tutorials/2d/2d_lights_and_shadows.html</link>
	</tutorials>
	<members>
		<member name="height" type="float" setter="set_height" getter="get_height" default="0.0">
			The height of the light. Used with 2D normal mapping. The units are in pixels, e.g. if the height is 100, then it will illuminate an object 100 pixels away at a 45° angle to the plane.
		</member>
		<member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset" default="Vector2(0, 0)">
			The offset of the light's [member texture].
		</member>
		<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
			[Texture2D] used for the light's appearance.
		</member>
		<member name="texture_scale" type="float" setter="set_texture_scale" getter="get_texture_scale" default="1.0">
			The [member texture]'s scale factor.
		</member>
	</members>
</class>