Merge pull request #116263 from Calinou/doc-ik-skeletonmodifier3d-index-parameter

Document the purpose of the index parameter in IK and SkeletonModifier3D classes

doc/classes/BoneConstraint3D.xml

@@ -5,6 +5,7 @@
 	</brief_description>
 	<description>
 		Base class of [SkeletonModifier3D] that modifies the bone set in [method set_apply_bone] based on the transform of the bone retrieved by [method get_reference_bone].
+		[b]Note:[/b] Most methods in this class take an [code]index[/code] parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. [code]settings/&lt;index&gt;/amount[/code]).
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/BoneTwistDisperser3D.xml

@@ -7,6 +7,7 @@
 		This [BoneTwistDisperser3D] allows for smooth twist interpolation between multiple bones by dispersing the end bone's twist to the parents. This only changes the twist without changing the global position of each joint.
 		This is useful for smoothly twisting bones in combination with [CopyTransformModifier3D] and IK.
 		[b]Note:[/b] If an extracted twist is greater than 180 degrees, flipping occurs. This is similar to [ConvertTransformModifier3D].
+		[b]Note:[/b] Most methods in this class take an [code]index[/code] parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. [code]settings/<index>/root_bone_name[/code]).
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/ChainIK3D.xml

@@ -5,6 +5,7 @@
 	</brief_description>
 	<description>
 		Base class of [SkeletonModifier3D] that automatically generates a joint list from the bones between the root bone and the end bone.
+		[b]Note:[/b] All the methods in this class take an [code]index[/code] parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. [code]settings/&lt;index&gt;/root_bone_name[/code]).
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/IterateIK3D.xml

@@ -6,6 +6,7 @@
 	<description>
 		Base class of [SkeletonModifier3D] to approach the goal by repeating small rotations.
 		Each bone chain (setting) has one effector, which is processed in order of the setting list. You can set some limitations for each joint.
+		[b]Note:[/b] All the methods in this class take an [code]index[/code] parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. [code]settings/&lt;index&gt;/target_node[/code]).
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/LimitAngularVelocityModifier3D.xml

@@ -6,6 +6,7 @@
 	<description>
 		This modifier limits bone rotation angular velocity by comparing poses between previous and current frame.
 		You can add bone chains by specifying their root and end bones, then add the bones between them to a list. Modifier processes either that list or the bones excluding those in the list depending on the option [member exclude].
+		[b]Note:[/b] Most methods in this class take an [code]index[/code] parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. [code]settings/&lt;index&gt;/root_bone_name[/code]).
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/SplineIK3D.xml

@@ -9,6 +9,7 @@
 		Bone twist is determined based on the [method Curve3D.get_point_tilt].
 		If the root bone joint and the start point of the [Curve3D] are separated, it assumes that there is a linear line segment between them. This means that the vector pointing toward the start point of the [Curve3D] takes precedence over the shortest intersection point along the [Curve3D].
 		If the end bone joint exceeds the path length, it is bent as close as possible to the end point of the [Curve3D].
+		[b]Note:[/b] All the methods in this class take an [code]index[/code] parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. [code]settings/<index>/root_bone_name[/code]).
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/SpringBoneSimulator3D.xml

@@ -11,6 +11,7 @@
 		For simplicity, you can set values to all joints at the same time by using a [Curve]. If you want to specify detailed values individually, set [method set_individual_config] to [code]true[/code].
 		For physical simulation, [SpringBoneSimulator3D] can have children as self-standing collisions that are not related to [PhysicsServer3D], see also [SpringBoneCollision3D].
 		[b]Warning:[/b] A scaled [SpringBoneSimulator3D] will likely not behave as expected. Make sure that the parent [Skeleton3D] and its bones are not scaled.
+		[b]Note:[/b] Most methods in this class take an [code]index[/code] parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. [code]settings/<index>/root_bone_name[/code]).
 	</description>
 	<tutorials>
 	</tutorials>

doc/classes/TwoBoneIK3D.xml

@@ -6,6 +6,7 @@
 	<description>
 		This [IKModifier3D] requires a pole target. It provides deterministic results by constructing a plane from each joint and pole target and finding the intersection of two circles (disks in 3D).
 		This IK can handle twist by setting the pole direction. If there are more than one bone between each set bone, their rotations are ignored, and the straight line connecting the root-middle and middle-end joints are treated as virtual bones.
+		[b]Note:[/b] All the methods in this class take an [code]index[/code] parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. [code]settings/&lt;index&gt;/root_bone_name[/code]).
 	</description>
 	<tutorials>
 	</tutorials>