override_usd_prim
Author an over spec at a prim path on a registered USD stage to add opinions without defining the prim; missing ancestors are over-authored and existing prims remain untouched.
Instructions
Author an over (specifier over, no type) at prim_path on a registered USD stage, at its current edit target, with overs for missing ancestors, to add opinions to a prim without defining it. A prim that already exists there is returned untouched (already_existed true, no specifier reported, since nothing was authored); specifier Over comes back only for an over this call authored. is_valid=false means USD refused; a missing stage or a bad path is an error. In memory only: save_usd_stage writes it. define_usd_prim creates a typed def; set_usd_prim_specifier changes the specifier of an existing prim.
Returns: { prim_path: string, is_valid: bool, already_existed: bool, specifier?: string }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| prim_path | Yes | Absolute SdfPath to author the over at, e.g. "/World/Cube" | |
| stage_name | No | Name the stage was registered under by create_usd_stage or open_usd_stage; a stage already in the USD cache also matches by the end of its root layer identifier. |