virtualx-engine/doc/classes/Path.xml
Hugo Locurcio b087538119
Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00

28 lines
1,002 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Path" inherits="Spatial" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Contains a [Curve3D] path for [PathFollow] nodes to follow.
</brief_description>
<description>
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">
A [Curve3D] describing the path.
</member>
</members>
<signals>
<signal name="curve_changed">
<description>
Emitted when the [member curve] changes.
</description>
</signal>
</signals>
<constants>
</constants>
</class>