pandemonium_engine/modules/vertex_lights_2d/doc_classes/VertexLight2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VertexLight2D" inherits="Node2D" version="4.4">
	<brief_description>
		A [Node2D] that manages a light in [VertexLights2DServer].
	</brief_description>
	<description>
		A [Node2D] that manages a light in [VertexLights2DServer].
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation" default="1.0">
			The light's attenuation.
		</member>
		<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 1, 1, 1, 1 )">
			The light's color.
		</member>
		<member name="enabled" type="bool" setter="set_enabled" getter="get_is_enabled" default="true">
			WHether this light is enabled or not.
		</member>
		<member name="item_cull_mask" type="int" setter="set_item_cull_mask" getter="get_item_cull_mask" default="1">
			The light's item cull mask.
		</member>
		<member name="layer_range" type="Vector2i" setter="set_layer_range" getter="get_layer_range" default="Vector2i( -512, 512 )">
			The light's layer range.
		</member>
		<member name="mode" type="int" setter="set_mode" getter="get_mode" enum="VertexLight2D.VertexLight2DMode" default="0">
			The light's mode.
		</member>
		<member name="range" type="Vector2i" setter="set_range" getter="get_range" default="Vector2i( 32, 32 )">
			The light's range.
		</member>
		<member name="z_range" type="Vector2i" setter="set_z_range" getter="get_z_range" default="Vector2i( -1024, 1024 )">
			The light's z range.
		</member>
	</members>
	<constants>
		<constant name="VERTEX_LIGHT_2D_MODE_ADD" value="0" enum="VertexLight2DMode">
			The light's color gets added to the resulting colors.
		</constant>
		<constant name="VERTEX_LIGHT_2D_MODE_SUB" value="1" enum="VertexLight2DMode">
			The light's color gets substracted to the resulting colors.
		</constant>
		<constant name="VERTEX_LIGHT_2D_MODE_MIX" value="2" enum="VertexLight2DMode">
			The light's color gets blended with the resulting colors.
		</constant>
	</constants>
</class>