doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde
parent
a1c19b9a1e
commit
7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
|
|
@ -11,139 +11,110 @@
|
|||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_point">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="position" type="Vector3">
|
||||
</argument>
|
||||
<argument index="1" name="in" type="Vector3" default="Vector3(0, 0, 0)">
|
||||
</argument>
|
||||
<argument index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)">
|
||||
</argument>
|
||||
<argument index="3" name="at_position" type="int" default="-1">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="position" type="Vector3" />
|
||||
<argument index="1" name="in" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<argument index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)" />
|
||||
<argument index="3" name="at_position" type="int" default="-1" />
|
||||
<description>
|
||||
Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code].
|
||||
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>
|
||||
<method name="clear_points">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Removes all points from the curve.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_baked_length" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<return type="float" />
|
||||
<description>
|
||||
Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_baked_points" qualifiers="const">
|
||||
<return type="PackedVector3Array">
|
||||
</return>
|
||||
<return type="PackedVector3Array" />
|
||||
<description>
|
||||
Returns the cache of points as a [PackedVector3Array].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_baked_tilts" qualifiers="const">
|
||||
<return type="PackedFloat32Array">
|
||||
</return>
|
||||
<return type="PackedFloat32Array" />
|
||||
<description>
|
||||
Returns the cache of tilts as a [PackedFloat32Array].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_baked_up_vectors" qualifiers="const">
|
||||
<return type="PackedVector3Array">
|
||||
</return>
|
||||
<return type="PackedVector3Array" />
|
||||
<description>
|
||||
Returns the cache of up vectors as a [PackedVector3Array].
|
||||
If [member up_vector_enabled] is [code]false[/code], the cache will be empty.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_closest_offset" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="to_point" type="Vector3">
|
||||
</argument>
|
||||
<return type="float" />
|
||||
<argument index="0" name="to_point" type="Vector3" />
|
||||
<description>
|
||||
Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked] or [method interpolate_baked_up_vector].
|
||||
[code]to_point[/code] must be in this curve's local space.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_closest_point" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="to_point" type="Vector3">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="to_point" type="Vector3" />
|
||||
<description>
|
||||
Returns the closest baked point (in curve's local space) to [code]to_point[/code].
|
||||
[code]to_point[/code] must be in this curve's local space.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_point_count" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the number of points describing the curve.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_point_in" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_point_out" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_point_position" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_point_tilt" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="float" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code]0[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="interpolate" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="t" type="float">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="t" type="float" />
|
||||
<description>
|
||||
Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 >= t <=1[/code]) give strange, but predictable results.
|
||||
If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="interpolate_baked" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="offset" type="float">
|
||||
</argument>
|
||||
<argument index="1" name="cubic" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="offset" type="float" />
|
||||
<argument index="1" name="cubic" type="bool" default="false" />
|
||||
<description>
|
||||
Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve.
|
||||
To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code].
|
||||
|
|
@ -151,12 +122,9 @@
|
|||
</description>
|
||||
</method>
|
||||
<method name="interpolate_baked_up_vector" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="offset" type="float">
|
||||
</argument>
|
||||
<argument index="1" name="apply_tilt" type="bool" default="false">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="offset" type="float" />
|
||||
<argument index="1" name="apply_tilt" type="bool" default="false" />
|
||||
<description>
|
||||
Returns an up vector within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve.
|
||||
To do that, it finds the two cached up vectors where the [code]offset[/code] lies between, then interpolates the values. If [code]apply_tilt[/code] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector.
|
||||
|
|
@ -164,75 +132,56 @@
|
|||
</description>
|
||||
</method>
|
||||
<method name="interpolatef" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="fofs" type="float">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="fofs" type="float" />
|
||||
<description>
|
||||
Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_point">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_point_in">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="position" type="Vector3">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="position" type="Vector3" />
|
||||
<description>
|
||||
Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_point_out">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="position" type="Vector3">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="position" type="Vector3" />
|
||||
<description>
|
||||
Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_point_position">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="position" type="Vector3">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="position" type="Vector3" />
|
||||
<description>
|
||||
Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_point_tilt">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="tilt" type="float">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="tilt" type="float" />
|
||||
<description>
|
||||
Sets the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
|
||||
The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow3D], this tilt is an offset over the natural tilt the [PathFollow3D] calculates.
|
||||
</description>
|
||||
</method>
|
||||
<method name="tessellate" qualifiers="const">
|
||||
<return type="PackedVector3Array">
|
||||
</return>
|
||||
<argument index="0" name="max_stages" type="int" default="5">
|
||||
</argument>
|
||||
<argument index="1" name="tolerance_degrees" type="float" default="4">
|
||||
</argument>
|
||||
<return type="PackedVector3Array" />
|
||||
<argument index="0" name="max_stages" type="int" default="5" />
|
||||
<argument index="1" name="tolerance_degrees" type="float" default="4" />
|
||||
<description>
|
||||
Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.
|
||||
This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue