CCG/Buildable

KIND: BUILDABLE

Description

A variant of Kind Scenery, with similar attributes, but allowing attached track to be used as part of the model. Does not support processes, as used in a Kind Industry.

Container Structure

A well formed buildable kind has the following container structure:

See Chapter 7 for an example asset of this kind.

A TYPICAL ASSET OF THIS KIND MAY HAVE THE FOLLOWING TAGS:

kuid                   kuid
trainz-build           data
category-class         data
category-region        data
category-era           data
username               data
kind                   "buildable"
mesh-table
default
mesh                   file
auto-create            data
attached-track         track_0
track                  kuid
vertices
0                      data
1                      data
kuid-table
0                      kuid
thumbnails
0
image                  file
width                  data
height                 data

TAGS AND CONTAINERS

The following tags are further defined in Chapter 5:

kuid: Generated automatically by CCP.

trainz-build: Automatically set to 2.9 for 2009 assets.

category-class: Should be "BB - Buildable (Kind Buildable)" See the "Buildings & Structures" section of the Category Class.

category-region: See Category Region for a list of valid category-region values.

category-era: See Category Era for a list of valid category-era values.

username: Asset username. This will be the name that appears in the surveyor menu.

kind: Must be "buildable".

mesh-table: Default - Contains the default mesh. Auto-create should be set to true in order to make the mesh visible.

Additional Containers

As well as containing all of the common tags and containers detailed in Chapter 5 , the buildable kind also contains additional containers and tags that are specialised to the requirements of the kind.

attached-track Container

Auto-generated spline track. Generated through attachment points located within the default mesh. Attached-tracks update automatically to the spline track connected to it in Surveyor. You may over-ride this auto-update feature by adding useadjoiningtracktype 0 below.

Note: Correct track end attachment orientation is essential. The Y axis must point 'out' at the correct angle. The Z axis must point 'up' - refer to Page 75.

The attached-track Container has the following tags and containers:

track: Kuid of the track to be used.

useadjoiningtracktype: Indicates whether the track type should change to match that of the first track joined to the object.

vertex: Attachment points at which to place track.

attached-trigger Container

A Trigger is a point along an attached track with a specified radius. When a compatible rollingstock item enters this radius it triggers a set of commands, controlled through its script. A trigger is setup in an industries or buildable config.txt.

The attached-trigger Container has the following tags:

att: The attachment point (stored in the mesh file) to place the trigger.

radius: Radius (in meters) of the trigger.

track: The track name which the train must be on to trigger.

Consists Container

The consists tag stores information on consists that can be generated by the industry.

The consists Container has the following Tags:

show-in-consist-menu: Boolean flag that dictates whether the train appears in the consist menu (0 - false, 1 - true). The consist menu was along the bottom of the screen in the original Trainz and UTC but is no longer present. It effectively stopped a user from getting access to an AI train. Redundant for most uses except for legacy/scenario usage.

coupling-mask: Coupling mask that applies to the consist. 0 will block off all coupling activity while "1" will mean you can couple with a vehicle.

decoupling-mask: Decoupling mask that applies to the consist. 0 will mean you can't decouple vehicles in the train while 1 means you can decouple vehicles.

Consist Element (Consist subcontainer)

vehicle: The kuid of the vehicle to be used.

facing: Indicates the direction of the vehicle.

running-number: Running number of the vehicle.

kuid-table: The kuid of the track\road used in the asset should be present here, as should those of any other referenced assets.

Additional Tags

passenger-height: Used when making a station. Indicates the height of the platform on which the passengers stand.

THIS KIND SUPPORTS THE FOLLOWING:

CONTAINERS: queues Container, Smoke Container, SoundScript Container, Mesh Table, Attached Track Container, Attached Trigger Container, String Table, Chinese String, Table, Czech String Table, Dutch String Table, French String Table, German String Table, Italian String Table, Polish String Table, Russian String Table, Spanish String Table, KUID Table, Obsolete Table, Thumbnails, Privileges, Extensions, Consists Container.

TAGS: kuid, trainz-build, category-class, category-region, category-era, username, kind, alias, author, autoname, category-keyword, class, contact-email, contact-website, description, description-cn, description-cz, description-de, description-es, description-fr, description-it, description-nl, description-pl, description-ru, dighole, floating, height-range, icon-texture, icon0, icon1, icon2, icon3, license, light, nightmode, organisation, passenger-height, preview-mesh-kuid, preview-scale, rgb, rollstep, rotate, rotate-yz-range, rotstep, script, snapgrid, snapmode, surveyor-name-label, surveyor-only, username-cn, username-cz, username-de, username-es, username-fr, username-it, username-nl, username-pl, username-ru.

Return to CCG Index

Content Creator's Guide

CCG/Buildable

Contents