Command · prefab

prefab.instantiate

Place an instance of a prefab; its content stays linked to the prefab.

scope edit:scenenot idempotentnon-destructive

Params

Typed as PrefabInstantiateParams. Fields marked * are required.

prefab*

asset<prefab>

The prefab, as @path#id, @path or @#id.

required

option<string>

ID of the instance: a symbol ($door) or a concrete unused record ID. Minted when absent.

default null

name

option<string>

Display name; absent keeps the prefab root's name.

default null

parent

option<entity>

Parent entity; absent creates a root.

default null

index

option<u32>

Position among the parent's children; absent appends.

default null

position

option<vec3>

Local position of the instance.

default nullm

Examples

JSON (MCP ara_apply, batches)

{
  "cmd": "prefab.instantiate",
  "args": {
    "prefab": "@prefabs/crate.prefab",
    "id": "$crate",
    "position": [
      0,
      0,
      4
    ]
  }
}

CLI

ara do prefab.instantiate --args '{"prefab":"@prefabs/crate.prefab","id":"$crate","position":[0,0,4]}' --why "…"