SpawnMarker

← Back to Asset Types

Documentation for the SpawnMarker asset type.

Location

NPC/Spawn/Markers

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/SpawnMarker.schema.json" Copy

Schema

Tree

Model stringnull

The optional visual representation to use in the world when in creative mode (this has a default value which can be specified using DefaultSpawnMarkerModel in the server config for the spawning plugin).

NPCs array

A weighted list of NPCs and their configurations.

Array items: SpawnConfiguration

ExclusionRadius number

A radius used to prevent a marker from spawning new NPCs if a player in adventure mode is within range.

Default:0

Min: 0

MaxDropHeight number

A maximum offset from the marker's position at which the mob can be spawned. Ground mobs are spawned directly on the ground, so if the marker is high in the air due to the building having been destroyed, if the distance between the marker and the ground is greater than this, the marker will not spawn mobs.

Default:4

Min (exclusive): 0

RealtimeRespawn boolean

Whether to use real time or game time for the respawn timer.

Default:false

ManualTrigger boolean

Indicates if the spawn marker has to be triggered manually or not.

Default:false

DeactivationDistance number

If no players are inside this range, the spawn marker will deactivate and store its NPCs once this distance is exceeded.

Default:40

Min (exclusive): 0

DeactivationTime number

The delay before deactivation happens when no players are in range.

Default:5

Min (exclusive): 0

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "SpawnMarker.json",
  "title": "SpawnMarker",
  "description": "A marker designed to spawn NPCs with its current position and rotation. When the NPC dies, a new NPC will spawn after a defined cooldown. This cooldown can be specified either in terms of game time or real time and begins to count down from the moment the mob dies.",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Model": {
      "type": [
        "string",
        "null"
      ],
      "description": "The optional visual representation to use in the world when in creative mode (this has a default value which can be specified using DefaultSpawnMarkerModel in the server config for the spawning plugin).",
      "markdownDescription": "The optional visual representation to use in the world when in creative mode (this has a default value which can be specified using **DefaultSpawnMarkerModel** in the server config for the spawning plugin)."
    },
    "NPCs": {
      "type": "array",
      "title": "WeightedMap",
      "description": "A weighted list of NPCs and their configurations.",
      "items": {
        "$ref": "common.schema.json#/$defs/SpawnConfiguration"
      }
    },
    "ExclusionRadius": {
      "type": "number",
      "description": "A radius used to prevent a marker from spawning new NPCs if a player in adventure mode is within range.",
      "minimum": 0,
      "default": 0
    },
    "MaxDropHeight": {
      "type": "number",
      "description": "A maximum offset from the marker's position at which the mob can be spawned. Ground mobs are spawned directly on the ground, so if the marker is high in the air due to the building having been destroyed, if the distance between the marker and the ground is greater than this, the marker will not spawn mobs.",
      "exclusiveMinimum": 0,
      "default": 4
    },
    "RealtimeRespawn": {
      "type": "boolean",
      "description": "Whether to use real time or game time for the respawn timer.",
      "default": false
    },
    "ManualTrigger": {
      "type": "boolean",
      "description": "Indicates if the spawn marker has to be triggered manually or not.",
      "default": false
    },
    "DeactivationDistance": {
      "type": "number",
      "description": "If no players are inside this range, the spawn marker will deactivate and store its NPCs once this distance is exceeded.",
      "exclusiveMinimum": 0,
      "default": 40
    },
    "DeactivationTime": {
      "type": "number",
      "description": "The delay before deactivation happens when no players are in range.",
      "exclusiveMinimum": 0,
      "default": 5
    }
  }
}