rename_ik_retarget_chain
Rename a retarget chain in an IK Rig asset and save the change as one undo transaction. Returns the final unique name, plus renamed and saved status.
Instructions
Rename a retarget chain of an IK Rig asset through the IK Rig controller (one undo transaction) and save it. The engine makes the new name unique, so read new_name back; an unknown chain_name is not an error but returns renamed false, saved false and a note, with nothing saved. A failed save makes success false, with saved=false and save_error.
Returns: { asset_path: string, old_name: string, new_name: string, renamed: bool, saved: bool, save_error?: string, note?: string }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| new_name | Yes | Requested new name; the engine may add a suffix to keep it unique. | |
| chain_name | Yes | Current name of the retarget chain, as get_ik_rig_info lists it. | |
| ik_rig_path | Yes | IK Rig (UIKRigDefinition) asset path, e.g. "/Game/Retarget/IK_Hero". |