SpawnSuppression

← Back to Asset Types

Documentation for the SpawnSuppression asset type.

Location

NPC/Spawn/Suppression

Use in Your Files

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

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

Schema

Tree

SuppressionRadius number

The radius this spawn suppression should cover. Any chunk which falls even partially within this radius will be affected by the suppression on the x and z axes, but will use exact distance for the y axis. This allows NPCs to continue to spawn in caves below the position or in the skies above, but is slightly more efficient and provides no noticeable differences in world spawns.

Default:10

Min (exclusive): 0

SuppressedGroups arraynull

An array of NPCGroup ids that will be suppressed.

Array items: string

SuppressSpawnMarkers boolean

Whether or not to suppress any spawn markers within the range of this suppression. If set to true, any spawn marker within this range will cease to function while the suppression exists

Default:false

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "SpawnSuppression.json",
  "title": "SpawnSuppression",
  "description": "A configuration designed to prevent certain NPCs spawns within a given region.",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "SuppressionRadius": {
      "type": "number",
      "description": "The radius this spawn suppression should cover. Any chunk which falls even partially within this radius will be affected by the suppression on the x and z axes, but will use exact distance for the y axis. This allows NPCs to continue to spawn in caves below the position or in the skies above, but is slightly more efficient and provides no noticeable differences in world spawns.",
      "exclusiveMinimum": 0,
      "default": 10
    },
    "SuppressedGroups": {
      "type": [
        "array",
        "null"
      ],
      "description": "An array of NPCGroup ids that will be suppressed.",
      "items": {
        "type": "string"
      }
    },
    "SuppressSpawnMarkers": {
      "type": "boolean",
      "description": "Whether or not to suppress any spawn markers within the range of this suppression. If set to true, any spawn marker within this range will cease to function while the suppression exists",
      "default": false
    }
  }
}