From ad79c703008394a360eb9875196a9414e1c84585 Mon Sep 17 00:00:00 2001
From: Bojidar Marinov
Date: Fri, 12 Jan 2018 00:38:35 +0200
Subject: Update docs
[ci skip]
---
doc/classes/PathFollow2D.xml | 142 ++++++++-----------------------------------
1 file changed, 27 insertions(+), 115 deletions(-)
(limited to 'doc/classes/PathFollow2D.xml')
diff --git a/doc/classes/PathFollow2D.xml b/doc/classes/PathFollow2D.xml
index 56bec3d71..eed12b610 100644
--- a/doc/classes/PathFollow2D.xml
+++ b/doc/classes/PathFollow2D.xml
@@ -12,122 +12,34 @@
-
-
-
-
- This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly.
-
-
-
-
-
-
- Returns the horizontal displacement this node has from its parent [Path2D].
-
-
-
-
-
-
- Returns the distance along the path in pixels.
-
-
-
-
-
-
- Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last).
-
-
-
-
-
-
- Returns the vertical displacement this node has from its parent [Path2D].
-
-
-
-
-
-
- Returns whether this node wraps its offsets around, or truncates them to the path ends.
-
-
-
-
-
-
- Returns whether this node rotates to follow the path.
-
-
-
-
-
-
-
-
- The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
- There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
- This method controls whether the position between two cached points is interpolated linearly, or cubicly.
-
-
-
-
-
-
-
-
- Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset.
- A similar effect may be achieved moving this node's descendants.
-
-
-
-
-
-
-
-
- If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths.
-
-
-
-
-
-
-
-
- Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path.
-
-
-
-
-
-
-
-
- If set, this node rotates to follow the path, making its descendants rotate.
-
-
-
-
-
-
-
-
- Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
-
-
-
-
-
-
-
-
- Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset].
-
-
+
+
+ If [code]true[/code] the position between two cached points is interpolated cubically, and linearly otherwise.
+ The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
+ There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
+
+
+ The node's offset along the curve.
+
+
+
+
+ If [code]true[/code], any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
+
+
+ The distance along the path in pixels.
+
+
+ If [code]true[/code], this node rotates to follow the path, making its descendants rotate.
+
+
+ The distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length.
+
+
+ The node's offset perpendicular to the curve.
+
+
--
cgit v1.2.3-70-g09d2