virtualx-engine/doc/classes/LineShape2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="LineShape2D" inherits="Shape2D" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Line shape for 2D collision objects.
	</brief_description>
	<description>
		Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_d" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the line distance from the origin.
			</description>
		</method>
		<method name="get_normal" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Return the line normal.
			</description>
		</method>
		<method name="set_d">
			<return type="void">
			</return>
			<argument index="0" name="d" type="float">
			</argument>
			<description>
				Set the line distance from the origin.
			</description>
		</method>
		<method name="set_normal">
			<return type="void">
			</return>
			<argument index="0" name="normal" type="Vector2">
			</argument>
			<description>
				Set the line normal.
			</description>
		</method>
	</methods>
	<members>
		<member name="d" type="float" setter="set_d" getter="get_d">
		</member>
		<member name="normal" type="Vector2" setter="set_normal" getter="get_normal">
		</member>
	</members>
	<constants>
	</constants>
</class>