set_ik_retarget_chain_bones
Update the start bone, end bone, or IK goal of an existing IK Rig retarget chain and save the asset. Provide at least one field; each change is an undo transaction.
Instructions
Change the start bone, end bone and/or IK goal of an existing retarget chain in an IK Rig asset through the IK Rig controller (each change an undo transaction), then save the asset. Pass at least one of the three, else an error. A missing chain, a bone not in the rig skeleton or a goal_name the rig has no goal for is not an error but start_bone_set, end_bone_set or goal_set false, and that field is left unchanged. A value the chain already has is left alone; when nothing changes, changed is false, saved is false, a note says why and nothing is saved. A failed save makes success false, with saved=false and save_error. Siblings: add_ik_retarget_chain, rename_ik_retarget_chain.
Returns: { asset_path: string, chain_name: string, start_bone: string, end_bone: string, goal_name: string, start_bone_set: bool, end_bone_set: bool, goal_set: bool, changed: bool, saved: bool, save_error?: string, note?: string }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_bone | No | Optional new end bone | |
| goal_name | No | Optional new associated IK goal, which must be a goal of the rig; None clears the goal of the chain. | |
| chain_name | Yes | Name of the retarget chain to mutate | |
| start_bone | No | Optional new start bone | |
| ik_rig_path | Yes | Path to the UIKRigDefinition asset |