TerritorySpawn

Overview

TerritoryData files define territory spawns: individual NPC spawn entries within territory areas. Each spawn configures an NPC’s position, behavior, aggro rules, patrol routes, and social animations. Spawns can exist directly under a territory or within a party group.

Version Support

Version	Status
v92	Full
v90	-
v86	-

DSL Support

Entity: territorySpawns Operations: create, update, delete, upsert, updateWhere, deleteWhere Key attributes: huntingZoneId, groupId, territoryId, npcInstanceId (composite key)

Quick Recipes

Create

spec:
  version: "1.0"
  schema: v92

territorySpawns:
  create:
    - huntingZoneId: 400
      groupId: 1
      territoryId: 1
      npcInstanceId: 5001
      npcTemplateId: 42010
      memberId: 0
      desc: "Guard NPC"
      pos: [150.0, 200.0, 0.0]
      dir: 180
      offsetZ: 0
      randomPos: false
      escapeLocation: [0, 0, 0]
      spawnCount: 1
      respawnTime: 30
      conditionalSpawn: false
      ai: 0
      isAggressiveMonster: false
      isReturn: true
      returnDistance: 2000
      moveInTerritory: true
      viewRadius: 30
      viewAngle: 360
      alertRadius: 50
      alertAngle: 360
      questPatrol: false
      aggroShareGroupId: 0
      aggroSendToPartyDistance: 0
      aggroSendToClanDistance: 0
      aggroIgnorePartyId: ""
      aggroReceiveOnlyInSight: false

Update

spec:
  version: "1.0"
  schema: v92

territorySpawns:
  update:
    - huntingZoneId: 400
      groupId: 1
      territoryId: 1
      npcInstanceId: 5001
      changes:
        respawnTime: 60
        isAggressiveMonster: true
        viewRadius: 40

Delete

spec:
  version: "1.0"
  schema: v92

territorySpawns:
  delete:
    - huntingZoneId: 400
      groupId: 1
      territoryId: 1
      npcInstanceId: 5001

Upsert

spec:
  version: "1.0"
  schema: v92

territorySpawns:
  upsert:
    - huntingZoneId: 400
      groupId: 1
      territoryId: 1
      npcInstanceId: 5001
      npcTemplateId: 42010
      memberId: 0
      desc: "Upserted NPC"
      pos: [150.0, 200.0, 0.0]
      dir: 180
      offsetZ: 0
      randomPos: false
      escapeLocation: [0, 0, 0]
      spawnCount: 1
      respawnTime: 30
      conditionalSpawn: false
      ai: 0
      isAggressiveMonster: false
      isReturn: true
      returnDistance: 2000
      moveInTerritory: true
      viewRadius: 30
      viewAngle: 360
      alertRadius: 50
      alertAngle: 360
      questPatrol: false
      aggroShareGroupId: 0
      aggroSendToPartyDistance: 0
      aggroSendToClanDistance: 0
      aggroIgnorePartyId: ""
      aggroReceiveOnlyInSight: false

UpdateWhere

Batch-update spawns matching filter criteria across all zone files.

spec:
  version: "1.0"
  schema: v92

territorySpawns:
  updateWhere:
    - filter:
        npcTemplateId: 42010
      changes:
        respawnTime: 15
        isAggressiveMonster: true

DeleteWhere

Batch-delete spawns matching filter criteria across all zone files.

spec:
  version: "1.0"
  schema: v92

territorySpawns:
  deleteWhere:
    - filter:
        npcTemplateId: 42010

Properties Reference

Required Attributes

Attribute	Type	Since	Description
`huntingZoneId`	`int`	v92	Hunting zone identifier (used for file partitioning)
`groupId`	`int`	v92	Parent territory group identifier
`territoryId`	`int`	v92	Parent territory area identifier
`npcInstanceId`	`int`	v92	Unique NPC instance identifier
`npcTemplateId`	`int`	v92	NPC template reference (from NpcData)
`memberId`	`int`	v92	Member group identifier
`desc`	`string`	v92	Spawn description
`pos`	`decimal[]`	v92	Spawn position `[x, y, z]`
`dir`	`decimal`	v92	Facing direction in degrees
`offsetZ`	`int`	v92	Vertical position offset
`randomPos`	`bool`	v92	Use random positioning within territory
`escapeLocation`	`decimal[]`	v92	Escape destination `[x, y, z]`
`spawnCount`	`int`	v92	Number of NPCs to spawn
`respawnTime`	`int`	v92	Respawn interval in seconds
`conditionalSpawn`	`bool`	v92	Whether spawn is conditional
`ai`	`int`	v92	AI behavior reference
`isAggressiveMonster`	`bool`	v92	Attacks players on sight
`isReturn`	`bool`	v92	Returns to spawn area when leaving
`returnDistance`	`int`	v92	Maximum distance before returning
`moveInTerritory`	`bool`	v92	Moves within territory bounds
`viewRadius`	`int`	v92	Line of sight radius
`viewAngle`	`int`	v92	Field of view angle in degrees
`alertRadius`	`int`	v92	Alert detection radius
`alertAngle`	`int`	v92	Alert detection angle in degrees
`questPatrol`	`bool`	v92	Uses quest patrol behavior
`aggroShareGroupId`	`int`	v92	Aggro sharing group (0 for none)
`aggroSendToPartyDistance`	`int`	v92	Aggro propagation distance to party
`aggroSendToClanDistance`	`int`	v92	Aggro propagation distance to clan
`aggroIgnorePartyId`	`string`	v92	Party IDs to ignore for aggro
`aggroReceiveOnlyInSight`	`bool`	v92	Only receive aggro within line of sight

Optional Attributes (Spawn Variants)

Attribute	Type	Since	Description
`respawnRandomTime`	`string`	v92	Random variance added to respawn time
`voidSpawn`	`bool`	v92	Void spawn mode
`delaySpawnTimeWhenWorldStart`	`int`	v92	Spawn delay when server starts
`delaySpawnRandomTimeWhenWorldStart`	`int`	v92	Random variance on world start delay
`persistentChannelSpawn`	`bool`	v92	Persists across channel changes
`randomSpawnProb`	`int`	v92	Random spawn probability (percentage)

Optional Attributes (Combat)

Attribute	Type	Since	Description
`canbeattacked`	`bool`	v92	Whether the NPC can be attacked
`friendOfPlayer`	`bool`	v92	Allied to players
`villager`	`bool`	v92	Is a villager NPC
`battlefieldTeam`	`string`	v92	Battlefield team assignment
`isFlying`	`bool`	v92	Flying NPC
`flyMoveSequenceId`	`int`	v92	Flight movement sequence reference
`canGetBuff`	`bool`	v92	Can receive buffs
`excludeAggroLimit`	`bool`	v92	Bypasses aggro limit restrictions

Optional Attributes (Movement)

Attribute	Type	Since	Description
`peaceStateNoMoving`	`bool`	v92	No movement in peace state
`cautionStateNoMoving`	`bool`	v92	No movement in caution state
`isReturnMyTerritory`	`bool`	v92	Returns to own territory
`returnToSpawnPos`	`bool`	v92	Returns to exact spawn position

Attribute	Type	Since	Description
`aggroCopyFromNpc`	`string`	v92	Copy aggro table from another NPC
`aggroCopyFromNpcDistance`	`string`	v92	Distance for aggro copy
`aggroSendToTerritory`	`string`	v92	Propagate aggro to territory
`aggroTargetIsUserOnly`	`bool`	v92	Only target players

Optional Attributes (Messages)

Attribute	Type	Since	Description
`popupMsg`	`string`	v92	Popup message on interaction
`msgBroadcastingChannel`	`bool`	v92	Broadcast messages to channel
`msgInterval`	`int`	v92	Message broadcast interval
`msgProb`	`decimal`	v92	Message broadcast probability

Optional Attributes (Misc)

Attribute	Type	Since	Description
`interactionRuleId`	`int`	v92	Interaction rule reference

Optional Nested Elements

Attribute	Type	Since	Description
`patrolList`	`nested`	v92	Patrol route configuration. See PatrolList.
`socialSet`	`nested`	v92	Social animation configuration. See SocialSet.

Nested Elements

PatrolList

Defines patrol routes with waypoints and optional social animations.

Attribute	Type	Since	Description
`type`	`string`	v92	Patrol type
`randomSocial`	`bool`	v92	Randomize social animations
`socialDuration`	`int`	v92	Duration of social animations
`patrols`	`list[Patrol]`	v92	Patrol waypoints

Patrol

Attribute	Type	Since	Description
`pos`	`decimal[]`	v92	Waypoint position `[x, y, z]`
`formationId`	`int`	v92	Formation at this waypoint
`socials`	`list[Social]`	v92	Social animations at this waypoint

Attribute	Type	Since	Description
`motionId`	`int`	v92	Animation motion reference
`dir`	`int`	v92	Facing direction during animation
`probability`	`decimal`	v92	Probability of playing this animation

SocialSet

Idle social animations played at configurable intervals.

Attribute	Type	Since	Description
`checkInterval`	`int`	v92	Interval between social checks
`probSocial`	`decimal`	v92	Probability of social animation
`socials`	`list[Social]`	v92	Available social animations

Attribute	Type	Since	Description
`motionId`	`int`	v92	Animation motion reference

XML Structure

TerritoryData_{huntingZoneId}.xml
└── TerritoryData (huntingZoneId)
    └── TerritoryGroup (id)
        └── TerritoryList
            └── Territory (id)
                ├── Npc (instanceId, npcTemplateId, ...) [multiple]
                │   ├── PatrolList (optional)
                │   │   └── Patrol [multiple]
                │   │       └── Social [multiple]
                │   └── SocialSet (optional)
                │       └── Social [multiple]
                └── Party (id)
                    └── Npc (instanceId, npcTemplateId, ...) [multiple]

Common Pitfalls

Composite key: Spawns are identified by huntingZoneId, groupId, territoryId, AND npcInstanceId. For party-nested spawns, partyId is also part of the key.
Party vs standalone spawns: NPCs can exist directly under a Territory or under a Party within a Territory. The partyId key attribute distinguishes these cases.
updateWhere scope: The updateWhere operation scans all TerritoryData_*.xml files in the base path. Use filters carefully to avoid unintended changes across zones.
deleteWhere scope: Same as updateWhere — operates across all zone files. Filtered elements are removed from wherever they match.
Coordinate format: Position values (pos, escapeLocation) use [x, y, z] array format in YAML, serialized as "x, y, z" string format in XML.
Operation ordering: When combining updateWhere, explicit update, and delete operations in the same spec, updateWhere runs first, then update (which can override), then delete.