Zone-Profile

Zones (formerly Territories) are pre-defined locations in the game world that can be used to control what encounters are allowed to spawn and when. Zone Profiles do not attach to SpawnGroups or any other profile.

Here is an example of how a Zone is defined:

<?xml version="1.0"?>
<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <EntityComponents>

    <EntityComponent xsi:type="MyObjectBuilder_InventoryComponentDefinition">
      <Id>
        <TypeId>Inventory</TypeId>
        <SubtypeId>MES-Zone-PirateZone</SubtypeId>
      </Id>
      <Description>

        [MES Zone]

        [PublicName:Pirate Space]

        [Active:true]
        [Persistent:true]
        [Strict:true]

        [Coordinates:{X:1 Y:1 Z:1}]
        [Radius:25000]

      </Description>

    </EntityComponent>

  </EntityComponents>
</Definitions>

Below are the types of tags you can include in your Zone Profile:

Tag:                                Active
Tag Format: [Active:Value]
Description: This tag specifies if the Zone should be active in the game world or not.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                Persistent
Tag Format: [Persistent:Value]
Description: This tag determines if a Zone should persist in the game world between saves, reloads, etc.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                Strict
Tag Format: [Strict:Value]
Description: This tag determines if encounters must be able to spawn in this zone in order to spawn at all.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                NoSpawnZone
Tag Format: [NoSpawnZone:Value]
Description: This tag determines if the Zone should be considered a No Spawn Zone, preventing any type of encounter from spawning.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                PublicName
Tag Format: [PublicName:Value]
Description: This tag determines the name the Zone will use with the Spawner. You'll use this to link Zones to your Zone Conditions Profiles.
Allowed Values: Any Name
Default Value(s): N/A
Multiple Tag Allowed: No
Tag:                                Coordinates
Tag Format: [Coordinates:Value]
Description: This tag determines the exact location of the center of this Zone.
Allowed Values: Vector3D Coordinates
eg: {X:0 Y:0 Z:0}
Default Value(s): {X:0 Y:0 Z:0}
Multiple Tag Allowed: No
Tag:                                CoordinateRadiusPairs
Tag Format: [CoordinateRadiusPairs:Coordinates, Radius]
Description: This tag allows for defining more zone centers, with their associated radii. This only supports world coordinates - not planet-relative setups.
Allowed Values: Vector3D Coordinates
eg: {X:0 Y:0 Z:0}
Double Radius
eg: 1000
Default Value(s): N/A
Multiple Tag Allowed: Yes
Tag:                                Radius
Tag Format: [Radius:Value]
Description: This tag determines the radius distance from the Zone center coordinates.
Allowed Values: Any Number Greater Than0
Default Value(s): 0
Multiple Tag Allowed: No
Tag:                                PlanetaryZone
Tag Format: [PlanetaryZone:Value]
Description: This tag determines if a zone should be dynamically calculated based on provided planetary details.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                PlanetName
Tag Format: [PlanetName:Value]
Description: This tag determines the name of the planet that the Zone will be created on.
Allowed Values: Any Planet Name
Default Value(s): N/A
Multiple Tag Allowed: No
Tag:                                Direction
Tag Format: [Direction:Value]
Description: This tag determines the direction from the center of the planet that the Zone is created at. If a direction is provided, then the Zone center will be at the surface location nearest to the direction provided. If no direction is provided, then the center of the planet is instead used for the Zone center.
Use the /MES.Info.GetLocationMatrix chat command to get the direction vector at your current player position.
Allowed Values: Vector3D Coordinates
eg: {X:0 Y:0 Z:0}
Default Value(s): {X:0 Y:0 Z:0}
Multiple Tag Allowed: No
Tag:                                HeightOffset
Tag Format: [HeightOffset:Value]
Description: This tag determines the height offset from the planet surface if aDirection tag is provided.
Use the /MES.Info.GetLocationMatrix chat command to get the height offset at your current player position.
Allowed Values: Any Number
Default Value(s): 0
Multiple Tag Allowed: No
Tag:                                UseAllowedFactions
Tag Format: [UseAllowedFactions:Value]
Description: This tag determines if the Zone should only allow encounters from certain factions to spawn within it.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                AllowedFactions
Tag Format: [AllowedFactions:Value]
Description: This tag determines the Factions that are allowed to spawn within the Zone if using theUseAllowedFactions tag.
Allowed Values: Any Faction Tag
Default Value(s): N/A
Multiple Tag Allowed: Yes
Tag:                                UseRestrictedFactions
Tag Format: [UseRestrictedFactions:Value]
Description: This tag determines if the Zone should not allow encounters from certain factions to spawn within it.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                RestrictedFactions
Tag Format: [RestrictedFactions:Value]
Description: This tag determines the Factions that are not allowed to spawn within the Zone if using theUseRestrictedFactions tag.
Allowed Values: Any Faction Tag
Default Value(s): N/A
Multiple Tag Allowed: Yes
Tag:                                UseAllowedSpawnGroups
Tag Format: [UseAllowedSpawnGroups:Value]
Description: This tag determines if only a list of specific SpawnGroups should only be allowed to spawn in this Zone.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                AllowedSpawnGroups
Tag Format: [AllowedSpawnGroups:Value]
Description: This tag determines which SpawnGroups are allowed to spawn inside this Zone.
Allowed Values: Any SpawnGroup SubtypeID
Default Value(s): N/A
Multiple Tag Allowed: Yes
Tag:                                UseRestrictedSpawnGroups
Tag Format: [UseRestrictedSpawnGroups:Value]
Description: This tag determines if certain SpawnGroups should not be allowed to spawn while in this Zone.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                RestrictedSpawnGroups
Tag Format: [RestrictedSpawnGroups:Value]
Description: This tag determines which SpawnGroups are not allowed to spawn inside this Zone.
Allowed Values: Any SpawnGroup SubtypeID
Default Value(s): N/A
Multiple Tag Allowed: Yes
Tag:                                UseAllowedModIDs
Tag Format: [UseAllowedModIDs:Value]
Description: Whentrue, only SpawnGroups from mods listed in AllowedModIDs may spawn while the spawn position is inside this zone. This does not prevent those mods from spawning outside the zone. Note: this feature is only available for Steam workshop mods.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                AllowedModIDs
Tag Format: [AllowedModIDs:Value]
Description: Workshop mod published file IDs allowed to spawn inside this zone whenUseAllowedModIDs is true. Multiple tags or comma-separated values are supported. Note: this feature is only available for Steam workshop mods.
Allowed Values: Any workshop mod published file ID (ulong)
Default Value(s): N/A
Multiple Tag Allowed: Yes
Tag:                                UseRestrictedModIDs
Tag Format: [UseRestrictedModIDs:Value]
Description: Whentrue, SpawnGroups from mods listed in RestrictedModIDs are blocked while the spawn position is inside this zone. This does not block those mods outside the zone. If a mod is both allowed and restricted at the same position, restriction wins. Note: this feature is only available for Steam workshop mods.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                RestrictedModIDs
Tag Format: [RestrictedModIDs:Value]
Description: Workshop mod published file IDs blocked from spawning inside this zone whenUseRestrictedModIDs is true. Multiple tags or comma-separated values are supported. Note: this feature is only available for Steam workshop mods.
Allowed Values: Any workshop mod published file ID (ulong)
Default Value(s): N/A
Multiple Tag Allowed: Yes
Tag:                                UseZoneAnnounce
Tag Format: [UseZoneAnnounce:Value]
Description: This tag determines if players should receive an alert if they enter or leave this Zone.
Allowed Values: truefalse
Default Value(s): false
Multiple Tag Allowed: No
Tag:                                ZoneEnterAnnounce
Tag Format: [ZoneEnterAnnounce:Value]
Description: This tag determines the message players will receive when they enter this Zone.
Allowed Values: Any Message
Default Value(s): N/A
Multiple Tag Allowed: No
Tag:                                ZoneLeaveAnnounce
Tag Format: [ZoneLeaveAnnounce:Value]
Description: This tag determines the message players will receive when they leave this Zone.
Allowed Values: Any Message
Default Value(s): N/A
Multiple Tag Allowed: No
Tag:                                RequiredSandboxBool
Tag Format: [RequiredSandboxBool:Value]
Description: This tag allows you to specify the name of a Sandbox Boolean that must betrue in order for this zone to be Active.
Allowed Value(s): Any Sandbox Boolean Name
Default Value(s): N/A
Multiple Tags Allowed: No
Tag:                                RequiredFalseSandboxBool
Tag Format: [RequiredFalseSandboxBool:Value]
Description: This tag allows you to specify the name of a Sandbox Boolean that must befalse in order for this zone to be Active.
Allowed Value(s): Any Sandbox Boolean Name
Default Value(s): N/A
Multiple Tags Allowed: No