A node containing a bone hierarchy, used to create a 3D skeletal animation.
[Skeleton3D] provides an interface for managing a hierarchy of bones, including pose, rest and animation (see [Animation]). It can also use ragdoll physics. The overall transform of a bone with respect to the skeleton is determined by bone pose. Bone rest defines the initial transform of the bone pose. Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it is not the actual global/world transform of the bone. To setup different types of inverse kinematics, consider using [SkeletonIK3D], or add a custom IK implementation in [method Node._process] as a child node.
https://godotengine.org/asset-library/asset/523 https://godotengine.org/asset-library/asset/678
Adds a bone, with name [param name]. [method get_bone_count] will become the bone index.
Clear all the bones in this skeleton.
Removes the global pose override on all bones in the skeleton.
Returns the bone index that matches [param name] as its name.
Force updates the bone transforms/poses for all bones in the skeleton. [i]Deprecated.[/i] Do not use.
Force updates the bone transform for the bone at [param bone_idx] and all of its children.
Returns an array containing the bone indexes of all the children node of the passed in bone, [param bone_idx].
Returns the number of bones in the skeleton.
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.
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.
Returns the global pose override transform for [param bone_idx].
Returns the global rest transform for [param bone_idx].
Returns the name of the bone at index [param bone_idx].
Returns the bone index which is the parent of the bone at [param bone_idx]. If -1, then bone has no parent. [b]Note:[/b] The parent bone returned will always be less than [param bone_idx].
Returns the pose transform of the specified bone.
Returns the rest transform for a bone [param bone_idx].
Returns an array with all of the bones that are parentless. Another way to look at this is that it returns the indexes of all the bones that are not dependent or modified by other bones in the Skeleton.
Returns the number of times the bone hierarchy has changed within this skeleton, including renames. The Skeleton version is not serialized: only use within a single instance of Skeleton3D. Use for invalidating caches in IK solvers and other nodes which process bones.
Returns whether the bone pose for the bone at [param bone_idx] is enabled.
Returns all bones in the skeleton to their rest poses.
Adds a collision exception to the physical bone. Works just like the [RigidBody3D] node.
Removes a collision exception to the physical bone. Works just like the [RigidBody3D] node.
Tells the [PhysicalBone3D] nodes in the Skeleton to start simulating and reacting to the physics world. Optionally, a list of bone names can be passed-in, allowing only the passed-in bones to be simulated.
Tells the [PhysicalBone3D] nodes in the Skeleton to stop simulating.
Binds the given Skin to the Skeleton.
Sets the bone pose to rest for [param bone_idx].
Sets all bone poses to rests.
Disables the pose for the bone at [param bone_idx] if [code]false[/code], enables the bone pose if [code]true[/code].
Sets the global pose transform, [param pose], for the bone at [param bone_idx]. [param amount] is the interpolation strength that will be used when applying the pose, and [param persistent] determines if the applied pose will remain. [b]Note:[/b] The pose transform needs to be a global pose! To convert a world transform from a [Node3D] to a global bone pose, multiply the [method Transform3D.affine_inverse] of the node's [member Node3D.global_transform] by the desired world transform.
Sets the bone index [param parent_idx] as the parent of the bone at [param bone_idx]. If -1, then bone has no parent. [b]Note:[/b] [param parent_idx] must be less than [param bone_idx].
Sets the rest transform for bone [param bone_idx].
Unparents the bone at [param bone_idx] and sets its rest position to that of its parent prior to being reset.
- Multiplies the 3D position track animation. [b]Note:[/b] Unless this value is [code]1.0[/code], the key value in animation will not match the actual position value.
This signal is emitted when one of the bones in the Skeleton3D node have changed their pose. This is used to inform nodes that rely on bone positions that one of the bones in the Skeleton3D have changed their transform/pose.