Command · entity

entity.create

Create an entity, optionally with a parent, a position among its siblings and components.

scope edit:scenenot idempotentnon-destructive

Params

Typed as EntityCreateParams. Fields marked * are required.

option<string>

ID of the new entity: a symbol ($crate) that later calls in the batch can use, or a concrete unused record ID. Minted when absent.

default null

name

option<string>

Display name.

default null

parent

option<entity>

Parent entity; absent creates a root. May be inside a prefab instance.

default null

index

option<u32>

Position among the parent's children; absent appends.

default null

components

option<map<json>>

Components to add, by type name; {} uses every default.

default null

Examples

JSON (MCP ara_apply, batches)

{
  "cmd": "entity.create",
  "args": {
    "id": "$crate",
    "name": "Crate",
    "components": {
      "Transform": {
        "position": [
          2,
          0,
          3
        ]
      }
    }
  }
}

CLI

ara do entity.create --args '{"id":"$crate","name":"Crate","components":{"Transform":{"position":[2,0,3]}}}' --why "…"

JSON (MCP ara_apply, batches)

{
  "cmd": "entity.create",
  "args": {
    "name": "Lid",
    "parent": "$crate",
    "index": 0
  }
}

CLI

ara do entity.create --args '{"name":"Lid","parent":"$crate","index":0}' --why "…"