diff options
Diffstat (limited to 'doc/classes/Line2D.xml')
| -rw-r--r-- | doc/classes/Line2D.xml | 43 |
1 files changed, 23 insertions, 20 deletions
diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index c55760767a..b627ae7344 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -17,7 +17,7 @@ <argument index="1" name="at_position" type="int" default="-1"> </argument> <description> - Add a point at the [code]position[/code]. Appends the point at the end of the line. + Adds a point at the [code]position[/code]. Appends the point at the end of the line. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position < 0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. </description> </method> @@ -50,7 +50,7 @@ <argument index="0" name="i" type="int"> </argument> <description> - Remove the point at index [code]i[/code] from the line. + Removes the point at index [code]i[/code] from the line. </description> </method> <method name="set_point_position"> @@ -66,39 +66,42 @@ </method> </methods> <members> - <member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode"> - Controls the style of the line's first point. Use [code]LINE_CAP_*[/code] constants. Default value: [code]LINE_CAP_NONE[/code]. + <member name="begin_cap_mode" type="int" setter="set_begin_cap_mode" getter="get_begin_cap_mode" enum="Line2D.LineCapMode" default="0"> + Controls the style of the line's first point. Use [code]LINE_CAP_*[/code] constants. </member> - <member name="default_color" type="Color" setter="set_default_color" getter="get_default_color"> + <member name="default_color" type="Color" setter="set_default_color" getter="get_default_color" default="Color( 0.4, 0.5, 1, 1 )"> The line's color. Will not be used if a gradient is set. </member> - <member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" enum="Line2D.LineCapMode"> - Controls the style of the line's last point. Use [code]LINE_CAP_*[/code] constants. Default value: [code]LINE_CAP_NONE[/code]. + <member name="end_cap_mode" type="int" setter="set_end_cap_mode" getter="get_end_cap_mode" enum="Line2D.LineCapMode" default="0"> + Controls the style of the line's last point. Use [code]LINE_CAP_*[/code] constants. </member> - <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient"> + <member name="gradient" type="Gradient" setter="set_gradient" getter="get_gradient" default="null"> The gradient is drawn through the whole line from start to finish. The default color will not be used if a gradient is set. </member> - <member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode"> + <member name="joint_mode" type="int" setter="set_joint_mode" getter="get_joint_mode" enum="Line2D.LineJointMode" default="0"> The style for the points between the start and the end. </member> - <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points"> + <member name="points" type="PoolVector2Array" setter="set_points" getter="get_points" default="PoolVector2Array( )"> The points that form the lines. The line is drawn between every point set in this array. </member> - <member name="round_precision" type="int" setter="set_round_precision" getter="get_round_precision"> + <member name="round_precision" type="int" setter="set_round_precision" getter="get_round_precision" default="8"> The smoothness of the rounded joints and caps. This is only used if a cap or joint is set as round. </member> - <member name="sharp_limit" type="float" setter="set_sharp_limit" getter="get_sharp_limit"> - The direction difference in radians between vector points. This value is only used if [code]joint mode[/code] is set to [code]LINE_JOINT_SHARP[/code]. + <member name="sharp_limit" type="float" setter="set_sharp_limit" getter="get_sharp_limit" default="2.0"> + The direction difference in radians between vector points. This value is only used if [code]joint mode[/code] is set to [constant LINE_JOINT_SHARP]. </member> - <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> + <member name="texture" type="Texture" setter="set_texture" getter="get_texture" default="null"> The texture used for the line's texture. Uses [code]texture_mode[/code] for drawing style. </member> - <member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="Line2D.LineTextureMode"> - The style to render the [code]texture[/code] on the line. Use [code]LINE_TEXTURE_*[/code] constants. Default value: [code]LINE_TEXTURE_NONE[/code]. + <member name="texture_mode" type="int" setter="set_texture_mode" getter="get_texture_mode" enum="Line2D.LineTextureMode" default="0"> + The style to render the [code]texture[/code] on the line. Use [code]LINE_TEXTURE_*[/code] constants. </member> - <member name="width" type="float" setter="set_width" getter="get_width"> + <member name="width" type="float" setter="set_width" getter="get_width" default="10.0"> The line's width. </member> + <member name="width_curve" type="Curve" setter="set_curve" getter="get_curve"> + The line's width varies with the curve. The original width is simply multiply by the value of the Curve. + </member> </members> <constants> <constant name="LINE_JOINT_SHARP" value="0" enum="LineJointMode"> @@ -111,7 +114,7 @@ The line's joints will be rounded. </constant> <constant name="LINE_CAP_NONE" value="0" enum="LineCapMode"> - Don't have a line cap. + Don't draw a line cap. </constant> <constant name="LINE_CAP_BOX" value="1" enum="LineCapMode"> Draws the line cap as a box. @@ -123,10 +126,10 @@ Takes the left pixels of the texture and renders it over the whole line. </constant> <constant name="LINE_TEXTURE_TILE" value="1" enum="LineTextureMode"> - Tiles the texture over the line. The texture need to be imported with Repeat Enabled for it to work properly. + Tiles the texture over the line. The texture must be imported with [b]Repeat[/b] enabled for it to work properly. </constant> <constant name="LINE_TEXTURE_STRETCH" value="2" enum="LineTextureMode"> - Stretches the texture across the line. Import the texture with Repeat Disabled for best results. + Stretches the texture across the line. Import the texture with [b]Repeat[/b] disabled for best results. </constant> </constants> </class> |