virtualx-engine/doc/classes/CollisionPolygon.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionPolygon" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Editor-only class for defining a collision polygon in 3D space.
	</brief_description>
	<description>
		Allows editing a collision polygon's vertices on a selected plane. Can also set a depth perpendicular to that plane. This class is only available in the editor. It will not appear in the scene tree at runtime. Creates a [Shape] for gameplay. Properties modified during gameplay will have no effect.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_depth" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_polygon" qualifiers="const">
			<return type="PoolVector2Array">
			</return>
			<description>
			</description>
		</method>
		<method name="is_disabled" qualifiers="const">
			<return type="bool">
			</return>
			<description>
			</description>
		</method>
		<method name="set_depth">
			<return type="void">
			</return>
			<argument index="0" name="depth" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_disabled">
			<return type="void">
			</return>
			<argument index="0" name="disabled" type="bool">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_polygon">
			<return type="void">
			</return>
			<argument index="0" name="polygon" type="PoolVector2Array">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="depth" type="float" setter="set_depth" getter="get_depth">
			Length that the resulting collision extends in either direction perpendicular to its polygon.
		</member>
		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
			If true, no collision will be produced.
		</member>
		<member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon">
			Array of vertices which define the polygon.
		</member>
	</members>
	<constants>
	</constants>
</class>