浏览代码

[godot] More in-editor docs.

Mario Zechner 3 年之前
父节点
当前提交
2ab6f361cb

+ 9 - 0
spine-godot/spine_godot/docs/SpineIkConstraint.xml

@@ -13,26 +13,32 @@
 		<method name="get_bend_direction">
 			<return type="int" />
 			<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.
 			</description>
 		</method>
 		<method name="get_data">
 			<return type="SpineIkConstraintData" />
 			<description>
+				The IK constraint's setup pose data.
 			</description>
 		</method>
 		<method name="get_mix">
 			<return type="float" />
 			<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">
@@ -43,16 +49,19 @@
 		<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 > 0, and 3) if the parent bone has local nonuniform scale, stretch is not applied.
 			</description>
 		</method>
 		<method name="get_target">
 			<return type="SpineBone" />
 			<description>
+				The bone that is the IK target.
 			</description>
 		</method>
 		<method name="is_active">

+ 13 - 0
spine-godot/spine_godot/docs/SpineIkConstraintData.xml

@@ -1,8 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <class name="SpineIkConstraintData" inherits="SpineConstraintData" version="3.4">
 	<brief_description>
+		Stores the setup pose for an [code]SpineIkConstraint[/code].
 	</brief_description>
 	<description>
+		Stores the setup pose for an [code]SpineIkConstraint[/code].
+		See [url]http://esotericsoftware.com/spine-ik-constraints[/url] in the Spine User Guide.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -10,41 +13,51 @@
 		<method name="get_bend_direction">
 			<return type="int" />
 			<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 are constrained by this IK constraint.
 			</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.
 			</description>
 		</method>
 		<method name="get_mix">
 			<return type="float" />
 			<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_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 > 0, and 3) if the parent bone has local nonuniform scale, stretch is not applied.
 			</description>
 		</method>
 		<method name="get_target">
 			<return type="SpineBoneData" />
 			<description>
+				The bone that is the IK target.
 			</description>
 		</method>
 		<method name="get_uniform">
 			<return type="bool" />
 			<description>
+				When true and compress or stretch is used, the bone is scaled on both the X and Y axes.
 			</description>
 		</method>
 		<method name="set_bend_direction">

+ 11 - 0
spine-godot/spine_godot/docs/SpinePathConstraint.xml

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

+ 11 - 0
spine-godot/spine_godot/docs/SpinePathConstraintData.xml

@@ -10,56 +10,67 @@
 		<method name="get_bones">
 			<return type="Array" />
 			<description>
+				The bones that will be modified by this path constraint. Modifying the array has no effect.
 			</description>
 		</method>
 		<method name="get_mix_rotate">
 			<return type="float" />
 			<description>
+				A percentage (0-1) that controls the mix between the constrained and unconstrained rotation.
 			</description>
 		</method>
 		<method name="get_mix_x">
 			<return type="float" />
 			<description>
+				A percentage (0-1) that controls the mix between the constrained and unconstrained translation X.
 			</description>
 		</method>
 		<method name="get_mix_y">
 			<return type="float" />
 			<description>
+				A percentage (0-1) that controls the mix between the constrained and unconstrained translation Y.
 			</description>
 		</method>
 		<method name="get_offset_rotation">
 			<return type="float" />
 			<description>
+				An offset added to the constrained bone rotation.
 			</description>
 		</method>
 		<method name="get_position">
 			<return type="float" />
 			<description>
+				The position along the path.
 			</description>
 		</method>
 		<method name="get_position_mode">
 			<return type="int" enum="SpineConstant.PositionMode" />
 			<description>
+				The mode for positioning the first bone on the path.
 			</description>
 		</method>
 		<method name="get_rotate_mode">
 			<return type="int" enum="SpineConstant.RotateMode" />
 			<description>
+				The mode for adjusting the rotation of the bones.
 			</description>
 		</method>
 		<method name="get_spacing">
 			<return type="float" />
 			<description>
+				The spacing between bones.
 			</description>
 		</method>
 		<method name="get_spacing_mode">
 			<return type="int" enum="SpineConstant.SpacingMode" />
 			<description>
+				The mode for positioning the bones after the first bone on the path.
 			</description>
 		</method>
 		<method name="get_target">
 			<return type="SpineSlotData" />
 			<description>
+				The slot whose path attachment will be used to constrained the bones.
 			</description>
 		</method>
 		<method name="set_mix_rotate">