NPCGroup

← Back to Asset Types

Documentation for the NPCGroup asset type.

Location

NPC/Groups

Use in Your Files

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

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

Schema

Tree

IncludeRoles arraynull

A list of individual types to include.

Array items: string

ExcludeRoles arraynull

A list of individual types to exclude.

Array items: string

IncludeGroups arraynull

A list of other groups to include.

Array items: string

ExcludeGroups arraynull

A list of other groups to exclude.

Array items: string

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "NPCGroup.json",
  "title": "NPCGroup",
  "description": "Defines a group or collection of NPC types.",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "IncludeRoles": {
      "type": [
        "array",
        "null"
      ],
      "description": "A list of individual types to include.",
      "items": {
        "type": "string"
      }
    },
    "ExcludeRoles": {
      "type": [
        "array",
        "null"
      ],
      "description": "A list of individual types to exclude.",
      "items": {
        "type": "string"
      }
    },
    "IncludeGroups": {
      "type": [
        "array",
        "null"
      ],
      "description": "A list of other groups to include.",
      "items": {
        "type": "string"
      }
    },
    "ExcludeGroups": {
      "type": [
        "array",
        "null"
      ],
      "description": "A list of other groups to exclude.",
      "items": {
        "type": "string"
      }
    }
  }
}