add_ik_retarget_chain
Add a retarget bone chain between two skeleton bones in an IK Rig asset, optionally attach an IK goal, and save the updated rig.
Instructions
Add a retarget bone chain from start_bone to end_bone, optionally tied to an IK goal, to an IK Rig asset and save it. Both bones must exist in the skeleton of the rig; the chain name is made unique, so read chain_name back. A failed save makes success false, with saved=false and save_error.
Returns: { asset_path: string, chain_name: string, start_bone: string, end_bone: string, goal_name: string, chain_count: int, saved: bool, save_error?: string }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_bone | Yes | Last bone of the chain; must exist in the skeleton of the rig. | |
| goal_name | No | IK goal to attach the chain to (default none); not checked against the goals of the rig. | |
| chain_name | Yes | Name for the new retarget chain (uniquified by the engine) | |
| start_bone | Yes | First bone of the chain; must exist in the skeleton of the rig. | |
| ik_rig_path | Yes | IK Rig (UIKRigDefinition) asset path, e.g. "/Game/Retarget/IK_Hero". |