UnityMirror/spine-runtimes
1
0
Fork 0
mirror of https://github.com/EsotericSoftware/spine-runtimes.git synced 2025-12-20 17:26:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

[godot] Update GDScript docs

Browse Source
This commit is contained in:
Mario Zechner 2025-10-01 15:22:56 +02:00
parent 26efd7e01d
commit 93399d104a
22 changed files with 1852 additions and 591 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
spine-godot/spine_godot/docs/SpineAnimation.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineAnimation" inherits="SpineObjectWrapper" version="3.4">
<brief_description>
Stores a list of timelines to animate a skeleton's pose over time. The timelines can not be modified through GDScript.
Stores a list of timelines to animate a skeleton's pose over time.
</brief_description>
<description>
Stores a list of timelines to animate a skeleton's pose over time. The timelines can not be modified through GDScript.
Stores a list of timelines to animate a skeleton's pose over time. An animation modifies the skeleton's pose based on time, using timelines to control bone transforms, slot colors, attachment visibility, events, draw order, and more.
</description>
<tutorials>
</tutorials>

27
spine-godot/spine_godot/docs/SpineAttachment.xml
View File

@ -1,26 +1,25 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineAttachment" inherits="SpineObjectWrapper" version="3.4">
<class name="SpineAttachment" inherits="SpineObjectWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Represents an attachment in a Spine skeleton's skin.
The base class for attachments.
</brief_description>
<description>
Represents an attachment in a Spine skeleton's skin. See [url]http://en.esotericsoftware.com/spine-runtime-skins[/url].
Attachments can only be queried for their name and can not be manipulated.
The base class for attachments. Attachments are stored in skins and can be attached to slots. Attachments are reference counted and may be shared across multiple skeletons.
See [url=http://esotericsoftware.com/spine-attachments]Attachments[/url] in the Spine User Guide.
</description>
<tutorials>
</tutorials>
<methods>
<method name="copy">
<return type="SpineAttachment" />
<description>
</description>
</method>
<method name="get_attachment_name">
<return type="String" />
<description>
Returns the attachment's name.
</description>
</method>
<method name="copy">
<return type="SpineAttachment" />
<description>
Returns a copy of this attachment.
</description>
</method>
</methods>
<constants>
</constants>
</class>
</class>

387
spine-godot/spine_godot/docs/SpineBone.xml
View File

@ -1,397 +1,150 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineBone" inherits="SpineObjectWrapper" version="3.4">
<class name="SpineBone" inherits="SpineObjectWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
A bone of a Spine skeleton, storing its current pose.
The current pose for a bone, before constraints are applied.
</brief_description>
<description>
A bone of a Spine skeleton, storing its current pose.
The current pose for a bone, before constraints are applied.
A bone has a local transform which is used to compute its world transform. A bone also has an applied transform, which is a local transform that can be applied to compute the world transform. The local transform and applied transform may differ if a constraint or application code modifies the world transform after it was computed from the local transform.
The bone's world transform is relative to the skeleton's coordinate system origin. Use [code]set_global_transform()[/code] and [code]get_global_transform()[/code] to convert from and to Godot's Canvas coordinate system.
The bone's world transform is relative to the skeleton's coordinate system origin. Use [method set_global_transform] and [method get_global_transform] to convert from and to Godot's Canvas coordinate system.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_a">
<return type="float" />
<method name="world_to_local">
<return type="Vector2" />
<param index="0" name="world_position" type="Vector2" />
<description>
Part of the world transform matrix for the X axis. If changed, [code]update_applied_transform[/code] should be called.
Transforms a point from world coordinates to the bone's local coordinates. The world coordinate space is equal to the SpineSprite coordinate space.
</description>
</method>
<method name="get_a_scale_x">
<return type="float" />
<method name="world_to_parent">
<return type="Vector2" />
<param index="0" name="world_position" type="Vector2" />
<description>
The local scaleX.
Transforms a point from world coordinates to the parent bone's local coordinates.
</description>
</method>
<method name="get_a_scale_y">
<return type="float" />
<method name="local_to_world">
<return type="Vector2" />
<param index="0" name="local_position" type="Vector2" />
<description>
The local scaleY.
Transforms a point from the bone's local coordinates to world coordinates. The world coordinate space equals the coordinate space of the SpineSprite.
</description>
</method>
<method name="get_a_shear_x">
<return type="float" />
<method name="parent_to_world">
<return type="Vector2" />
<param index="0" name="local_position" type="Vector2" />
<description>
The local shearX.
Transforms a point from the parent bone's coordinates to world coordinates.
</description>
</method>
<method name="get_a_shear_y">
<method name="world_to_local_rotation">
<return type="float" />
<param index="0" name="world_rotation" type="float" />
<description>
The local shearY.
Transforms a world rotation to a local rotation. The world coordinate space is equal to the SpineSprite coordinate space.
</description>
</method>
<method name="get_a_x">
<method name="local_to_world_rotation">
<return type="float" />
<param index="0" name="local_rotation" type="float" />
<description>
The applied local x translation.
Transforms a local rotation to a world rotation. The world coordinate space equals the coordinate space of the SpineSprite.
</description>
</method>
<method name="get_a_y">
<return type="float" />
<method name="rotate_world">
<return type="void" />
<param index="0" name="degrees" type="float" />
<description>
The applied local y translation.
</description>
</method>
<method name="get_applied_rotation">
<return type="float" />
<description>
The applied local rotation in degrees, counter clockwise.
</description>
</method>
<method name="get_b">
<return type="float" />
<description>
Part of the world transform matrix for the Y axis. If changed, [code]update_applied_transform()[/code] should be called.
</description>
</method>
<method name="get_c">
<return type="float" />
<description>
Part of the world transform matrix for the X axis. If changed, [code]update_applied_transform()[/code] should be called.
</description>
</method>
<method name="get_children">
<return type="Array" />
<description>
The immediate children of this bone. Modifications of the array have no effect.
</description>
</method>
<method name="get_d">
<return type="float" />
<description>
Part of the world transform matrix for the Y axis. If changed, [code]update_applied_transform()[/code] should be called.
Rotates the world transform the specified amount in degrees.
After changes are made to the world transform, update_local_transform should be called on the applied pose and update_world_transform will need to be called on any child bones, recursively.
</description>
</method>
<method name="get_data">
<return type="SpineBoneData" />
<description>
The bone's setup pose data.
</description>
</method>
<method name="get_global_transform">
<return type="Transform2D" />
<description>
Returns the bone transform as a [code]Transform2D[/code] relative to Godot's global canvas coordinate space. Shear is not encoded in the transform.
Returns the bone's setup pose data.
</description>
</method>
<method name="get_parent">
<return type="SpineBone" />
<description>
The parent bone, or null if this is the root bone.
Returns the parent bone, or null if this is the root bone.
</description>
</method>
<method name="get_rotation">
<return type="float" />
<method name="get_children">
<return type="Array" />
<description>
The local rotation in degrees, counter clockwise.
Returns the immediate children of this bone. Modifications of the array have no effect.
</description>
</method>
<method name="get_scale_x">
<return type="float" />
<method name="get_pose">
<return type="SpineBoneLocal" />
<description>
The local scaleX.
Returns the local pose for this bone. The pose contains the local transform (position, rotation, scale, shear).
</description>
</method>
<method name="get_scale_y">
<return type="float" />
<method name="get_applied_pose">
<return type="SpineBonePose" />
<description>
The local scaleY.
</description>
</method>
<method name="get_shear_x">
<return type="float" />
<description>
The local shearX.
</description>
</method>
<method name="get_shear_y">
<return type="float" />
<description>
The local shearY.
</description>
</method>
<method name="get_transform">
<return type="Transform2D" />
<description>
Returns the bone transform as a [code]Transform2D[/code] relative to the [code]SpineSprite[/code] node representing the skeleton. Shear is not encoded in the transform.
</description>
</method>
<method name="get_world_rotation_x">
<return type="float" />
<description>
The world rotation for the X axis in degrees, calculated using a and c of the transform. The rotation is relative to the [code]SpineSprite[/code].
</description>
</method>
<method name="get_world_rotation_y">
<return type="float" />
<description>
The world rotation for the X axis in degrees, calculated using b and d of the transform. The rotation is relative to the [code]SpineSprite[/code].
</description>
</method>
<method name="get_world_scale_x">
<return type="float" />
<description>
The magnitude (always positive) of the world scale X, calculated using a and c. The scale is relative to the [code]SpineSprite[/code].
</description>
</method>
<method name="get_world_scale_y">
<return type="float" />
<description>
The magnitude (always positive) of the world scale X, calculated using b and d. The scale is relative to the [code]SpineSprite[/code].
</description>
</method>
<method name="get_world_to_local_rotation_x">
<return type="float" />
<description>
Transforms a world rotation to a local rotation. The world coordinate system is equal to the [code]SpineSprite[/code] coordinate space.
</description>
</method>
<method name="get_world_to_local_rotation_y">
<return type="float" />
<description>
Transforms a world rotation to a local rotation. The world coordinate system is equal to the [code]SpineSprite[/code] coordinate space.
</description>
</method>
<method name="get_world_x">
<return type="float" />
<description>
The world X position. If changed, [code]update_applied_transform()[/code] should be called. The world coordinate system is equal to the [code]SpineSprite[/code] coordinate space.
</description>
</method>
<method name="get_world_y">
<return type="float" />
<description>
The world Y position. If changed, [code]update_applied_transform()[/code] should be called. The world coordinate system is equal to the [code]SpineSprite[/code] coordinate space.
</description>
</method>
<method name="get_x">
<return type="float" />
<description>
The local x translation.
</description>
</method>
<method name="get_y">
<return type="float" />
<description>
The local y translation.
Returns the applied pose for this bone. The applied pose contains both the local transform and the world transform. The applied transform may differ from the pose if a constraint or application code modifies the world transform after it was computed from the local transform.
</description>
</method>
<method name="is_active">
<return type="bool" />
<description>
Returns false when the bone has not been computed because [code]BoneData.get_skin_required()[/code] is true and the active skin does not contain this bone.
</description>
</method>
<method name="local_to_world">
<return type="Vector2" />
<argument index="0" name="local_position" type="Vector2" />
<description>
Transforms a point from the bone's local coordinates to world coordinates. The world coordinate space equals the coordinate space of the [code]SpineSprite[/code].
</description>
</method>
<method name="local_to_world_rotation">
<return type="float" />
<argument index="0" name="local_rotation" type="float" />
<description>
Transforms a local rotation to a world rotation. The world coordinate space equals the coordinate space of the [code]SpineSprite[/code].
</description>
</method>
<method name="rotate_world">
<return type="void" />
<argument index="0" name="arg0" type="float" />
<description>
Rotates the world transform the specified amount.
After changes are made to the world transform, [code]update_applied_transform[/code] should be called and [code]update()[/code] will need to be called on any child bones, recursively.
</description>
</method>
<method name="set_a">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_a_scale_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_a_scale_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_a_shear_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_a_shear_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_a_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_a_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
Returns false when the bone has not been computed because BoneData.skin_required is true and the active skin does not contain this bone.
</description>
</method>
<method name="set_active">
<return type="void" />
<argument index="0" name="v" type="bool" />
<param index="0" name="v" type="bool" />
<description>
Sets whether this bone is active. Inactive bones are not computed until they are active again.
</description>
</method>
<method name="set_applied_rotation">
<method name="update">
<return type="void" />
<argument index="0" name="v" type="float" />
<param index="0" name="skeleton" type="SpineSkeleton" />
<param index="1" name="physics" type="int" enum="SpineConstant.Physics" />
<description>
Updates this bone. This is called internally when the skeleton's world transform is computed and should typically not be called directly. The physics parameter determines how physics are applied. See [enum SpineConstant.Physics].
</description>
</method>
<method name="set_b">
<method name="apply_world_transform_2d">
<return type="void" />
<argument index="0" name="v" type="float" />
<param index="0" name="o" type="Variant" />
<description>
Applies a world transform to this bone from a Node2D or Bone2D object.
</description>
</method>
<method name="set_c">
<return type="void" />
<argument index="0" name="v" type="float" />
<method name="get_transform">
<return type="Transform2D" />
<description>
</description>
</method>
<method name="set_d">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_global_transform">
<return type="void" />
<argument index="0" name="global_transform" type="Transform2D" />
<description>
Sets the bone's transform to the global Godot [code]Transform2D[/code].
</description>
</method>
<method name="set_rotation">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_scale_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_scale_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_shear_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_shear_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_to_setup_pose">
<return type="void" />
<description>
Sets this bone's local transform to the setup pose.
Returns the bone transform as a Transform2D relative to the SpineSprite node representing the skeleton. Shear is not encoded in the transform.
</description>
</method>
<method name="set_transform">
<return type="void" />
<argument index="0" name="local_transform" type="Transform2D" />
<param index="0" name="transform" type="Transform2D" />
<description>
Sets the bone transform to the Godot [code]Transform2D[/code].
Sets the bone transform to the Godot Transform2D relative to the SpineSprite.
</description>
</method>
<method name="set_world_x">
<method name="get_global_transform">
<return type="Transform2D" />
<description>
Returns the bone transform as a Transform2D relative to Godot's global canvas coordinate space. Shear is not encoded in the transform.
</description>
</method>
<method name="set_global_transform">
<return type="void" />
<argument index="0" name="v" type="float" />
<param index="0" name="trans" type="Transform2D" />
<description>
</description>
</method>
<method name="set_world_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="update_world_transform">
<return type="void" />
<description>
Computes the world transform using the parent bone and this bone's local transform.
</description>
</method>
<method name="world_to_local">
<return type="Vector2" />
<argument index="0" name="world_position" type="Vector2" />
<description>
Transforms a point from world coordinates to the bone's local coordinates. The world coordinate space is equal to the [code]SpineSprite[/code] coordinate space.
</description>
</method>
<method name="world_to_local_rotation">
<return type="float" />
<argument index="0" name="world_rotation" type="float" />
<description>
Transforms a world rotation to a local rotation. The world coordinate space is equal to the [code]SpineSprite[/code] coordinate space.
Sets the bone's transform to the global Godot Transform2D.
</description>
</method>
</methods>
<constants>
</constants>
</class>
</class>

154
spine-godot/spine_godot/docs/SpineBoneData.xml
View File

@ -1,163 +1,93 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineBoneData" inherits="SpineObjectWrapper" version="3.4">
<class name="SpineBoneData" inherits="SpineObjectWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores the setup pose for a bone.
</brief_description>
<description>
Stores the setup pose for a bone.
Stores the setup pose for a bone. The setup pose is the reference pose for the skeleton, before any animations are applied.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_bone_name">
<return type="String" />
<description>
The name of the bone, which is unique across all bones in the skeleton.
</description>
</method>
<method name="get_color">
<return type="Color" />
<description>
The color of the bone as it was in Spine, or a default color if nonessential data was not exported. Bones are not usually rendered at runtime.
</description>
</method>
<method name="get_index">
<return type="int" />
<description>
The index of the bone in [code]Skeleton.get_bones()[/code].
Returns the index of the bone in Skeleton.bones.
</description>
</method>
<method name="get_length">
<return type="float" />
<method name="get_bone_name">
<return type="String" />
<description>
The bone's length.
Returns the name of the bone, which is unique across all bones in the skeleton.
</description>
</method>
<method name="get_parent">
<return type="SpineBoneData" />
<description>
Returns the parent bone data. May be null for the root bone.
</description>
</method>
<method name="get_rotation">
<method name="get_length">
<return type="float" />
<description>
The local rotation in degrees.
Returns the bone's length.
</description>
</method>
<method name="get_scale_x">
<return type="float" />
<method name="set_length">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
The local scaleX.
Sets the bone's length.
</description>
</method>
<method name="get_scale_y">
<return type="float" />
<method name="get_setup_pose">
<return type="SpineBoneLocal" />
<description>
The local scaleY.
</description>
</method>
<method name="get_shear_x">
<return type="float" />
<description>
The local shearX.
</description>
</method>
<method name="get_shear_y">
<return type="float" />
<description>
The local shearY.
</description>
</method>
<method name="get_transform_mode">
<return type="int" enum="SpineConstant.TransformMode" />
<description>
The transform mode for how parent world transforms affect this bone.
</description>
</method>
<method name="get_x">
<return type="float" />
<description>
The local x translation.
</description>
</method>
<method name="get_y">
<return type="float" />
<description>
The local y translation.
Returns the local setup pose for this bone, containing position, rotation, scale, and shear.
</description>
</method>
<method name="is_skin_required">
<return type="bool" />
<description>
</description>
</method>
<method name="set_color">
<return type="void" />
<argument index="0" name="v" type="Color" />
<description>
</description>
</method>
<method name="set_length">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_rotation">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_scale_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_scale_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_shear_x">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_shear_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
Returns whether the bone is only active when a skin containing it is active.
</description>
</method>
<method name="set_skin_required">
<return type="void" />
<argument index="0" name="v" type="bool" />
<param index="0" name="v" type="bool" />
<description>
Sets whether the bone is only active when a skin containing it is active.
</description>
</method>
<method name="set_transform_mode">
<return type="void" />
<argument index="0" name="v" type="int" enum="SpineConstant.TransformMode" />
<method name="get_color">
<return type="Color" />
<description>
Returns the color of the bone as it was in Spine, or a default color if nonessential data was not exported. Bones are not usually rendered at runtime.
</description>
</method>
<method name="set_x">
<method name="set_color">
<return type="void" />
<argument index="0" name="v" type="float" />
<param index="0" name="v" type="Color" />
<description>
Sets the color of the bone.
</description>
</method>
<method name="set_y">
<return type="void" />
<argument index="0" name="v" type="float" />
<method name="get_icon">
<return type="String" />
<description>
Returns the icon name for this bone, if any.
</description>
</method>
<method name="is_visible">
<return type="bool" />
<description>
Returns whether the bone is visible.
</description>
</method>
<method name="set_visible">
<return type="void" />
<param index="0" name="v" type="bool" />
<description>
Sets whether the bone is visible.
</description>
</method>
</methods>
<constants>
</constants>
</class>
</class>

138
spine-godot/spine_godot/docs/SpineBoneLocal.xml Normal file
View File

@ -0,0 +1,138 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineBoneLocal" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores a bone's local pose.
</brief_description>
<description>
Stores a bone's local pose, which consists of the bone's position, rotation, scale, and shear in its local coordinate space (relative to its parent). The inherit property determines how parent world transforms affect this bone.
</description>
<methods>
<method name="get_x">
<return type="float" />
<description>
Returns the local x translation.
</description>
</method>
<method name="set_x">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the local x translation.
</description>
</method>
<method name="get_y">
<return type="float" />
<description>
Returns the local y translation.
</description>
</method>
<method name="set_y">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the local y translation.
</description>
</method>
<method name="get_rotation">
<return type="float" />
<description>
Returns the local rotation in degrees, counter clockwise.
</description>
</method>
<method name="set_rotation">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the local rotation in degrees, counter clockwise.
</description>
</method>
<method name="get_scale_x">
<return type="float" />
<description>
Returns the local scaleX.
</description>
</method>
<method name="set_scale_x">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the local scaleX.
</description>
</method>
<method name="get_scale_y">
<return type="float" />
<description>
Returns the local scaleY.
</description>
</method>
<method name="set_scale_y">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the local scaleY.
</description>
</method>
<method name="get_shear_x">
<return type="float" />
<description>
Returns the local shearX.
</description>
</method>
<method name="set_shear_x">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the local shearX.
</description>
</method>
<method name="get_shear_y">
<return type="float" />
<description>
Returns the local shearY.
</description>
</method>
<method name="set_shear_y">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the local shearY.
</description>
</method>
<method name="get_inherit">
<return type="int" enum="SpineConstant.Inherit" />
<description>
Returns how parent world transforms affect this bone. See [enum SpineConstant.Inherit].
</description>
</method>
<method name="set_inherit">
<return type="void" />
<param index="0" name="v" type="int" enum="SpineConstant.Inherit" />
<description>
Sets how parent world transforms affect this bone. See [enum SpineConstant.Inherit].
</description>
</method>
<method name="set_position">
<return type="void" />
<param index="0" name="x" type="float" />
<param index="1" name="y" type="float" />
<description>
Sets both the local x and y translation at once.
</description>
</method>
<method name="set_scale">
<return type="void" />
<param index="0" name="scale_x" type="float" />
<param index="1" name="scale_y" type="float" />
<description>
Sets both the local scaleX and scaleY at once.
</description>
</method>
<method name="set_scale_uniform">
<return type="void" />
<param index="0" name="scale" type="float" />
<description>
Sets both the local scaleX and scaleY to the same value.
</description>
</method>
</methods>
</class>

186
spine-godot/spine_godot/docs/SpineBonePose.xml Normal file
View File

@ -0,0 +1,186 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineBonePose" inherits="SpineBoneLocal" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
The applied pose for a bone with constraints applied and world transform computed.
</brief_description>
<description>
The applied pose for a bone. This is the bone pose with constraints applied and the world transform computed by [SpineSkeleton]'s update_world_transform method. Inherits all local transform properties from [SpineBoneLocal] and adds world transform properties and transformation methods.
See [url=https://esotericsoftware.com/spine-runtime-skeletons#World-transforms]World transforms[/url] in the Spine Runtimes Guide.
</description>
<methods>
<method name="get_a">
<return type="float" />
<description>
Returns part of the world transform matrix for the X axis. If changed, update_local_transform should be called.
</description>
</method>
<method name="set_a">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets part of the world transform matrix for the X axis. If changed, update_local_transform should be called.
</description>
</method>
<method name="get_b">
<return type="float" />
<description>
Returns part of the world transform matrix for the Y axis. If changed, update_local_transform should be called.
</description>
</method>
<method name="set_b">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets part of the world transform matrix for the Y axis. If changed, update_local_transform should be called.
</description>
</method>
<method name="get_c">
<return type="float" />
<description>
Returns part of the world transform matrix for the X axis. If changed, update_local_transform should be called.
</description>
</method>
<method name="set_c">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets part of the world transform matrix for the X axis. If changed, update_local_transform should be called.
</description>
</method>
<method name="get_d">
<return type="float" />
<description>
Returns part of the world transform matrix for the Y axis. If changed, update_local_transform should be called.
</description>
</method>
<method name="set_d">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets part of the world transform matrix for the Y axis. If changed, update_local_transform should be called.
</description>
</method>
<method name="get_world_x">
<return type="float" />
<description>
Returns the world X position. If changed, update_local_transform should be called.
</description>
</method>
<method name="set_world_x">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the world X position. If changed, update_local_transform should be called.
</description>
</method>
<method name="get_world_y">
<return type="float" />
<description>
Returns the world Y position. If changed, update_local_transform should be called.
</description>
</method>
<method name="set_world_y">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the world Y position. If changed, update_local_transform should be called.
</description>
</method>
<method name="get_world_rotation_x">
<return type="float" />
<description>
Returns the world rotation for the X axis, calculated using a and c.
</description>
</method>
<method name="get_world_rotation_y">
<return type="float" />
<description>
Returns the world rotation for the Y axis, calculated using b and d.
</description>
</method>
<method name="get_world_scale_x">
<return type="float" />
<description>
Returns the magnitude (always positive) of the world scale X, calculated using a and c.
</description>
</method>
<method name="get_world_scale_y">
<return type="float" />
<description>
Returns the magnitude (always positive) of the world scale Y, calculated using b and d.
</description>
</method>
<method name="world_to_local">
<return type="Vector2" />
<param index="0" name="world_position" type="Vector2" />
<description>
Transforms a point from world coordinates to the bone's local coordinates.
</description>
</method>
<method name="local_to_world">
<return type="Vector2" />
<param index="0" name="local_position" type="Vector2" />
<description>
Transforms a point from the bone's local coordinates to world coordinates.
</description>
</method>
<method name="world_to_parent">
<return type="Vector2" />
<param index="0" name="world_position" type="Vector2" />
<description>
Transforms a point from world coordinates to the parent bone's local coordinates.
</description>
</method>
<method name="parent_to_world">
<return type="Vector2" />
<param index="0" name="parent_position" type="Vector2" />
<description>
Transforms a point from the parent bone's coordinates to world coordinates.
</description>
</method>
<method name="world_to_local_rotation">
<return type="float" />
<param index="0" name="world_rotation" type="float" />
<description>
Transforms a world rotation to a local rotation.
</description>
</method>
<method name="local_to_world_rotation">
<return type="float" />
<param index="0" name="local_rotation" type="float" />
<description>
Transforms a local rotation to a world rotation.
</description>
</method>
<method name="rotate_world">
<return type="void" />
<param index="0" name="degrees" type="float" />
<description>
Rotates the world transform the specified amount in degrees.
After changes are made to the world transform, update_local_transform should be called on this bone and any child bones, recursively.
</description>
</method>
<method name="update_world_transform">
<return type="void" />
<param index="0" name="skeleton" type="SpineSkeleton" />
<description>
Computes the world transform using the parent bone's applied pose and this pose. Child bones are not updated.
See [url=https://esotericsoftware.com/spine-runtime-skeletons#World-transforms]World transforms[/url] in the Spine Runtimes Guide.
</description>
</method>
<method name="update_local_transform">
<return type="void" />
<param index="0" name="skeleton" type="SpineSkeleton" />
<description>
Computes the local transform values from the world transform.
If the world transform is modified (by a constraint, rotate_world, etc) then this method should be called so the local transform matches the world transform. The local transform may be needed by other code (eg to apply another constraint).
Some information is ambiguous in the world transform, such as -1,-1 scale versus 180 rotation. The local transform after calling this method is equivalent to the local transform used to compute the world transform, but may not be identical.
</description>
</method>
</methods>
</class>

167
spine-godot/spine_godot/docs/SpineConstant.xml Normal file
View File

@ -0,0 +1,167 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineConstant" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Contains constant values and enumerations used throughout the Spine runtime.
</brief_description>
<description>
The SpineConstant class provides access to various enumeration values used by the Spine runtime system in Godot. These constants are used to configure animation mixing, bone inheritance, path constraints, blend modes, and physics settings.
</description>
<constants>
<constant name="MixBlend_Setup" value="0" enum="MixBlend">
Transitions between the setup and timeline values (the current value is not used). Before the first frame, the setup value is used. MixBlend_Setup is intended to transition to or from the setup pose, not for animations layered on top of others.
</constant>
<constant name="MixBlend_First" value="1" enum="MixBlend">
Transitions between the current and timeline values. Before the first frame, transitions between the current and setup values. Timelines which perform instant transitions, such as DrawOrderTimeline or AttachmentTimeline, use the setup value before the first frame. MixBlend_First is intended for the first animations applied, not for animations layered on top of others.
</constant>
<constant name="MixBlend_Replace" value="2" enum="MixBlend">
Transitions between the current and timeline values. No change is made before the first frame. MixBlend_Replace is intended for animations layered on top of others, not for the first animations applied.
</constant>
<constant name="MixBlend_Add" value="3" enum="MixBlend">
Transitions between the current value and the current plus timeline values. No change is made before the first frame. MixBlend_Add is intended for animations layered on top of others, not for the first animations applied. Properties set by additive animations must be set manually or by another animation before applying the additive animations, else the property values will increase each time the additive animations are applied.
</constant>
<constant name="MixDirection_In" value="0" enum="MixDirection">
Spine animation mix direction for mixing in.
</constant>
<constant name="MixDirection_Out" value="1" enum="MixDirection">
Spine animation mix direction for mixing out.
</constant>
<constant name="Property_Rotate" value="1" enum="PropertyId">
Timeline property for rotation.
</constant>
<constant name="Property_X" value="2" enum="PropertyId">
Timeline property for X position.
</constant>
<constant name="Property_Y" value="4" enum="PropertyId">
Timeline property for Y position.
</constant>
<constant name="Property_ScaleX" value="8" enum="PropertyId">
Timeline property for X scale.
</constant>
<constant name="Property_ScaleY" value="16" enum="PropertyId">
Timeline property for Y scale.
</constant>
<constant name="Property_ShearX" value="32" enum="PropertyId">
Timeline property for X shear.
</constant>
<constant name="Property_ShearY" value="64" enum="PropertyId">
Timeline property for Y shear.
</constant>
<constant name="Property_Rgb" value="128" enum="PropertyId">
Timeline property for RGB color.
</constant>
<constant name="Property_Alpha" value="256" enum="PropertyId">
Timeline property for alpha transparency.
</constant>
<constant name="Property_Rgb2" value="512" enum="PropertyId">
Timeline property for second RGB color (for two-color tinting).
</constant>
<constant name="Property_Attachment" value="1024" enum="PropertyId">
Timeline property for attachment changes.
</constant>
<constant name="Property_Deform" value="2048" enum="PropertyId">
Timeline property for mesh deformation.
</constant>
<constant name="Property_Event" value="4096" enum="PropertyId">
Timeline property for events.
</constant>
<constant name="Property_DrawOrder" value="8192" enum="PropertyId">
Timeline property for draw order changes.
</constant>
<constant name="Property_IkConstraint" value="16384" enum="PropertyId">
Timeline property for IK constraint.
</constant>
<constant name="Property_TransformConstraint" value="32768" enum="PropertyId">
Timeline property for transform constraint.
</constant>
<constant name="Property_PathConstraintPosition" value="65536" enum="PropertyId">
Timeline property for path constraint position.
</constant>
<constant name="Property_PathConstraintSpacing" value="131072" enum="PropertyId">
Timeline property for path constraint spacing.
</constant>
<constant name="Property_PathConstraintMix" value="262144" enum="PropertyId">
Timeline property for path constraint mix.
</constant>
<constant name="Property_Sequence" value="524288" enum="PropertyId">
Timeline property for sequence.
</constant>
<constant name="Inherit_Normal" value="0" enum="Inherit">
Normal transform inheritance from parent bone.
</constant>
<constant name="Inherit_OnlyTranslation" value="1" enum="Inherit">
Inherits only translation from parent bone.
</constant>
<constant name="Inherit_NoRotationOrReflection" value="2" enum="Inherit">
Inherits transform except rotation and reflection.
</constant>
<constant name="Inherit_NoScale" value="3" enum="Inherit">
Inherits transform except scale.
</constant>
<constant name="Inherit_NoScaleOrReflection" value="4" enum="Inherit">
Inherits transform except scale and reflection.
</constant>
<constant name="PositionMode_Fixed" value="0" enum="PositionMode">
Path constraint position mode using fixed values.
</constant>
<constant name="PositionMode_Percent" value="1" enum="PositionMode">
Path constraint position mode using percentage of path length.
</constant>
<constant name="SpacingMode_Length" value="0" enum="SpacingMode">
Path constraint spacing based on fixed length.
</constant>
<constant name="SpacingMode_Fixed" value="1" enum="SpacingMode">
Path constraint spacing with fixed number of bones.
</constant>
<constant name="SpacingMode_Percent" value="2" enum="SpacingMode">
Path constraint spacing as percentage of path length.
</constant>
<constant name="RotateMode_Tangent" value="0" enum="RotateMode">
Path constraint rotation follows the path tangent.
</constant>
<constant name="RotateMode_Chain" value="1" enum="RotateMode">
Path constraint rotation chains bones together.
</constant>
<constant name="RotateMode_ChainScale" value="2" enum="RotateMode">
Path constraint rotation chains bones together with scale.
</constant>
<constant name="BlendMode_Normal" value="0" enum="BlendMode">
Normal alpha blending.
</constant>
<constant name="BlendMode_Additive" value="1" enum="BlendMode">
Additive blending.
</constant>
<constant name="BlendMode_Multiply" value="2" enum="BlendMode">
Multiply blending.
</constant>
<constant name="BlendMode_Screen" value="3" enum="BlendMode">
Screen blending.
</constant>
<constant name="UpdateMode_Process" value="0" enum="UpdateMode">
Update during the process step.
</constant>
<constant name="UpdateMode_Physics" value="1" enum="UpdateMode">
Update during the physics step.
</constant>
<constant name="UpdateMode_Manual" value="2" enum="UpdateMode">
Manual update mode, updates must be triggered explicitly.
</constant>
<constant name="BoneMode_Follow" value="0" enum="BoneMode">
Bone follows the physics simulation.
</constant>
<constant name="BoneMode_Drive" value="1" enum="BoneMode">
Bone drives the physics simulation.
</constant>
<constant name="Physics_None" value="0" enum="Physics">
Physics are not updated or applied.
</constant>
<constant name="Physics_Reset" value="1" enum="Physics">
Physics are reset to the current pose.
</constant>
<constant name="Physics_Update" value="2" enum="Physics">
Physics are updated and the pose from physics is applied.
</constant>
<constant name="Physics_Pose" value="3" enum="Physics">
Physics are not updated but the pose from physics is applied.
</constant>
</constants>
</class>

95
spine-godot/spine_godot/docs/SpineEventData.xml Normal file
View File

@ -0,0 +1,95 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineEventData" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores the setup pose values for an Event.
</brief_description>
<description>
Stores the setup pose values for an Event. Events can have various types of values associated with them including integers, floats, strings, and audio information. The event name is unique within the skeleton.
</description>
<methods>
<method name="get_event_name">
<return type="String" />
<description>
Returns the name of the event, which is unique within the skeleton.
</description>
</method>
<method name="get_int_value">
<return type="int" />
<description>
Returns the integer value for this event.
</description>
</method>
<method name="set_int_value">
<return type="void" />
<param index="0" name="v" type="int" />
<description>
Sets the integer value for this event.
</description>
</method>
<method name="get_float_value">
<return type="float" />
<description>
Returns the float value for this event.
</description>
</method>
<method name="set_float_value">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the float value for this event.
</description>
</method>
<method name="get_string_value">
<return type="String" />
<description>
Returns the string value for this event.
</description>
</method>
<method name="set_string_value">
<return type="void" />
<param index="0" name="v" type="String" />
<description>
Sets the string value for this event.
</description>
</method>
<method name="get_audio_path">
<return type="String" />
<description>
Returns the audio path for this event.
</description>
</method>
<method name="set_audio_path">
<return type="void" />
<param index="0" name="v" type="String" />
<description>
Sets the audio path for this event.
</description>
</method>
<method name="get_volume">
<return type="float" />
<description>
Returns the volume for the audio of this event.
</description>
</method>
<method name="set_volume">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the volume for the audio of this event.
</description>
</method>
<method name="get_balance">
<return type="float" />
<description>
Returns the balance for the audio of this event.
</description>
</method>
<method name="set_balance">
<return type="void" />
<param index="0" name="v" type="float" />
<description>
Sets the balance for the audio of this event.
</description>
</method>
</methods>
</class>

122
spine-godot/spine_godot/docs/SpineIkConstraint.xml
View File

@ -1,122 +1,70 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineIkConstraint" inherits="SpineObjectWrapper" version="3.4">
<class name="SpineIkConstraint" inherits="SpineObjectWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores the current pose for an IK constraint.
</brief_description>
<description>
Stores the current pose for an IK constraint. An IK constraint adjusts the rotation of 1 or 2 constrained bones so the tip of the last bone is as close to the target bone as possible.
See [url]http://esotericsoftware.com/spine-ik-constraints[/url] in the Spine User Guide.
See [url=http://esotericsoftware.com/spine-ik-constraints]IK constraints[/url] in the Spine User Guide.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_bend_direction">
<return type="int" />
<method name="update">
<return type="void" />
<param index="0" name="skeleton" type="SpineSkeleton" />
<description>
For two bone IK, controls the bend direction of the IK bones, either 1 or -1.
</description>
</method>
<method name="get_bones">
<return type="Array" />
<description>
The bones that will be modified by this IK constraint. Modifying the array has no effect.
</description>
</method>
<method name="get_compress">
<return type="bool" />
<description>
For one bone IK, when true and the target is too close, the bone is scaled to reach it.
Updates the constraint. The IK constraint is solved by adjusting the rotation of the bones so the tip of the last bone is as close to the target as possible.
</description>
</method>
<method name="get_data">
<return type="SpineIkConstraintData" />
<description>
The IK constraint's setup pose data.
Returns the IK constraint's setup pose data.
</description>
</method>
<method name="get_mix">
<return type="float" />
<method name="get_bones">
<return type="Array" />
<description>
A percentage (0-1) that controls the mix between the constrained and unconstrained rotation.
For two bone IK: if the parent bone has local nonuniform scale, the child bone's local Y translation is set to 0.
</description>
</method>
<method name="get_order">
<return type="int" />
<description>
</description>
</method>
<method name="get_softness">
<return type="float" />
<description>
For two bone IK, the target bone's distance from the maximum reach of the bones where rotation begins to slow. The bones will not straighten completely until the target is this far out of range.
</description>
</method>
<method name="get_stretch">
<return type="bool" />
<description>
When true and the target is out of range, the parent bone is scaled to reach it. For two bone IK: 1) the child bone's local Y translation is set to 0, 2) stretch is not applied if softness is &gt; 0, and 3) if the parent bone has local nonuniform scale, stretch is not applied.
Returns the bones that will be modified by this IK constraint. Modifying the array has no effect.
</description>
</method>
<method name="get_target">
<return type="SpineBone" />
<description>
The bone that is the IK target.
Returns the bone that is the target for the IK constraint. The bones will be rotated so the tip of the last bone is as close to the target as possible.
</description>
</method>
<method name="set_target">
<return type="void" />
<param index="0" name="v" type="SpineBone" />
<description>
Sets the bone that is the target for the IK constraint. The bones will be rotated so the tip of the last bone is as close to the target as possible.
</description>
</method>
<method name="get_pose">
<return type="SpineIkConstraintPose" />
<description>
Returns the current pose for this IK constraint, containing mix, softness, bend direction, compress, and stretch values.
</description>
</method>
<method name="get_applied_pose">
<return type="SpineIkConstraintPose" />
<description>
Returns the applied pose for this IK constraint.
</description>
</method>
<method name="is_active">
<return type="bool" />
<description>
Returns whether this IK constraint is active. When inactive, the constraint is not applied.
</description>
</method>
<method name="set_active">
<return type="void" />
<argument index="0" name="v" type="bool" />
<description>
</description>
</method>
<method name="set_bend_direction">
<return type="void" />
<argument index="0" name="v" type="int" />
<description>
</description>
</method>
<method name="set_compress">
<return type="void" />
<argument index="0" name="v" type="bool" />
<description>
</description>
</method>
<method name="set_mix">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_softness">
<return type="void" />
<argument index="0" name="v" type="float" />
<description>
</description>
</method>
<method name="set_stretch">
<return type="void" />
<argument index="0" name="v" type="bool" />
<description>
</description>
</method>
<method name="set_target">
<return type="void" />
<argument index="0" name="v" type="SpineBone" />
<description>
</description>
</method>
<method name="update">
<return type="void" />
<param index="0" name="v" type="bool" />
<description>
Sets whether this IK constraint is active. When inactive, the constraint is not applied.
</description>
</method>
</methods>
<constants>
</constants>
</class>
</class>

84
spine-godot/spine_godot/docs/SpineIkConstraintPose.xml Normal file
View File

@ -0,0 +1,84 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineIkConstraintPose" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores the current pose for an IK constraint.
</brief_description>
<description>
Stores the current pose values for an IK (Inverse Kinematics) constraint. IK constraints can be used to make bones follow a target, with various parameters controlling how the constraint behaves.
</description>
<methods>
<method name="get_mix">
<return type="float" />
<description>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained rotation.
For two bone IK: if the parent bone has local nonuniform scale, the child bone's local Y translation is set to 0.
</description>
</method>
<method name="set_mix">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets a percentage (0-1) that controls the mix between the constrained and unconstrained rotation.
For two bone IK: if the parent bone has local nonuniform scale, the child bone's local Y translation is set to 0.
</description>
</method>
<method name="get_softness">
<return type="float" />
<description>
For two bone IK, returns the target bone's distance from the maximum reach of the bones where rotation begins to slow. The bones will not straighten completely until the target is this far out of range.
</description>
</method>
<method name="set_softness">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
For two bone IK, sets the target bone's distance from the maximum reach of the bones where rotation begins to slow. The bones will not straighten completely until the target is this far out of range.
</description>
</method>
<method name="get_bend_direction">
<return type="int" />
<description>
For two bone IK, returns the bend direction of the IK bones, either 1 or -1.
</description>
</method>
<method name="set_bend_direction">
<return type="void" />
<param index="0" name="value" type="int" />
<description>
For two bone IK, sets the bend direction of the IK bones, either 1 or -1.
</description>
</method>
<method name="get_compress">
<return type="bool" />
<description>
For one bone IK, returns whether the bone is scaled to reach the target when the target is too close.
</description>
</method>
<method name="set_compress">
<return type="void" />
<param index="0" name="value" type="bool" />
<description>
For one bone IK, sets whether the bone is scaled to reach the target when the target is too close.
</description>
</method>
<method name="get_stretch">
<return type="bool" />
<description>
Returns whether the parent bone is scaled to reach the target when the target is out of range.
For two bone IK: 1) the child bone's local Y translation is set to 0, 2) stretch is not applied if softness is > 0, and 3) if the parent bone has local nonuniform scale, stretch is not applied.
</description>
</method>
<method name="set_stretch">
<return type="void" />
<param index="0" name="value" type="bool" />
<description>
Sets whether the parent bone is scaled to reach the target when the target is out of range.
For two bone IK: 1) the child bone's local Y translation is set to 0, 2) stretch is not applied if softness is > 0, and 3) if the parent bone has local nonuniform scale, stretch is not applied.
</description>
</method>
</methods>
</class>

76
spine-godot/spine_godot/docs/SpinePathConstraintPose.xml Normal file
View File

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpinePathConstraintPose" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores a pose for a path constraint.
</brief_description>
<description>
Stores the current pose values for a path constraint. Path constraints position and rotate bones along a path defined by a slot's attachment.
</description>
<methods>
<method name="get_position">
<return type="float" />
<description>
Returns the position along the path.
</description>
</method>
<method name="set_position">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the position along the path.
</description>
</method>
<method name="get_spacing">
<return type="float" />
<description>
Returns the spacing between bones.
</description>
</method>
<method name="set_spacing">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the spacing between bones.
</description>
</method>
<method name="get_mix_rotate">
<return type="float" />
<description>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained rotation.
</description>
</method>
<method name="set_mix_rotate">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets 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>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained translation X.
</description>
</method>
<method name="set_mix_x">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets 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>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained translation Y.
</description>
</method>
<method name="set_mix_y">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets a percentage (0-1) that controls the mix between the constrained and unconstrained translation Y.
</description>
</method>
</methods>
</class>

76
spine-godot/spine_godot/docs/SpinePhysicsConstraint.xml Normal file
View File

@ -0,0 +1,76 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpinePhysicsConstraint" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores the current pose for a physics constraint that applies physics to bones.
</brief_description>
<description>
A physics constraint applies physics simulation to bones, allowing them to move and react based on physical forces like gravity, inertia, and momentum.
See [url=https://esotericsoftware.com/spine-physics-constraints]Physics constraints[/url] in the Spine User Guide.
</description>
<methods>
<method name="update">
<return type="void" />
<param index="0" name="skeleton" type="SpineSkeleton" />
<param index="1" name="physics" type="int" enum="SpineConstant.Physics" />
<description>
Updates the physics constraint. The physics parameter determines how physics are applied. See [enum SpineConstant.Physics].
</description>
</method>
<method name="get_data">
<return type="SpinePhysicsConstraintData" />
<description>
Returns the data for this physics constraint.
</description>
</method>
<method name="get_bone">
<return type="SpineBonePose" />
<description>
Returns the bone constrained by this physics constraint.
</description>
</method>
<method name="set_bone">
<return type="void" />
<param index="0" name="v" type="SpineBonePose" />
<description>
Sets the bone constrained by this physics constraint.
</description>
</method>
<method name="get_pose">
<return type="SpinePhysicsConstraintPose" />
<description>
Returns the current pose for this physics constraint.
</description>
</method>
<method name="get_applied_pose">
<return type="SpinePhysicsConstraintPose" />
<description>
Returns the applied pose for this physics constraint.
</description>
</method>
<method name="reset">
<return type="void" />
<param index="0" name="skeleton" type="SpineSkeleton" />
<description>
Resets the physics constraint.
</description>
</method>
<method name="translate">
<return type="void" />
<param index="0" name="x" type="float" />
<param index="1" name="y" type="float" />
<description>
Translates the physics constraint so next update forces are applied as if the bone moved an additional amount in world space.
</description>
</method>
<method name="rotate">
<return type="void" />
<param index="0" name="x" type="float" />
<param index="1" name="y" type="float" />
<param index="2" name="degrees" type="float" />
<description>
Rotates the physics constraint so next update forces are applied as if the bone rotated around the specified point in world space.
</description>
</method>
</methods>
</class>

109
spine-godot/spine_godot/docs/SpinePhysicsConstraintData.xml Normal file
View File

@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpinePhysicsConstraintData" inherits="SpineConstraintData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores the setup pose for a PhysicsConstraint.
</brief_description>
<description>
Stores the setup pose data for a physics constraint, which determines how physics simulation is configured for a bone.
See [url=https://esotericsoftware.com/spine-physics-constraints]Physics constraints[/url] in the Spine User Guide.
</description>
<methods>
<method name="get_bone">
<return type="SpineBoneData" />
<description>
Returns the bone constrained by this physics constraint.
</description>
</method>
<method name="get_x">
<return type="float" />
<description>
Returns the X offset for the physics constraint.
</description>
</method>
<method name="get_y">
<return type="float" />
<description>
Returns the Y offset for the physics constraint.
</description>
</method>
<method name="get_rotate">
<return type="float" />
<description>
Returns the rotation offset for the physics constraint.
</description>
</method>
<method name="get_scale_x">
<return type="float" />
<description>
Returns the X scale for the physics constraint.
</description>
</method>
<method name="get_shear_x">
<return type="float" />
<description>
Returns the X shear for the physics constraint.
</description>
</method>
<method name="get_limit">
<return type="float" />
<description>
Returns the limit for the physics constraint.
</description>
</method>
<method name="get_step">
<return type="float" />
<description>
Returns the step value for the physics simulation.
</description>
</method>
<method name="is_inertia_global">
<return type="bool" />
<description>
Returns whether inertia is applied globally.
</description>
</method>
<method name="is_strength_global">
<return type="bool" />
<description>
Returns whether strength is applied globally.
</description>
</method>
<method name="is_damping_global">
<return type="bool" />
<description>
Returns whether damping is applied globally.
</description>
</method>
<method name="is_mass_global">
<return type="bool" />
<description>
Returns whether mass is applied globally.
</description>
</method>
<method name="is_wind_global">
<return type="bool" />
<description>
Returns whether wind is applied globally.
</description>
</method>
<method name="is_gravity_global">
<return type="bool" />
<description>
Returns whether gravity is applied globally.
</description>
</method>
<method name="is_mix_global">
<return type="bool" />
<description>
Returns whether mix is applied globally.
</description>
</method>
<method name="get_setup_pose">
<return type="SpinePhysicsConstraintPose" />
<description>
Returns the setup pose for this physics constraint data.
</description>
</method>
</methods>
</class>

102
spine-godot/spine_godot/docs/SpinePhysicsConstraintPose.xml Normal file
View File

@ -0,0 +1,102 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpinePhysicsConstraintPose" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores a pose for a physics constraint.
</brief_description>
<description>
Stores the current pose values for a physics constraint, including physics properties like inertia, strength, damping, mass, wind, and gravity.
</description>
<methods>
<method name="get_inertia">
<return type="float" />
<description>
Returns the inertia value for the physics constraint.
</description>
</method>
<method name="set_inertia">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the inertia value for the physics constraint.
</description>
</method>
<method name="get_strength">
<return type="float" />
<description>
Returns the strength value for the physics constraint.
</description>
</method>
<method name="set_strength">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the strength value for the physics constraint.
</description>
</method>
<method name="get_damping">
<return type="float" />
<description>
Returns the damping value for the physics constraint.
</description>
</method>
<method name="set_damping">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the damping value for the physics constraint.
</description>
</method>
<method name="get_mass_inverse">
<return type="float" />
<description>
Returns the inverse mass value for the physics constraint.
</description>
</method>
<method name="set_mass_inverse">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the inverse mass value for the physics constraint.
</description>
</method>
<method name="get_wind">
<return type="float" />
<description>
Returns the wind value for the physics constraint.
</description>
</method>
<method name="set_wind">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the wind value for the physics constraint.
</description>
</method>
<method name="get_gravity">
<return type="float" />
<description>
Returns the gravity value for the physics constraint.
</description>
</method>
<method name="set_gravity">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the gravity value for the physics constraint.
</description>
</method>
<method name="get_mix">
<return type="float" />
<description>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained poses.
</description>
</method>
<method name="set_mix">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets a percentage (0-1) that controls the mix between the constrained and unconstrained poses.
</description>
</method>
</methods>
</class>

63
spine-godot/spine_godot/docs/SpineSlider.xml Normal file
View File

@ -0,0 +1,63 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineSlider" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
A slider constraint for animating properties.
</brief_description>
<description>
A slider constraint that can be used to animate various properties of bones. Sliders provide a way to control and animate bone transformations through constraint values.
</description>
<methods>
<method name="update">
<return type="void" />
<param index="0" name="skeleton" type="SpineSkeleton" />
<param index="1" name="physics" type="int" enum="SpineConstant.Physics" />
<description>
Updates the slider constraint. The physics parameter determines how physics are applied. See [enum SpineConstant.Physics].
</description>
</method>
<method name="get_data">
<return type="SpineSliderData" />
<description>
Returns the data for this slider constraint.
</description>
</method>
<method name="get_bone">
<return type="SpineBonePose" />
<description>
Returns the bone affected by this slider.
</description>
</method>
<method name="set_bone">
<return type="void" />
<param index="0" name="v" type="SpineBonePose" />
<description>
Sets the bone affected by this slider.
</description>
</method>
<method name="get_pose">
<return type="SpineSliderPose" />
<description>
Returns the current pose for this slider.
</description>
</method>
<method name="get_applied_pose">
<return type="SpineSliderPose" />
<description>
Returns the applied pose for this slider.
</description>
</method>
<method name="is_active">
<return type="bool" />
<description>
Returns whether this slider is active.
</description>
</method>
<method name="set_active">
<return type="void" />
<param index="0" name="v" type="bool" />
<description>
Sets whether this slider is active.
</description>
</method>
</methods>
</class>

88
spine-godot/spine_godot/docs/SpineSliderData.xml Normal file
View File

@ -0,0 +1,88 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineSliderData" inherits="SpineConstraintData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores the setup pose for a Slider.
</brief_description>
<description>
Stores the setup pose data for a slider constraint, including the animation it references, whether it's additive, looping settings, and scale/offset values.
</description>
<methods>
<method name="get_animation">
<return type="SpineAnimation" />
<description>
Returns the animation referenced by this slider.
</description>
</method>
<method name="get_additive">
<return type="bool" />
<description>
Returns whether this slider uses additive blending.
</description>
</method>
<method name="set_additive">
<return type="void" />
<param index="0" name="value" type="bool" />
<description>
Sets whether this slider uses additive blending.
</description>
</method>
<method name="get_loop">
<return type="bool" />
<description>
Returns whether this slider loops.
</description>
</method>
<method name="set_loop">
<return type="void" />
<param index="0" name="value" type="bool" />
<description>
Sets whether this slider loops.
</description>
</method>
<method name="get_bone">
<return type="SpineBoneData" />
<description>
Returns the bone data for this slider.
</description>
</method>
<method name="set_bone">
<return type="void" />
<param index="0" name="value" type="SpineBoneData" />
<description>
Sets the bone data for this slider.
</description>
</method>
<method name="get_scale">
<return type="float" />
<description>
Returns the scale value for this slider.
</description>
</method>
<method name="set_scale">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the scale value for this slider.
</description>
</method>
<method name="get_offset">
<return type="float" />
<description>
Returns the offset value for this slider.
</description>
</method>
<method name="set_offset">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the offset value for this slider.
</description>
</method>
<method name="get_setup_pose">
<return type="SpineSliderPose" />
<description>
Returns the setup pose for this slider data.
</description>
</method>
</methods>
</class>

37
spine-godot/spine_godot/docs/SpineSliderPose.xml Normal file
View File

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineSliderPose" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores a pose for a slider.
</brief_description>
<description>
Stores the current pose values for a slider constraint, including the time position and mix value.
</description>
<methods>
<method name="get_time">
<return type="float" />
<description>
Returns the time position for this slider.
</description>
</method>
<method name="set_time">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the time position for this slider.
</description>
</method>
<method name="get_mix">
<return type="float" />
<description>
Returns the mix value for this slider.
</description>
</method>
<method name="set_mix">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets the mix value for this slider.
</description>
</method>
</methods>
</class>

133
spine-godot/spine_godot/docs/SpineSlot.xml
View File

@ -1,102 +1,121 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineSlot" inherits="SpineObjectWrapper" version="3.4">
<class name="SpineSlot" inherits="SpineObjectWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores a slot's current pose.
</brief_description>
<description>
Stores a slot's current pose. Slots organize attachments for {@link Skeleton#drawOrder} purposes and provide a place to store state for an attachment. State cannot be stored in an attachment itself because attachments are stateless and may be shared across multiple skeletons.
Stores a slot's current pose. Slots organize attachments for skeleton draw order purposes and provide a place to store state for an attachment. State cannot be stored in an attachment itself because attachments are stateless and may be shared across multiple skeletons.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_attachment">
<return type="SpineAttachment" />
<description>
The current attachment for the slot, or null if the slot has no attachment.
</description>
</method>
<method name="get_attachment_state">
<return type="int" />
<method name="get_data">
<return type="SpineSlotData" />
<description>
Returns the slot's setup pose data.
</description>
</method>
<method name="get_bone">
<return type="SpineBone" />
<description>
The bone this slot belongs to.
Returns the bone this slot belongs to.
</description>
</method>
<method name="get_pose">
<return type="SpineSlotPose" />
<description>
Returns the current pose for this slot, containing color, attachment, and deform data.
</description>
</method>
<method name="get_color">
<return type="Color" />
<description>
The color used to tint the slot's attachment. If {@link #getDarkColor()} is set, this is used as the light color for two color tinting. Modifying the color has no effect.
Returns the color used to tint the slot's attachment. If dark color is set, this is used as the light color for two color tinting.
</description>
</method>
<method name="set_color">
<return type="void" />
<param index="0" name="v" type="Color" />
<description>
Sets the color used to tint the slot's attachment. If dark color is set, this is used as the light color for two color tinting.
</description>
</method>
<method name="get_dark_color">
<return type="Color" />
<description>
The dark color used to tint the slot's attachment for two color tinting, or null if two color tinting is not used. The dark color's alpha is not used. Modifying the color has no effect.
Returns the dark color used to tint the slot's attachment for two color tinting, or null if two color tinting is not used. The dark color's alpha is not used.
</description>
</method>
<method name="get_data">
<return type="SpineSlotData" />
<method name="set_dark_color">
<return type="void" />
<param index="0" name="v" type="Color" />
<description>
The slot's setup pose data.
</description>
</method>
<method name="get_deform">
<return type="Array" />
<description>
Values to deform the slot's attachment. For an unweighted mesh, the entries are local positions for each vertex. For a weighted mesh, the entries are an offset for each vertex which will be added to the mesh's local vertex positions. Modifying the deform has no effect.
</description>
</method>
<method name="get_sequence_index">
<return type="int" />
<description>
The index of the texture region to display when the slot's attachment has a sequence. -1 represents the sequence's setup index.
Sets the dark color used to tint the slot's attachment for two color tinting. The dark color's alpha is not used.
</description>
</method>
<method name="has_dark_color">
<return type="bool" />
<description>
Whether the slot has a dark color.
Returns whether the slot has a dark color for two color tinting.
</description>
</method>
<method name="set_has_dark_color">
<return type="void" />
<param index="0" name="v" type="bool" />
<description>
Sets whether the slot has a dark color for two color tinting.
</description>
</method>
<method name="get_attachment">
<return type="SpineAttachment" />
<description>
Returns the current attachment for the slot, or null if the slot has no attachment.
</description>
</method>
<method name="set_attachment">
<return type="void" />
<argument index="0" name="v" type="SpineAttachment" />
<param index="0" name="v" type="SpineAttachment" />
<description>
Sets the slot's attachment and, if the attachment changed, resets the sequence index and clears the deform. The deform is not cleared if the old attachment has the same timeline as the specified attachment
Sets the slot's attachment and, if the attachment changed, resets sequence_index and clears the deform. The deform is not cleared if the old attachment has the same timeline attachment as the specified attachment.
</description>
</method>
<method name="set_attachment_state">
<return type="void" />
<argument index="0" name="v" type="int" />
<description>
</description>
</method>
<method name="set_color">
<return type="void" />
<argument index="0" name="arg0" type="Color" />
<description>
</description>
</method>
<method name="set_dark_color">
<return type="void" />
<argument index="0" name="v" type="Color" />
<description>
</description>
</method>
<method name="set_deform">
<return type="void" />
<argument index="0" name="v" type="Array" />
<method name="get_sequence_index">
<return type="int" />
<description>
Returns the index of the texture region to display when the slot's attachment has a Sequence. -1 represents the setup index.
</description>
</method>
<method name="set_sequence_index">
<return type="void" />
<argument index="0" name="v" type="int" />
<param index="0" name="v" type="int" />
<description>
Sets the index of the texture region to display when the slot's attachment has a Sequence. -1 represents the setup index.
</description>
</method>
<method name="get_attachment_state">
<return type="int" />
<description>
Returns the attachment state for this slot.
</description>
</method>
<method name="set_attachment_state">
<return type="void" />
<param index="0" name="v" type="int" />
<description>
Sets the attachment state for this slot.
</description>
</method>
<method name="get_deform">
<return type="PackedFloat32Array" />
<description>
Returns values to deform the slot's attachment. For an unweighted mesh, the entries are local positions for each vertex. For a weighted mesh, the entries are an offset for each vertex which will be added to the mesh's local vertex positions.
See VertexAttachment.computeWorldVertices and DeformTimeline.
</description>
</method>
<method name="set_deform">
<return type="void" />
<param index="0" name="v" type="PackedFloat32Array" />
<description>
Sets values to deform the slot's attachment. For an unweighted mesh, the entries are local positions for each vertex. For a weighted mesh, the entries are an offset for each vertex which will be added to the mesh's local vertex positions.
</description>
</method>
<method name="set_to_setup_pose">
@ -106,6 +125,4 @@
</description>
</method>
</methods>
<constants>
</constants>
</class>
</class>

2
spine-godot/spine_godot/docs/SpineSlotData.xml
View File

@ -42,7 +42,7 @@
<method name="get_index">
<return type="int" />
<description>
The index of the slot in [code]Skeleton.get_slots()[/code].
Returns the index of the slot in Skeleton.slots.
</description>
</method>
<method name="get_name">

89
spine-godot/spine_godot/docs/SpineSlotPose.xml Normal file
View File

@ -0,0 +1,89 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineSlotPose" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores a pose for a slot.
</brief_description>
<description>
Stores the current pose for a slot, including color tinting, attachment, and deformation values.
</description>
<methods>
<method name="get_color">
<return type="Color" />
<description>
Returns the color used to tint the slot's attachment. If dark color is set, this is used as the light color for two color tinting.
</description>
</method>
<method name="set_color">
<return type="void" />
<param index="0" name="v" type="Color" />
<description>
Sets the color used to tint the slot's attachment. If dark color is set, this is used as the light color for two color tinting.
</description>
</method>
<method name="get_dark_color">
<return type="Color" />
<description>
Returns the dark color used to tint the slot's attachment for two color tinting. The dark color's alpha is not used.
</description>
</method>
<method name="set_dark_color">
<return type="void" />
<param index="0" name="v" type="Color" />
<description>
Sets the dark color used to tint the slot's attachment for two color tinting. The dark color's alpha is not used.
</description>
</method>
<method name="has_dark_color">
<return type="bool" />
<description>
Returns true if this slot has a dark color.
</description>
</method>
<method name="set_has_dark_color">
<return type="void" />
<param index="0" name="v" type="bool" />
<description>
Sets whether this slot has a dark color.
</description>
</method>
<method name="get_attachment">
<return type="SpineAttachment" />
<description>
Returns the current attachment for the slot, or null if the slot has no attachment.
</description>
</method>
<method name="set_attachment">
<return type="void" />
<param index="0" name="v" type="SpineAttachment" />
<description>
Sets the slot's attachment and, if the attachment changed, resets sequence_index and clears the deform. The deform is not cleared if the old attachment has the same timeline attachment as the specified attachment.
</description>
</method>
<method name="get_sequence_index">
<return type="int" />
<description>
Returns the index of the texture region to display when the slot's attachment has a Sequence. -1 represents the setup index.
</description>
</method>
<method name="set_sequence_index">
<return type="void" />
<param index="0" name="v" type="int" />
<description>
Sets the index of the texture region to display when the slot's attachment has a Sequence. -1 represents the setup index.
</description>
</method>
<method name="get_deform">
<return type="PackedFloat32Array" />
<description>
Returns values to deform the slot's attachment. For an unweighted mesh, the entries are local positions for each vertex. For a weighted mesh, the entries are an offset for each vertex which will be added to the mesh's local vertex positions.
</description>
</method>
<method name="set_deform">
<return type="void" />
<param index="0" name="v" type="PackedFloat32Array" />
<description>
Sets values to deform the slot's attachment. For an unweighted mesh, the entries are local positions for each vertex. For a weighted mesh, the entries are an offset for each vertex which will be added to the mesh's local vertex positions.
</description>
</method>
</methods>
</class>

89
spine-godot/spine_godot/docs/SpineTransformConstraintPose.xml Normal file
View File

@ -0,0 +1,89 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineTransformConstraintPose" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores a pose for a transform constraint.
</brief_description>
<description>
Stores the current pose values for a transform constraint. Transform constraints adjust bone transforms to match a target bone's transform, with various mix values controlling how much each transform component is affected.
</description>
<methods>
<method name="get_mix_rotate">
<return type="float" />
<description>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained rotation.
</description>
</method>
<method name="set_mix_rotate">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets 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>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained translation X.
</description>
</method>
<method name="set_mix_x">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets 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>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained translation Y.
</description>
</method>
<method name="set_mix_y">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets a percentage (0-1) that controls the mix between the constrained and unconstrained translation Y.
</description>
</method>
<method name="get_mix_scale_x">
<return type="float" />
<description>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained scale X.
</description>
</method>
<method name="set_mix_scale_x">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets a percentage (0-1) that controls the mix between the constrained and unconstrained scale X.
</description>
</method>
<method name="get_mix_scale_y">
<return type="float" />
<description>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained scale Y.
</description>
</method>
<method name="set_mix_scale_y">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets a percentage (0-1) that controls the mix between the constrained and unconstrained scale Y.
</description>
</method>
<method name="get_mix_shear_y">
<return type="float" />
<description>
Returns a percentage (0-1) that controls the mix between the constrained and unconstrained shear Y.
</description>
</method>
<method name="set_mix_shear_y">
<return type="void" />
<param index="0" name="value" type="float" />
<description>
Sets a percentage (0-1) that controls the mix between the constrained and unconstrained shear Y.
</description>
</method>
</methods>
</class>

215
spine-godot/spine_godot/docs/docs.md Normal file
View File

@ -0,0 +1,215 @@
# Spine Godot Documentation Update Guide
## Overview
This document serves as a reusable prompt for updating the Spine Godot documentation. The documentation consists of XML files in `spine_godot/docs/` that document the user-facing API classes exposed to GDScript.
## Key Rule
**Any `SpineXXX.h` class that contains a `_bind_methods()` declaration must be documented**, as this indicates the class is exposed to GDScript users.
## Instructions for Documentation Update
**IMPORTANT: DO NOT USE TASK AGENTS FOR THIS WORK!** You must work on documentation sequentially, one class at a time, checking off completed items as you go.
### Step 1: Analyze Current State
Before updating documentation, you must:
1. Run: `grep -l "_bind_methods" spine_godot/Spine*.h | sort` to find all classes that need documentation
2. List all existing `.xml` files in `spine_godot/docs/`
3. Compare the two lists to identify missing documentation
4. Update the checklist below based on current state
### Step 2: Documentation Sources
For each class that needs documentation:
1. **Primary source**: The Godot wrapper header in `spine_godot/SpineXXX.h` - check the `_bind_methods()` implementation in the corresponding `.cpp` file to see what's exposed
2. **CRITICAL source for documentation text**: The corresponding spine-cpp header in `spine_godot/spine-cpp/include/spine/*.h` - **COPY AND ADAPT THE DOCUMENTATION FROM HERE**
3. **Implementation details**: The corresponding `.cpp` file if needed for understanding behavior
### Step 3: Update Process (WORK SEQUENTIALLY)
For each class in the checklist, working one at a time:
1. Read the wrapper's `_bind_methods()` to identify all exposed methods, properties, signals, and constants
2. **READ THE SPINE-CPP HEADER FILE AND COPY THE DOCUMENTATION COMMENTS** - Look for:
- Class-level documentation (usually after `class ClassName`)
- Method documentation (usually comments above or near methods)
- Member variable documentation (inline comments or above declarations)
3. **ADAPT the spine-cpp documentation to GDScript**:
- Convert C++ terminology to GDScript terminology
- Adjust examples to use GDScript syntax
- Keep the technical accuracy and detail from the original documentation
4. For Godot-specific additions (signals, properties not in spine-cpp), document based on implementation
5. Create or update the XML documentation following Godot's documentation format
6. Ensure all bound methods, properties, signals, and enum constants are documented
7. **Check off the item in the checklist after completing its documentation**
### CRITICAL RULE FOR DOCUMENTATION
**DO NOT WRITE GENERIC OR VAGUE DOCUMENTATION!** You must:
- Copy the actual documentation from spine-cpp headers
- Preserve technical details about what each method/property does
- Explain the purpose and behavior as documented in spine-cpp
- Only write your own documentation for Godot-specific features not in spine-cpp
## Documentation Checklist
**Instructions**: Update this checklist every time before processing documentation updates. Check the box [x] when documentation is complete and up-to-date.
### Classes with Existing Documentation
Based on files in `spine_godot/docs/`:
- [ ] **SpineAnimation** - `spine_godot/SpineAnimation.h` → `spine-cpp/include/spine/Animation.h`
- [ ] **SpineAnimationState** - `spine_godot/SpineAnimationState.h` → `spine-cpp/include/spine/AnimationState.h`
- [ ] **SpineAnimationTrack** - `spine_godot/SpineAnimationTrack.h` → (Godot wrapper specific)
- [ ] **SpineAtlasResource** - `spine_godot/SpineAtlasResource.h` → `spine-cpp/include/spine/Atlas.h`
- [ ] **SpineAttachment** - `spine_godot/SpineAttachment.h` → `spine-cpp/include/spine/Attachment.h`
- [ ] **SpineBone** - `spine_godot/SpineBone.h` → `spine-cpp/include/spine/Bone.h`
- [ ] **SpineBoneData** - `spine_godot/SpineBoneData.h` → `spine-cpp/include/spine/BoneData.h`
- [ ] **SpineBoneNode** - `spine_godot/SpineBoneNode.h` → (Godot node wrapper)
- [ ] **SpineConstraintData** - `spine_godot/SpineConstraintData.h` → `spine-cpp/include/spine/ConstraintData.h`
- [ ] **SpineEvent** - `spine_godot/SpineEvent.h` → `spine-cpp/include/spine/Event.h`
- [ ] **SpineIkConstraint** - `spine_godot/SpineIkConstraint.h` → `spine-cpp/include/spine/IkConstraint.h`
- [ ] **SpineIkConstraintData** - `spine_godot/SpineIkConstraintData.h` → `spine-cpp/include/spine/IkConstraintData.h`
- [ ] **SpinePathConstraint** - `spine_godot/SpinePathConstraint.h` → `spine-cpp/include/spine/PathConstraint.h`
- [ ] **SpinePathConstraintData** - `spine_godot/SpinePathConstraintData.h` → `spine-cpp/include/spine/PathConstraintData.h`
- [ ] **SpineSkeleton** - `spine_godot/SpineSkeleton.h` → `spine-cpp/include/spine/Skeleton.h`
- [ ] **SpineSkeletonDataResource** - `spine_godot/SpineSkeletonDataResource.h` → `spine-cpp/include/spine/SkeletonData.h`
- [ ] **SpineSkeletonFileResource** - `spine_godot/SpineSkeletonFileResource.h` → (Godot resource loader)
- [ ] **SpineSkin** - `spine_godot/SpineSkin.h` → `spine-cpp/include/spine/Skin.h`
- [ ] **SpineSlot** - `spine_godot/SpineSlot.h` → `spine-cpp/include/spine/Slot.h`
- [ ] **SpineSlotData** - `spine_godot/SpineSlotData.h` → `spine-cpp/include/spine/SlotData.h`
- [ ] **SpineSlotNode** - `spine_godot/SpineSlotNode.h` → (Godot node wrapper)
- [ ] **SpineSprite** - `spine_godot/SpineSprite.h` → (Main Godot node for Spine animations)
- [ ] **SpineTimeline** - `spine_godot/SpineTimeline.h` → `spine-cpp/include/spine/Timeline.h`
- [ ] **SpineTrackEntry** - `spine_godot/SpineTrackEntry.h` → (Part of AnimationState)
- [ ] **SpineTransformConstraint** - `spine_godot/SpineTransformConstraint.h` → `spine-cpp/include/spine/TransformConstraint.h`
- [ ] **SpineTransformConstraintData** - `spine_godot/SpineTransformConstraintData.h` → `spine-cpp/include/spine/TransformConstraintData.h`
### Classes Missing Documentation (Have _bind_methods but no .xml file)
These classes have `_bind_methods()` in their headers but lack documentation:
#### Data Classes
- [ ] **SpineEventData** - `spine_godot/SpineEventData.h` → `spine-cpp/include/spine/EventData.h`
- Setup pose data for events
#### Physics Classes (New in 4.x)
- [ ] **SpinePhysicsConstraint** - `spine_godot/SpinePhysicsConstraint.h` → `spine-cpp/include/spine/PhysicsConstraint.h`
- Runtime physics constraint
- [ ] **SpinePhysicsConstraintData** - `spine_godot/SpinePhysicsConstraintData.h` → `spine-cpp/include/spine/PhysicsConstraintData.h`
- Setup data for physics constraints
- [ ] **SpinePhysicsConstraintPose** - `spine_godot/SpinePhysicsConstraintPose.h` → `spine-cpp/include/spine/PhysicsConstraintPose.h`
- Physics constraint pose state
#### Slider Classes (New in 4.x)
- [ ] **SpineSlider** - `spine_godot/SpineSlider.h` → `spine-cpp/include/spine/Slider.h`
- Runtime slider for property animation
- [ ] **SpineSliderData** - `spine_godot/SpineSliderData.h` → `spine-cpp/include/spine/SliderData.h`
- Setup data for sliders
- [ ] **SpineSliderPose** - `spine_godot/SpineSliderPose.h` → `spine-cpp/include/spine/SliderPose.h`
- Slider pose state
#### Pose Classes
- [x] **SpineBoneLocal** - `spine_godot/SpineBoneLocal.h` → `spine-cpp/include/spine/BoneLocal.h`
- Local bone transform data
- [x] **SpineBonePose** - `spine_godot/SpineBonePose.h` → `spine-cpp/include/spine/BonePose.h`
- Bone pose state
- [ ] **SpineIkConstraintPose** - `spine_godot/SpineIkConstraintPose.h` → `spine-cpp/include/spine/IkConstraintPose.h`
- IK constraint pose state
- [ ] **SpinePathConstraintPose** - `spine_godot/SpinePathConstraintPose.h` → `spine-cpp/include/spine/PathConstraintPose.h`
- Path constraint pose state
- [ ] **SpineSlotPose** - `spine_godot/SpineSlotPose.h` → `spine-cpp/include/spine/SlotPose.h`
- Slot pose state
- [ ] **SpineTransformConstraintPose** - `spine_godot/SpineTransformConstraintPose.h` → `spine-cpp/include/spine/TransformConstraintPose.h`
- Transform constraint pose state
#### Constants/Enums Class
- [ ] **SpineConstant** - `spine_godot/SpineConstant.h` → (Godot-specific constants)
- Exposes Spine enums and constants to GDScript (MixBlend, MixDirection, Property, etc.)
### Classes to Skip (Internal/Editor Only)
These have `_bind_methods()` but should NOT have user-facing documentation:
- **SpineCommon** - Internal base classes and utilities
- **SpineEditorPlugin** - Editor-only functionality
## Documentation Template
When creating new documentation files, use this template:
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineClassName" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
One-line description of the class purpose.
</brief_description>
<description>
Detailed description of the class.
Include usage context and relationship to other Spine classes.
For wrapper classes, explain what Spine runtime feature this exposes.
</description>
<methods>
<method name="method_name">
<return type="return_type" />
<param index="0" name="param_name" type="param_type" />
<description>
Method description. Check _bind_methods() for exact signature.
</description>
</method>
</methods>
<members>
<member name="property_name" type="property_type" setter="set_property" getter="get_property">
Property description. Must match ADD_PROPERTY in _bind_methods().
</member>
</members>
<signals>
<signal name="signal_name">
<param index="0" name="param_name" type="param_type" />
<description>
Signal description. Must match ADD_SIGNAL in _bind_methods().
</description>
</signal>
</signals>
<constants>
<constant name="CONSTANT_NAME" value="0" enum="EnumName">
Constant description. Must match BIND_ENUM_CONSTANT in _bind_methods().
</constant>
</constants>
</class>
```
## Validation Steps
After updating documentation:
1. Verify every method in `_bind_methods()` has corresponding documentation
2. Check that all `ADD_PROPERTY` calls have corresponding member documentation
3. Verify all `ADD_SIGNAL` calls have corresponding signal documentation
4. Ensure all `BIND_ENUM_CONSTANT` calls have corresponding constant documentation
5. Test that property setters/getters match the actual implementation
6. Validate that examples (if provided) are valid GDScript code
## Important Notes
### Identifying What to Document
- Run `grep -l "_bind_methods" spine_godot/Spine*.h` to get the definitive list
- The presence of `_bind_methods()` is the key indicator that a class needs documentation
- Even if a class seems internal, if it has `_bind_methods()` it's exposed to users
### Class Categories
1. **Core Runtime Classes**: SpineSkeleton, SpineAnimation, SpineBone, etc.
2. **Data Classes**: Classes ending in "Data" that hold setup/configuration
3. **Pose Classes**: Classes ending in "Pose" that represent runtime state
4. **Constraint Classes**: IK, Path, Transform, Physics constraints
5. **Resource Classes**: Atlas, SkeletonData, SkeletonFile resources
6. **Node Classes**: SpineSprite, SpineBoneNode, SpineSlotNode (Godot scene nodes)
7. **Constants Class**: SpineConstant (enum definitions)
### Version Considerations
- Physics constraints and sliders are new in Spine 4.x
- Some features may not be available in all Spine versions
- Documentation should note version requirements where applicable
## Running the Documentation Update
To use this guide:
1. Run `grep -l "_bind_methods" spine_godot/Spine*.h | sort` to get current list
2. Compare with existing .xml files in `spine_godot/docs/`
3. Update this checklist based on findings
4. For each unchecked item, create or update the XML documentation
5. Focus on the `_bind_methods()` implementation to ensure accuracy
6. Mark items as complete when documentation is finished
7. Commit with message indicating which classes were documented
Remember: The presence of `_bind_methods()` is the definitive indicator that a class needs documentation.