virtualx-engine/doc/classes/ConvexPolygonShape2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Convex Polygon Shape for 2D physics.
	</brief_description>
	<description>
		Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check).
		The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_points" qualifiers="const">
			<return type="PoolVector2Array">
			</return>
			<description>
				Returns a list of points in either clockwise or counter clockwise order, forming a convex polygon.
			</description>
		</method>
		<method name="set_point_cloud">
			<return type="void">
			</return>
			<argument index="0" name="point_cloud" type="PoolVector2Array">
			</argument>
			<description>
				Currently, this method does nothing.
			</description>
		</method>
		<method name="set_points">
			<return type="void">
			</return>
			<argument index="0" name="points" type="PoolVector2Array">
			</argument>
			<description>
				Sets a list of points in either clockwise or counter clockwise order, forming a convex polygon.
			</description>
		</method>
	</methods>
	<members>
		<member name="points" type="PoolVector2Array" setter="set_points" getter="get_points">
			The polygon's list of vertices. Can be in either clockwise or counterclockwise order.
		</member>
	</members>
	<constants>
	</constants>
</class>