Trainz/Kinds/kind buildable

From Wikibooks, open books for an open world
< Trainz‎ | Kinds
Jump to navigation Jump to search


[e ]
KINDs (type asset groups)
and containers


Kind Buildable[edit]

KIND buildable is a variant of kind SceneryWithTrack, and may be used in place of a normal scenery item where buildable or attached-track mechanisms are required. It does not support industry processes; kind Industry should be used for that purpose.

  • Buildable kinds are mesh-array indexed to display a varying state of appearances as time passes, which the content creator controls and specifies. Such meshes can also be animated and when appropriate, script controlled.
  • Some content creators have used kind buildable with scripting and triggers to show more than one position, for example as in the junctions in the TRS2006 monorail project modeling Disney's monorail.

Parent Classes[edit]

Child Classes[edit]


Supported Tags[edit]

kind Buildable supports all of the kind SceneryWithTrack tags, and adds the following tags. Each tag is shown here with its default value.

 building-cost
 {
   duration 0
 }


duration - The duration (real-time seconds) over which an instance of this asset is built once instructed to begin building.


Asset Configuration[edit]

A kind Buildable asset provides additional functionality extending kind SceneryWithTrack if, and only if, a mesh-table entry named 'potential' exists. If this mesh-table entry does not exist, the asset is treated as a regular kind SceneryWithTrack. The documentation on this asset type describe the scenario where the 'potential' mesh exists.

A kind Buildable asset should contain the following named entries in its mesh-table:

  • 'potential'
  • 'building-0'
  • 'building-N' (where N represents each consecutive integer.)
  • 'default'

The meshes should not be configured to auto-create.

When initially placed, instances of this asset type will show using their 'potential' mesh. While building, the mesh will step through the appropriate 'building-N' meshes over the build duration. Upon completion, the 'default' mesh is displayed.

By default, the user can access 'Build' and 'Cancel' commands through the Driver RMB contextual menu. Access to these commands can be limited via script. Canceling a build reverts the instance to the fully unbuilt state.