Skeleton3D: Add SkeletonModifier / Deprecate Override / Separate PB

1 files changed, 51 insertions, 9 deletions

diff --git a/doc/classes/Skeleton3D.xml b/doc/classes/Skeleton3D.xml
index c9ad204247..17c93af652 100644
--- a/doc/classes/Skeleton3D.xml
+++ b/doc/classes/Skeleton3D.xml
@@ -27,7 +27,7 @@
 				Clear all the bones in this skeleton.
 			</description>
 		</method>
-		<method name="clear_bones_global_pose_override">
+		<method name="clear_bones_global_pose_override" deprecated="">
 			<return type="void" />
 			<description>
 				Removes the global pose override on all bones in the skeleton.
@@ -58,6 +58,11 @@
 				Force updates the bone transform for the bone at [param bone_idx] and all of its children.
 			</description>
 		</method>
+		<method name="get_animate_physical_bones" qualifiers="const" deprecated="">
+			<return type="bool" />
+			<description>
+			</description>
+		</method>
 		<method name="get_bone_children" qualifiers="const">
 			<return type="PackedInt32Array" />
 			<param index="0" name="bone_idx" type="int" />
@@ -76,16 +81,17 @@
 			<param index="0" name="bone_idx" type="int" />
 			<description>
 				Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone.
+				[b]Note:[/b] This is the global pose you set to the skeleton in the process, the final global pose can get overridden by modifiers in the deferred process, if you want to access the final global pose, use [signal SkeletonModifier3D.modification_processed].
 			</description>
 		</method>
-		<method name="get_bone_global_pose_no_override" qualifiers="const">
+		<method name="get_bone_global_pose_no_override" qualifiers="const" deprecated="">
 			<return type="Transform3D" />
 			<param index="0" name="bone_idx" type="int" />
 			<description>
 				Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone.
 			</description>
 		</method>
-		<method name="get_bone_global_pose_override" qualifiers="const">
+		<method name="get_bone_global_pose_override" qualifiers="const" deprecated="">
 			<return type="Transform3D" />
 			<param index="0" name="bone_idx" type="int" />
 			<description>
@@ -119,6 +125,7 @@
 			<param index="0" name="bone_idx" type="int" />
 			<description>
 				Returns the pose transform of the specified bone.
+				[b]Note:[/b] This is the pose you set to the skeleton in the process, the final pose can get overridden by modifiers in the deferred process, if you want to access the final pose, use [signal SkeletonModifier3D.modification_processed].
 			</description>
 		</method>
 		<method name="get_bone_pose_position" qualifiers="const">
@@ -176,7 +183,7 @@
 				Returns all bones in the skeleton to their rest poses.
 			</description>
 		</method>
-		<method name="physical_bones_add_collision_exception">
+		<method name="physical_bones_add_collision_exception" deprecated="">
 			<return type="void" />
 			<param index="0" name="exception" type="RID" />
 			<description>
@@ -184,7 +191,7 @@
 				Works just like the [RigidBody3D] node.
 			</description>
 		</method>
-		<method name="physical_bones_remove_collision_exception">
+		<method name="physical_bones_remove_collision_exception" deprecated="">
 			<return type="void" />
 			<param index="0" name="exception" type="RID" />
 			<description>
@@ -192,7 +199,7 @@
 				Works just like the [RigidBody3D] node.
 			</description>
 		</method>
-		<method name="physical_bones_start_simulation">
+		<method name="physical_bones_start_simulation" deprecated="">
 			<return type="void" />
 			<param index="0" name="bones" type="StringName[]" default="[]" />
 			<description>
@@ -200,7 +207,7 @@
 				Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated.
 			</description>
 		</method>
-		<method name="physical_bones_stop_simulation">
+		<method name="physical_bones_stop_simulation" deprecated="">
 			<return type="void" />
 			<description>
 				Tells the [PhysicalBone3D] nodes in the Skeleton to stop simulating.
@@ -226,6 +233,12 @@
 				Sets all bone poses to rests.
 			</description>
 		</method>
+		<method name="set_animate_physical_bones" deprecated="">
+			<return type="void" />
+			<param index="0" name="enabled" type="bool" />
+			<description>
+			</description>
+		</method>
 		<method name="set_bone_enabled">
 			<return type="void" />
 			<param index="0" name="bone_idx" type="int" />
@@ -234,7 +247,16 @@
 				Disables the pose for the bone at [param bone_idx] if [code]false[/code], enables the bone pose if [code]true[/code].
 			</description>
 		</method>
-		<method name="set_bone_global_pose_override">
+		<method name="set_bone_global_pose">
+			<return type="void" />
+			<param index="0" name="bone_idx" type="int" />
+			<param index="1" name="pose" type="Transform3D" />
+			<description>
+				Sets the global pose transform, [param pose], for the bone at [param bone_idx].
+				[b]Note:[/b] If other bone poses have been changed, this method executes an update process and will cause performance to deteriorate. If you know that multiple global poses will be applied, consider using [method set_bone_pose] with precalculation.
+			</description>
+		</method>
+		<method name="set_bone_global_pose_override" deprecated="">
 			<return type="void" />
 			<param index="0" name="bone_idx" type="int" />
 			<param index="1" name="pose" type="Transform3D" />
@@ -251,6 +273,7 @@
 			<param index="0" name="bone_idx" type="int" />
 			<param index="1" name="name" type="String" />
 			<description>
+				Sets the bone name, [param name], for the bone at [param bone_idx].
 			</description>
 		</method>
 		<method name="set_bone_parent">
@@ -262,6 +285,14 @@
 				[b]Note:[/b] [param parent_idx] must be less than [param bone_idx].
 			</description>
 		</method>
+		<method name="set_bone_pose">
+			<return type="void" />
+			<param index="0" name="bone_idx" type="int" />
+			<param index="1" name="pose" type="Transform3D" />
+			<description>
+				Sets the pose transform, [param pose], for the bone at [param bone_idx].
+			</description>
+		</method>
 		<method name="set_bone_pose_position">
 			<return type="void" />
 			<param index="0" name="bone_idx" type="int" />
@@ -303,7 +334,8 @@
 		</method>
 	</methods>
 	<members>
-		<member name="animate_physical_bones" type="bool" setter="set_animate_physical_bones" getter="get_animate_physical_bones" default="true">
+		<member name="modifier_callback_mode_process" type="int" setter="set_modifier_callback_mode_process" getter="get_modifier_callback_mode_process" enum="Skeleton3D.ModifierCallbackModeProcess" default="1">
+			Sets the processing timing for the Modifier.
 		</member>
 		<member name="motion_scale" type="float" setter="set_motion_scale" getter="get_motion_scale" default="1.0">
 			Multiplies the 3D position track animation.
@@ -320,6 +352,10 @@
 				Emitted when the bone at [param bone_idx] is toggled with [method set_bone_enabled]. Use [method is_bone_enabled] to check the new value.
 			</description>
 		</signal>
+		<signal name="bone_list_changed">
+			<description>
+			</description>
+		</signal>
 		<signal name="bone_pose_changed">
 			<param index="0" name="bone_idx" type="int" />
 			<description>
@@ -342,5 +378,11 @@
 			Notification received when this skeleton's pose needs to be updated.
 			This notification is received [i]before[/i] the related [signal pose_updated] signal.
 		</constant>
+		<constant name="MODIFIER_CALLBACK_MODE_PROCESS_PHYSICS" value="0" enum="ModifierCallbackModeProcess">
+			Set a flag to process modification during physics frames (see [constant Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS]).
+		</constant>
+		<constant name="MODIFIER_CALLBACK_MODE_PROCESS_IDLE" value="1" enum="ModifierCallbackModeProcess">
+			Set a flag to process modification during process frames (see [constant Node.NOTIFICATION_INTERNAL_PROCESS]).
+		</constant>
 	</constants>
 </class>