virtualx-engine/doc/classes/Line2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Line2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		A 2D line.
	</brief_description>
	<description>
		A line through several points in 2D space.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="add_point">
			<return type="void">
			</return>
			<argument index="0" name="pos" type="Vector2">
			</argument>
			<description>
				Add a point at the x/y position in the supplied [Vector2]
			</description>
		</method>
		<method name="get_begin_cap_mode" qualifiers="const">
			<return type="int" enum="Line2D.LineCapMode">
			</return>
			<description>
			</description>
		</method>
		<method name="get_default_color" qualifiers="const">
			<return type="Color">
			</return>
			<description>
			</description>
		</method>
		<method name="get_end_cap_mode" qualifiers="const">
			<return type="int" enum="Line2D.LineCapMode">
			</return>
			<description>
			</description>
		</method>
		<method name="get_gradient" qualifiers="const">
			<return type="Gradient">
			</return>
			<description>
			</description>
		</method>
		<method name="get_joint_mode" qualifiers="const">
			<return type="int" enum="Line2D.LineJointMode">
			</return>
			<description>
			</description>
		</method>
		<method name="get_point_count" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_point_pos" qualifiers="const">
			<return type="Vector2">
			</return>
			<argument index="0" name="i" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="get_points" qualifiers="const">
			<return type="PoolVector2Array">
			</return>
			<description>
			</description>
		</method>
		<method name="get_round_precision" qualifiers="const">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_sharp_limit" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_texture" qualifiers="const">
			<return type="Texture">
			</return>
			<description>
			</description>
		</method>
		<method name="get_texture_mode" qualifiers="const">
			<return type="int" enum="Line2D.LineTextureMode">
			</return>
			<description>
			</description>
		</method>
		<method name="get_width" qualifiers="const">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="remove_point">
			<return type="void">
			</return>
			<argument index="0" name="i" type="int">
			</argument>
			<description>
				Remove the point at index 'i' from the line.
			</description>
		</method>
		<method name="set_begin_cap_mode">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="Line2D.LineCapMode">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_default_color">
			<return type="void">
			</return>
			<argument index="0" name="color" type="Color">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_end_cap_mode">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="Line2D.LineCapMode">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_gradient">
			<return type="void">
			</return>
			<argument index="0" name="color" type="Gradient">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_joint_mode">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="Line2D.LineJointMode">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_point_pos">
			<return type="void">
			</return>
			<argument index="0" name="i" type="int">
			</argument>
			<argument index="1" name="pos" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_points">
			<return type="void">
			</return>
			<argument index="0" name="points" type="PoolVector2Array">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_round_precision">
			<return type="void">
			</return>
			<argument index="0" name="precision" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_sharp_limit">
			<return type="void">
			</return>
			<argument index="0" name="limit" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_texture">
			<return type="void">
			</return>
			<argument index="0" name="texture" type="Texture">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_texture_mode">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int" enum="Line2D.LineTextureMode">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_width">
			<return type="void">
			</return>
			<argument index="0" name="width" type="float">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode">
		</member>
		<member name="default_color" type="Color" setter="set_default_color" getter="get_default_color">
		</member>
		<member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" enum="Line2D.LineCapMode">
		</member>
		<member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient">
		</member>
		<member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode">
		</member>
		<member name="points" type="PoolVector2Array" setter="set_points" getter="get_points">
		</member>
		<member name="round_precision" type="int" setter="set_round_precision" getter="get_round_precision">
		</member>
		<member name="sharp_limit" type="float" setter="set_sharp_limit" getter="get_sharp_limit">
		</member>
		<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
		</member>
		<member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="Line2D.LineTextureMode">
		</member>
		<member name="width" type="float" setter="set_width" getter="get_width">
		</member>
	</members>
	<constants>
		<constant name="LINE_JOINT_SHARP" value="0">
		</constant>
		<constant name="LINE_JOINT_BEVEL" value="1">
		</constant>
		<constant name="LINE_JOINT_ROUND" value="2">
		</constant>
		<constant name="LINE_CAP_NONE" value="0">
		</constant>
		<constant name="LINE_CAP_BOX" value="1">
		</constant>
		<constant name="LINE_CAP_ROUND" value="2">
		</constant>
		<constant name="LINE_TEXTURE_NONE" value="0">
		</constant>
		<constant name="LINE_TEXTURE_TILE" value="1">
		</constant>
	</constants>
</class>