CCG/Kinds

This should be merged into Content Configuration.

Chapter 2: Introduction to Kinds, Containers, Tags, and Config.txt files

KINDS

Trainz recognises a number of Kinds of assets. Each Kind has different attributes, allowing different asset functions and behaviour to be used in the simulator.

In creating a new asset, a suitable Kind must be chosen. The following is a list of all the Kinds that may be created in TC, with a brief description.

Activity

An activity is a scripted scenario, that details the locomotives and rollingstock used in a map, the driver settings, commands and scripts. A train driver can undertake a sequence of planned moves – a scenario.

Behavior

A configurable behavior module that forms part of a session.

Bogey

Bogeys are locomotive or rolling stock wheel mechanisms, sometimes known as ‘Trucks’. This asset is for attachment to a traincar (locomotive or rollingstock) and can include animation and a shadow model.

Bridge

Road or rail bridges and similar assets, as variable length splines. The bridge kind may include initiator and terminator segments, and shadows. The height and gradient of the bridge spline may be varied in Surveyor.

Buildable

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

Chunky-Track

Track and rails for Trains (the common flexi-track), by defining the cross section shape and properties of the track. It uses a texture file but does not require a 3dsmax or gmax mesh model.

Double-Track

Track splines that may place two or more tracks as one model, by specifying the track spacings to be used.

DriverCharacter

The locomotive driver character. This specifies the picture icon that appears in Driver for the engine driver.

DriverCommand

A command for the train driver to accomplish a specific task.

Engine

An engine specification for locomotives and rollingstock, which defines the detailed performance requirements; including throttle requirements, engine and braking performance

EngineSound

An engine sound specification, detailing the locomotive engine sound files, referenced by the enginesound tag in a traincar kind.

Environment

Additional sky textures, specifying the normal, night and stormy sky images to be used in Trainz

FixedTrack

A fixedtrack asset can be likened to a model trains sectional track system. The models may be straight or curved and snap into position when moved onto another track in Surveyor.

GroundTexture

A ground texture is tiled in Surveyor to color and cover the base grid. It can optionally reference a low polygon mesh and insert the mesh automatically as the ground is painted.

HornSound

A traincar horn sound, referenced by the hornsound tag in a traincar config.txt file. It references the various sound file to be used.

Html-Asset

An html-asset example is the ingame tutorial. The config.txt file references one or more .html pages. The html-asset can be referenced from scripts and from some of the Surveyor rules

Industry

A scenery asset with product processing functionality. Industry assets interact with compatible rolling stock assets through their script file and asset triggers. An Industry asset supports product queues and attached track

Interior

A traincar interior asset. It allows the interior mesh model to be defined, and may have attached levers and controls to operate a locomotive in cab mode. It also creates an interior for rolling stock.

Library

Coded modules that interact with other coded modules.

Mesh

A mesh that is never referenced through Surveyor panels, but referenced from another asset. It could be referenced through the preview-mesh-kuid tag or as a kind attachment effect, like the red arrows used on fixed-track assets.

Mesh-Reducing-Track

Mesh-Reducing-Track is used to create poly efficient splines. The asset consists of a short high detailed mesh and a longer less detailed mesh, based on the same object. The short mesh is displayed when the camera is close to the asset whilst the long mesh is shown when less detail is required, when the viewpoint is further away.

MOCrossing

Combined rail and road crossings, that reacts to trains or script control. This allows animation, special lighting effects and attachment points for rail track and roads.

MOJunction

Junction control levers, which are attached to track junctions, include sound, and may be offset a specified distance from the track. They can be used to replace the default junction lever.

MOSignal

A train signal with lights (coronas). It specifies the aspects the signal is capable of displaying, the light points activated when each state is displayed, and the corona details. The signal may be offset a specified distance from the track.

MOSpeedBoard

A Speed limit sign for Trains. It displays the maximum limit (sign texture made by the creator) and the sign may be offset a specified distance from the track. The limit to control train speed is specified in the asset in metres per second.

Paintshed-Skin

A reskin texture for a locomotive or rolling stock asset.

Paintshed-Template

A template for particular locomotives and rolling stock that may be used in the integrated Paintshed utility. The template may be painted in different colour schemes

Pantograph

The animated mechanisms on the roof of electric locomotives that conduct electricity from the catenary (wires) above. It is referenced by the pantograph tag in a traincar config.txt file.

Product

An individual product (commodity) that Trainz compatible rolling stock and industry assets are able to process. It specifies the type, unit of measurement and the picture icon that displays the product in the simulator. Produce and materials are product examples.

Product-Category

A category class of products (commodities) that Trainz compatible rolling-stock and industry assets are able to process. It specifies the type, unit of measurement and the picture icon that displays the category on Surveyor or Driver. Bulk, liquid, passengers and containers are product category examples.

Profile

A Profile is known as a Session in Trainz. This kind creates a session defining a single route with different consists, starting points, and industry outputs. Different sets of trains may be used in each different session.

Region

A region is chosen in Surveyor to create a new map or route. This Kind creates a new region in addition to the in-built regions, such as Australia or USA for example. The region can define geographical location, road traffic and weather conditions.

Scenery

A basic scenery asset, that supports night lighting, smoke (particle) effects, sound and animation. It is height adjustable and forms the majority of map objects used.

Scenery-Trackside

A special scenery asset, attached to rail track, with the offset distance from the track specified in the asset. Examples could include a signal box, or dummy track sign or track object.

Steam-Engine

The special engine specification for steam locomotives, which defines the detailed performance requirements, including throttle settings, engine and braking performance, and boiler capacity and steam attributes.

Texture

A simple texture as an asset that can be referenced from another asset for example, a custom corona, by reference to its kuid.

Texture-Group

Defines a group of textures as an asset that can be referenced from another asset or via scripting.

Track

Variable length spline based track, roads, and other scenery items. Tracks may include initiator and terminator segments, and are height adjustable. Other examples include fences, power lines and hedges.

TrackSound

A sound asset that is referenced by track or bogeys to play a different sound from the default track/train sound (for example, when a train travels over a bridge or through a tunnel).

Traincar

A locomotive or rolling stock item. A traincar specifies the dependant assets (bogey, engine sound, engine specification, pantograph and interior), to make a complete traincar asset.

Tunnel

Road and rail tunnel variable length splines. These allow the spline to be placed below ground and usually require an integrated initiator and termination mesh as a tunnel entrance.

TurnTable

A turntable asset for moving or rotating traincars, specifying the static and moving part of the turntable. Animated rotation (turntable) and lateral translation (transfer table) assets are supported.

Water2

Animated water texture assets.

There is two additional Kinds that are used by Trainz, but may not be created from within Content Creator Plus (CCP):

Map Kind

A map kind needs a number of files to be created when saving from Surveyor. This is not possible from within CCP. However, a Map Kind created in Surveyor may be edited in CCP, for instance, to add specific car Kuids to the Map file. These cars will then be mixed with the default in-built cars on roads in the map.

Displacements

This is a special Kind that is not created in CCP as it does not require a config.txt file. Displacement maps are used to create the differing height/depth and shape of an area of terrain, based on shades of grey in a .bmp file.

The graphic file is placed in the Displacements directory under the installed Custom directory in Trainz. This is the only instance where the Custom directory is used in TC.