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 to consider the building as bus depot for the idle game (old bus system).

bus_depot#

Whether a building is considered a bus depot in the new bus system.

Added in version 1.12.28

bus_platform#

Whether to consider the building as a bus platform.

Added in version 1.12.28

bus_station#

Whether to consider the building as bus station in the new bus system.

Added in version 1.12.28

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.

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.

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.

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.

destroyed road#

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

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.

destroyed tree#

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

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.

dsa rocket supplier#

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

elevated_train_platform#

Whether to consider the building as an elevated train platform.

Added in version 1.12.28

elevated_train_station#

Whether to consider the building as an elevated train station.

Added in version 1.12.28

farm field#

freight_train_platform#

Whether to consider the building as a freight train platform.

Added in version 1.12.28

freight_train_station#

Whether to consider the building as a freight train station.

Added in version 1.12.28

heavy_freight_train_station#

Whether to consider the building as a heavy freight train station.

Added in version 1.12.28

long_distance_passenger_train_station#

Whether to consider the building as a long distance passenger train station.

Added in version 1.12.28

metro#

Whether to consider the building as a metro station. This will affect the rendering in the UI.

metro_depot#

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

Added in version 1.12.28

metro_platform#

Whether to consider the building as a metro platform.

Added in version 1.12.28

metro_station#

Whether to consider the building as a metro station.

Added in version 1.12.28

monorail_platform#

Whether to consider the building as a monorail platform.

Added in version 1.12.29

monorail_station#

Whether to consider the building as a monorail station.

Added in version 1.12.29

passenger_train_platform#

Whether to consider the building as a passenger train platform.

Added in version 1.12.28

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]
      }
    }
  }
}

short_distance_passenger_train_station#

Whether to consider the building as a short distance passenger train station.

Added in version 1.12.28

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.

bus_busstop#

Whether to consider the bus stop as a station that is used in the new bus system.

Added in version 1.12.29

default_busstop#

Whether to consider the bus stop as a station that is used in the new bus system.

Added in version 1.12.28

Deprecated

Superseded by bus_busstop.

elevated_train_busstop#

Whether to consider the bus stop as a station that is used in the elevated train system.

Added in version 1.12.28

metro_busstop#

Whether to consider the bus stop as a station that is used in the metro system.

Added in version 1.12.29

monorail_busstop#

Whether to consider the bus stop as a station that is used in the monorail system.

Added in version 1.12.29

passenger_train_busstop#

Whether to consider the bus stop as a station that is used in the passenger train system.

Added in version 1.12.28

Car tags#

These are tags that are only supported by car drafts.

airport taxi#

Identifies the car as an airport taxi car.

car hearse#

Identifies the car as a hearse car.

carcom0#

Identifies the car as a level 1 commercial car.

carcom1#

Identifies the car as a level 2 commercial car.

carcom2#

Identifies the car as a level 3 commercial car.

carind0#

Identifies the car as a level 1 industrial car.

carind1#

Identifies the car as a level 2 industrial car.

carind2#

Identifies the car as a level 3 industrial car.

carres0#

Identifies the car as a level 1 residential car.

carres1#

Identifies the car as a level 2 residential car.

carres2#

Identifies the car as a level 3 residential car.

fire brigade#

Identifies the car as a fire brigade car.

garbage#

Identifies the car as a garbage truck car.

idle bus#

Identifies the car as a bus car that can be used in the idle game (old bus system).

medic#

Identifies the car as a medic car.

military truck#

Identifies the car as a military truck car.

police#

Identifies the car as a police car.

swat#

Identifies the car as a swat car.

ts_normal_bus#

Identifies the car as a bus car that is used in the new bus system.

Added in version 1.12.28

Feature tags#

These are tags that are only supported by feature drafts.

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. This will affect the budget accounting and rendering in the UI.

{
  "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.

Train car tags#

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

elevated_train#

Identifies the train car as an elevated train.

Added in version 1.12.28

freight_train#

Identifies the train car as a freight train.

Added in version 1.12.28

heavy_freight_train#

Identifies the train car as a heavy freight train.

Added in version 1.12.28

long_distance_passenger_train#

Identifies the train car as a long distance passenger train.

Added in version 1.12.28

metro_train#

Identifies the train car as a metro train.

Added in version 1.12.28

monorail_train#

Identifies the train car as an monorail train.

Added in version 1.12.29

short_distance_passenger_train#

Identifies the train car as a short distance passenger train.

Added in version 1.12.28

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'
      }
    }
  }
}