spine-runtimes/spine-godot/spine_godot/docs/SpinePathConstraint.xml
2022-07-18 10:27:42 +02:00

122 lines
3.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpinePathConstraint" inherits="SpineObjectWrapper" version="3.4">
<brief_description>
Stores the current pose for a path constraint.
</brief_description>
<description>
Stores the current pose for a path constraint. A path constraint adjusts the rotation, translation, and scale of the constrained bones so they follow a {@link PathAttachment}.
See [url]http://esotericsoftware.com/spine-path-constraints[/url] in the Spine User Guide.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_bones">
<return type="Array" />
<description>
The bones that will be modified by this path constraint. Modifying the array has no effect.
</description>
</method>
<method name="get_data">
<return type="SpinePathConstraintData" />
<description>
The path constraint's setup pose data.
</description>
</method>
<method name="get_mix_rotate">
<return type="float" />
<description>
A percentage (0-1) that controls the mix between the constrained and unconstrained rotation.
</description>
</method>
<method name="get_mix_x">
<return type="float" />
<description>
A percentage (0-1) that controls the mix between the constrained and unconstrained translation X.
</description>
</method>
<method name="get_mix_y">
<return type="float" />
<description>
A percentage (0-1) that controls the mix between the constrained and unconstrained translation Y.
</description>
</method>
<method name="get_order">
<return type="int" />
<description>
</description>
</method>
<method name="get_position">
<return type="float" />
<description>
The position along the path.
</description>
</method>
<method name="get_spacing">
<return type="float" />
<description>
The spacing between bones.
</description>
</method>
<method name="get_target">
<return type="SpineSlot" />
<description>
The slot whose path attachment will be used to constrained the bones.
</description>
</method>
<method name="is_active">
<return type="bool" />
<description>
</description>
</method>
<method name="set_active">
<return type="void" />
<argument index="0" name="v" type="bool" />
<description>
</description>
</method>
<method name="set_mix_rotate">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_mix_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_mix_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_position">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_spacing">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_target">
<return type="void" />
<argument index="0" name="v" type="SpineSlot" />
<description>
</description>
</method>
<method name="update">
<return type="void" />
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>