Schemas / Play

rig.play.spawner

v1.0.0 · stable maturity: draft 4 fields 2 required

Fields

FieldTypeMeaning
prototype entity required Entity to clone
period float required Seconds between spawns
maxAlive uint optional Optional. Cap on living clones; absent = 1
active bool optional Optional. Spawns while true; absent = true

Clones a prototype on a period. Format when present.

The clone copies the prototype's components. Spawned entity ids and the cooldown clock stay in the host. The prototype itself is not one of the alive clones.

JSON Schema

Resolves at https://rig.works/schemas/rig.play.spawner.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.play.spawner.schema.json",
  "title": "rig.play.spawner",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "prototype": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "period": {
      "$ref": "./_defs.schema.json#/$defs/float"
    },
    "maxAlive": {
      "$ref": "./_defs.schema.json#/$defs/uint"
    },
    "active": {
      "$ref": "./_defs.schema.json#/$defs/bool"
    }
  },
  "required": [
    "prototype",
    "period"
  ],
  "x-rig-maturity": "draft"
}

Seen in

play-scene.json