UnityMirror/spine-runtimes
1
0
Fork 0
mirror of https://github.com/EsotericSoftware/spine-runtimes.git synced 2026-02-17 04:21:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

[godot] Fix-up newlines in editor docs.

Browse Source
This commit is contained in:
Mario Zechner 2022-06-21 13:18:18 +02:00
parent dcfc3ef969
commit 9d5508732e
9 changed files with 49 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,8 +26,7 @@
<method name="get_duration">
<return type="float" />
<description>
The duration of the animation in seconds, which is usually the highest time of all frames in the timeline. The duration is
used to know when it has completed and when it should loop back to the start.
The duration of the animation in seconds, which is usually the highest time of all frames in the timeline. The duration is used to know when it has completed and when it should loop back to the start.
</description>
</method>
<method name="get_name">

72
spine-godot/spine_godot/docs/SpineAnimationState.xml
View File

@ -1,12 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineAnimationState" inherits="Reference" version="3.4">
<brief_description>
Applies animations over time, queues animations for later playback, mixes (crossfading) between animations, and applies
multiple animations on top of each other (layering).
Applies animations over time, queues animations for later playback, mixes (crossfading) between animations, and applies multiple animations on top of each other (layering).
</brief_description>
<description>
Applies animations over time, queues animations for later playback, mixes (crossfading) between animations, and applies
multiple animations on top of each other (layering). See [link]http://esotericsoftware.com/spine-applying-animations[/link] in the Spine Runtimes Guide.
Applies animations over time, queues animations for later playback, mixes (crossfading) between animations, and applies multiple animations on top of each other (layering). See [url]http://esotericsoftware.com/spine-applying-animations[/url] in the Spine Runtimes Guide.
</description>
<tutorials>
</tutorials>
@ -18,13 +16,8 @@
<argument index="2" name="loop" type="bool" default="true" />
<argument index="3" name="track_id" type="int" default="0" />
<description>
Adds an animation to be played after the current or last queued animation for a track. If the track is empty, it is
equivalent to calling [code]set_animation[/code].
If [code]delay[/code] &gt; 0, sets [code]TrackEntry.delay[/code]. If [code]delay[/code] &lt;= 0, the delay set is the duration of the previous track entry
minus any mix duration (from the [code]AnimationStateData[/code]) plus the specified [code]delay[/code] (ie the mix
ends at ([code]delay[/code] &gt;= 0) or before ([code]delay[/code] &lt; 0) the previous track entry duration). If the
previous entry is looping, its next loop completion is used instead of its duration.
Adds an animation to be played after the current or last queued animation for a track. If the track is empty, it is equivalent to calling [code]set_animation[/code].
If [code]delay[/code] &gt; 0, sets [code]TrackEntry.delay[/code]. If [code]delay[/code] &lt;= 0, the delay set is the duration of the previous track entry minus any mix duration (from the [code]AnimationStateData[/code]) plus the specified [code]delay[/code] (ie the mix ends at ([code]delay[/code] &gt;= 0) or before ([code]delay[/code] &lt; 0) the previous track entry duration). If the previous entry is looping, its next loop completion is used instead of its duration.
</description>
</method>
<method name="add_empty_animation">
@ -33,14 +26,8 @@
<argument index="1" name="mix_duration" type="float" />
<argument index="2" name="delay" type="float" />
<description>
Adds an empty animation to be played after the current or last queued animation for a track, and sets the track entry's
mix duration. If the track is empty, it is equivalent to calling
[code]set_empty_animation()[/code]. See [code]set_empty_animation()[/code].
If [code]delay[/code]> 0, sets the track entry's delay. If &lt;= 0, the delay set is the duration of the previous track entry
minus any mix duration plus the specified [code]delay[/code] (ie the mix ends at ([code]delay[/code] = 0) or
before ([code]delay[/code] &lt; 0) the previous track entry duration). If the previous entry is looping, its next
loop completion is used instead of its duration.
Adds an empty animation to be played after the current or last queued animation for a track, and sets the track entry's mix duration. If the track is empty, it is equivalent to calling [code]set_empty_animation()[/code]. See [code]set_empty_animation()[/code].
If [code]delay[/code]> 0, sets the track entry's delay. If &lt;= 0, the delay set is the duration of the previous track entry minus any mix duration plus the specified [code]delay[/code] (ie the mix ends at ([code]delay[/code] = 0) or before ([code]delay[/code] &lt; 0) the previous track entry duration). If the previous entry is looping, its next loop completion is used instead of its duration.
Returns a track entry to allow further customization of animation playback. References to the track entry must not be kept
after the dispose event occurs.
</description>
@ -49,9 +36,7 @@
<return type="bool" />
<argument index="0" name="skeleton" type="SpineSkeleton" />
<description>
Poses the skeleton using the track entry animations. The animation state is not changed, so can be applied to multiple
skeletons to pose them identically.
Poses the skeleton using the track entry animations. The animation state is not changed, so can be applied to multiple skeletons to pose them identically.
Returns true if any animations were applied.
</description>
</method>
@ -60,18 +45,14 @@
<argument index="0" name="arg0" type="int" />
<description>
Removes all animations from the track, leaving skeletons in their current pose.
It may be desired to use [code]set_empty_animation()[/code] to mix the skeletons back to the setup pose,
rather than leaving them in their current pose.
It may be desired to use [code]set_empty_animation()[/code] to mix the skeletons back to the setup pose, rather than leaving them in their current pose.
</description>
</method>
<method name="clear_tracks">
<return type="void" />
<description>
Removes all animations from all tracks, leaving skeletons in their current pose.
It may be desired to use [code]set_empty_animations()[/code] to mix the skeletons back to the setup pose,
rather than leaving them in their current pose.
It may be desired to use [code]set_empty_animations()[/code] to mix the skeletons back to the setup pose, rather than leaving them in their current pose.
</description>
</method>
<method name="disable_queue">
@ -102,8 +83,7 @@
<method name="get_time_scale">
<return type="float" />
<description>
Multiplier for the delta time when the animation state is updated, causing time for all animations and mixes to play slower
or faster. Defaults to 1.
Multiplier for the delta time when the animation state is updated, causing time for all animations and mixes to play slower or faster. Defaults to 1.
</description>
</method>
<method name="set_animation">
@ -112,14 +92,9 @@
<argument index="1" name="loop" type="bool" default="true" />
<argument index="2" name="track_id" type="int" default="0" />
<description>
Sets the current animation for a track, discarding any queued animations. If the formerly current track entry was never
applied to a skeleton, it is replaced (not mixed from).
If [loop] is true, the animation will repeat. If false it will not, instead its last frame is applied if played beyond its
duration. In either case [code]TrackEntry.trackEnd[/code] determines when the track is cleared.
Returns track entry to allow further customization of animation playback. References to the track entry must not be kept
after the dispose event occurs.
Sets the current animation for a track, discarding any queued animations. If the formerly current track entry was never applied to a skeleton, it is replaced (not mixed from).
If [loop] is true, the animation will repeat. If false it will not, instead its last frame is applied if played beyond its duration. In either case [code]TrackEntry.trackEnd[/code] determines when the track is cleared.
Returns track entry to allow further customization of animation playback. References to the track entry must not be kept after the dispose event occurs.
</description>
</method>
<method name="set_empty_animation">
@ -127,21 +102,9 @@
<argument index="0" name="track_id" type="int" />
<argument index="1" name="mix_duration" type="float" />
<description>
Sets an empty animation for a track, discarding any queued animations, and sets the track entry's
mix duration. An empty animation has no timelines and serves as a placeholder for mixing in or out.
Mixing out is done by setting an empty animation with a mix duration using either [code]set_empty_animation()[/code],
[code]set_empty_animations()[/code], or [code]add_empty_animation()[/code]. Mixing to an empty animation causes
the previous animation to be applied less and less over the mix duration. Properties keyed in the previous animation
transition to the value from lower tracks or to the setup pose value if no lower tracks key the property. A mix duration of
0 still mixes out over one frame.
Mixing in is done by first setting an empty animation, then adding an animation using
[code]add_animation()[/code]with the desired delay (an empty animation has a duration of 0) and on
the returned track entry, set the mix duration. Mixing from an empty animation causes the new
animation to be applied more and more over the mix duration. Properties keyed in the new animation transition from the value
from lower tracks or from the setup pose value if no lower tracks key the property to the value keyed in the new
animation.
Sets an empty animation for a track, discarding any queued animations, and sets the track entry's mix duration. An empty animation has no timelines and serves as a placeholder for mixing in or out.
Mixing out is done by setting an empty animation with a mix duration using either [code]set_empty_animation()[/code], [code]set_empty_animations()[/code], or [code]add_empty_animation()[/code]. Mixing to an empty animation causes the previous animation to be applied less and less over the mix duration. Properties keyed in the previous animation transition to the value from lower tracks or to the setup pose value if no lower tracks key the property. A mix duration of 0 still mixes out over one frame.
Mixing in is done by first setting an empty animation, then adding an animation using [code]add_animation()[/code]with the desired delay (an empty animation has a duration of 0) and on the returned track entry, set the mix duration. Mixing from an empty animation causes the new animation to be applied more and more over the mix duration. Properties keyed in the new animation transition from the value from lower tracks or from the setup pose value if no lower tracks key the property to the value keyed in the new animation.
</description>
</method>
<method name="set_empty_animations">
@ -155,8 +118,7 @@
<return type="void" />
<argument index="0" name="time_scale" type="float" />
<description>
Sets the multiplier for the delta time when the animation state is updated, causing time for all animations and mixes to play slower
or faster. Defaults to 1.
Sets the multiplier for the delta time when the animation state is updated, causing time for all animations and mixes to play slower or faster. Defaults to 1.
</description>
</method>
<method name="update">

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

@ -4,8 +4,7 @@
Represents an attachment in a Spine skeleton's skin.
</brief_description>
<description>
Represents an attachment in a Spine skeleton's skin. See [link]http://en.esotericsoftware.com/spine-runtime-skins[/link].
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.
</description>
<tutorials>

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

@ -5,13 +5,8 @@
</brief_description>
<description>
A bone of a Spine skeleton, storing its current pose.
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.
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.
</description>
<tutorials>
</tutorials>
@ -205,8 +200,7 @@
<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.
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">
@ -228,9 +222,7 @@
<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.
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">

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

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineBoneData" inherits="SpineObjectWrapper" version="3.4">
<brief_description>
Stores the setup pose for a bone.
</brief_description>
<description>
Stores the setup pose for a bone.
</description>
<tutorials>
</tutorials>
@ -10,21 +12,25 @@
<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].
</description>
</method>
<method name="get_length">
<return type="float" />
<description>
The bone's length.
</description>
</method>
<method name="get_parent">
@ -35,41 +41,49 @@
<method name="get_rotation">
<return type="float" />
<description>
The local rotation in degrees.
</description>
</method>
<method name="get_scale_x">
<return type="float" />
<description>
The local scaleX.
</description>
</method>
<method name="get_scale_y">
<return type="float" />
<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.
</description>
</method>
<method name="is_skin_required">

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

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineBoneNode" inherits="Node2D" version="3.4">
<brief_description>
Node2D that either follows or drives a bone in a [code]SpineSprite[/code].
</brief_description>
<description>
Node2D that either follows or drives a bone in a [code]SpineSprite[/code]. If set to follow a bone, the bone's shear will be ignored.
</description>
<tutorials>
</tutorials>

5
spine-godot/spine_godot/docs/SpineConstraintData.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineConstraintData" inherits="SpineObjectWrapper" version="3.4">
<brief_description>
The base class for all constraint datas.
</brief_description>
<description>
The base class for all constraint datas.
</description>
<tutorials>
</tutorials>
@ -10,16 +12,19 @@
<method name="get_constraint_name">
<return type="String" />
<description>
The constraint's name, which is unique across all constraints in the skeleton of the same type.
</description>
</method>
<method name="get_order">
<return type="int" />
<description>
The ordinal of this constraint for the order a skeleton's constraints will be applied by [code]Skeleton.update_world_transform[/code].
</description>
</method>
<method name="is_skin_required">
<return type="bool" />
<description>
When true, [code]Skeleton.update_world_transform[/code] only updates this constraint if the active skin contains this constraint.
</description>
</method>
<method name="set_order">

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

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineEvent" inherits="SpineObjectWrapper" version="3.4">
<brief_description>
Stores the current pose values for an event. See [url]http://esotericsoftware.com/spine-events[/url] in the Spine User Guide.
</brief_description>
<description>
Stores the current pose values for an event. See [url]http://esotericsoftware.com/spine-events[/url] in the Spine User Guide.
</description>
<tutorials>
</tutorials>

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

@ -1,8 +1,11 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpineIkConstraint" inherits="SpineObjectWrapper" version="3.4">
<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.
</description>
<tutorials>
</tutorials>