virtualx-engine/doc/classes/OccluderPolygon2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="OccluderPolygon2D" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Defines a 2D polygon for LightOccluder2D.
	</brief_description>
	<description>
		Editor facility that helps you draw a 2D polygon used as resource for [LightOccluder2D].
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="closed" type="bool" setter="set_closed" getter="is_closed" default="true">
			If [code]true[/code], closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction.
		</member>
		<member name="cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="OccluderPolygon2D.CullMode" default="0">
			The culling mode to use.
		</member>
		<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array()">
			A [Vector2] array with the index for polygon's vertices positions.
			[b]Note:[/b] The returned value is a copy of the underlying array, rather than a reference.
		</member>
	</members>
	<constants>
		<constant name="CULL_DISABLED" value="0" enum="CullMode">
			Culling is disabled. See [member cull_mode].
		</constant>
		<constant name="CULL_CLOCKWISE" value="1" enum="CullMode">
			Culling is performed in the clockwise direction. See [member cull_mode].
		</constant>
		<constant name="CULL_COUNTER_CLOCKWISE" value="2" enum="CullMode">
			Culling is performed in the counterclockwise direction. See [member cull_mode].
		</constant>
	</constants>
</class>