summaryrefslogtreecommitdiff
path: root/doc/classes/Path.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Path.xml')
-rw-r--r--doc/classes/Path.xml13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/classes/Path.xml b/doc/classes/Path.xml
index 1b553dbc02..5c1100e670 100644
--- a/doc/classes/Path.xml
+++ b/doc/classes/Path.xml
@@ -1,22 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Path" inherits="Spatial" category="Core" version="3.2">
<brief_description>
- Container for a [Curve3D].
+ Contains a [Curve3D] path for [PathFollow] nodes to follow.
</brief_description>
<description>
- This class is a container/Node-ification of a [Curve3D], so it can have [Spatial] properties and [Node] info.
+ Can have [PathFollow] child nodes moving along the [Curve3D]. See [PathFollow] for more information on the usage.
+ Note that the path is considered as relative to the moved nodes (children of [PathFollow]). As such, the curve should usually start with a zero vector [code](0, 0, 0)[/code].
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
- <member name="curve" type="Curve3D" setter="set_curve" getter="get_curve">
+ <member name="curve" type="Curve3D" setter="set_curve" getter="get_curve" default="Object(Curve3D,&quot;resource_local_to_scene&quot;:false,&quot;resource_name&quot;:&quot;&quot;,&quot;bake_interval&quot;:0.2,&quot;_data&quot;:{
+&quot;points&quot;: PoolVector3Array( ),
+&quot;tilts&quot;: PoolRealArray( )
+},&quot;up_vector_enabled&quot;:true,&quot;script&quot;:null)
+">
+ A [Curve3D] describing the path.
</member>
</members>
<signals>
<signal name="curve_changed">
<description>
+ Emitted when the [member curve] changes.
</description>
</signal>
</signals>