virtualx-engine/doc/classes/SpotLight3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpotLight3D" inherits="Light3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A spotlight, such as a reflector spotlight or a lantern.
	</brief_description>
	<description>
		A Spotlight is a type of [Light3D] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance. This attenuation can be configured by changing the energy, radius and attenuation parameters of [Light3D].
		[b]Note:[/b] When using the Mobile or Compatibility rendering methods, spot lights will only correctly affect meshes whose visibility AABB intersects with the light's AABB. If using a shader to deform the mesh in a way that makes it go outside its AABB, [member GeometryInstance3D.extra_cull_margin] must be increased on the mesh. Otherwise, the light may not be visible on the mesh.
	</description>
	<tutorials>
		<link title="3D lights and shadows">$DOCS_URL/tutorials/3d/lights_and_shadows.html</link>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</tutorials>
	<members>
		<member name="shadow_bias" type="float" setter="set_param" getter="get_param" overrides="Light3D" default="0.03" />
		<member name="shadow_normal_bias" type="float" setter="set_param" getter="get_param" overrides="Light3D" default="1.0" />
		<member name="spot_angle" type="float" setter="set_param" getter="get_param" default="45.0">
			The spotlight's angle in degrees.
			[b]Note:[/b] [member spot_angle] is not affected by [member Node3D.scale] (the light's scale or its parent's scale).
		</member>
		<member name="spot_angle_attenuation" type="float" setter="set_param" getter="get_param" default="1.0">
			The spotlight's angular attenuation curve.
		</member>
		<member name="spot_attenuation" type="float" setter="set_param" getter="get_param" default="1.0">
			The spotlight's light energy attenuation curve.
		</member>
		<member name="spot_range" type="float" setter="set_param" getter="get_param" default="5.0">
			The maximal range that can be reached by the spotlight. Note that the effectively lit area may appear to be smaller depending on the [member spot_attenuation] in use. No matter the [member spot_attenuation] in use, the light will never reach anything outside this range.
			[b]Note:[/b] [member spot_range] is not affected by [member Node3D.scale] (the light's scale or its parent's scale).
		</member>
	</members>
</class>