Skip to content

Tags#

This is an object of the meta object that contains tags. You can define multiple tags in the same meta object.

Adding custom tags may be useful as you can fetch drafts via tags using Draft.getDrafts("meta tag").

Animation tags#

These are tags that are only supported by animation drafts.

firework#

Used for defining custom fireworks.

alpha#

The direction of the particle(s).

speed#

The speed of a particle(s).

speed variation#

If there should be variation in speed of the particle(s).

n#

The number of particles to spawn.

time#

The duration of the particle(s).

time variation#

If there should be variation in the duration of the particle(s).

next#

The ID of the particle(s) that should spawn after the lifetime of the current particle(s) expired.

{
  "meta": {
    "tags": {
      "firework": {
        "alpha": 0, // float
        "speed": 0, // float
        "speed variation": 0, // float
        "n": 0, // int
        "time": 0, // int
        "time variation": 0, // float
        "next": [{
          "id": "", // animation draft ID
          "p": 1, // float
          "always": false // bool
        }]
      }
    }
  }
}

road occupation#

{
  "meta": {
    "tags": {
      "road occupation": {
        "speed": 1, // float
        "remove flags": 0 // int
      }
    }
  }
}

Building tags#

These are tags that are only supported by building drafts.

build rail#

Used to prebuild rails and metro lines for elevated trains and metro. 

{
  "meta": {
    "tags": {
      "build rail": {
        "id": "", // rail or road ID
        "offsets": [], // optional int array

        // These are only if its a road ID
        "level": 0, // int
        "all": false, // bool
        "dir": 1 // int
      }
    }
  }
}

bus depot#

Whether a building is considered a bus depot.

{
  "meta": {
    "tags": {
      "bus depot": {}
    }
  }
}

decorator#

{
  "meta": {
    "tags": {
      "decorator": {
        "zones": [] // zone ID arr
      }
    }
  }
}

destroyed building#

Whether to consider this building as a replacement for destroyed buildings. If no such drafts are defined, $destroyedtile will be used instead.

{
  "meta": {
    "tags": {
      "destroyed building": {}
    }
  }
}

destroyed building radioactive#

Whether to consider this building as a replacement for radioactive destroyed buildings. If no such drafts are defined, $destroyedtileradioactive00 will be used instead.

{
  "meta": {
    "tags": {
      "destroyed building radioactive": {}
    }
  }
}

destroyed tree#

Whether to consider this building as a replacement for destroyed trees. If no such drafts are defined, $destroyedtile will be used instead.

{
  "meta": {
    "tags": {
      "destroyed tree": {}
    }
  }
}

destroyed tree radioactive#

Whether to consider this building as a replacement for radioactive destroyed trees. If no such drafts are defined, $destroyedtileradioactive00 will be used instead.

{
  "meta": {
    "tags": {
      "destroyed tree radioactive": {}
    }
  }
}

destroyed road#

Whether to consider this building as a replacement for destroyed roads. If no such drafts are defined, $destroyedtile will be used instead.

{
  "meta": {
    "tags": {
      "destroyed road": {}
    }
  }
}

destroyed road radioactive#

Whether to consider this building as a replacement for radioactive destroyed roads. If no such drafts are defined, $destroyedtileradioactive00 will be used instead.

{
  "meta": {
    "tags": {
      "destroyed road radioactive": {}
    }
  }
}

destroyed plain#

Whether to consider this building as a replacement for destroyed wires, rail and fences. If no such drafts are defined, $destroyedtile will be used instead.

{
  "meta": {
    "tags": {
      "destroyed plain": {}
    }
  }
}

destroyed plain radioactive#

Whether to consider this building as a replacement for radioactive destroyed wires, rail and fences. If no such drafts are defined, $destroyedtileradioactive00 will be used instead.

{
  "meta": {
    "tags": {
      "destroyed plain radioactive": {}
    }
  }
}

dsa rocket supplier#

Whether the building is considered a rocket supplier and should spawn supply trucks for the launchpad.

{
  "meta": {
    "tags": {
      "dsa rocket supplier": {}
    }
  }
}

farm field#

{
  "meta": {
    "tags": {
      "farm field": {}
    }
  }
}

metro#

Whether to consider the building as a metro station.

{
  "meta": {
    "tags": {
      "metro": {}
    }
  }
}

metro_station#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

Whether to consider the building as a metro station.

{
  "meta": {
    "tags": {
      "metro_station": {}
    }
  }
}

metro_depot#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

Whether to consider the building as a metro depot where metro cars are dispatched from.

{
  "meta": {
    "tags": {
      "metro_depot": {}
    }
  }
}

freight_train_platform#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

Whether to consider the building as a freight train platform.

{
  "meta": {
    "tags": {
      "freight_train_platform": {}
    }
  }
}

policehelicopter#

{
  "meta": {
    "tags": {
      "policehelicopter": {}
    }
  }
}

railway#

Used to define rail-using station buildings. Levels attribute is used to specify served height levels.

  • Regular railway stations use "levels": [0]
  • Elevated railway stations use "levels": [1]
  • Metro stations use "levels": [-1]
{
  "meta": {
    "tags": {
      "railway": {
        "levels": [0]
      }
    }
  }
}

spawn train#

ID of a train to spawn at this station. $train00 by default.

{
  "meta": {
    "tags": {
      "spawn train": {
        "id": "$train00"
      }
    }
  }
}

Bus stop tags#

These are tags that are only supported by bus stop drafts.

default_busstop#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

{
  "meta": {
    "tags": {
      "default_busstop": {}
    }
  }
}

Car tags#

These are tags that are only supported by car drafts.

airport taxi#

{
  "meta": {
    "tags": {
      "airport taxi": {}
    }
  }
}

carres0#

Used to mark a car draft as a level 1 residential car.

{
  "meta": {
    "tags": {
      "carres0": {}
    }
  }
}

carres1#

Used to mark a car draft as a level 2 residential car.

{
  "meta": {
    "tags": {
      "carres1": {}
    }
  }
}

carres2#

Used to mark a car draft as a level 3 residential car.

{
  "meta": {
    "tags": {
      "carres2": {}
    }
  }
}

carcom0#

Used to mark a car draft as a level 1 commercial car.

{
  "meta": {
    "tags": {
      "carcom0": {}
    }
  }
}

carcom1#

Used to mark a car draft as a level 2 commercial car.

{
  "meta": {
    "tags": {
      "carcom1": {}
    }
  }
}

carcom2#

Used to mark a car draft as a level 3 commercial car.

{
  "meta": {
    "tags": {
      "carcom2": {}
    }
  }
}

carind0#

Used to mark a car draft as a level 1 industrial car.

{
  "meta": {
    "tags": {
      "carind0": {}
    }
  }
}

carind1#

Used to mark a car draft as a level 2 industrial car.

{
  "meta": {
    "tags": {
      "carind1": {}
    }
  }
}

carind2#

Used to mark a car draft as a level 3 industrial car.

{
  "meta": {
    "tags": {
      "carind2": {}
    }
  }
}

car hearse#

Used to mark a car draft as a hearse car.

{
  "meta": {
    "tags": {
      "car hearse": {}
    }
  }
}

fire brigade#

Used to mark a car draft as a fire brigade car.

{
  "meta": {
    "tags": {
      "fire brigade": {}
    }
  }
}

garbage#

Used to mark a car draft as a garbage truck.

{
  "meta": {
    "tags": {
      "garbage": {}
    }
  }
}

idle bus#

{
  "meta": {
    "tags": {
      "idle bus": {}
    }
  }
}

ts_normal_bus#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

Whether to consider the vehicle as a bus that is used in the bus system.

{
  "meta": {
    "tags": {
      "ts_normal_bus": {}
    }
  }
}

medic#

Used to mark a car draft as a medic car.

{
  "meta": {
    "tags": {
      "medic": {}
    }
  }
}

military truck#

Used to mark a car draft as a military truck.

{
  "meta": {
    "tags": {
      "military truck": {}
    }
  }
}

police#

Used to mark a car draft as a police car.

{
  "meta": {
    "tags": {
      "police": {}
    }
  }
}

swat#

Used to mark a car draft as a swat car.

{
  "meta": {
    "tags": {
      "swat": {}
    }
  }
}

Feature tags#

consumable#

{
  "meta": {
    "tags": {
      "consumable": {}
    }
  }
}

Road tags#

These are tags that are only supported by road drafts.

airport lane#

{
  "meta": {
    "tags": {
      "airport lane": {}
    }
  }
}

metro#

Whether to consider the road as a metro line.

{
  "meta": {
    "tags": {
      "metro": {}
    }
  }
}

Road decoration tags#

These are tags that are only supported by road decoration drafts.

car accident#

Whether the road decoration is considered to be a car accident.

{
  "meta": {
    "tags": {
      "car accident": {}
    }
  }
}

Train car tags#

These are tags that are only supported by train car drafts.

short_distance_passenger_train#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

{
  "meta": {
    "tags": {
      "short_distance_passenger_train": {}
    }
  }
}

long_distance_passenger_train#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

{
  "meta": {
    "tags": {
      "long_distance_passenger_train": {}
    }
  }
}

freight_train#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

{
  "meta": {
    "tags": {
      "freight_train": {}
    }
  }
}

heavy_freight_train#

Unstable

This feature is part of the ongoing transport update and may be subject to change in the future.

{
  "meta": {
    "tags": {
      "heavy_freight_train": {}
    }
  }
}

Tree tags#

These are tags that are only supported by tree drafts.

ranger tree#

Whether the tree can be spawned by the Forester's Lodge.

{
  "meta": {
    "tags": {
      "ranger tree": {}
    }
  }
}

Tags supported by all drafts#

These are tags that are supported by all drafts, regardless of their type.

budget item#

Used to create a new budget item that shows up in the financials menu.

See budget item attribute for how it can be referenced from a building.

{
  "meta": {
    "tags": {
      "budget item": {}
    }
  }
}

console#

Used to implement a console command with a draft. Multiple commands can be defined.

{
  "meta": {
    "tags": {
      "console": {
        "commands": {
          "mycustomcommand1": {
            // Fun actions and conditions
            "condition": {...},
            "actions": [
              {"type": "feedback", "id": "Condition ok"},
            ],
            "else actions": [
              {"type": "feedback", "id": "Condition not ok"}
            ]
          },
          "mycustomcommand2": {
            // Fun actions and conditions
            "condition": {...},
            "actions": [
              {"type": "feedback", "id": "Condition ok"},
            ],
            "else actions": [
              {"type": "feedback", "id": "Condition not ok"}
            ]
          }
        }
      }
    }
  }
}

tool#

{
  "meta": {
    "tags": {
      "tool": {
        "marker": "" // any of the following: 'pipe', 'water', 'power', 'traffic', 'density', 'happiness', 'level'
      }
    }
  }
}