TrainzOnline - User contributions [en]

CCG/MOSpeedBoard config

2010-04-07T05:52:24Z

Windwalkr (legacy 2550):

This should be merged into [[KIND MOSpeedboard]].

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

'''KIND: MOSPEEDBOARD'''

This is a speed limit sign.

Config.txt:
kuid <KUID2:####:#####:1>
kind mospeedboard
trackside -2.5
speedlimit 5.56
username
description " "
trainz-build 2.5
category-class “WS”
category-region “AU”
category-era “2000s”

'''Breakdown:'''

;trackside
:This is a value that is the distance in meters the object is placed relative to the center of the track. Negative values will put the object on the left side of the track, and positive values will appear on the right.
;Speedlimit
:This value is the maximum speed allowed in meters per seconds.

''To convert miles per hour to meters per second multiply by a conversion factor of 0.447. e.g. 10mph is 4.47 m/s.''

''To convert kilometers per hour to meters per second multiply by a conversion factor of 0.278. e.g. 10kph is 2.78m/s.''

CCG/Kinds

2010-04-07T05:51:48Z

Windwalkr (legacy 2550):

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 [[Content Creator Plus|CCP]]. However, a Map Kind created in Surveyor may be edited in [[Content Creator Plus|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 [[Content Creator Plus|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.

Mesh-table

2010-03-25T09:42:18Z

Windwalkr (legacy 2550):

This page is a duplicate and not in the correct format. Any additional information should be merged into the [["mesh-table" container]] page and this page should be removed.

This is the new and preferred method of asset mesh placement for most mesh asset types. It gives flexibility and control for mesh placement and animations.

As of TC 2, there are some asset types that cannot use a mesh-table. These include all Bridges, Tunnels, Rails, Pantographs and other Spline Objects (eg. Fences or Catenaries).

===Example Mesh Table===
mesh-table
{
default
{
mesh industry.lm
anim anim.kin
animation-loop-speed 1.0
auto-create 1
effects
{
0
{
[[kind name]]
fontsize 0.15
fontcolor 30,30,30
att a.name0
name name
}
1
{
[[kind corona]]
att a.coronawhite
frequency 1
directional 0
texture-kuid <KUID:-3:10111>
}
}
}
default-night
{
mesh nightwindows/nightwindows.im
night-mesh-base default
}
attachedanimation
{
mesh subdirectoryname/meshname.im
anim subdirectoryname/animname.kin
auto-create 1
att a.pointname
att-parent default
animation-loop-speed 1.0
}
}

===default===
Default is the ‘main’ mesh of the asset.

===mesh===
The ‘main’ mesh name. This may include a sub-path;
ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.

Use .im files exported from 3dsmax (as opposed to .pm.) or reference an .lm file if you wish your asset to have ‘Level of Detail’ mesh reduction. A pantograph model still requires a .pm file.

Level of detail is a process of using different model meshes, depending on how far the viewer is from the model. A finer mesh is used for close up viewing in Trainz.

===anim===
The animation file (.kin) exported from 3dsmax. This may include a sub-path.

===animation-loop-speed===
This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax.

===auto-create 1===
The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.

===default-night===
‘Main’ night window mesh on scenery and industry and traincar assets. Modeled to the same 3d space as the default mesh and is inserted at the default mesh origin.

===night-mesh-base default===
This night mesh is linked to the default mesh and is visible only at night. It is invisible if the ‘default’ mesh is invisible, (if the auto-create 0 line were used so the default mesh can be controlled by script).

===att===
The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).

===att-parent name===
The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.

Mesh-table

2010-03-25T09:42:04Z

Windwalkr (legacy 2550):

<font=red>This page is a duplicate and not in the correct format. Any additional information should be merged into the [["mesh-table" container]] page and this page should be removed.

This is the new and preferred method of asset mesh placement for most mesh asset types. It gives flexibility and control for mesh placement and animations.

As of TC 2, there are some asset types that cannot use a mesh-table. These include all Bridges, Tunnels, Rails, Pantographs and other Spline Objects (eg. Fences or Catenaries).

===Example Mesh Table===
mesh-table
{
default
{
mesh industry.lm
anim anim.kin
animation-loop-speed 1.0
auto-create 1
effects
{
0
{
[[kind name]]
fontsize 0.15
fontcolor 30,30,30
att a.name0
name name
}
1
{
[[kind corona]]
att a.coronawhite
frequency 1
directional 0
texture-kuid <KUID:-3:10111>
}
}
}
default-night
{
mesh nightwindows/nightwindows.im
night-mesh-base default
}
attachedanimation
{
mesh subdirectoryname/meshname.im
anim subdirectoryname/animname.kin
auto-create 1
att a.pointname
att-parent default
animation-loop-speed 1.0
}
}

===default===
Default is the ‘main’ mesh of the asset.

===mesh===
The ‘main’ mesh name. This may include a sub-path;
ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.

Use .im files exported from 3dsmax (as opposed to .pm.) or reference an .lm file if you wish your asset to have ‘Level of Detail’ mesh reduction. A pantograph model still requires a .pm file.

Level of detail is a process of using different model meshes, depending on how far the viewer is from the model. A finer mesh is used for close up viewing in Trainz.

===anim===
The animation file (.kin) exported from 3dsmax. This may include a sub-path.

===animation-loop-speed===
This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax.

===auto-create 1===
The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.

===default-night===
‘Main’ night window mesh on scenery and industry and traincar assets. Modeled to the same 3d space as the default mesh and is inserted at the default mesh origin.

===night-mesh-base default===
This night mesh is linked to the default mesh and is visible only at night. It is invisible if the ‘default’ mesh is invisible, (if the auto-create 0 line were used so the default mesh can be controlled by script).

===att===
The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).

===att-parent name===
The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.

Setting Up the Asset.

2010-03-25T09:39:36Z

Windwalkr (legacy 2550):

Now we will examine the creation of a simple scripted asset and will deal with managing messages sent by other objects, with handling animations, corona and name effects and with playing sound files via script. We will be setting up methods to react automatically to events in the Trainz environment and we will be scripting a simple interface to allow the user to edit some of the object's properties.

We will need a simple mesh asset to hang all of this script on and here is the asset we will be using. In case it's difficult for you to tell, this is an engine shed with animated opening doors, a flashing light and a name written on the pediment above. If you want to texture it properly and add windows and drainpipes, be my guest. It will have a roof mesh which can be hidden, so that we can see what is going on inside, and we will be arranging for bells to ring when the doors open.

Since the asset will need attached tracks and a scenery trigger we will make it as a ''kind buildable''. The shed has been designed to suit diesel engines or railcars about twenty metres in length, steam engines with tenders or articulated trams introduce some complications so leave those for later.

The shed is being set up so that an engine can be issued with a ''Drive'' command and sent towards the shed. The doors will open on the train's approach and close as it draws to a halt, all without user intervention. You will need to back out very slowly and under human control.

Here is a diagram of the building with the dimensions that I used to build my version. All of the X dimensions are zero and the width and height of the shed itself are not particularly important as long as there is room for the train. The two helper points above the doors are ''a.corona'' and ''a.name'', you might need to refer to the CCG to get the orientation right for the name effect. 

[[Image:Engine Shed.jpg]] 

You will need to create this, or something similar, in Max and animate the front doors, I used 50 frames. Each door should be linked to its respective dummy and everything else, including the two door dummies themselves, should be linked to b.r.main at the centre of the object. Make sure that ''a.tracka1'' and ''a.tracka3'' are aligned as shown, the alignment of ''a.tracka2'' doesn't matter.

When you have built the main shed you will need to make an entirely separate roof mesh, exported as ''roof.im.''

If you prefer you can [[Media:Tutorial.zip|click on this link]] to download a zip file containing all of the files you will need (except for ''config.txt'' and ''Tutorial.gs'' which you should copy and paste from these pages) The gmax source is also included, although it's not my best model. Unzip the download to a folder on your hard drive, add your .txt and .gs files and drop the folder into CMP.

Here is the config.txt with one or two comments added (which cmp will not allow you to retain).

kuid <ADD YOUR OWN KUID>
username "Engine Shed Tutorial"
kind buildable
trainz-build 2.5

light 1

category-region "00"
category-era "2000s"
category-class "TF"

script Tutorial
class Tutorial

mesh-table {
default {
mesh "shed.im"
anim "shed.kin"
auto-create 1
effects {
corona {
kind corona
att "a.corona"
texture-kuid <kuid:-3:10110>
frequency 2
directional 0
object-size 0.15
}
name {
kind name
fontsize 0.5
fontcolor 160,160,160
att "a.name"
name
}
masonry {
kind "texture-replacement"
texture "brick.texture"
}
}
}
roof {
mesh "roof.im"
auto-create 0
}
}

// There are two attached track segments, the front segment will auto-update when you attach
// your track to it, the second will remain invisible and is only present because trains under
// a drive command will not go to the end of a track. You may need to adjust the position of
// ''a.tracka3'' to get the train to stop in the right place 

attached-track {
track1 {
track <kuid:-10:137>
useadjoiningtracktype 1
vertices {
0 "a.tracka1"
1 "a.tracka2"
}
}
track2 {
track <kuid:-10:137>
useadjoiningtracktype 0
vertices {
0 "a.tracka2"
1 "a.tracka3"
}
}
}

// This is the trigger which detects the approaching train. Since it has a ''track'' assignment
// it will ignore trains on any parallel tracks in the same object. You will find this a useful
// device if you decide to turn this into a multi track shed.

attached-trigger {
trigger1 {
att "a.tracka1"
radius 25
track "track1"
}
}

Once you have all of this done create a script file called ''Tutorial.gs'' and add the following code. This does nothing other than turning off the corona. We will be adding to it in steps.

include "Buildable.gs"

class Tutorial isclass Buildable {

public void Init(void) {
inherited();
SetFXCoronaTexture("corona",null);
}

};

Now you should load the asset via CMP, commit it and make sure that it is error free and shows up correctly in the game. Don't worry that the roof is invisible, this is by design.

When working with script it's usually advisable to add short sections of code and test them out thoroughly. Even though it will mean frequently restarting Trainz, it will be quicker to do this in the end. There are very few facilities for debugging and you can be reasonably sure that any errors or problems that you find will be connected to the last change you made. Don't forget to check the compilation before restarting Trainz, this will save you a lot of aggravation. 
Next Tutorial: [[Automating Animations.]]

Mesh-table

2010-03-25T09:38:19Z

Windwalkr (legacy 2550):

This is the new and preferred method of asset mesh placement for most mesh asset types. It gives flexibility and control for mesh placement and animations.

As of TC 2, there are some asset types that cannot use a mesh-table. These include all Bridges, Tunnels, Rails, Pantographs and other Spline Objects (eg. Fences or Catenaries).

===Example Mesh Table===
mesh-table
{
default
{
mesh industry.lm
anim anim.kin
animation-loop-speed 1.0
auto-create 1
effects
{
0
{
[[kind name]]
fontsize 0.15
fontcolor 30,30,30
att a.name0
name name
}
1
{
[[kind corona]]
att a.coronawhite
frequency 1
directional 0
texture-kuid <KUID:-3:10111>
}
}
}
default-night
{
mesh nightwindows/nightwindows.im
night-mesh-base default
}
attachedanimation
{
mesh subdirectoryname/meshname.im
anim subdirectoryname/animname.kin
auto-create 1
att a.pointname
att-parent default
animation-loop-speed 1.0
}
}

===default===
Default is the ‘main’ mesh of the asset.

===mesh===
The ‘main’ mesh name. This may include a sub-path;
ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.

Use .im files exported from 3dsmax (as opposed to .pm.) or reference an .lm file if you wish your asset to have ‘Level of Detail’ mesh reduction. A pantograph model still requires a .pm file.

Level of detail is a process of using different model meshes, depending on how far the viewer is from the model. A finer mesh is used for close up viewing in Trainz.

===anim===
The animation file (.kin) exported from 3dsmax. This may include a sub-path.

===animation-loop-speed===
This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax.

===auto-create 1===
The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.

===default-night===
‘Main’ night window mesh on scenery and industry and traincar assets. Modeled to the same 3d space as the default mesh and is inserted at the default mesh origin.

===night-mesh-base default===
This night mesh is linked to the default mesh and is visible only at night. It is invisible if the ‘default’ mesh is invisible, (if the auto-create 0 line were used so the default mesh can be controlled by script).

===att===
The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).

===att-parent name===
The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.

Autodesk 3ds Max Exporters

2010-03-25T09:37:40Z

Windwalkr (legacy 2550):

'''Current Exporters'''

Auran uses Autodesk 3DS Max for internal modeling needs. At the current time, this is the only Auran-supported tool for creating models for the Trainz environment. Auran supplies exporters for the following Max versions for TS2009:

* Max 4
* Max 5
* Max 6
* Max 7
* Max 8
* Max 9
* Max 2008

Supported exporters may be [[Downloads | downloaded here]].

'''Installing an Exporter'''
#Have a supported version of 3DS Max installed. Have the downloaded exporters archive available. (*)
#Unzip or extract the exporters archive to your Desktop or other handy location.
#Locate the exporter version to match your version of 3DS Max.
#Copy the exporter .DLE file to your 3DS Max plugins folder.

For example. If 3DS Max is installed in

C:\Program Files\Autodesk\3ds Max 2008

Copy 'JetExporter.dle' into the plugin folder so it ends up:

C:\Program Files\Autodesk\3ds Max 2008\plugins\JetExporter.dle

(*) You will also need up-to-date Microsoft Run Time Libraries for the exporter to load and run correctly.
Although run time libraries ship with your operating system, they are usually out of date. There is never
any harm in updating your libraries, as the installer will simply add the files you are missing. If you
don't have a compatible library version installed, the software will not run and you will likely see an
ambiguous message like ''"This application has failed to start because the application configuration is incorrect."''

What are Run Time Libraries?

Have you noticed that when you run different Windows applications, they often look similar, with familiar
buttons, menus and dialog boxes? That is because they share bits of program in libraries, usually packaged
as .DLL files. As time passes, newer versions of these shared libraries are distributed, with the latest
version shipping with your operating system at that time. Anyway, you need them, and if you don't have them
they are freely available for download from Microsoft:

Microsoft Visual C++ 2005 SP1 Redistributable Package (x86) (~2.6 MB)
[http://www.microsoft.com/downloads/details.aspx?familyid=200B2FD9-AE1A-4A14-984D-389C36F85647&displaylang=en Download From Microsoft]

Microsoft .NET Framework Version 2.0 Redistributable Package (x86) (~22.4 MB)
[http://www.microsoft.com/downloads/details.aspx?familyid=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&displaylang=en Download From Microsoft]

Follow the instructions on the web page, but you typically just download the .exe file and run it to update your system.

'''To test the exporter:'''
# Start 3D Studio (it should load without unusual error messages)
# Click File -> Export
# Save as type, drop down and select ''Trainz format (*.IM, *.KIN)''

If an error occurs while loading 3D Studio, or the ''Trainz format'' save type is not present in the Export dialog, carefully read the installation instructions again and repeat the process. If you have copied the files to the wrong location, carefully check that the file names match those of the Trainz Exporter before deleting those files.

'''Uninstalling the exporter'''
# Locate the 3DS Max plugin folder
# Delete JetExporter.dle

'''Older versions of the exporter'''

Auran previously distributed a gmax bundle including a Trainz exporter. The output from this exporter remains compatible with TS2009, however the gmax exporter lacks support for many Trainz features which are considered mandatory for TS2009 content. Auran is unable to provide updated versions of the gmax exporter as the third-party gmax application software has long since been discontinued.

Auran has previously released a Max 3 exporter, however this lacks support for many Trainz features which are considered mandatory for TS2009 content.

To remove older versions of the exporter, locate your plugins folder and remove these files:

*JetExporter.dle
*JetExporter\AnimationExport.dll
*JetExporter\GenericMeshExport.dll
*JetExporter\IndexedMeshExport.dll
*JetExporter\ProgressiveMeshExport.dll
*JetExporter\JetExporter.cfg

'''Other ways to get models and animations into Trainz'''

A XML import format is now available, which allows 3D data, potentially from any source to be used in Trainz.
For more information, please visit: [[Trainz Mesh Importer]]

List of Standard Messages

2010-03-25T09:35:52Z

Windwalkr (legacy 2550):

*[[TrainzScript Language Reference|API Hierarchy]]

*This list is a first step towards documenting Trainz use of messages. It has been generated by scanning one or two copies of jetlog.txt from TC, together with the TC scripts folder and the TRS2006 copy of index.chm. There are probably many standard messages missing and there are some obscure ones listed. Please add anything that is missing. I will progressively link and document the list.
__NOTOC__ __NOEDITSECTION__
 

{|rules="rows" cellpadding="2" cellspacing="2" width="95%" style="border-collapse:collapse;"
|-
|width="15"|
|width="250"|Message
|width="165"|Source & Destination
|Purpose
|
{{IndexSplit|A}}
|-
|
|[[Animation-Event Message|Animation-Event,''eventname'']]
|meshobject > meshobject
|Sent when an animation triggers an event. These events are included in *.kin files generated by Max when the 'Query for Event' box is checked during animation export. They are used to enable code to be executed in sync with animations.
{{IndexSplit|B}}
|-
|
|BaseIndustry,LoadComplete
|industry > industry
|Sent when an industry loading operation has completed
|-
|
|[[Browser Messages|Browser-Closed,''null'']]
|browser > broadcast
|Sent when any in game browser is closed.
|-
|
|Browser-Key,ScriptObjectives
|? > ?
|Sent by Trainz in response to a ScriptObjectives hotkey press. Obsolete?
|-
|
|[[Browser Messages|Browser-URL,''live://linkname'']]
|browser > broadcast
|Sent when the user clicks in a link in a custom browser
|-
|
|Build,Cancelled
|? > buildable
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.
|-
|
|Build,Completed
|? > buildable
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.
|-
|
|Build,Started
|? > buildable
|Not generally used. Intended for RTS-style gameplay where individual industries (etc) start in an unbuilt state and can be built at some resource cost during gameplay.
{{IndexSplit|C}}
|-
|
|[[Camera Messages|Camera,Interior-Changed]]
|new train? > broadcast
|Sent when a different train is selected.
|-
|
|[[Camera Messages|Camera,Target-Changed]]
|new target? > broadcast
|Sent when the camera selects a different target, may not be a train.
|-
|
|[[Camera Messages|Camera,External-View]]
|? > broadcast
|Sent when the camera mode is changed.
|-
|
|[[Camera Messages|Camera,Internal-View]]
|? > Broadcast
|Sent when the camera mode is changed.
|-
|
|[[Camera Messages|Camera,Roaming-View]]
|? > broadcast
|Sent when the camera mode is changed.
|-
|
|[[Camera Messages|Camera,Tracking-View]]
|? > broadcast
|Sent when the camera mode is changed.
|-
|
|Check,Speed
|vehicle > vehicle
|Sent continuously to ensure that jetlog isn't allowed to remain legible :-)
{{IndexSplit|D}}
|-
|
|DriverCharacter,BoardedTrain
|driver > broadcast
|Sent when a driver boards a train
|-
|
|DriverCharacter,Created
|driver > broadcast
|Sent when a driver character is initialised
|-
|
|DriverCharacter,LeftTrain
|driver > broadcast
|Sent when a driver leaves a train
|-
|
|DriverDisplay,ResetTripMeter
|
|
|-
|
|[[Interface Messages|DriverModule,DCC-Panel-Created]]
|? > broadcast
|Sent when driver selection widget has been created
|-
|
|DriverSetup,CharactersDone
|? > broadcast
|Sent when driver characters have been initialised
{{IndexSplit|G}}
|-
|
|GenericIndustry,LoadComplete
|industry > industry
|Sent when an industry loading operation has completed
|-
|
|GenericIndustry,ProcessComplete
|industry > industry
|Sent when an industry process has completed
{{IndexSplit|H}}
|-
|
|HandleTrain,Release
|industry > train
|Sent when an industry loading operation has completed
{{IndexSplit|I}}
|-
|
|[[Interface Messages|Interface,ClickSystemButton]]
|
|
|-
|
|[[Interface Messages|Interface-Event,MapViewOff]]
|? > broadcast
|Sent when the minimap is opened
|-
|
|[[Interface Messages|Interface-Event,MapViewOn]]
|? > broadcast
|Sent when the minimap is closed
|-
|
|[[Interface Messages|Interface-Event,Minimap-Mouse-Enter]]
|
|
|-
|
|[[Interface Messages|Interface-Event,Minimap-Mouse-Leave]]
|
|
|-
|
|[[Interface Messages|Interface-Event,New-Driver-Message]]
|
|
|-
|
|[[Interface Messages|Interface-Event,Mouse-Enter]]
|object > broadcast
|Sent on mouseover an object
|-
|
|[[Interface Messages|Interface-Event,Mouse-Leave]]
|? > broadcast
|Sent on mouseout of an object
|-
|
|[[Interface Messages|Interface-Event,Set-Metric-Mode]]
|? > broadcast
|Sent when the interface units are changed
|-
|
|[[Interface Messages|Interface-Event,Toggle-Interface]]
|? > broadcast
|Sent when the main HUD is turned on or off
|-
|
|[[Interface Messages|Interface-Event,Toggle-ButtonBar]]
|
|
|-
|
|[[Interface Messages|Interface-Event,Toggle-CustomHUD]]
|
|
|-
|
|[[Interface Messages|Interface-Event,Toggle-VehicleControls]]
|
|
|-
|
|[[Interface Messages|Interface-Event,Left-Click]]
|
|
|-
|
|[[Interface Messages|Interface-Event,Surveyor-Left-Click]]
|
|
{{IndexSplit|J}}
|-
|
|[[Object Messages|Junction,Enter]]
|junction > train
|Sent when a train enters a junction's outer area
|-
|
|[[Object Messages|Junction,InnerEnter]]
|junction > train
|Sent when a train enters a junction's inner area
|-
|
|[[Object Messages|Junction,InnerLeave]]
|junction > train
|Sent when a train leaves a junction's inner area
|-
|
|[[Object Messages|Junction,Leave]]
|junction > train
|Sent when a train leaves a junction's outer area
|-
|
|[[Object Messages|Junction,Stopped]]
|junction > train
|Sent when a train stops in a junction trigger area
|-
|
|Junction,Toggled
|junction > broadcast
|Sent when a junctionbase object is toggled
{{IndexSplit|M}}
|-
|
|[[MapObject Messages|MapObject,View-Details]]
|? > object
|Sent when the user right-clicks an object and selects 'View Details' from the resulting menu, some assets provide a built-in browser in response to this message.
|-
|
|[[MapObject Messages|MapObject,View-Schedule]]
|? > ?
|Sent when the user right-clicks an object and selects 'View Schedule' from the resulting menu. The vehicle must have a timetable for this menu item to be displayed.
|-
|
|MeshObject-Click,*
|
|
{{IndexSplit|O}}
|-
|
|[[Object Messages|Object,Enter]]
|crossing > crossing
|Train has entered crossing trigger area
|-
|
|[[Object Messages|Object,Leave]]
|crossing > crossing
|Train has left crossing trigger area
|-
|
|[[Object Messages|Object,Enter]]
|train > junction
|Sent when a train enters a junction's outer area
|-
|
|[[Object Messages|Object,InnerEnter]]
|train > junction
|Sent when a train enters a junction's inner area
|-
|
|[[Object Messages|Object,InnerLeave]]
|train > junction
|Sent when a train leaves a junction's inner area
|-
|
|[[Object Messages|Object,Leave]]
|train > junction
|Sent when a train leaves a junction's outer area
|-
|
|[[Object Messages|Object,Stopped]]
|train > junction
|Sent when a train stops in a junction trigger area
|-
|
|[[Object Messages|Object,Enter]]
|train > trackmark
|Sent when a train enters a trackmark
|-
|
|[[Object Messages|Object,Leave]]
|train > trackmark
|Sent when a train leaves a trackmark
|-
|
|[[Object Messages|Object,Stopped]]
|train > trackmark
|Sent when a train stops at a trackmark
|-
|
|[[Object Messages|Object,Enter]]
|train > trigger
|Sent when a train enters a trigger
|-
|
|[[Object Messages|Object,Leave]]
|train > trigger
|Sent when a train leaves a trigger
|-
|
|[[Object Messages|Object,Stopped]]
|train > trigger
|Sent when a train stops at a trigger
|-
|
|[[Object Messages|Object,Enter]]
|vehicle > scenerywithtrack
|Sent when a vehicle enters a scenery trigger's outer area
|-
|
|[[Object Messages|Object,InnerEnter]]
|vehicle > scenerywithtrack
|Sent when a vehicle enters a scenery trigger's inner area
|-
|
|[[Object Messages|Object,InnerLeave]]
|vehicle > scenerywithtrack
|Sent when a vehicle leaves a scenery trigger's inner area
|-
|
|[[Object Messages|Object,Leave]]
|vehicle > scenerywithtrack
|Sent when a vehicle leaves a scenery trigger's outer area
|-
|
|[[Object Messages|Object,Stopped]]
|vehicle > scenerywithtrack
|Sent when a train stops in a scenery trigger
|-
|
|OnlineAccess,ReceiveMessage
|? > onlineaccess
|Message awaiting collection
|-
|
|OnlineAccess,StatusChange
|? > onlineaccess
|Network status change
|-
|
|OnlineGroup,StatusChange
|? > onlinegroup
|Network status change
|-
|
|OnlineGroup,UsersChange
|? > onlinegroup
|Network users change
|-
|
|OnlineGroup.UserRemoved,*
|? > onlinegroup
|Network users change
|-
|
|OnlineGroup.UserAdded,*
|? > onlinegroup
|Network users change
|-
|
|OnlineGroup.UserStatus,*
|? > onlinegroup
|Network users change
{{IndexSplit|P}}
|-
|
|Permit,Granted
|? > objectrequesting
|Sent when a track or junction permit is granted
|-
|
|PortalTunnel,EmitTrain
|portal > portal
|Sent when a portal produces a train
|-
|
|[[pfx Message|pfx,''particledata'']]
|script > object
|Sent by script to control particle effects
|-
|
|Process-Start,''processname''
|industry > industry
|Sent when an industry process has started
|-
|
|Process-Stop,''processname''
|industry > industry
|Sent when an industry process has completed
{{IndexSplit|S}}
|-
|
|Scenario,KillMonitor
|? > ?
|Sent to terminate a scenario thread
|-
|
|Scenario,Quit
|? > ?
|Sent to terminate a scenario
|-
|
|ScenarioBehaviour,Touch
|? > ?
|Called on a parent rule when the child rule completes. May also indicate other state changes.
|-
|
|[[Object Messages|SceneryTrigger,Enter]]
|scenerywithtrack > vehicle
|Sent when a vehicle enters a scenery trigger's outer area
|-
|
|[[Object Messages|SceneryTrigger,InnerEnter]]
|scenerywithtrack > vehicle
|Sent when a vehicle enters a scenery trigger's inner area
|-
|
|[[Object Messages|SceneryTrigger,InnerLeave]]
|scenerywithtrack > vehicle
|Sent when a vehicle leaves a scenery trigger's inner area
|-
|
|[[Object Messages|SceneryTrigger,Leave]]
|scenerywithtrack > vehicle
|Sent when a vehicle leaves a scenery trigger's outer area
|-
|
|[[Object Messages|SceneryTrigger,Stopped]]
|scenerywithtrack > vehicle
|Sent when a train stops in a scenery trigger
|-
|
|Schedule,Abort
|train > train
|Sent when a command schedule is abandoned
|-
|
|Schedule,Complete
|train > broadcast
|Sent when a command schedule is completed
|-
|
|Schedule,Touch
|train > train
|Sent when a Train's AI schedule state is modified (see Train.StopSchedule()) and sniffed by DriverCharacter to implement DriverCommand support.
|-
|
|[[Signal Messages|Signal,StateChanged]]
|signal > broadcast
|Signal aspect has changed
|-
|
|StationMain.Timer,Tick
|station > station
|Sent by stations to initiate a periodic update
{{IndexSplit|T}}
|-
|
|Timer,Tick
|? > ?
|A common custom message used by various scripts to implement timed polling.
|-
|
|Timetable,
|? > ?
|?
|-
|
|[[Object Messages|Trackmark,Enter]]
|trackmark > train
|Sent when a train enters a trackmark
|-
|
|[[Object Messages|Trackmark,Leave]]
|trackmark > train
|Sent when a train leaves a trackmark
|-
|
|[[Object Messages|Trackmark,Stopped]]
|trackmark > train
|Sent when a train stops at a trackmark
|-
|
|[[Signal Messages|Train,Entered red signal]]
|signal > train
|Train has entered signal
|-
|
|[[Signal Messages|Train,Entered red signal notify]]
|train > broadcast
|Train has entered signal
|-
|
|[[Signal Messages|Train,Passed Signal]]
|
|
|-
|
|[[Train Messages|Train,Over speed limit]]
|train > broadcast
|Sent when a train exceeds the current speed limit.
|-
|
|[[Train Messages|Train,Under speed limit]]
|train > broadcast
|Sent when a train slows below the current speed limit.
|-
|
|[[Train Messages|Train,Over advisory speed limit]]
|train > broadcast
|Sent when a train exceeds the current advisory speed limit.
|-
|
|[[Train Messages|Train,Under advisory speed limit]]
|train > broadcast
|Sent when a train slows below the current advisory speed limit.
|-
|
|[[Train Messages|Train,Over floating speed limit]]
|train > broadcast
|Sent when a train exceeds the floating speed limit.
|-
|
|[[Train Messages|Train,Under floating speed limit]]
|train > broadcast
|Sent when a train slows below the floating speed limit.
|-
|
|[[Train Messages|Train,Cleanup]]
|? > ?
|Sent immediately prior to the destruction of a Train object, to allow certain scripts to clean up their state.
|-
|
|[[Train Messages|Train,Deleted]]
|train > ?
|Sent when a train is deleted from the train list. This will also occur when two trains couple to form a new train.
|-
|
|Train,ThreadAITrainStoppedMovingFailed
|train > train
|Internal Train.gs implementation- sent when the AI fails to enter the expected junction.
|-
|
|Train,CommandCoupleVehicleTimer
|train > train
|Internal Train.gs implementation- sent when the AI fails to couple in a two-second window.
|-
|
|Train,CommandReverseTrain.Pulse
|train > train
|Internal Train.gs implementation- sent when the AI fails to take permits to reverse a train within a 20-second window.
|-
|
|[[Train Messages|Train,DriverBoarded]]
|train > driver
|Sent when a driver boards a train
|-
|
|Train,NotifyBell
|train > train
|Sent when the interface bell button is clicked
|-
|
|Train,NotifyHeadlights
|train > train
|Sent when the interface headlight button is clicked
|-
|
|Train,NotifyHorn
|train > train
|Sent when the interface horn button is clicked
|-
|
|Train,NotifyPantographs
|train > train
|Sent when the interface pantograph button is clicked
|-
|
|Train,NotifySanding
|
|
|-
|
|Train,TurnAround
|
|
|-
|
|[[Train Messages|Train,ReachedTarget]]
|? > ?
|Sent by Trainz when a train reaches the specified Autopilot Target Position.
|-
|
|[[Train Messages|Train,SlowingForTarget]]
|train > train
|Sent by Trainz when the train begins to slow on approach to a specified Autopilot Target Position.
|-
|
|[[Train Messages|Train,Handbrake-Apply]]
|
|
|-
|
|[[Train Messages|Train,Handbrake-Release]]
|
|
|-
|
|[[Train Messages|Train,StartedMoving]]
|train > train
|Sent when a train starts to move
|-
|
|[[Train Messages|Train,StoppedMoving]]
|train > train
|Sent when a train stops
|-
|
|[[Train Messages|Train,ThrottleChanged]]
|
|
|-
|
|Train,Tick
|train > train
|?
|-
|
|[[Object Messages|Train,EnterTrack]]
|track > train
|Sent when a train enters a track section
|-
|
|[[Object Messages|Train,InnerEnterTrack]]
|track > train
|?
|-
|
|[[Object Messages|Train,InnerLeaveTrack]]
|track > train
|?
|-
|
|[[Object Messages|Train,LeaveTrack]]
|track > train
|Sent when a train leaves a track section
|-
|
|Train.ThreadAITrainStuck,Touch
|train > train
|?
|-
|
|TrainTimetable,Touch
|? > ?
|?
|-
|
|[[Object Messages|Trigger,Enter]]
|trigger > train
|Sent when a train enters a trigger
|-
|
|[[Object Messages|Trigger,Leave]]
|trigger > train
|Sent when a train leaves a trigger
|-
|
|[[Object Messages|Trigger,Stopped]]
|trigger > train
|Sent when a train stops at a trigger
{{IndexSplit|V}}
|-
|
|[[Vehicle Messages|Vehicle,BadCouple]]
|vehicle > broadcast
|Sent when a vehicle couples at excessive speed
|-
|
|[[Vehicle Messages|Vehicle,Collided]]
|vehicle > broadcast
|Sent on a collision between vehicles
|-
|
|[[Vehicle Messages|Vehicle,Coupled]]
|vehicle > broadcast
|Sent when a vehicle couples to another
|-
|
|[[Vehicle Messages|Vehicle,Decoupled]]
|vehicle > broadcast
|Sent when a vehicle uncouples from another
|-
|
|[[Vehicle Messages|Vehicle,Derailed]]
|vehicle > broadcast
|Sent when a vehicle is derailed
|-
|
|Vehicle,LoadComplete
|industry > vehicle
|Sent when loading of a vehicle from an industry is complete
|-
|
|Vehicle,Coupler breakage
|
|
|-
|
|Vehicle,Coupler breakage notify
|
|
|-
|
|Vehicle,Coupler Repaired
|
|
{{IndexSplit|W}}
|-
|
|[[Interface Messages|WaybillManager,WaybillsWindowShown]]
|waybillmanager > broadcast
|?
|-
|
|[[Interface Messages|WaybillManager,WaybillsWindowHidden]]
|waybillmanager > broadcast
|?
|-
|
|[[ModuleInit Message|World,ModuleInit]]
|? > broadcast
|Sent whenever TRS switches to Driver, Surveyor or Railyard modes
|-
|
|World,Paused
|? > broadcast
|?
|-
|
|World,Unpaused
|? > broadcast
|?
|-
|
|World,Day
|? > broadcast
|Sent 1.) at ca. 05:45 ~ 0.739409 Gametime 2.) sometimes when TS starts Driver
|-
|
|World,Night
|? > broadcast
|Sent 1.) at ca. 18:15 ~ 0.260611 GameTime 2.) whenever TS starts Driver or Surveyor and Playtime is beween 18:15 and 05:45 3.) sometimes when TS switched to Driver or Surveyor
|}

Kind name

2010-03-25T09:35:39Z

Windwalkr (legacy 2550):

Some assets may have editable signs. When you set an asset’s name in surveyor through the Edit Properties icon (‘?’ icon) the signage can be set-up to automatically update. The variables can be set for each sign.

Typical Kind Name mesh table set-up:

mesh-table
{
default
{
mesh industry.lm
auto-create 1
effects
{
0
{
kind name
font garamond
fontsize 0.15
fontcolor 30,30,30
att a.name0
name name
}
1
{
kind name
font swiss
fontsize 0.3
fontcolor 30,30,30
att a.name1
name name
}
}
}
}

You do not have to use the 0,1,2... block naming convention.

For the name effects described in the example, 0 could easily be mainsign or something more relevant to your model.

Setting unique names may be useful for script purposes, so you can easily recognize a script reference, for instance.

==Breakdown of KIND NAME:==
===kind name===
The effect kind
===font===
Only supported in Trainz Classics and later

The name of the font - refer to the list of names below:
arial
console
comic_sans
courier
cordia
century_gothic
garamond
helvetica
impact
sans_serif
swiss
tahoma
times_new_roman
verdana
All these fonts have a base size of 24 points. This size is varied by using the fontsize tag (a multiplying factor of the default font size) in the config.txt file.

===fontsize===
The size of the font as a fraction of the original default font size, eg. 0.15 is 15% of the default size of 24 points.

There is an additional larger default font size that has been used in TC which is available for use. This is referenced by the in-game name, mainmenu_titles, not by the more usual “font” name Arial. By using this larger font (80 points) and specifying a font size factor, better quality may be obtained for the name text on the created asset.

mainmenu_titles
===fontcolor===
The color of the sign text in r.g.b.
===att===
The sign text insertion point (part of the mesh). The attachment point must be orientated correctly in 3dsmax.

Points are placed in top view in 3dsmax. When aligning the point in 3dsmax, click on the Hierarchy - Affect Pivot Only option to examine the axis direction, turn off the Affect Pivot Only selection, and rotate the point itself to the correct orientation. Click on the Affect Pivot Only option again to check the new alignment. Make sure you rotate the point, not the axis.
===name===
The default text when placed

When name name is specified, it uses the asset’s changeable name option, changed through the Edit Properties icon (the ‘?’ icon) in Surveyor.

If name Graceland (for example) were used, the sign would never be able to be changed, even though the user may have changed the asset’s name in Surveyor.

When you use the name tag, this name will appear in the minimap. In some instances the names will be hard to distinguish in a crowded map. For this reason, it may be advisable to limit the use of the name tag to objects that have a use for the attribute.

Index of Tags & Containers

2010-03-25T09:35:24Z

Windwalkr (legacy 2550):

{| cellpadding="5" cellspacing="0" border="1"
|- style="background-color:#ffffcc;"
|width=15%|Tag or Container
|width=15%|Data Type
|width=15%|Parent
|width=15%|Applies to
|width=40%|Description
|-
|accel
|float,float
|smoke {
|smoke block
|Acceleration. First number is Gravity effect, second is wind effect. Default is 0,0.
|-
|adhesion
|?
|motor {
|engine
|?
|-
|air-drag-coefficient
|?
|motor {
|engine
|?
|-
|alias
|kuid
|config.txt
|general
|Kuid of the asset to be referenced as a basis for the new asset. For example TRS Traincars can reference archived locomotive mesh assets for use with custom textures. This process is done by aliasing the KUID of the archived traincars.
|-
|alias
|kuid
|config.txt
|paintshed-skin
|the kuid of the paintshed template the paintshed reskin is based on
|-
|allowed-categories {
|subcontainer
|queues-ID {
|industry
|The allowed product categories in this queue.
|-
|allowed-products {
|subcontainer
|queues-ID {
|industry
|The allowed products in this queue.
|-
|allows-mixing
|boolean
|config.txt
|product
|Products with this tag may be combined in a single queue along with other products of the same category. Eg. Lumber and 20ft Container on a flatcar. By default, allows-mixing is set to 0. Therefore by default, a queue will only allow one product-category at a time. To look at allows-mixing from another angle, liquid products should never have allows-mixing enabled. Otherwise you have the potential to mix petrol with oil within the same tanker.
|-
|altitude
|?
|config.txt
|region
|altitude of this region
|-
|ambient
|boolean
|soundscript-ID {
|mesh object
|0 or 1, default 0 is off. Ambient sounds have no 3D “position” and may be stereo. Non-ambient (positional) sounds are positioned on the object and must be mono - see attachment above
|-
|amount
|float
|inputs-ID {
|industry
|Amount required as input.
|-
|amount
|float
|outputs-ID {
|industry
|Amount to output.
|-
|angle
|float list degrees
|config.txt
|turntable
|Specifies the angles at which the turntable stops. Not used if the turntable is set up as animation.
|-
|angles
|float list
|mesh-table-ID {
|interior
|Rotational boundaries in radians relative to its attachment point.
|-
|anim
|[path/]filename.kin
|config.txt
|pantograph
|The “anim.kin” animation file for the pantograph
|-
|anim
|[path/]filename.kin
|effects-ID {
|animation effect
|Reference to the animation file (.kin)
|-
|anim
|[path/]filename.kin
|mesh-table-ID {
|mesh object
|The animation file (.kin) exported from 3dsmax.
|-
|animated-mesh
|mesh-table-ID {
|queues-ID {
|industry
|Animated mesh which changes as the queue becomes full.
|-
|animation-loop-speed
|float
|mesh-table-ID {
|mesh object
|This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax.
|-
|animdist
|float
|config.txt
|bogey
|Leave this tag out if the bogey is not animated. The distance traveled in meters by the bogeys in 1 second (30 frames) of animation. Bogey animations (exported from 3ds Max) are called “anim.kin”.
|-
|asset-filename
|string
|config.txt
|general
|Obsolete
|-
|att
|helper
|attached-trigger-ID {
|industry
|Attachment point (stored in the mesh file)
|-
|att
|helper
|effects-ID {
|effects-ID {
|The effect insertion point. The attachment point must be orientated correctly in 3dsmax.
|-
|att
|helper
|mesh-table-ID {
|mesh object
|The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).
|-
|attached-track {
|container
|config.txt
|scenery with track
|Auto-generated spline track. Generated through attachment points located within the default mesh. Attached-tracks update automatically to the spline track connected to it. You may over-ride this auto-update feature by adding useadjoiningtracktype 0 Note. Correct track end attachment orientation is essential. The Y axis must point ‘out’ at the correct angle. The Z axis must point ‘up’.
|-
|attached-track-ID {
|subcontainer
|attached-track {
|scenery with track
|User supplied identifier
|-
|attached-trigger {
|container
|config.txt
|industry
|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.
|-
|attached-trigger-ID {
|User supplied identifier
|attached-trigger {
|industry
|User supplied identifier
|-
|attachment
|helper
|smoke# {
|smoke block
|The attachment point (stored in the mesh file) to place the smoke effect.
|-
|attachment
|helper
|soundscript-ID {
|mesh object
|Attachment point on the object to which the sound is attached. Default: The sound will attach to the origin of parent object (not used for ambient sound)
|-
|attachment-points {
|subcontainer
|queues-ID {
|industry
|List of attachment points for this queue on which products are visualised. (Use this, OR animated-mesh)
|-
|att-parent
|mesh-table-ID {
|mesh-table-ID {
|mesh object
|The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.
|-
|author
|string
|config.txt
|general
|Author, contact-email and contact-website are useful information, particularly if a user has a question on your models or would like to offer help or suggestions.
|-
|autobrakecylinder
|?
|volume {
|engine
|?
|-
|autobrakecylinder_start
|?
|pressure {
|engine
|?
|-
|autobrakecylindervent
|?
|flowsize {
|engine
|?
|-
|auto-create
|boolean
|mesh-table-ID {
|mesh object
|The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.
|-
|autoname
|boolean
|config.txt
|general
|When enabled, automatically assigns a unique name to this object as it is placed.
|-
|autopilotmode
|boolean
|driver-settings {
|activity
|AI driver setting. (off, on)
|-
|auxreservoir
|?
|volume {
|engine
|?
|-
|auxreservoir_autobrakecylinder
|?
|flowsize {
|engine
|?
|-
|auxreservoir_no3
|?
|flowsize {
|engine
|?
|-
|auxreservoir_start
|?
|pressure {
|engine
|?
|-
|auxreservoir_trainbrakepipe
|?
|flowsize {
|engine
|?
|-
|auxreservoirvent
|?
|flowsize {
|engine
|?
|-
|axle-count
|?
|motor {
|engine
|?
|-
|backdrop
|boolean
|config.txt
|scenery
|Specifies whether the object is treated as a backdrop or not. (stays visible even when far from the camera)
|-
|bendy
|boolean
|config.txt
|splines
|Switches how track is bent on corners, set as 1 allows the mesh to be deformed as the spline is bend around corners.
|-
|bogey
|kuid
|bogeys-ID {
|traincar
|Kuid of bogey asset.
|-
|bogey
|kuid
|config.txt
|traincar
|The bogey KUID number (default for a.bog0 and a.bog1)
|-
|bogey
|kuid
|tracksound {
|Tracksound
|The bogey to which this sound will apply.
|-
|bogey-#
|kuid
|config.txt
|traincar
|The bogey KUID number for a.bog# (Used only if different to a.bog0)
|-
|bogey-#-r
|kuid
|config.txt
|traincar
|Used instead of ‘bogey’ and bogey-1. The bogey will have reversed orientation. Note: This will cause bogey animation to play in reverse unless the attachment point for the bogey is also rotated 180 degrees in 3dmax.
|-
|bogey-r
|kuid
|config.txt
|traincar
|Used instead of ‘bogey’ and bogey-1. The bogey will have reversed orientation. Note: This will cause bogey animation to play in reverse unless the attachment point for the bogey is also rotated 180 degrees in 3dmax.
|-
|bogeys {
|container
|config.txt
|traincar
|The bogey container stores the bogeys used for the loco\rollingstock item.
|-
|bogeys-ID {
|subcontainer
|bogeys {
|traincar
|User supplied identifier
|-
|boiler-to-piston-flow
|?
|steam {
|steam-engine
|?
|-
|boiler-volume
|?
|steam {
|steam-engine
|?
|-
|brakefull
|?
|pressure {
|engine
|?
|-
|brakeinitial
|?
|pressure {
|engine
|?
|-
|brakepipe
|?
|pressure {
|engine
|?
|-
|brakeratio
|?
|motor {
|engine
|?
|-
|bridgetrack
|kuid
|config.txt
|splines
|Kuid of the track type to be used.
|-
|buffer-speed
|float metres/second
|config.txt
|trackside
|Used for buffers; specifies the maximum speed up to which the buffer will stop a train.
|-
|burn-rate
|?
|steam {
|steam-engine
|?
|-
|burn-rate-idle
|?
|steam {
|steam-engine
|?
|-
|cabinsway
|float
|config.txt
|traincar
|Cabin sway multiplier. Eg -2.
|-
|camera#
|float list
|cameralist {
|interior
|A camera contains 5 numeric coordinates that determine the placement and orientation of the camera. These are: 0,0,0,0,0 =left/right, front/back, up/down, yaw, pitch To determine these variables add -freeintcam to the trainzoptions.txt. Pan around the interior using arrow keys and mouse. Co-ordinates are displayed at bottom-left of screen. industry asset’s script file.
|-
|cameradefault
|integer
|config.txt
|interior
|The in-cab camera view Trainz defaults to when entering the cab.
|-
|cameralist {
|container
|config.txt
|interior
|List of camera viewpoints
|-
|car#
|kuid
|config.txt
|map
|Each of these tags stores the kuid of a car to be used on the roads.
|-
|car#
|kuid
|config.txt
|region
|Each of these tags stores the kuid of a car to be used on the roads.
|-
|carrate
|float seconds
|config.txt
|splines
|Defines traffic density on road (minimum seconds between each car generated). 0 = No traffic. Number must be greater than 3.
|-
|casts_shadows
|boolean
|config.txt
|splines
|Toggles whether the shadow model is displayed.
|-
|category-class
|class code
|config.txt
|general
|The class code for this asset.
|-
|category-era
|era code
|config.txt
|general
|Era code list.
|-
|category-era-#
|era list
|config.txt
|general
|Era code.
|-
|category-keywords
|keyword list
|config.txt
|general
|Keyword list
|-
|category-region
|region list
|config.txt
|general
|A list of REGION codes or REGION GROUP codes,
|-
|category-region-#
|region code
|config.txt
|general
|A REGION codes or REGION GROUP code.
|-
|changeability
|0/1/2
|driver-settings {
|activity
|Propensity for weather to change. (none, periodic, extreme)
|-
|chunky_info
|float list
|config.txt
|splines
|These values (in metres) define the shape of the mesh created for the track.
|-
|chunky_mesh
|folder
|config.txt
|splines
|Name of texture to apply to rail. The texture must be within a directory of the same name (ie. “textureName\textureName.texture.txt”). The chunky_mesh value will simply be the name of this directory (ie. “textureName”).
|-
|class
|string
|config.txt
|general
|This refers to the class of asset within the script file (the class must match that stated in the script).
|-
|clutter-mesh
|kuid
|config.txt
|groundtexture
|Ground textures can now reference a mesh and insert the mesh automatically as the ground is painted. Painting over a clutter-mesh ground texture effectively deletes clutter meshes and texture. The mesh it refers to is can be standard scenery object kind mesh. Clutter-meshes must have only one Max material assigned to it only. Polycounts must be very low.
|-
|collate-meshes
|?
|config.txt
|trackside
|Enables clutter-mesh support (eg. fast trees)
|-
|collision-parent
|mesh-table-ID {
|mesh-table-ID {
|interior
|For collision-proxy meshes in an interior mesh-table, this specifies the parent object to be proxied. is 3.
|-
|color
|rgb value
|smoke# {
|smoke block
|The R,G,B colour value of the effect.
|-
|company
|string
|config.txt
|traincar
|The Locomotive or car owner
|-
|compressor
|?
|flowsize {
|engine
|?
|-
|compressor
|?
|pressure {
|engine
|?
|-
|conesize
|?
|smoke# {
|smoke block
|?
|-
|conflicts-with queues {
|subcontainer
|queues-ID {
|industry
|This queue and the conflicting queue(s) cannot be used simultaneously.
|-
|consists {
|container
|config.txt
|industry
|The consists tag stores information on consists that can be generated by the industry.
|-
|consists-ID {
|subcontainer
|consists {
|industry
|User supplied identifier
|-
|consists-vehicle-ID {
|subcontainer
|consists-ID {
|industry
|User supplied identifier
|-
|contact-email
|string
|config.txt
|general
|Author, contact-email and contact-website are useful information, particularly if a user has a question on your models or would like to offer help or suggestions.
|-
|contact-website
|string
|config.txt
|general
|Author, contact-email and contact-website are useful information, particularly if a user has a question on your models or would like to offer help or suggestions.
|-
|controlmethod
|0/1
|driver-settings {
|activity
|Driver control setting. (dcc, cabin)
|-
|coupling-mask
|boolean
|consists-ID {
|industry
|Coupling mask that applies to the consist. 0 will block off all coupling activity while “1” will mean you can couple with a vehicle.
|-
|critical-animation
|boolean
|mesh-table-ID {
|mesh object
|When enabled, this forces the animation to continue playing when off screen. Impacts performance when enabled.
|-
|custom-attachments
|?
|queues-ID {
|industry
|Not used.
|-
|decoupling-mask
|boolean
|consists-ID {
|industry
|Coupling mask that applies to the consist. 0 will mean you can’t decouple vehicles in the train while 1 means you can decouple vehicles.
|-
|default {
|subcontainer
|mesh-table {
|mesh object
|Main mesh of the asset
|-
|defaultjunction
|kuid
|config.txt
|region
|Default type of junction in this region.
|-
|default-mesh
|kuid
|effects-ID {
|attachment effect
|The KUID of the attached mesh.
|-
|default-night {
|subcontainer
|mesh-table {
|mesh object
|‘Main’ night window mesh on scenery and industry and traincar assets. Modeled to the same 3d space as the default mesh and is inserted at the default mesh origin.
|-
|default-night-forward {
|subcontainer
|mesh-table {
|mesh object
|The name for a submesh attached to a locomotive, to show a beam of light for example, in the direction of movement of the locomotive. Trainz recognises the name and turns on the correct mesh depending on the running direction.
|-
|default-night-reverse {
|subcontainer
|mesh-table {
|mesh object
|The name for a submesh attached to a locomotive, to show a beam of light for example, in the direction of movement of the locomotive. Trainz recognises the name and turns on the correct mesh depending on the running direction.
|-
|deraillevel
|0/1/2
|driver-settings {
|activity
|Derail setting. (none, arcade, realistic)
|-
|description
|string
|config.txt
|general
|Description of the asset.
|-
|description-##
|string
|config.txt
|general
|Translated description of the asset.
|-
|dighole
|float length, width
|config.txt
|scenery
|Specifies the number of grid segments (length, width) to be removed from the surveyor grid to accommodate the turntable pit.
|-
|direct-drive
|boolean
|config.txt
|bogey
|When direct-drive is present, the bogey animation is linked to the steam piston and physics system. If this tag is not included the piston and steam sounds will not work!
|-
|direction
|vector
|smoke# {
|smoke block
|The vector at which the smoke travels.
|-
|directional
|boolean
|effects-ID {
|corona effect
|The default for coronas is to be aligned to the attachment point to face the NEGATIVE Z direction. This is especially useful for Traincars.
|-
|disable-extra-track-sounds
|boolean
|config.txt
|traincar
|Disables the “click-clack” tracksounds. (0, 1)
|-
|distance
|min, max metres
|soundscript-ID {
|mesh object
|2 numbers (meters) 1st number is the distance at which the sound is played 100% 2nd number is the cut-off distance. Doesn’t affect the volume of the sound (Default: 50m, 150m)
|-
|ditch_color
|rgb value
|config.txt
|traincar
|RGB ditch light colour. Eg. 255,255,255.
|-
|divider
|folder
|config.txt
|splines
|Name of the model to use as the middle bridge section. Placed in subfolder with same name.
|-
|don’t-flip-terminator
|boolean
|config.txt
|splines
|Terminator model isn’t mirrored on one side.
|-
|driver-settings {
|container
|config.txt
|activity
|Specify the settings of this scenario, similar to Driver’s settings screen
|-
|duration
|float
|process-ID {
|industry
|Length of time (in seconds) that the process runs for.
|-
|dynamic-brake {
|container
|?
|engine
|?
|-
|effects {
|subcontainer
|mesh-table-ID {
|mesh-table-ID {
|Optional mesh-table variations
|-
|effects {
|subcontainer
|mesh-table-ID {
|mesh object
|Optional mesh-table variations
|-
|effects-ID {
|subcontainer
|effects {
|effects {
|User supplied identifier
|-
|enabled
|boolean
|smoke# {
|smoke block
|Specifies whether the effect is enabled.
|-
|endcolor
|rgb value
|smoke# {
|smoke block
|The final colour the smoke effect shifts to.
|-
|endlength
|float metres
|config.txt
|splines
|Length in meters of the initiator and terminator models.
|-
|engine
|boolean
|config.txt
|traincar
|States type of traincar. 0 for Rolling stock, 1 for Locomotive.
|-
|enginesound
|kuid
|config.txt
|traincar
|References the KUID number for the traincar’s sound.
|-
|enginespec
|kuid
|config.txt
|traincar
|References the engine KUID number. This specifies the driver physics boundaries for the traincar.
|-
|epreservoirpipe
|?
|flowsize {
|engine
|?
|-
|epreservoirpipe
|?
|volume {
|engine
|?
|-
|epreservoirpipe_autobrakecylinder
|?
|flowsize {
|engine
|?
|-
|epreservoirpipe_start
|?
|pressure {
|engine
|?
|-
|equaliser
|?
|volume {
|engine
|?
|-
|equaliser_mainreservoir
|?
|flowsize {
|engine
|?
|-
|equaliser_start
|?
|pressure {
|engine
|?
|-
|equaliservent
|?
|flowsize {
|engine
|?
|-
|equaliserventemergency
|?
|flowsize {
|engine
|?
|-
|equaliserventhandleoff
|?
|flowsize {
|engine
|?
|-
|extensions {
|container
|config.txt
|all
|Asset specific data.
|-
|faces
|camera/motion/down
|smoke# {
|smoke block
|The direction the smoke effect faces.
|-
|face-texture
|[path/]filename.texture
|config.txt
|drivercharacter
|This is the driver icon used in TRS. Must be 64x64 pixels
|-
|facing
|boolean
|consists-vehicle-ID {
|industry
|Indicates the direction of the vehicle.
|-
|file
|[path/]filename.tfx
|smoke# {
|smoke block
|The twinkle file to be used (optional).
|-
|firebox-efficiency
|?
|steam {
|steam-engine
|?
|-
|firebox-to-boiler-heat-flow
|?
|steam {
|steam-engine
|?
|-
|firebox-to-boiler-heat-flow-idle
|?
|steam {
|steam-engine
|?
|-
|firebox-volume
|?
|steam {
|steam-engine
|?
|-
|flowsize {
|container
|config.txt
|engine
|?
|-
|fontcolor
|rgb value
|effects-ID {
|corona effect
|The colour of the sign text in r.g.b.
|-
|fonts
|integer
|config.txt
|traincar
|Indicates how many types of numbering fonts used.
|-
|fontsize
|float metres
|effects-ID {
|corona effect
|The size of the sign text
|-
|fonts-path
|folder
|config.txt
|traincar
|Replaces asset-filename usage for ‘fonts’.
|-
|frame-rate
|float frames/second
|config.txt
|turntable
|Generally make this 30 (frames per second)
|-
|frequency
|float per second
|effects-ID {
|corona effect
|This variable specifies the frequency in Hz (or ‘flashes’ per second). e.g. 1 for once per second, 0.5 for once every 2 seconds, 2 for twice per second.
|-
|fuel
|?
|mass {
|engine
|?
|-
|fuel-energy
|?
|steam {
|steam-engine
|?
|-
|function
|'TrackSignal'
|config.txt
|trackside
|Must be set to 'TrackSignal'
|-
|grounded
|float metres
|config.txt
|splines
|Height in meters for the road to be offset from terrain.
|-
|height
|float metres
|config.txt
|splines
|Height from the track level to the base. Must be a negative value in order to raise the bridge above the ground.
|-
|height
|integer
|thumbnails-ID {
|all
|Image height
|-
|height
|negative metres
|config.txt
|scenery
|Height from the track level to the base. Should be negative.
|-
|height-range
|min,max metres
|config.txt
|scenery
|height-range min, max eg: height-range –10, 100. Where min and max are values in meters.
|-
|hidden
|boolean
|config.txt
|splines
|Prevents the spline from being rendered.
|-
|highspeedexhauster
|?
|pressure {
|engine
|?
|-
|highspeedexhauster_vacuumbrakepipe
|?
|flowsize {
|engine
|?
|-
|hornsound
|kuid
|config.txt
|traincar
|References the KUID number for the traincar horn sound.
|-
|icon0
|kuid
|config.txt
|general
|Window preview icon - see information box
|-
|icon1
|kuid
|config.txt
|general
|Window preview icon - see information box
|-
|icon2
|kuid
|config.txt
|general
|Window preview icon - see information box
|-
|icon3
|kuid
|config.txt
|general
|Window preview icon - see information box
|-
|icon-texture
|[path/]filename.texture
|config.txt
|product
|The in-game representation of the product when specifying the load type for a compatible rollingstock item (driver) Should be a 64x64 TGA.
|-
|image
|[path/]filename
|thumbnails-ID {
|all
|Image filename
|-
|indbrakefull
|?
|pressure {
|engine
|?
|-
|independantbrakecylinder
|?
|volume {
|engine
|?
|-
|independantbrakecylinder_start
|?
|pressure {
|engine
|?
|-
|info-page
|[path/]filename.html
|config.txt
|profile
|Filename of the HTML information page for the session.
|-
|inherit-velocity
|?
|smoke# {
|smoke block
|?
|-
|initial-boiler-temperature
|?
|steam {
|steam-engine
|?
|-
|initial-count
|integer
|queues-ID {
|industry
|The initial number of items in the queue.
|-
|initiator
|folder
|config.txt
|splines
|Name of model to use at start of bridge, placed in subfolder with same name.
|-
|inputs {
|subcontainer
|processID {
|industry
|Input process list
|-
|inputs-ID {
|subcontainer
|inputs {
|industry
|User supplied identifier
|-
|instance-type
|'instance'/'resource'
|config.txt
|product
|Instance-type: 'resource' is used when there is no mesh, or one only mesh is referenced in the mesh table (Ie Liquids, Bulk loads etc). 'instance' is used when more than one mesh is in the mesh table Ie: Passengers, General Goods. 200 max.‘size’ per Asset.
|-
|interior
|kuid
|config.txt
|traincar
|References the KUID number for the traincar interior cab view.
|-
|interpolate
|?
|smoke# {
|smoke block
|?
|-
|invisible
|boolean
|config.txt
|splines
|Specifies whether the object is invisible.
|-
|isroad
|boolean
|config.txt
|splines
|Isroad/Istrack. Two boolean tags detailing the behavior of the bridge. If the isroad is set to true, then cars are placed on the bridge. Both values should not be set to true.
|-
|istrack
|boolean
|config.txt
|splines
|Isroad/Istrack. Two boolean tags detailing the behavior of the bridge. If the isroad is set to true, then cars are placed on the bridge. Both values should not be set to true.
|-
|junction-lever-mesh
|subcontainer
|junction-vertices-ID {
|fixed track
|The mesh (selected from the mesh table) to be used as a junction lever.
|-
|junction-vertex
|helper
|junction-vertices-ID {
|fixed track
|The attachment point (located in mesh file) at which to place the lever.
|-
|junction-vertices {
|container
|config.txt
|fixed track
|The Junction-Vertices Container contains the tags needed to handle the lever portions of a fixed track.
|-
|junction-vertices-ID {
|container
|junction-vertices {
|fixed track
|User supplied identifier
|-
|keyframes
|integer list
|config.txt
|turntable
|Specifies where on the animation the turntable is to stop.
|-
|kind
|'animation'
|effects-ID {
|effects-ID {
|This effect is used when a mesh has a variety of animations. Usually the animations will be controlled by a script related to the asset.
|-
|kind
|'attachment'
|effects-ID {
|effects-ID {
|In TRS we now have the ability to attach a mesh into another mesh by referencing it’s KUID through a meshtable.
|-
|kind
|'corona'
|effects-ID {
|effects-ID {
|A corona is a ‘glow’ light effect. It is a simple texture that is inserted at an attachment point within the mesh. Coronas can be added to any asset that uses a meshtable.
|-
|kind
|interior object kind
|mesh-table-ID {
|interior
|The type of interior object the particular mesh is. Affects the behavior of the mesh in game. Kinds: lever (Levers, switches, dials etc), animated-lever (Animated Levers etc Eg. in steam cabs), collision-proxy (Mouse collisions for animated levers), needle (Gauge needles, Speedo, brake pres.), pullrope (Pull rope horn as in the F7), light (Wheelslip light)
|-
|kind
|kind
|config.txt
|general
|Asset kind.
|-
|kind
|'name'
|effects-ID {
|effects-ID {
|Some assets may have editable signs. When you set an asset’s name in surveyor through the Edit Properties icon (‘?’ icon) the signage can be set-up to automatically update. The variables can be set for each sign.
|-
|kind
|'texture-replacement'
|effects-ID {
|effects-ID {
|This effect was created for rolling stock items to swap the visible texture of bulk loads (such as coal or woodchips).
|-
|kuid
|kuid
|config.txt
|general
|Asset kuid
|-
|kuid-table {
|container
|config.txt
|all
|List of all required dependencies.
|-
|kuid-table-ID {
|kuid
|kuid-table {
|all
|User supplied identifier
|-
|latitude
|?
|config.txt
|region
|latitude of this region
|-
|left-passenger-door {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Left side passenger doors.
|-
|length
|float metres
|config.txt
|splines
|Length of track segment in meters
|-
|levels {
|subcontainer
|tracksound {
|Tracksound
|Relative sound levels. The sound is silent until 0.1 m/s, ramping up in volume until 10.0 m/s, constant maximum after that. Note, a value below 0.1 will not play a sound.
|-
|licence
|string
|config.txt
|general
|User licence details
|-
|lifetime
|float
|smoke# {
|smoke block
|Time in seconds that smoke particles exist for. Default is 3.
|-
|light
|boolean
|config.txt
|scenery
|Sets lighting to be used for object to be ambient or directional. 0 sets ambient lighting and object is light by general light value, 1 sets directional light which is affected by the position of the sun.
|-
|light
|boolean
|mesh-table-ID {
|mesh object
|Sets lighting to be used for object to be ambient or directional. 0 sets ambient lighting and object is light by general light value, 1 sets directional light which is affected by the position of the sun.
|-
|light_color
|rgb value
|config.txt
|traincar
|RGB headlight colour. Eg. 255,255,255.
|-
|lights {
|container
|config.txt
|mosignal
|Signal lighting container. A list of coronas attached to each light point. Coronas are stored in each signal object’s directory alongside it’s textures.
|-
|lights-ID {
|subcontainer
|lights {
|mosignal
|Light point identifier.
|-
|limits
|float list
|mesh-table-ID {
|interior
|Mathematical boundaries Trainz uses determine the objects function. These values vary as different objects use different mathematical units.
|-
|longitude
|?
|config.txt
|region
|longitude of this region
|-
|loop
|float seconds
|smoke# {
|smoke block
|Time in seconds to loop the smoke sequence. Only valid if mode is set to time.
|-
|loopdelay
|float seconds
|smoke# {
|smoke block
|Delay (in seconds) before the effect is played again.
|-
|looped
|boolean
|effects-ID {
|animation effect
|Looped 1 (optional) Use only if the animation is looping (repeating). Default 0 (i.e. not looped).
|-
|looping
|boolean
|config.txt
|turntable
|specifies that the turntable can go all the way around, rather than stopping at a certain point.
|-
|mainreservoir
|?
|pressure {
|engine
|?
|-
|mainreservoir
|?
|volume {
|engine
|?
|-
|mainreservoir_ep
|?
|flowsize {
|engine
|?
|-
|mainreservoir_start
|?
|pressure {
|engine
|?
|-
|main-reservoir-volume
|?
|steam {
|steam-engine
|?
|-
|map-kuid
|kuid
|config.txt
|profile
|Kuid of the map attached to this session.
|-
|mass
|float kg
|config.txt
|product
|The physical mass of the product. For Containers and Passengers this is calculated in kilograms/unit, while for Liquid and Bulk loads this is calculated in kilograms/litre.
|-
|mass
|integer kg
|config.txt
|traincar
|Mass in kilograms
|-
|mass {
|container
|config.txt
|engine
|?
|-
|max-accel
|?
|motor {
|engine
|?
|-
|max-coupler-gap
|float metres
|config.txt
|traincar
|maximum gap expected between couplers of this type
|-
|max-decel
|?
|motor {
|engine
|?
|-
|max-distance
|float
|tracksound {
|Tracksound
|Maximum distance at which the sound is played. Eg 1000
|-
|max-fire-coal-mass
|?
|steam {
|steam-engine
|?
|-
|max-fire-temperature
|?
|steam {
|steam-engine
|?
|-
|maximum-volume
|?
|steam {
|steam-engine
|?
|-
|maxrate
|float
|smoke# {
|smoke block
|The maximum rate at which particles are emitted.
|-
|maxsize
|float
|smoke# {
|smoke block
|?
|-
|maxspeed
|?
|motor {
|engine
|?
|-
|maxspeedkph
|float
|smoke# {
|smoke block
|?
|-
|maxvoltage
|?
|motor {
|engine
|?
|-
|mesh
|[path/]filename.im
|mesh-table-ID {
|mesh object
|The mesh name. This may include a sub-path. ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.
|-
|mesh
|[path/]filename.lm
|mesh-table-ID {
|mesh object
|The mesh name. This may include a sub-path. ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.
|-
|mesh
|[path/]filename.pm
|mesh-table-ID {
|mesh object
|The mesh name. This may include a sub-path. ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.
|-
|mesh
|kuid
|config.txt
|drivercharacter
|This refers to the kuid of the mesh asset inserted in to the locomotive mesh at a.driver0 (when in the Driver Module).
|-
|mesh-table {
|container
|config.txt
|mesh object
|This is the new and preferred method of asset mesh placement for most mesh asset types. It gives huge control over mesh placement and animations. There are some asset types that cannot use a meshtable. These include all Bridges, Tunnels, Rails, Pantographs and other Spline Objects (eg. Fences or Catenaries).
|-
|mesh-table-ID {
|subcontainer
|mesh-table {
|mesh object
|User supplied identifier
|-
|mesh-table-ID {
|subcontainer
|mesh-table {
|interior
|User supplied identifier
|-
|min-distance
|float
|tracksound {
|Tracksound
|Minimum distance at which the sound is played. Eg 0.
|-
|minimum-volume
|?
|steam {
|steam-engine
|?
|-
|minrate
|float
|smoke# {
|smoke block
|The minimum rate at which particles are emitted.
|-
|minsize
|float
|smoke# {
|smoke block
|?
|-
|mode
|speed/anim/timeofday/time
|smoke# {
|smoke block
|Describes the mode or type of this smoke effect. This affects how start and period are interpreted. (time | speed | anim | timeofday).
|-
|mode0 {
|subcontainer
|mesh-table {
|trackside
|Mesh showing lever in first position
|-
|mode0 {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Mesh showing lever in first position
|-
|mode1 {
|subcontainer
|mesh-table {
|trackside
|Mesh showing lever in second position
|-
|mode1 {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Mesh showing lever in second position
|-
|motor {
|container
|config.txt
|engine
|?
|-
|mousespeed
|float
|mesh-table-ID {
|interior
|This controls the use of the mouse on screen. Use this to control the mouse speed and push/pull direction for levers and dials. • mousespeed -1 Inverts mouse direction. • mousespeed 2 Doubles mouse speed in default direction. • mousespeed -0.5 Inverts mouse direction and halves the speed.
|-
|moving-friction-coefficient
|?
|motor {
|engine
|?
|-
|name
|<blank>
|effects-ID {
|name effect
|Leave blank to allow the name to be inserted by script without an initial default.
|-
|name
|'name'
|effects-ID {
|name effect
|When name name is specified, it uses the asset’s changeable name. Changed through the Edit Properties icon (the ‘?’ icon) in Surveyor.
|-
|name
|string
|effects-ID {
|name effect
|The default text when placed. If name Graceland (for example) was used, the sign would never be able to be changed even though the user may have changed the asset’s name in Surveyor.
|-
|night
|[path/]filename.tga
|config.txt
|environment
|Name of image file for night sky. File should be 256 x 256 pixel 24bit tga. The file extension should be excluded here, ie “QLD_Sky” rather than "qLD_Sky.texture.txt”.
|-
|night-mesh-base
|mesh-table-ID {
|mesh-table-ID {
|mesh object
|The mesh to which 'default-night' is linked. If the 'night-mesh-base' is hidden then 'default-night' will not be displayed.
|-
|nightmode
|home/lamp/constant
|config.txt
|scenery
|Only add this tag if you reference a default-night mesh in the mesh-table. Values: home, lamp or constant.
|-
|no3pipe
|?
|flowsize {
|engine
|?
|-
|no3pipe
|?
|volume {
|engine
|?
|-
|no3pipe_autobrakecylinder
|?
|flowsize {
|engine
|?
|-
|no3pipe_mainreservoir
|?
|flowsize {
|engine
|?
|-
|no3pipe_start
|?
|pressure {
|engine
|?
|-
|no3pipevent
|?
|flowsize {
|engine
|?
|-
|no4pipe
|?
|flowsize {
|engine
|?
|-
|no4pipe
|?
|volume {
|engine
|?
|-
|no4pipe_start
|?
|pressure {
|engine
|?
|-
|normal
|[path/]filename.tga
|config.txt
|environment
|Name of image file for normal sky. File should be 256 x 256 pixel 24bit tga. The file extension should be excluded here, ie “QLD_Sky” rather than "qLD_Sky.texture.txt”.
|-
|nostartdelay
|boolean
|soundscript-ID {
|mesh object
|0 or 1, default 0 If not set, the sound will have a short delay before playing, this stops flanging (flanging is a really nasty sound caused when several copies of the same sound are played at once).
|-
|notches
|float list
|mesh-table-ID {
|interior
|The position of notches within the angle boundaries. These are represented as decimal points between and including 0 and 1.
|-
|notchheight
|float list
|mesh-table-ID {
|interior
|The size of the notches specified.
|-
|object-size
|float metres
|effects-ID {
|corona effect
|Size of the corona on the object when viewed up close Defaults to 0.15 (i.e. 0.15m)
|-
|obsolete-table {
|container
|config.txt
|all
|The obsolete-table describes the asset’s revision history.
|-
|ontheright
|boolean
|config.txt
|region
|Cars drive on the right side of the road.
|-
|opacity
|0..1
|mesh-table-ID {
|mesh object
|Controls the opacity of the mesh. Zero (invisible, not recommended) or one (solid).
|-
|opacity
|0..1
|mesh-table-ID {
|interior
|Usually used for the window mesh to give transparency (and the impression of reflection).
|-
|organisation
|string
|config.txt
|general
|Organisation name will show in Trainz in Railyard as the organisation for the model, for instance if you use Joe’s Trainz or Cripple Creek Logging Company.
|-
|origin
|string
|config.txt
|traincar
|The Country Abbreviation.
|-
|outputs {
|subcontainer
|process-ID {
|industry
|Output process list
|-
|outputs-ID {
|subcontainer
|outputs {
|industry
|User supplied identifier
|-
|paintshed-skin-used
|kuid
|config.txt
|paintshed-skin
|Kuid of the paintshed skin used. (if applicable)
|-
|paintshed-skin-used
|kuid
|config.txt
|paintshed-template
|Kuid of the paintshed skin to be used for this template.
|-
|paintshed-template-used
|kuid
|config.txt
|paintshed-skin
|Kuid of the paintshed template used. (if applicable)
|-
|pantograph
|kuid
|config.txt
|traincar
|The pantograph kuid number inserted at a.pant0, a.pant1, etc. Use this tag only when needed.
|-
|passenger-height
|float metres
|config.txt
|industry
|This value sets the height of the passenger asset in metres, to suit the platform model height. (Doesn't work)
|-
|passenger-queue
|boolean
|queues-ID {
|industry
|Defines this as a passenger station queue.
|-
|period
|?
|smoke# {
|smoke block
|The usage of period depends on the value of the mode tag. If the mode is set to time, period is the duration of time this effect will remain active.
|-
|permit-commit
|boolean
|privileges {
|all
|Allows the end-user to commit changes to this asset.
|-
|permit-edit
|boolean
|privileges {
|all
|Allows the end-user to open this asset for editing
|-
|permit-listing
|boolean
|privileges {
|all
|Allows the end-user to view this object in the surveyor pickers (if it is of an appropriate kind.) Does not affect the visibility of the asset within the CMP asset list.
|-
|piston-angular-offsets
|?
|steam {
|steam-engine
|?
|-
|piston-area
|?
|steam {
|steam-engine
|?
|-
|piston-to-atmosphere-flow
|?
|steam {
|steam-engine
|?
|-
|piston-volume-max
|?
|steam {
|steam-engine
|?
|-
|piston-volume-min
|?
|steam {
|steam-engine
|?
|-
|pressure {
|container
|config.txt
|engine
|?
|-
|preview-mesh-kuid
|kuid
|mesh-table-ID {
|mesh object
|The mesh to be used in the surveyor preview area. This is useful when an asset has a large bounding box. Ie the "Airport” with it’s jet animation.
|-
|preview-scale
|float
|mesh-table-ID {
|mesh object
|Scale of the preview mesh.
|-
|priority
|float, 0 = highest
|tracksound {
|Tracksound
|The priority of the sound versus other sounds to be played. Lower values indicate a higher priority.
|-
|privileges {
|container
|config.txt
|all
|Limited content protection applies only to built-in (JArchived) assets.
|-
|processes {
|container
|config.txt
|industry
|Processes (required) The input and output settings of the industry. You can specify the amount of input and output for each queue referenced product as well as the duration (or rate) in seconds for that process to take place. All queues and processes are linked through the industry asset’s script file.
|-
|process-ID {
|subcontainer
|processes {
|industry
|User supplied identifier
|-
|product-category
|kuid
|config.txt
|product
|Kuid of applicable category for this product
|-
|product-id
|?
|config.txt
|paintshed-skin
|For paintshed support.
|-
|product-kuid
|kuid
|queues-ID {
|industry
|The product type used to fill ‘initial-count’
|-
|product-texture
|[path/]filename.texture
|config.txt
|product
|The texture to be used with load ‘texture-replacement’. Ie When a hopper loads woodchips instead of it’s default load of coal.
|-
|product-type
|?
|config.txt
|paintshed-skin
|For paintshed support.
|-
|product-version
|?
|config.txt
|paintshed-skin
|For paintshed support.
|-
|queue
|queues-ID {
|inputs-ID {
|industry
|queue from which to take input.
|-
|queue
|queues-ID {
|outputs-ID {
|industry
|queue in which to place output.
|-
|queues {
|container
|config.txt
|industry
|The queues container states which product or products the industry can use. It contains the size of each product, the initial count when placed, and can refer to it’s visual load state whether through a load animation or attachment.
|-
|queues-ID {
|subcontainer
|queues {
|industry
|User supplied identifier
|-
|radius
|float
|attached-trigger-ID {
|industry
|Radius (in meters) of the trigger.
|-
|radius
|float
|mesh-table-ID {
|interior
|The notch position relative to the attachment point.
|-
|random-color-high-hsb
|hsb value
|config.txt
|scenery
|For clutter-mesh objects, specifies a color range for tinting purposes. HSB color space.
|-
|random-color-low-hsb
|hsb value
|config.txt
|scenery
|For clutter-mesh objects, specifies a color range for tinting purposes. HSB color space.
|-
|rate
|float particles/second
|smoke# {
|smoke block
|The rate of emission in particles per second for modes time, speed, and timeofday, or the number of particles to emit over the animation period for anim mode. Default is 4.
|-
|region
|region code
|config.txt
|general
|The country region to which this asset belongs. This should be one of the Auran-supplied region names
|-
|repeat-delay
|random [min,max] seconds
|soundscript-ID {
|mesh object
|1 or 2 numbers (min, max, in sec) time to delay between the end of the sound playing, and playing it again randomised between(min .. max) default min is 0, default max is equal to min Notes: Repeat-delay now has two values rather than one. When upgrading old assets, make sure there is a repeat delay for both values or the sound will loop endlessly when triggered.
|-
|repeats
|integer
|config.txt
|splines
|The number of times the mesh is placed between spline points
|-
|resistance
|?
|motor {
|engine
|?
|-
|reversed
|boolean
|bogeys-ID {
|traincar
|Affects the direction of the bogey.
|-
|rgb
|rgb value
|config.txt
|splines
|This value should be left as default.
|-
|right-passenger-door {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Right side passenger doors.
|-
|rollstep
|float degrees
|config.txt
|scenery
|Where n is a value in degrees. Used in conjunction with rotate-yz-range, rollstep lets you specify the step size of roll angles for this object. Other example values are 1, 5, 20 etc. The default rollstep is 1.0.
|-
|rotate
|boolean
|config.txt
|scenery
|Where n is 0 or 1 (default). This lets you disable rotation on a scenery object. 0 to disable, 1 to enable (default).
|-
|rotate-yz-range
|min,max degrees
|config.txt
|scenery
|Where min and max are values in degrees. This tag lets you set the roll / yz rotation range (normal object rotation is an xy rotation). If you want your scenery object to support rolling then use this tag to set the minimum and maximum roll range. By default, objects have a min/max roll range of 0 to 0.
|-
|rotstep
|float degrees
|config.txt
|general
|Where n is a value in degrees. This lets you specify the step size of rotation angles for this object. Other example values are 1, 10, 20, 90, 180 etc. The default rotstep is 1.0
|-
|running-number
|string
|consists-vehicle-ID {
|industry
|Running number of the vehicle.
|-
|safety-valve-high-flow
|?
|steam {
|steam-engine
|?
|-
|safety-valve-high-pressure
|?
|steam {
|steam-engine
|?
|-
|safety-valve-low-flow
|?
|steam {
|steam-engine
|?
|-
|safety-valve-low-pressure
|?
|steam {
|steam-engine
|?
|-
|scale
|?
|smoke# {
|smoke block
|?
|-
|scale
|?
|mass {
|engine
|?
|-
|scale
|?
|pressure {
|engine
|?
|-
|scale
|?
|volume {
|engine
|?
|-
|script
|[path/]filename.gs
|config.txt
|general
|This refers to the name of the script file.
|-
|search-limit
|?
|config.txt
|trackside
|Not required. For internal use only.
|-
|shadow {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier. Shadow mesh.
|-
|shadows
|?
|config.txt
|splines
|Undocumented
|-
|shift
|?
|smoke# {
|smoke block
|?
|-
|shovel-coal-mass
|?
|steam {
|steam-engine
|?
|-
|showhelp
|boolean
|driver-settings {
|activity
|Show Driver Help. (off, on)
|-
|show-in-consist-menu
|boolean
|consists-ID {
|industry
|Boolean flag that dictates whether this 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.
|-
|signals {
|container
|config.txt
|mosignal
|Sets out which aspects the signal is capable of displaying, and also which light points are activated when each state is displayed.
|-
|signals-ID {
|subcontainer
|lights {
|mosignal
|Signal point identifier.
|-
|size
|integer
|queues-ID {
|industry
|Size of queue.
|-
|smoke_fastlife
|float
|config.txt
|traincar
|Longevity of smoke particles at normal speed.
|-
|smoke_fastspeed
|?
|config.txt
|traincar
|?
|-
|smoke_height
|float
|config.txt
|traincar
|How hard particles are pushed out of the stack.
|-
|smoke_random
|float
|config.txt
|traincar
|Level of particle excitation.
|-
|smoke_shade
|float
|config.txt
|traincar
|Smoke opacity. (0 - 1)
|-
|smoke_slowlife
|float
|config.txt
|traincar
|Longevity of smoke particles at low speed.
|-
|smoken {
|container
|config.txt
|smoke block
|?
|-
|snapgrid
|float metres
|config.txt
|scenery
|Where n is a value in meters. This lets you specify the size of the grid the object snaps to. We recommend factors/fractions of 720 as this is the size of a base board and the positioning may do funny things across section borders. e.g. 1, 2, 5, 10, 20, 30, 40, 45, 60, 80, 90, 120, 180, 240, 360, 720. The default snapgrid is 10.
|-
|snapmode
|0/1/2
|config.txt
|scenery
|Where n is either 0 (default) , 1 or 2. Use snapmode to enable snapping of a scenery object to the snap grid. 0 will disable grid snapping (default), 1 will enable grid snapping, 2 will enable an offset grid snapping. Offset grid snapping will cause objects to be snapped to the grid but will also offset the object’s position by ½ the grid size – essentially positioning the object in between the normal grid lines.
|-
|sound {
|subcontainer
|soundscript-ID {
|mesh object
|List of .wav files to play (randomly picked)
|-
|soundscript {
|container
|config.txt
|mesh object
|Controls the looping sound made by the object.
|-
|soundscript-ID {
|subcontainer
|soundscript {
|mesh object
|User supplied identifier
|-
|speed
|float
|effects-ID {
|animation effect
|Speed factor of the animation. Default 1, 2 for double speed, 0.5 for half speed
|-
|speedlimit
|float metres/second
|config.txt
|trackside
|This value is the maximum speed allowed in meters per second
|-
|start
|?
|smoke# {
|smoke block
|The usage of stard depends on the value of the mode tag. If the mode is set to time, start is a set of time values in seconds after the creation of this effect’s parent object when this phase of the effect will start. If the mode is set to speed, start is a speed in meters per second (m/s) and period is not used. (Note: 1 m/s = 3.6 km/hr.) All other sequence attributes (rate, velocity, lifetime, minsize, maxsize) are interpolated so there are smooth transitions between phases. If the mode is set to anim, start is a value from 0.0 to 1.0 which describes the start time into the object’s animation cycle. If the mode is set to timeofday, start is a value from 0.0 to 1.0 which describes the time of day when this effect will start. Values range as follow: 0 - midnight, 0.25 - 6am, 0.5 - midday, 0.75 6pm, 1.0 - midnight.
|-
|start-enabled
|boolean
|process-ID {
|industry
|Specifies whether the process starts enabled.
|-
|startingtime
|0..1
|driver-settings {
|activity
|Time of day. Range is from 0 to 1 (0.5 - midday).
|-
|steam {
|container
|config.txt
|steam-engine
|?
|-
|storm
|[path/]filename.tga
|config.txt
|environment
|Name of image file for stormy sky. File should be 256 x 256 pixel 24bit tga. The file extension should be excluded here, ie “QLD_Sky” rather than "qLD_Sky.texture.txt”.
|-
|string-table {
|container
|config.txt
|all
|The string table stores a list of text strings to be used by the industry script.
|-
|string-table-## {
|container
|config.txt
|all
|These alternative string tables store translated strings
|-
|supports-null-driver-character
|boolean
|config.txt
|drivercommand
|Command can be executed without a driver present in the selected loco.
|-
|surface-area
|?
|motor {
|engine
|?
|-
|surveyor-name-label
|boolean
|config.txt
|general
|Specifies whether this item has floating name label text.
|-
|surveyor-only
|boolean
|config.txt
|general
|Adding this means the attached mesh will only be visible in Surveyor and not Driver.
|-
|surveyor-only
|boolean
|effects-ID {
|attachment effect
|Adding this means the attached mesh will only be visible in Surveyor and not Driver.
|-
|tender
|boolean
|config.txt
|traincar
|Specifies that the traincar is a tender.
|-
|terminator
|folder
|config.txt
|splines
|Name of model to use at end of bridge, placed in subfolder with same name.
|-
|test-collisions
|boolean
|mesh-table-ID {
|interior
|Mouse cannot be used for this mesh. Collision mesh used instead. Ie animated-levers.
|-
|texture
|[path/]filename.texture
|config.txt
|general
|An image texture file.
|-
|texture
|[path]/filename.texture
|effects-ID {
|texture-replacement effect
|Texture reference denoting the texture file to be swapped by this effect.
|-
|texture
|kuid
|smoke# {
|smoke block
|Kuid of the texture to be used for the effect.
|-
|texture-kuid
|<blank>
|effects-ID {
|corona effect
|If the texture-kuid tag is not present the corona will use the default yellow/orange texture in TRS.
|-
|texture-kuid
|kuid
|effects-ID {
|corona effect
|Add this tag only when you want to specify your own texture for the corona. It specifies the KUID of a kind texture asset. See KIND TEXTURE.
|-
|textures {
|container
|config.txt
|texturegroup
|The textures container stores a list of additional textures to be used in the texture group.
|-
|three-part
|boolean
|config.txt
|hornsound
|Specifies that the hornsound has a beginning, middle and ending sound.
|-
|throttle-notches
|?
|motor {
|engine
|?
|-
|throttle-power {
|container
|config.txt
|engine
|?
|-
|thumbnails {
|container
|config.txt
|all
|Any asset may specify a thumbnail or preview image.
|-
|thumbnails-ID {
|subcontainer
|thumbnails {
|all
|User supplied identifier
|-
|timerate
|float
|driver-settings {
|activity
|Time progression. (1 - real-time, 2 - double speed etc.)
|-
|track
|kuid
|attached-track-ID {
|scenery with track
|Kuid of the track to be used.
|-
|track
|kuid
|tracksound {
|Tracksound
|The track type to which this sound will apply
|-
|track
|trackID
|attached-trigger-ID {
|industry
|The track name which the train must be on to trigger.
|-
|trackmark
|boolean
|config.txt
|trackside
|Specifies that the object is a trackmark.
|-
|trackoffsets
|float list, metres
|config.txt
|splines
|Distance in meters the rail/s are attached to the center of the spline. Any number of tracks can be attached to the spline, only splines with the same track offsets can be connected together.
|-
|track-parent
|kuid
|tracksound {
|Tracksound
|The parent (eg. bridge/industry/tunnel) of the track to which this sound will apply.
|-
|trackside
|float metres
|config.txt
|trackside
|This is a value that is the distance in meters the object is placed relative to the center of the track. Negative values will put the object on the left side of the track, and positive values will appear on the right.
|-
|track-sound
|kuid
|tracksound {
|Tracksound
|The kuid of the tracksound object to be used.
|-
|tracksound {
|container
|config.txt
|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).
|-
|trainbrakepipe
|?
|flowsize {
|engine
|?
|-
|trainbrakepipe
|?
|volume {
|engine
|?
|-
|trainbrakepipe_reservoir
|?
|flowsize {
|engine
|?
|-
|trainbrakepipe_start
|?
|pressure {
|engine
|?
|-
|trainbrakepipevent
|?
|flowsize {
|engine
|?
|-
|trainz-build
|build code
|config.txt
|general
|The Trainz build is the version number for which this asset was created.
|-
|trigger
|boolean
|config.txt
|trackside
|Specifies that the object is a trigger.
|-
|trigger
|string
|soundscript-ID {
|mesh object
|A trigger may be used in an event file (.evt) associated with an animation. It plays at selected key frames of animation as defined in the event file. Sound files may triggered in this manner, and from scripting. Used in the mojunction example (switch lever) the “toggle” action is automatically triggered when the lever is operated and the sound plays.
|-
|turntable {
|mesh-table-ID {
|mesh-table {
|turntable
|Predefined submesh identifier
|-
|turntable {
|subcontainer
|mesh-table {
|mesh object
|Predefined submesh identifier.
|-
|two-part
|boolean
|config.txt
|hornsound
|Indicates that the Railyard and Driver hornsounds are different. The Driver hornsound is looping. If this tag is not present, the hornsound defauts to UTC equivalent non-looping format.
|-
|type
|string
|config.txt
|scenery
|Specify a type for the model that will be used in the Surveyor menu drop down menu for Track or Object type.
|-
|uncached_alphas
|boolean
|config.txt
|splines
|This is used in certain situations to improve alpha sorting. This should only be set to 1 for tracks that use an alpha texture and are always placed flat
|-
|unit_mesh
|folder
|config.txt
|splines
|For mesh-reducing track, the filename of the long mesh, which must be placed in a subdirectory of the same name as the mesh. Only the file name is entered, not the directory name nor the file extension. For example, the full pathname and extension is “rockwall/rockwall.im”. Enter only “rockwall” in the text input box.
|-
|upright
|boolean
|config.txt
|splines
|Specifies whether the bridge “legs” point vertically, or perpendicular to the spline.
|-
|useadjoiningtracktype
|boolean
|attached-track-ID {
|scenery with track
|Indicates whether the track type should change to match that of the first track joined to the object.
|-
|use-gradient-track
|boolean
|config.txt
|scenery
|This means to use the spline gradient rather than following the ground height.
|-
|use-parent-bounds
|boolean
|mesh-table {
|mesh object
|Specifies that the mesh should use the bounds of the parent object for visibility culling. Use with caution.
|-
|username
|string
|config.txt
|general
|The human-readable English name of this asset.
|-
|username-##
|string
|config.txt
|general
|The human-readable translated name of this asset.
|-
|vacuumbrakecylinder
|?
|volume {
|engine
|?
|-
|vacuumbrakecylinder_start
|?
|pressure {
|engine
|?
|-
|vacuumbrakecylinder_vacuumbrakepipe
|?
|flowsize {
|engine
|?
|-
|vacuumbrakepipe
|?
|volume {
|engine
|?
|-
|vacuumbrakepipe
|?
|flowsize {
|engine
|?
|-
|vacuumbrakepipe_start
|?
|pressure {
|engine
|?
|-
|vacuumbrakepipereleasevent
|?
|flowsize {
|engine
|?
|-
|vacuumbrakepipevent
|?
|flowsize {
|engine
|?
|-
|vacuumbrakereservoir
|?
|volume {
|engine
|?
|-
|vacuumbrakereservoir_start
|?
|pressure {
|engine
|?
|-
|vacuumbrakereservoir_vacuumbrakepipe
|?
|flowsize {
|engine
|?
|-
|value-range
|min,max time of day
|soundscript-ID {
|mesh object
|2 numbers, currently used only for day/night sound effects. Midnight is 0.5, midday = 0.0 or 1.0 Where the numbers are not the same, this sets the start and end times for the sound to play. Default 0,0 (off)
|-
|vehicle
|kuid
|consists-vehicle-ID {
|industry
|The kuid of the vehicle to be used.
|-
|velocity
|float
|smoke# {
|smoke block
|The initial speed of emitted smoke particles. Default is 1.
|-
|vertices {
|subcontainer
|attached-track-ID {
|scenery with track
|Attachment points at which to place track.
|-
|visible-on-minimap
|boolean
|config.txt
|splines
|Specifies whether the object\track is displayed on the minimap.
|-
|volume
|0..1
|soundscript-ID {
|mesh object
|Gain of the sound Default 1.0 = 100%
|-
|volume {
|container
|config.txt
|engine
|?
|-
|water
|kuid
|config.txt
|map
|Undocumented
|-
|watercolor
|rgb value
|config.txt
|region
|RGB colour value of the water for the region.
|-
|water-injector-rate
|?
|steam {
|steam-engine
|?
|-
|wave-shift
|?
|effects-ID {
|corona effect
|Affects the flashing intensity pattren on the corona.
|-
|weather
|0..7
|driver-settings {
|activity
|Weather setting. (clear, cloudy, drizzle, rain, stormy, light snow, medium snow, heavy snow)
|-
|westinghouse-volume
|?
|steam {
|steam-engine
|?
|-
|width
|float metres
|config.txt
|splines
|Width of track mesh in meters.
|-
|width
|integer
|thumbnails-ID {
|all
|Image width
|-
|workingscale
|?
|config.txt
|map
|Undocumented
|-
|workingunits
|?
|config.txt
|map
|Undocumented
|-
|}

Automating Animations.

2010-03-25T09:34:57Z

Windwalkr (legacy 2550):

The code to deal with this follows. Any text sandwiched between /* and */ character pairs, and the text on any line starting with //, will be treated as a comment and ignored by the compiler.

include "Buildable.gs"

class Tutorial isclass Buildable {

/* We will need a variable to keep track of whether the shed doors are open or closed,
declaring this in the body of the class and outside of any method definitions will
make it available to any method in the class.*/ 

bool doorsOpen = false;

/* We are going to open and close the doors whenever a vehicle enters or leaves the area
defined by our trigger. To do this we will be listening for ''Object,InnerEnter'' and
''Object,InnerLeave'' messages. We do this by adding a handler in Init().*/ 

public void Init(void) {
inherited();
SetFXCoronaTexture("corona",null);
AddHandler(me,"Object","","ObjectHandler");
}

/* Object handler will 'wake up' whenever we receive an Object message. It is good
practice to check that the message is coming from an expected source. This is done
by converting or 'casting' the source of the message to a vehicle. If the cast does
not work the variable ''vehicle'' will be null and the handler is exited immediately.
The remainder of the method checks whether the vehicle is entering or leaving and runs
the animations as appropriate. ''SetMeshAnimationState()'' runs the animation attached
to the named mesh from its current position to the beginning or end, depending on the
value of the second parameter.*/ 

void ObjectHandler(Message msg) {
Vehicle vehicle = cast<Vehicle>msg.src;
if (!vehicle) return;
if (msg.minor == "InnerEnter") {
doorsOpen = true;
SetMeshAnimationState("default", true);
}
else if (msg.minor == "InnerLeave") {
doorsOpen = false;
SetMeshAnimationState("default", false);
}
}

};

There are a couple of quirks to notice about the code in ''ObjectHandler'':

1. The cast statement '''Vehicle vehicle = cast<Vehicle>msg.src;'''
* If you have remembered that TrainzScript is case sensitive you will see that there is a difference between ''Vehicle'' and ''vehicle''.
* The former is a built-in class name and the latter is a variable, so the phrase ''Vehicle vehicle'' is a declaration of a variable called ''vehicle'' to be of the class ''Vehicle''. You may need to read that a couple of times.
* I don't personally like this convention (script is confusing enough without it) but you will see it frequently so you might as well start getting used to it now.

2. The ''if'' statement '''if (msg.minor == "InnerEnter") doorsOpen = true;'''
* '''==''' and '''=''' mean different things.
* ''doorsOpen = true'' is an assignment, the same as saying let ''doorsOpen'' be equal to ''true''.
* ''msg.minor == "InnerEnter"'' is a comparison which will return ''true'' if ''msg.minor'' is equal to ''"InnerEnter"'' and false otherwise.
* The most common mistake you will make is to type ''if (msg.minor = "InnerEnter")'', missing out the second equals sign. This will always evaluate to true, will usually mess up your code, and will always be difficult to spot. You have been warned.

To check out your script:
* Compile the code and reload and commit the asset.
* Start Surveyor and place an instance (a copy) of the object on your map.
* Add a section of track to the track node nearest to the doors and extend it some distance away from the object
* Place a railcar or something similar at the far end of the track, orient it towards the engine shed.
* Go to Driver via the Quick Launch button, select DCC mode and click on the train that you have just placed.
* Issue a ''Drive'' command.
The selected train should head off towards the engine shed. Once it gets close enough the doors should open and the train should slow down as it approaches the end of the track. Once inside the train should stop and the doors should close. Since the shed doesn't currently have a visible roof you will be able to see all of this happening.

If its not quite right you may need to go back to the Max source and adjust some of the dimensions. The Object messages which control the doors are issued when the centre point of the traincar crosses the trigger radius. 
Next Tutorial: [[Handling Corona Effects.]]

Attachment point

2010-03-25T09:34:44Z

Windwalkr (legacy 2550):

Attachments are the means of specifying how sub meshes or other effects are placed or attached in a model.

=Attachments=
An attachment point is located in the model and reference is made from the [[Config.txt_file|config.txt]] file, to define its use and function.

Attachment points use the '''a.name''' convention, to be recognised in Trainz. For an attachment point to move with an animated dummy, there is a special naming convention for the point in 3dsmax, e.g. '''a.r.dummy/a.name'''.

Attachment points should be created in top view, and the orientation of the axis will then be consistent. Sometimes the attachment point may not be facing the correct direction, and has to be rotated (realigned). Refer to other sections for advice on any special orientation required for different attachment points, for track, names, bogeys, coupler points and effects.

'''a.bog''', '''a.limfront''' and '''a.limback''' are some of the important attachments for rollingstock models. As these have specific placements, it may be helpful to save a file of these points as a template, so you can merge it with your next model. With a few adjustments, you can quickly incorporate the template into the model and be sure the point names and orientation are correct.

=3D Studio Max Guidelines=
In 3dsmax: ‘Create’ tab, ‘Helpers’, ‘Point’.

[[Image:attachmentpointcreation.jpg]]

To maintain correct alignment, attachment points should be created in the TOP viewport. The front end of the train body should be on the Left hand side when displayed in the RIGHT viewport in 3dsmax (ie, in TOP view, the loco should face down the page).

Any object in the scene that has to move (ie. levers and dials), or animate, will need to be ‘detached’ from the main model. To do this, select the polygons or elements you want detached and through the 3dsmax modify panel, press the detach button and name the new object.

To make life a heck of a lot easier later on, it pays to move the pivot point of each new object to it’s logical position. Ie. For needles and levers the pivot point should be the centre of rotation (with the rotation around the Z axis). Align lever shaft in the Positive Y direction.

To do this, access the 3dsmax Hierarchy panel, and press Affect Pivot Only. From here you can centre and align the pivot to the object and move it to the preferred
location.

[[image:3dsmaxpivotpoint.jpg]]

Be aware that the point itself must be rotated correctly, not the axis of the point. The '''Hirerachy'''...'''Affect Pivot Only''' option may be turned on to determine the orientation of the point, it must then be turned off before rotating the point (click on the Affect Pivot Only box to toggle on/off). Turn on the axis information again to verify the rotation of the point has been done correctly.

Once the pivot points have been set for all your new objects, now is the time to start adding attachment points. Add these through the 3dsmax create panel (see image below). Remember to use the '''a.name''' naming convention. Attachment points are simply points in 3D space where another mesh can inserted (through [[Config.txt_file|config.txt]] reference).

Since you have already worked out the pivot points of all your objects, all you have to do is align the attachment points to your object pivot points. Press the icon (above) and select the object to align to....

These attachments are exported as part of the default mesh (or the main mesh). Objects for attachment must not be included in the export as they are each exported from their own 3dsmax files and attached to the default mesh separately (through [[Config.txt_file|config.txt]] reference).

''Remember to save a backup of the 3dsmax file!!'' Select each object from the scene and save each one as its own 3dsmax file, (command panel, file - save selected). You may delete the object from the main mesh scene after you save it.

[[Image:3dsmaxmoveandrotate.jpg]]
The next step is to open each 3dsmax file you have just created (of the movable objects), and move the object to 0,0,0 and make the rotational values 0,0,0 (press and right click these 3dsmax icons). This makes the object (and it’s pivot) aligned correctly to the origin of the scene.

Now is the time to export the object to a Trainz mesh file (.im).

=Naming=

==Moving attachment points for other models==
Attachments use the '''a.name''' convention and allow the attachment of a submesh to a specific point in a mesh. If the attachment point in the main mesh is to move with an animation of that mesh, the special naming convention above must be used for the point to follow the animation, and allow the submesh to then follow the point.
For example, a submesh is to be attached to a main mesh using the attachment name '''a.lever'''. This attachment point in the main mesh must be linked to a helper point called '''b.r.pivot''', that is animated.
The attachment point in the 3dsmax model must be named '''a.r.pivot/a.lever'''. In the [[Config.txt_file|config.txt]] file the attachment point will be entered as '''a.lever'''. Note the helper point in 3dsmax will be called '''b.r.pivot''', '''not a.r.pivot'''!
The submesh will now follow any animation in the main mesh. It can be useful for moving coronas, and animated nightwindow meshs.

==Level Of Detail Meshes==
From a '''.lm.txt''' configuration file:
attachmentCutOff = 0.1;
Attachment cutoff specifies the level where attachments with the flag ''':Cull''' are dropped.

ie To stop drawing the bogeys of the trains at a specific level of detail, append ''':Cull''' to the bogie attachment point. (ie '''a.bog0:Cull''' )

Where the above applies (bogeys culled) the body mesh will need a low poly representation of the bogeys.

==Special Attachment Points==
A number of [[Vehicle Attachment Points]] are reserved for predefined use in Trainz.

Animation-Event Message

2010-03-25T09:34:18Z

Windwalkr (legacy 2550):

Generic events can be linked to an animation key frame to give a measure of control over script timing. This is a different mechanism from Sound_Event, which interfaces with a ''soundscript'' container in config.txt and does not require scripting.

When an animation file, *.kin, is exported from Max, the exporter will make a query for an event file. Tick the box and you will be asked to browse to the file. The event information is added to the contents of the new animation.

* To produce an animation event which can be read by script you need to insert a line or lines similar to that below to a plain text file and to save it with an *.evt file extension.

002 Generic_Event animstart

* This example will result in the message ''Animation-Event,animstart'' being sent by the game whenever the animation plays past frame 2.
* It is best to avoid issuing events on the first or last frames since these are not always converted reliably into messages.
* To use the message you should define a handler using:

AddHandler(me,"Animation-Event","","AnimationHandler");

void AnimationHandler(Message msg) {
if (msg.minor == "animstart")
Interface.Print("Animation has started");
else if (msg.minor == "animstop")
Interface.Print("Animation has completed");
}

* In practice the game engine often issues duplicate messages so you will need to ensure that you are not responding more often than necessary. One way of doing this is to use a boolean variable to keep track of what your script is doing and use this to ignore duplicating script actions.

==See Also==
* [[List of Standard Messages]]

"mesh-table" container

2010-03-25T09:34:01Z

Windwalkr (legacy 2550):

The "mesh-table" container is a top-level [[config.txt file]] entry used by various [[Content Types]].

The mesh-table is a list of mesh subcontainers with no standalone tags. Each mesh subcontainer uses the following format. Tags are parsed in a standardised format, but not all [[Content Types]] support the full range of tags. Each mesh derives its name from the subcontainer's tag name. These names are used to refer to specific meshes from within the mesh-table and also from script.

=Supported Tags=
Each mesh subcontainer supports the following tags. Each tag is shown here with its default value.

mesh-asset <NULLKUID>
mesh ""
anim ""
lod-level 255
mesh-season 255
att ""
att-parent ""
opacity 1.0
position 0,0,0
orientation 0,0,0
auto-create 0
use-parent-bounds 0
animation-loop-speed 0
light 1
critical-animation 1
effects
{
}
night-mesh-base ""

====mesh-asset====
''TBD''

====mesh====
The ‘main’ mesh name. This may include a sub-path;
ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.

Use .im files exported from 3dsmax (as opposed to .pm.) or reference an .lm file if you wish your asset to have ‘Level of Detail’ mesh reduction.

Level of detail is a process of using different model meshes, depending on how far the viewer is from the model. A finer mesh is used for close up viewing in Trainz.

====anim====
The animation file (.kin) exported from 3dsmax. This may include a sub-path.

====lod-level====
The object LOD level at which this mesh is displayed. The default value (255) indicates that this mesh is visible at all detail levels. See also [[KIND Mesh]] for the 'mesh-detail-level' tag.

====mesh-season====
The season index for which this mesh is displayed. The default value (255) indicates that this mesh is visible in all seasons. See also [["Season-selector" container]].

====att====
The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).

====att-parent====
The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.

====opacity====
''TBD'

====position====
''TBD'

====orientation====
''TBD'

====auto-create====
The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.

====use-parent-bounds====
When enabled, this tag indicates that render culling should occur using the whole object's bounding box rather than this mesh's bounding box. Bounding boxes on individual meshes may not update correctly when animation moves the object's geometry any significant distance from the bind position. This flag can help mitigate such effects, at a tiny performance penalty.

====animation-loop-speed====
This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax.

====light====
''TBD'

====critical-animation====
"critical-animation" indicates that this mesh's animation generates events which are critical to the script system's behavior. If your asset is not scripted, does not use scripted animation events, or only uses the events for display purposes and will not break if the occasional event is missed, this tag should be set to ''false''. Leaving this flag set to ''true'' is a '''significant''' performance penalty.

====night-mesh-base====
This night mesh is linked to the specified mesh and is visible only at night. It is invisible if the specified mesh is invisible, (if the auto-create 0 line were used so the specified mesh can be controlled by script).

=Effects Container=
The effects container also contains a list of effect subcontainers. The effect subcontainers support the following generic tags.

kind ""
name ""

The effect subcontainers support additional tags depending on the effect kind. The following effect kinds are supported:

* [[Corona Effect]]
* [[Name Effect]]
* [[Attachment Effect]]
* [[Animation Effect]]
* [[Texture-Replacement Effect]]

=Mesh-Table Example=
The following is an example of a simple mesh-table which implements two levels of detail.

mesh-table
{
default-lod0
{
mesh "example-lod0.im"
auto-create 1
lod-level 0
}
default-lod1
{
mesh "example-lod1.im"
auto-create 1
lod-level 1
}
}

[[Category:Config Container]]

CCG/New in TC

2010-03-25T09:32:47Z

Windwalkr (legacy 2550):

This information is all pretty much obsolete and should be re-factored or removed. Historical information should be moved to the appropriate product page(s).

==CHAPTER 1: The Basics==

'''New in TC'''

TC introduces a number of new functions specifically designed to enhance the performance of Trainz. The aim in this build is to make the train driving experience more realistic. Some of the new features in TC are.

''In the Simulator:''
* Flexible Cab Signalling system
* Headlight dimmer system
* Flashing ditch-lights
* Train controlled sounds, lights and boom gates at build-in road crossings
* Automatic Train Protection options
* New sound functions for better representation of electric traction
* New Freeways feature supporting and including one way and multi-lane roads
* Remodelled roadway traffic featuring working head lights
* Computerised in-cab displays
* Improved Heads-Up-Display options
* Improved session-design options

''New Routes:''

* a route based on the Harlem Line in New York, developed by Auran staff
* also included is Metropolis - Modula City developed by third party creators.

''For Managing Content:''

The [[Content Manager]] module makes the management of assets very easy. It is integrated with the Download Station, listing the assets available on the Download Station, enabling updating of the list when connected to the Download Station via the Internet, and making the upload or download an efficient and simple process.

[[Content Manager]] relies on a database of content in your installation on your computer. This database makes the loading of data into Trainz on start up very efficient, and minimises load time.

''For Content Creation:''

The [[Content Creator Plus]] module is integrated with the [[Content Manager]] module. It is essential for creating content in TC.This document will cover detail on how to use Content Creator Plus to create config.txt files and manage the asset files.

New functions in TC for creators are covered in Appendix D.

CCG/Getting Started

2010-03-25T09:31:49Z

Windwalkr (legacy 2550):

==CHAPTER 3: Understanding and using Content Creator Plus==

The purpose of this chapter is to introduce users to [[Content Creator Plus]], a powerful program used to generate and validate [[config.txt file]]s. [[Content Creator Plus]] is intended for in-experienced content creators, however a degree of understanding regarding kinds and containers is assumed. Please refer to other Chapters in this document for assistance in familiarising yourself with the requirements and structures of containers and tags.

'''Getting Started'''

===Main Screen===

The main screen is divided into a number of areas:

[[Image:CCGFigure3-1.png|CCG main screen]]
* 1. Tree View
* 2. Tag space
* 3. 3D Viewport (only visible when a mesh is selected)
* 4. Error Message Box.

===1. Tree View===

When an existing config.txt file is loaded, the program will “parse” the text file and gather 2 different sorts of information: the tags and the containers. The tags are values being assigned to a property, and a container is a section of the config.txt that groups a number of tags or other containers.

With many possible tags and containers, the best way to manage the containers is to display them in a tree view hierarchy (like the tree view of Explorer for example). The diagram below is a section of the tree view for a Kind traincar model:

[[Image:CCGFigure3-2.png|CCG main screen tree view]]

The top “node” or Kind may be called traincar for example, and is the main container for the complete config.txt file. Traincar is the name of the Kind that we are currently creating (for example, if we were making a bogey, it would be listed as “bogey”). Under this main container are other sub containers in the config.txt file.

The tree may be freely expanded or collapsed (by clicking with the Left mouse button on the plus or minus symbols). When you click on one of the nodes, it will load the tags that are included for that container in the tag space, so you can add new entries or edit existing values. Left clicking on the node icon will select that node, whilst Left clicking the node name will select the node for renaming, if allowed (some names are reserved).

When you click with the Right mouse button on one of the nodes, a contextual menu will pop up with four different sections:

[[Image:CCGFigure3-3.png|CCG main screen tree view popup menu]]

Sub-Containers: The first section is the available sub-container section. This section shows which sub-containers you may add to the opened container. Select a sub-container by clicking on it with the Left mouse button. Depending on the type of container added, when you click with the Left mouse button on the new container name, a number of compulsory entry dialog boxes may appear. The diagram above shows the containers and tags available under a mesh container.

Tags: The second section is the tag section. This shows you the list of non-compulsory tags (a non-compulsory tag is an optional tag for additional functionality). When you click on one of the choices with the Left mouse button, it will be added to the tag space that represents the container. You may also delete any non-compulsory tags.

Rename: The rename option allows you to change the name of a container, unless it is a reserved name.

Remove: The remove option allows you to delete an unwanted container from the config.txt file. This is particularly useful if you are editing a config.txt from an existing asset to create a new asset. Click on a container name with the Right mouse button to open the options for the container, and select an item using the Left mouse button.

===2. Tag Space===

This section of the program displays the content of a container. It dynamically changes as you either select different containers or add\delete tags.

Selected tags may have a variety of buttons placed adjacently:

[[Image:CCGFigure3-4.png|CCG main screen tag space]]

Tag Name: The name of every mandatory and\or user selected tag will be displayed on the left hand side of the space.

Tag Value: The value stored in the selected tag - initially shows blank for a new asset.

Load: This button will let you select a file or asset (depending on the tag type) which will be loaded into the Tag Value display.

View in Content Manager Plus: This button will open [[Content Manager]] and allow you to find and select an asset, or for an already selected asset, will show you that asset. Because the assets are loaded using their username, it allows you to verify that the selection is the one intended.

Delete: Removes the selected tag from the working config.txt.

===3. 3D Viewport===

When a mesh is referenced for the model, you need to specify a mesh file. Clicking on the “...” button will allow you to browse for the filename. The program will load the referenced mesh file, and display it in the 3D viewport. This viewport only appears in [[Content Creator Plus]] when a valid mesh is loaded.

[[Image:CCGFigure3-5.png|CCG main screen 3D viewport]]

Buttons below the viewport allow the camera to be moved, rotated or zoomed. Alternatively, you can control the model with your mouse by interacting directly with the 3D Viewport.

: Use the Mousewheel to zoom in and out
: Hold the Left mouse button down and drag to move the display
: Hold the Right mouse button down to drag to rotate the display

===4. Error Message Box===

When you load or save a config.txt file, the program will validate your data input to make sure that everything is correct. The error box is used to output error\warning messages to the user to assist error checking if the model is not working in Trainz.

Clicking on an error message within CCP with the Left mouse button will jump to the relevant tag in the [[config.txt file]] (in CCP) that is causing the error.

You can also Right click on the message, which will bring up a contextual menu that will let you copy the error message to the clipboard.

''Note: Trainz offers many options (containers and tags) for an asset, and a user may select those that are considered appropriate for a particular Kind. CCP may not prompt you for a container or tag that is required to make the asset fully functional in Trainz.''

''For example, normally a traincar requires a reference to a bogey; if you neglect to select the appropriate bogey container for the asset, no error message will be displayed, but the asset may not show or operate correctly in Trainz. Using mandatory tags only may not be sufficient for an asset to operate correctly (or to your expectation) in Trainz.''

''Please refer to the chapters on Kinds, Containers, Tags and asset examples for guidance on the containers and tags required for a particular Kind.''

CCG/Introduction

2010-03-25T09:29:59Z

Windwalkr (legacy 2550):

==CHAPTER 1: The Basics==

'''Introduction'''

Welcome to the Content Creator’s Guide.

This document is designed to assist 3rd party content creators design and create functional content for the Trainz Railroad Simulator. The purpose of this document is to detail the way in which 3rd party content should be designed and built to be compatible with TC and to describe the use of the new functions in TC, the [[Content Manager]] and the [[Content Creator Plus]].

The [[Content Manager]] module manages content on your computer, communicates with the Download Station and uploads or downloads content more easily than in previous versions of Trainz.

The [[Content Creator Plus]] module assists in creating model assets that are compatible with the Download Station requirements, and incorporates error checking that should assist in the creation of successful models. The module creates the config.txt file for the model asset, the entry of data is by means of templates for each model asset Kind, and dialogue boxes that filter and check the data.

This document provides the standards and procedures for a content creator to enter data for the model asset, using [[Content Creator Plus]]. It also provides advice on the creation of the model mesh using 3dsmax, and the creation of correct texture files for the model.

Scripting is an integral part of model creation, however details on script code and usage are included in a separate document. Only brief references to Scripting are made in this document, as far as they effect the creation requirements.

New content creation features added to TC include:
* ability to vary track sounds on track for tunnels and bridges and for bogeys (tracksounds)
* basic animated turnouts
* ability to create backdrop objects
* control of invisible track display (visible in minimap)
* third-party configuration tags, in an extensions container
* use of asset thumbnails, replacing art files and other picture files
* new coupler performance tags and wheelslip functions
* a new kind steam engine and kind texture group.

These functions are described in Appendix D.

CCG/New in TC

2010-03-25T09:29:13Z

Windwalkr (legacy 2550):

this information is all pretty much obsolete and should be re-factored or removed.

==CHAPTER 1: The Basics==

'''New in TC'''

TC introduces a number of new functions specifically designed to enhance the performance of Trainz. The aim in this build is to make the train driving experience more realistic. Some of the new features in TC are.

''In the Simulator:''
* Flexible Cab Signalling system
* Headlight dimmer system
* Flashing ditch-lights
* Train controlled sounds, lights and boom gates at build-in road crossings
* Automatic Train Protection options
* New sound functions for better representation of electric traction
* New Freeways feature supporting and including one way and multi-lane roads
* Remodelled roadway traffic featuring working head lights
* Computerised in-cab displays
* Improved Heads-Up-Display options
* Improved session-design options

''New Routes:''

* a route based on the Harlem Line in New York, developed by Auran staff
* also included is Metropolis - Modula City developed by third party creators.

''For Managing Content:''

The [[Content Manager]] module makes the management of assets very easy. It is integrated with the Download Station, listing the assets available on the Download Station, enabling updating of the list when connected to the Download Station via the Internet, and making the upload or download an efficient and simple process.

[[Content Manager]] relies on a database of content in your installation on your computer. This database makes the loading of data into Trainz on start up very efficient, and minimises load time.

''For Content Creation:''

The [[Content Creator Plus]] module is integrated with the [[Content Manager]] module. It is essential for creating content in TC.This document will cover detail on how to use Content Creator Plus to create config.txt files and manage the asset files.

New functions in TC for creators are covered in Appendix D.

CCG/The Basics of Content Creation

2010-03-25T09:28:17Z

Windwalkr (legacy 2550):

==CHAPTER 1: The Basics==

'''The Basics of Content Creation'''

Creating new content for Trainz is generally a seven-step process.

===1. Research===

The research step involves finding out all the relevant information that you can about the item you wish to create. Research usually covers the accumulation of data about the content in question. The information needed may cover technical drawings of front, side and top, performance specifications (for loco engines), and photo’s for texture reference.

You will generally find that much of this information can be obtained by searching on the Internet. You should also be aware of, and comply with, any copyright issues on information obtained, including pictures, textures and information.

===2. Create a Mesh (.im file)===

An .im file is an Indexed Mesh. These files are created by exporting from ‘3D Studio Max’ (3dsmax) using an [[Downloads|Trainz exporter plugin]]. A third-party plugin for Blender is also available.

''Note: Early versions of Trainz supported a ‘Progressive Mesh’ file ( .pm ). In modern Trainz versions, only .im files are used, progressive mesh files are obsolete. These files will still function in Trainz, but for new models, the .im format should be used.''

So what is 3dsmax or Blender? These are 3D modeling programs that enable you to make things such as locomotives, items of rolling stock or scenery and trackside accessories. They are quite complex programs, and you can expect a steep learning curve should you decide to dive in and learn asset creation. However, on the plus side, the benefits are well worth it, and if you take the time to learn it well, you will certainly be able to create some masterpieces.

===3. Create textures===

Creating textures for your assets is a very important part of the content creation process. Making good textures is one of the hardest things to do, but they can be the difference between a good-looking model and a great looking model.

Textures are created for Trainz using any 3rd party program that supports the creation of 2D art, like Adobe Photoshop or Paint Shop Pro.

There are a number of free programs that may be available, but they may lack the functionality of the commercial programs.

There are special requirements for texture types and sizes for models, details are given in this document.

===4. Create a ‘Config.txt’ file.===

Each and every item of content for Trainz has it’s own [[config.txt file]]. This file is a human-readable text file included with its corresponding item of content. Depending on what the item of content is will determine the necessary contents of the text file, but it will always contain a unique [[KUID]], (a KUID is an identification serial code defined a little later in this document), a description and other information to make the model recognised by, and function in, Trainz.

Items of content created for Trainz are always assigned to a group of content called a KIND. A KIND is a type of content that has particular properties that Trainz recognizes. For example, one type of KIND is a TRACK. Trainz understands that items of content that belong to a group of this KIND define where locomotives and rolling stock travel, the “steel rails” for trains (of course some modern trains do not have “steel rails”, the Maglev for instance). Other KINDs are listed later in this document.

The config.txt file also includes a number of statements for content categories, time eras, Trainz Build, a list of items that the model may depend on (a KUID list of dependencies) and other instructions defining how the asset will behave in Trainz, or assist the Download Station to manage the content.

These instructions are called “tags” and a number of “tags” may be grouped functionally into “containers” within the config.txt file. Refer to examples later in this document.

Previous versions of Trainz required the config.txt file to be generated by a text editor such as Notepad, and saved as UTF-8 code, not ANSI. This encoding option is available from the save dialogue box. Programs such as MS Word that can introduce unwanted formatting, including non standard quotation marks, are not to be used.

While it is possible to generate a config.txt file in this manner for TC, the Content Creator Plus module will do this work for you when you enter the appropriate data.

This document gives details on how to create mesh and texture files, the config.txt file using the Content Creator Plus module, and how to incorporate them into the Trainz program.

===5. Incorporate your asset into Trainz===

All model assets are processed and incorporated in Trainz as a total asset database. This makes for very fast load times, but can restrict easy access to your files.

Briefly, when a new asset is created, [[Content Creator Plus]] (CCP) creates a directory for the new asset under the “editing” directory in your installed Trainz, and saves a [[config.txt file]] in Explorer. This newly created directory can then be located, and files may be placed or exported for the asset mesh and textures. Even if the model is only partly constructed, it can be viewed in Trainz, by “committing” the asset into the database. The directory is then removed automatically, and Trainz can be launched to see the model.

On exiting Trainz, CCP can re-open the directory for work to continue on the model and files if you wish. This process will be fully explained in the following pages.

===6. Upload your new content to the Auran Download Station.===

You should create all models for TC using the CCP and [[Content Manager]] modules if you wish to upload to the Auran [[Download Station]]. [[Content Manager]] has an integrated function to package your model for the Download Station and upload it.

[[Content Manager]] is a very useful application in that it automatically performs error checking and simplifies the preparation of your content for upload. The [[Content Manager]] module embeds information into the upload package that is required by the Auran Download Station.

Don’t include files such as .exe, .com or .bat in the model files. Because these files are a potential source of virus files they will not be packaged by CM. Only in-game and text files are packaged.

For information on how to upload files and the Download Station requirements refer to Chapter 9.

===7. Backup your new content===

Backing up newly created content is important, in case Trainz needs to be re-installed, or so that the content may be modified at a later date. Once content is committed into the database, the asset files are no longer available for copying or viewing, unless they are re-opened for editing. Re-opening files allows modifications to be made.

1. Assets on the Download Station may be installed by re-downloading again. The [[Content Manager]] (CM) module makes this a seamless task.

2. To disribute model assets to other users, outside of the Download Station option, make a cdp file from within CM.

3. Assets may be archieved from within CM. An archieve name and location may be specified, and more than one asset may be incorporated in the archieve. Trainz keeps track of any archieve created, making an archieve does not remove the assets from Trainz, it backs up the assets.

4. Of course the previous methods do not let you actually see the individual asset files nor allow them to be altered. To have access to the files, the asset is opened for editing in Explorer. An asset directory containing the files is created. This is found under the “editing” directory in the Trainz installation. If the asset has been given a username, the directory name will be that username. If a username has not been allocated, a temporary directory name using alphabetic and numeric characters will be created.

The created directory can then be copied to another location on the computer for backup or other purpose. While creating an asset, this procedure may be useful each time before committing the asset, to ensure that no files are lost should a computer or program failure occur. Remember that texture files and exported mesh files are not easily accessible once the asset is committed.

5. A temporary directory could be created outside of the Trainz installation and the texture files and mesh files placed there. This directory can then be imported into CM, the drag and drop feature makes this quite easy (drag the file directory into the main data window of CM). Of course a valid [[config.txt]] file needs to be included for CM to recognise the directory as a valid asset. Opening the asset in CCP, correcting any errors, or adding other tags and containers to finish the model, and then saving the [[config.txt]] file will then create a build 2.5 asset.

CCG/KUID Numbering

2010-03-25T09:22:28Z

Windwalkr (legacy 2550):

This information is obsolete and should be removed in favor of the [[KUID]] page.

==CHAPTER 1: The Basics==

'''KUID Numbering'''

A KUID is a unique number allocated to all content created for Trainz and can be thought of as a bar code.

===KUID2 Format===

The KUID format in TC follows the standard adopted in TRS2004, and takes the form of three Identification Numbers (ID) each separated by a colon.

The breakdown of the KUID system is as follows:

: <KUID2:User_ID:Content_ID:Version_ID>

An example of a Kuid number with actual figures:

: <KUID2:171456:38001:1>

===User ID Number===

The number 171456 after the KUID2 is the USER_ID of the content creator.

When you registered Trainz with the Planet Auran website, you would have been issued with your USER_ID. This is the number you should have entered into Trainz as your USER_ID.

Planet Auran may be found by clicking with the left mouse button on the Profil button in the top task bar of the Forum page, or visiting the website:

https://www.auran.com/planetauran/login_f.php

Every member of the Trainz community who is a member of Planet Auran has a USER_ID. Now, you may be wondering why you need a USER_ID if you don’t intend to make any content for Trainz. If you intend to make a layout (route or map) at some point in time and you’d like to share that layout with your friends or other community members, then you are in fact a content creator.

===Content ID Number===

The middle number is the CONTENT_ID.

This is a number that the content creator assigns to each creation to uniquely identify it, in previous Trainz builds. In TC, the Content Creator Plus module will automatically assign a CONTENT_ID when you create a new asset. It will not repeat a number, and keeps track of all content numbers installed, so you do not have to keep a separate list or spreadsheet of CONTENT_ID numbers for your model assets.

A CONTENT_ID number is also assigned automatically when you save a layout (map).

The combination of a creator’s USER_ID and the CONTENT_ID is unique, and will not conflict with assets created by others.

''Note:'' 
''Previous versions of Trainz used Content ID Ranges for KUID creation. The automatic assignment of CONTENT_ID numbers in TC has obsoleted the need for, or the usefullness of, a specific range of numbers for different kinds of assets.''

===Version ID Number===

The third number is the asset Version_ID number. The default for all assets is 0 e.g. <KUID2:xxx:yyyyy:0>

Should this asset require revisions after release to the Trainz Download Station, the Version ID for each subsequent revision may be updated as follows:
: First revision <KUID2:xxx:yyyyy:1>
: Second revision <KUID2:xxx:yyyyy:2>
: Third revision <KUID2:xxx:yyyyy:3> Etc.

The maximum version number is 127. After the maximum version number is used (rare) a new Content ID needs to be allocated for this asset, and the previous one needs to be added to the obsolete-table.

To make a new version asset, in CMP right click on the asset and select “Create New Version”. The version number will be incremented in the new model. Trainz will use the highest version number found for the asset. Obsoleting a KUID2 asset of the same content ID number does not require the use of the obsolete table.

Obsoleting is a process of replacing a previous item with a more recent one, for updating, improving, or replacing a faulty model.

Example 1: 
A model <KUID2:171456:38001:3> is to be replaced by a newer version. The new number <KUID2:171456:38001:4> is used in the new config.txt file. The previous model will be replaced (obsoleted).

Example 2: 
A model <KUID:171456:27001> (UTC version) is to be replaced, using the new KUID2 format, and with a new number, <KUID2:171456:27002:1>. Note the new content ID number is different from the original asset.

In this case, the obsolete table container is used to show the old model KUID to be obsoleted. In this way, the new KUID is linked to that of the older asset.

''Important Notes:''

''1. <KUID2:xxx:yyyyy:0> is exactly equal to <KUID:xxx:yyyyy> in the old KUID format. These will be read as duplicates should they be used simultaneously.''

''2. Similarly, <KUID2:xxx:yyyyy:1> acts as a KUID2 format obsoletion of <KUID:xxx:yyyyy> .''

''3. Using the zero, “0” as the first version is acceptable, however the display on the Download Station, and the installed file will be in the UTC KUID format, without the KUID2 format display. It is recommended that you start the numbering at one, “1” if this is a problem to you.''

''4. The Download Station displays a History of obsoleted models. If an obsoleted model has never been placed on the Download Station, do not include it in your obsolete table, it will result in a History error notification when you try to upload the asset.''

''5. While you may use leading zeros in the KUID system, a version “02” will be the same as “002” or “2”, and the zeros will be truncated. It is recommended not to use any leading zeros.''

An asset placed in your map will display (show as) the latest installed version. When retrieving an asset from the Download Station, the newest version will be automatically provided, and the Download Station will display a History tag for the model versions. For further examples of the use of the obsolete-table, refer to Chapter 2.

CCG/Trainz Build

2010-03-25T09:21:51Z

Windwalkr (legacy 2550):

This information is obsolete and should be removed in favor of the [["Trainz-build" tag]] page.

==CHAPTER 1: The Basics==

'''TRAINZ Build'''

Trainz build is the numbering system allocated to each released version of Trainz. Content may be created for different versions, making use of the newer functions in a more recent release. Consequently, some models will not function in earlier versions of the simulator.

It is important for models to list the version of Trainz for which they are compatible. For older Trainz builds, this is done by entering a Trainz-Build number in the model config.txt file. The Content Creator Plus module will automatically add the correct trainz-build 2.5 to the config.txt file.

A model constructed for an older version may function in a newer version, but this is not guaranteed, as there have been amendments made to subsequent versions. Likewise, a model using the latest functions will not work in an earlier version.

The Download Station identifies which version of Trainz you have installed and when you use the Download Helper option, it will not allow the download of a more recent model that is incompatible with your version.

The approved Trainz-Build version numbers are;
* trainz-build 1.3 for Trainz
* trainz-build 1.5 for Ultimate Trainz Collection
* trainz-build 2.4 for Trainz Railroad Simulator 2004
* trainz-build 2.5 for Trainz Railroad Simulator 2006
* trainz-build 2.6 for Trainz Railroad Simulator 2006, SP1
* trainz-build 2.7 for Trainz Classics

CCG/Getting Started

2010-03-25T09:20:21Z

Windwalkr (legacy 2550):

==CHAPTER 3: Understanding and using Content Creator Plus==

The purpose of this chapter is to introduce users to [[Content Creator Plus]], a powerful program used to generate and validate [[config.txt file]]s. [[Content Creator Plus]] is intended for in-experienced content creators, however a degree of understanding regarding kinds and containers is assumed. Please refer to other Chapters in this document for assistance in familiarising yourself with the requirements and structures of containers and tags.

'''Getting Started'''

===Main Screen===

The main screen is divided into a number of areas:

[[Image:CCGFigure3-1.png|CCG main screen]]
* 1. Tree View
* 2. Tag space
* 3. 3D Viewport (only visible when a mesh is selected)
* 4. Error Message Box.

===1. Tree View===

When an existing config.txt file is loaded, the program will “parse” the text file and gather 2 different sorts of information: the tags and the containers. The tags are values being assigned to a property, and a container is a section of the config.txt that groups a number of tags or other containers.

With many possible tags and containers, the best way to manage the containers is to display them in a tree view hierarchy (like the tree view of Explorer for example). The diagram below is a section of the tree view for a Kind traincar model:

[[Image:CCGFigure3-2.png|CCG main screen tree view]]

The top “node” or Kind may be called traincar for example, and is the main container for the complete config.txt file. Traincar is the name of the Kind that we are currently creating (for example, if we were making a bogey, it would be listed as “bogey”). Under this main container are other sub containers in the config.txt file.

The tree may be freely expanded or collapsed (by clicking with the Left mouse button on the plus or minus symbols). When you click on one of the nodes, it will load the tags that are included for that container in the tag space, so you can add new entries or edit existing values. Left clicking on the node icon will select that node, whilst Left clicking the node name will select the node for renaming, if allowed (some names are reserved).

When you click with the Right mouse button on one of the nodes, a contextual menu will pop up with four different sections:

[[Image:CCGFigure3-3.png|CCG main screen tree view popup menu]]

Sub-Containers: The first section is the available sub-container section. This section shows which sub-containers you may add to the opened container. Select a sub-container by clicking on it with the Left mouse button. Depending on the type of container added, when you click with the Left mouse button on the new container name, a number of compulsory entry dialog boxes may appear. The diagram above shows the containers and tags available under a mesh container.

Tags: The second section is the tag section. This shows you the list of non-compulsory tags (a non-compulsory tag is an optional tag for additional functionality). When you click on one of the choices with the Left mouse button, it will be added to the tag space that represents the container. You may also delete any non-compulsory tags.

Rename: The rename option allows you to change the name of a container, unless it is a reserved name.

Remove: The remove option allows you to delete an unwanted container from the config.txt file. This is particularly useful if you are editing a config.txt from an existing asset to create a new asset. Click on a container name with the Right mouse button to open the options for the container, and select an item using the Left mouse button.

===2. Tag Space===

This section of the program displays the content of a container. It dynamically changes as you either select different containers or add\delete tags.

Selected tags may have a variety of buttons placed adjacently:

[[Image:CCGFigure3-4.png|CCG main screen tag space]]

Tag Name: The name of every mandatory and\or user selected tag will be displayed on the left hand side of the space.

Tag Value: The value stored in the selected tag - initially shows blank for a new asset.

Load: This button will let you select a file or asset (depending on the tag type) which will be loaded into the Tag Value display.

View in Content Manager Plus: This button will open [[Content Manager]] and allow you to find and select an asset, or for an already selected asset, will show you that asset. Because the assets are loaded using their username, it allows you to verify that the selection is the one intended.

Delete: Removes the selected tag from the working config.txt.

===3. 3D Viewport===

When a mesh is referenced for the model, you need to specify a mesh file. Clicking on the “...” button will allow you to browse for the filename. The program will load the referenced mesh file, and display it in the 3D viewport. This viewport only appears in Content Manager Plus when a valid mesh is loaded.

[[Image:CCGFigure3-5.png|CCG main screen 3D viewport]]

Buttons below the viewport allow the camera to be moved, rotated or zoomed. Alternatively, you can control the model with your mouse by interacting directly with the 3D Viewport.

: Use the Mousewheel to zoom in and out
: Hold the Left mouse button down and drag to move the display
: Hold the Right mouse button down to drag to rotate the display

===4. Error Message Box===

When you load or save a config.txt file, the program will validate your data input to make sure that everything is correct. The error box is used to output error\warning messages to the user to assist error checking if the model is not working in Trainz.

Clicking on an error message within CCP with the Left mouse button will jump to the relevant tag in the [[config.txt file]] (in CCP) that is causing the error.

You can also Right click on the message, which will bring up a contextual menu that will let you copy the error message to the clipboard.

''Note: Trainz offers many options (containers and tags) for an asset, and a user may select those that are considered appropriate for a particular Kind. CCP may not prompt you for a container or tag that is required to make the asset fully functional in Trainz.''

''For example, normally a traincar requires a reference to a bogey; if you neglect to select the appropriate bogey container for the asset, no error message will be displayed, but the asset may not show or operate correctly in Trainz. Using mandatory tags only may not be sufficient for an asset to operate correctly (or to your expectation) in Trainz.''

''Please refer to the chapters on Kinds, Containers, Tags and asset examples for guidance on the containers and tags required for a particular Kind.''

Content Creator's Guide

2010-03-25T09:19:39Z

Windwalkr (legacy 2550): remove obsolete info

== Contents ==

'''Chapter 1: The basics'''

* [[CCG/Introduction|Introduction]]
* [[CCG/New in TC|New in TC]]
* [[CCG/The Basics of Content Creation|The Basics of Content Creation]]
* [[CCG/KUID Numbering|KUID Numbering]]
** [[CCG/KUID Numbering#KUID2 Format|KUID2 Format]]
** [[CCG/KUID Numbering#User ID Number|User ID Number]]
** [[CCG/KUID Numbering#Content ID Number|Content ID Number]]
** [[CCG/KUID Numbering#Version ID Number|Version ID Number]]
* [[CCG/Trainz Build|Trainz Build]]

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

* [[CCG/Kinds|Kinds]]

''Lots of other stuff''

'''Chapter 3: Understanding and using Content Creator Plus'''

* [[CCG/Getting Started|Getting Started]]
* [[CCG/Using Content Creator Plus|Using Content Creator Plus]]
* [[CCG/Inheritance Template|Inheritance Template]]

'''Chapter 4: Using Content Creator Plus to create a New Asset'''

* [[CCG/Creating a New Asset|Creating a New Asset]]

CCG/Getting Started

2010-03-25T09:19:22Z

Windwalkr (legacy 2550):

==CHAPTER 3: Understanding and using Content Creator Plus==

The purpose of this chapter is to introduce users to [[Content Creator Plus]], a powerful program used to generate and validate “config.txt” files. [[Content Creator Plus]] is intended for in-experienced content creators, however a degree of understanding regarding kinds and containers is assumed. Please refer to other Chapters in this document for assistance in familiarising yourself with the requirements and structures of containers and tags.

'''Getting Started'''

===Main Screen===

The main screen is divided into a number of areas:

[[Image:CCGFigure3-1.png|CCG main screen]]
* 1. Tree View
* 2. Tag space
* 3. 3D Viewport (only visible when a mesh is selected)
* 4. Error Message Box.

===1. Tree View===

When an existing config.txt file is loaded, the program will “parse” the text file and gather 2 different sorts of information: the tags and the containers. The tags are values being assigned to a property, and a container is a section of the config.txt that groups a number of tags or other containers.

With many possible tags and containers, the best way to manage the containers is to display them in a tree view hierarchy (like the tree view of Explorer for example). The diagram below is a section of the tree view for a Kind traincar model:

[[Image:CCGFigure3-2.png|CCG main screen tree view]]

The top “node” or Kind may be called traincar for example, and is the main container for the complete config.txt file. Traincar is the name of the Kind that we are currently creating (for example, if we were making a bogey, it would be listed as “bogey”). Under this main container are other sub containers in the config.txt file.

The tree may be freely expanded or collapsed (by clicking with the Left mouse button on the plus or minus symbols). When you click on one of the nodes, it will load the tags that are included for that container in the tag space, so you can add new entries or edit existing values. Left clicking on the node icon will select that node, whilst Left clicking the node name will select the node for renaming, if allowed (some names are reserved).

When you click with the Right mouse button on one of the nodes, a contextual menu will pop up with four different sections:

[[Image:CCGFigure3-3.png|CCG main screen tree view popup menu]]

Sub-Containers: The first section is the available sub-container section. This section shows which sub-containers you may add to the opened container. Select a sub-container by clicking on it with the Left mouse button. Depending on the type of container added, when you click with the Left mouse button on the new container name, a number of compulsory entry dialog boxes may appear. The diagram above shows the containers and tags available under a mesh container.

Tags: The second section is the tag section. This shows you the list of non-compulsory tags (a non-compulsory tag is an optional tag for additional functionality). When you click on one of the choices with the Left mouse button, it will be added to the tag space that represents the container. You may also delete any non-compulsory tags.

Rename: The rename option allows you to change the name of a container, unless it is a reserved name.

Remove: The remove option allows you to delete an unwanted container from the config.txt file. This is particularly useful if you are editing a config.txt from an existing asset to create a new asset. Click on a container name with the Right mouse button to open the options for the container, and select an item using the Left mouse button.

===2. Tag Space===

This section of the program displays the content of a container. It dynamically changes as you either select different containers or add\delete tags.

Selected tags may have a variety of buttons placed adjacently:

[[Image:CCGFigure3-4.png|CCG main screen tag space]]

Tag Name: The name of every mandatory and\or user selected tag will be displayed on the left hand side of the space.

Tag Value: The value stored in the selected tag - initially shows blank for a new asset.

Load: This button will let you select a file or asset (depending on the tag type) which will be loaded into the Tag Value display.

View in Content Manager Plus: This button will open [[Content Manager]] and allow you to find and select an asset, or for an already selected asset, will show you that asset. Because the assets are loaded using their username, it allows you to verify that the selection is the one intended.

Delete: Removes the selected tag from the working config.txt.

===3. 3D Viewport===

When a mesh is referenced for the model, you need to specify a mesh file. Clicking on the “...” button will allow you to browse for the filename. The program will load the referenced mesh file, and display it in the 3D viewport. This viewport only appears in Content Manager Plus when a valid mesh is loaded.

[[Image:CCGFigure3-5.png|CCG main screen 3D viewport]]

Buttons below the viewport allow the camera to be moved, rotated or zoomed. Alternatively, you can control the model with your mouse by interacting directly with the 3D Viewport.

: Use the Mousewheel to zoom in and out
: Hold the Left mouse button down and drag to move the display
: Hold the Right mouse button down to drag to rotate the display

===4. Error Message Box===

When you load or save a config.txt file, the program will validate your data input to make sure that everything is correct. The error box is used to output error\warning messages to the user to assist error checking if the model is not working in Trainz.

Clicking on an error message within CCP with the Left mouse button will jump to the relevant tag in the [[config.txt file]] (in CCP) that is causing the error.

You can also Right click on the message, which will bring up a contextual menu that will let you copy the error message to the clipboard.

''Note: Trainz offers many options (containers and tags) for an asset, and a user may select those that are considered appropriate for a particular Kind. CCP may not prompt you for a container or tag that is required to make the asset fully functional in Trainz.''

''For example, normally a traincar requires a reference to a bogey; if you neglect to select the appropriate bogey container for the asset, no error message will be displayed, but the asset may not show or operate correctly in Trainz. Using mandatory tags only may not be sufficient for an asset to operate correctly (or to your expectation) in Trainz.''

''Please refer to the chapters on Kinds, Containers, Tags and asset examples for guidance on the containers and tags required for a particular Kind.''

CCG/Using Content Creator Plus

2010-03-25T09:18:11Z

Windwalkr (legacy 2550):

==CHAPTER 3: Understanding and using Content Creator Plus==

'''Using Content Creator Plus'''

===Creating a new Asset===

In the [[Content Manager]] Program, clicking on the New button will open [[Content Creator Plus]] and display the “New Asset” window, from which you can select a base Kind to use as a template.

[[Image:CCGFigure3-6.png|CCP new asset window]]

The displayed list shows all the asset Kinds supported by Trainz. Click on the name of the Kind that you want to create and the program will generate the basic config.txt structure for that kind, using the mandatory tags. You may also add additional optional tags and containers to your config.txt file for a more complex asset.

Refer also to the [[CCG/Getting Started#4. Error Message Box|notes]] for containers and tags that are required for the model to function correctly.

===The Working Directory===

When you are creating or editing an asset with [[Content Creator Plus]], all of your content exists in a temporary “working directory” which is located in your “.\editing” folder within your Trainz install. Assets in this folder are considered “open for editing”.

All files required by your new model MUST be placed in your temporary working directory.

You can open this folder by selecting “Edit|Edit in Explorer” from the main menu bar. Note that the name of the folder may be of the form “edit nfd0hk9y6”. After you have given the asset a username, saved the config.txt file, and committed the asset, the directory name will change to the selected username when you next reopen it in Explorer.

===Formats for entering Tag Data===

Tags require different forms of entry depending on the type of data required. Some tags require a simple text string, while others will require more complex data like a Vector, a float list or a Boolean value.

====String, floating point numbers or integers====

These three data types are simple text or numeric values.

A string is a basic text field, a Floating point number (or float) is a number that includes a decimal point, while and integer is a numeric value with no decimal point (whole number). The value placed in the text box will be directly associated with the tag.

====Vector====

A vector is a series of values. A vector may have any number of values depending on the type of data it stores, for example a vector3 will display three separate text boxes, one for each value.

====Float list entry====

A float list for a tag will take a series of floating point number values.

[[Image:CCGFigure3-7.png|Float list entry]]

The list above includes a series of four floats, each of which can be removed if required. Additional values may be added to the list by clicking on the add button.

====KUIDs====

The KUID entry is made up of three different parts: The user ID, the content ID and the version ID.

[[Image:CCGFigure3-8.png|KUID]]

KUIDs are handled internally, and are unable to be edited directly.

====Boolean Entry====

A Boolean entry is a simple true or false value. It is represented by a tick box.

[[Image:CCGFigure3-9.png|Boolean entry]]

Clicking with the Left Mouse button in the box will toggle the tick mark on or off. A tick represents “True” or “1”.

====Data choices====

Where a large list of choices is offered, it is convenient for CCP to display the available selections in a combo box.

Open the box and select a value by clicking on that value with the Left mouse button. A tick-mark is shown in the box. You may select multiple choices by ticking additional boxes in the list. The category-region or category-era are examples of multiple selection options, while the category-class is a single selection from a drop down box.

[[Image:CCGFigure3-10.png|Data choices]]

====File Browser====

Clicking on the “...” button adjacent to an appropriate tag with the Left mouse button will open the file browser. The file browser is used to locate the files you wish to use in your asset.

[[Image:CCGFigure3-11.png|File browser]]

Once the file is located, click on the “Open” button and the field will be filled with the path for the file you have selected.

Remember that your files must be placed in the working directory.

The file type selections in the browser will reflect the types that are required to fill the dialog box. For example, a mesh dialog box offers a choice between “ *.im, *.lm, and *.lm.txt” types, whereas a script will allow files with “*.gs or *.gse” extensions to be selected.

====New Assets====

Some tags (typically images, scripts or HTML assets) will have an adjacent “New” button when the entry box is empty.

[[Image:CCGFigure3-12.png|New asset]]

Clicking on the “New” button will allow you to create a new asset of the appropriate kind, and will automatically create the necessary files and load them into your editor of choice (specified in your windows settings, for example Photoshop may be your default image editor).

If these tags are populated, the “New” button is replaced with an “Edit” button, which will open the asset in your default editor.

====Asset Browser====

Some fields require a link to other assets. For simplicity, a list of relevant assets is presented from which the user can select their desired asset, in the Asset Browser.

For convenience, the top drop down selection box filters assets by type, to simplify searching and selection.

Browse through the list of installed assets, or type in a partial name in the search box (second top box) to locate the asset required. Once you have found the asset you wish to use, Left click on the “Select” button. This will internally store the asset KUID. A null KUID may alternatively be selected where required. Note that the kuid for an asset is not displayed, usernames are used for simplification. Care should be used in selecting assets where the same username has been used for different assets - it may be convenient to locate the required asset in CMP to verify selections.

[[Image:CCGFigure3-13.png|Asset browser]]

====String Asset Browser====

The string asset (KUID) browser works similarly to the KUID browser, with the additional ability to change the actual name of the tag.

Refer to the [[CCG/Getting Started|Getting Started]] section for additional information on saving files and error checking, and to Chapter 4 for detailed information on creating a new asset.

"mesh-table" container

2010-03-24T10:39:06Z

Windwalkr (legacy 2550):

The "mesh-table" container is a top-level [[config.txt file]] entry used by various [[Content Types]].

The mesh-table is a list of mesh subcontainers with no standalone tags. Each mesh subcontainer uses the following format. Tags are parsed in a standardised format, but not all [[Content Types]] support the full range of tags. Each mesh derives its name from the subcontainer's tag name. These names are used to refer to specific meshes from within the mesh-table and also from script.

=Supported Tags=
Each mesh subcontainer supports the following tags. Each tag is shown here with its default value.

mesh-asset <NULLKUID>
mesh ""
anim ""
lod-level 255
mesh-season 255
att ""
att-parent ""
opacity 1.0
position 0,0,0
orientation 0,0,0
auto-create 0
use-parent-bounds 0
animation-loop-speed 0
light 1
critical-animation 1
effects
{
}
night-mesh-base ""

====mesh-asset====
''TBD''

====mesh====
The ‘main’ mesh name. This may include a sub-path;
ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.

Use .im files exported from 3dsmax or gmax (as opposed to .pm.) or reference an .lm file if you wish your asset to have ‘Level of Detail’ mesh reduction.

Level of detail is a process of using different model meshes, depending on how far the viewer is from the model. A finer mesh is used for close up viewing in Trainz.

====anim====
The animation file (.kin) exported from 3dsmax or gmax. This may include a sub-path.

====lod-level====
The object LOD level at which this mesh is displayed. The default value (255) indicates that this mesh is visible at all detail levels. See also [[KIND Mesh]] for the 'mesh-detail-level' tag.

====mesh-season====
The season index for which this mesh is displayed. The default value (255) indicates that this mesh is visible in all seasons. See also [["Season-selector" container]].

====att====
The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).

====att-parent====
The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.

====opacity====
''TBD'

====position====
''TBD'

====orientation====
''TBD'

====auto-create====
The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.

====use-parent-bounds====
When enabled, this tag indicates that render culling should occur using the whole object's bounding box rather than this mesh's bounding box. Bounding boxes on individual meshes may not update correctly when animation moves the object's geometry any significant distance from the bind position. This flag can help mitigate such effects, at a tiny performance penalty.

====animation-loop-speed====
This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax or gmax.

====light====
''TBD'

====critical-animation====
"critical-animation" indicates that this mesh's animation generates events which are critical to the script system's behavior. If your asset is not scripted, does not use scripted animation events, or only uses the events for display purposes and will not break if the occasional event is missed, this tag should be set to ''false''. Leaving this flag set to ''true'' is a '''significant''' performance penalty.

====night-mesh-base====
This night mesh is linked to the specified mesh and is visible only at night. It is invisible if the specified mesh is invisible, (if the auto-create 0 line were used so the specified mesh can be controlled by script).

=Effects Container=
The effects container also contains a list of effect subcontainers. The effect subcontainers support the following generic tags.

kind ""
name ""

The effect subcontainers support additional tags depending on the effect kind. The following effect kinds are supported:

* [[Corona Effect]]
* [[Name Effect]]
* [[Attachment Effect]]
* [[Animation Effect]]
* [[Texture-Replacement Effect]]

=Mesh-Table Example=
The following is an example of a simple mesh-table which implements two levels of detail.

mesh-table
{
default-lod0
{
mesh "example-lod0.im"
auto-create 1
lod-level 0
}
default-lod1
{
mesh "example-lod1.im"
auto-create 1
lod-level 1
}
}

[[Category:Config Container]]

"season-selector" container

2010-03-24T10:35:25Z

Windwalkr (legacy 2550): New page: The "Season-selector" container is a top-level container is some assets' config.txt file which allows the simulator to display an appropriate visual for each asset instance based o...

The [["Season-selector" container]] is a top-level container is some assets' [[config.txt file]] which allows the simulator to display an appropriate visual for each asset instance based on certain environmental parameters. The container does not specify anything about the visuals directly, but rather provides logic which maps the varied environmental parameters down to a single "season index" which is then used in other parts of the asset's [[config.txt file]].

The [["Season-selector" container]] is a recursive structure- meaning that the container may contain one or more of itself as sub-containers.

==Supported Tags==
The [["Season-selector" container]] supports the following tags. Each tag is show here with its default value.

output-season
season-range 0.0, 1.0
above-snow-line 0
branch-true
branch-false

====output-season====
:Type: Integer
:Desc: The season index used for this asset if the decision logic reaches this [sub-]container. If specified, this should be the only tag in this "Season-selector" [sub-]container.

====season-range====
:Type: vector2
:Desc: A conditional tag which tests whether the global time-of-year value falls within the specified range. If the first number is less than the second, the condition is evaluated by (first-value <= time-of-year <= second-value.) If the second number is less than the first, the condition is evaluated by (time-of-year <= second-value || time-of-year >= first-value.) The global time-of-year value varies from 0.0 to 1.0 throughout the year, where 0.0 is new year.

====above-snow-line====
:Type: boolean
:Desc: A conditional tag which tests whether the asset instance is above the snow-line. If set to a true value (eg. 1) then asset instances will evaluate this condition as (asset-height >= snow-line-height.) If set to a false value (eg. 0) then no test is performed.

====branch-true====
:Type: [["Season-selector" container]]
:Desc: If all of the conditional tags in this [sub-]container evaluate to true, this child branch is evaluated to determine the output-season for a specified asset instance.

====branch-false====
:Type: [["Season-selector" container]]
:Desc: If one or more of the conditional tags in this [sub-]container evaluate to false, this child branch is evaluated to determine the output-season for a specified asset instance.

=="Season-selector" Example==

[[Category:Config Container]]

Localization code

2010-03-08T12:46:34Z

Windwalkr (legacy 2550):

The following is a full list of the currently supported language suffix codes.

{| border=1 cellpadding=2 cellspacing=0
|username-cn||Chinese
|-
|username-cz||Czech
|-
|username-nl||Dutch
|-
|username-fr||French
|-
|username-de||German
|-
|username-hu||Hungarian
|-
|username-it||Italian
|-
|username-pl||Polish
|-
|username-ru||Russian
|-
|username-es||Spanish
|}

=See Also=
* [[HowTo/Localize an Asset]]
* [["Username" tag]]
* [["Description" tag]]
* [["String-table" container]]

TagName Normal-texture

2010-03-08T12:45:57Z

Windwalkr (legacy 2550): TagName Normal-texture moved to "Normal-texture" tag

#REDIRECT [["Normal-texture" tag]]

Localization code

2010-03-08T12:45:45Z

Windwalkr (legacy 2550):

The following is a full list of the currently supported language suffix codes.

{| border=1 cellpadding=2 cellspacing=0
|username-cn||Chinese
|-
|username-cz||Czech
|-
|username-nl||Dutch
|-
|username-fr||French
|-
|username-de||German
|-
|username-hu||Hungarian
|-
|username-it||Italian
|-
|username-pl||Polish
|-
|username-ru||Russian
|-
|username-es||Spanish
|}

=See Also=
* [[HowTo/Localize an Asset]]
* [["username" tag]]
* [["description" tag]]
* [["string-table" container]]

"Trainz-build" tag

2010-03-08T12:44:33Z

Windwalkr (legacy 2550):

Trainz build is the numbering system allocated to each released version of Trainz. Content may be created for different versions, making use of the newer functions in a more recent release. Consequently, some assets will not function in earlier versions of the simulator.

It is important for assets to list the version of Trainz with which they are compatible. For older Trainz builds, this is done by entering a Trainz-Build number in the model config.txt file. [[Content Creator Plus]] will automatically add the correct trainz-build to the config.txt file.

A correctly-constructed asset built for an older version will usually function in a newer version of Trainz, but this is not always guaranteed, as there have been amendments made to subsequent versions. ''(TBD: List of known breaking changes.)'' A model using the latest functions will not work in an earlier version.
The [[Download Station]] identifies which version of Trainz you have installed and when you use the [[Content Manager]], it will not allow the download of a more recent model that is incompatible with your version.

The approved Trainz-Build version numbers are as follows:

{| border=1 cellpadding=2 cellspacing=0
|'''trainz-build'''||'''First Trainz product to support this content version'''
|-
|1.3||[[Trainz SP3]]
|-
|1.5||Ultimate Trainz Collection
|-
|1.6||Ultimate Trainz Collection SP1
|-
|2.0||[[TRS2004]]
|-
|2.1||[[TRS2004]] SP1
|-
|2.2||[[TRS2004]] SP2 - Passenger Pack
|-
|2.3||[[TRS2004]] SP3
|-
|2.4||[[TRS2004]] SP4
|-
|2.5||[[TRS2006]]
|-
|2.6||[[TRS2006]] SP1
|-
|2.7||Trainz Classics 1&2
|-
|2.8||Trainz Classics 3
|-
|2.9||[[TS2009]]
|-
|3.0||[[TS2009]] SP1
|-
|3.1||[[TS2009]] SP2
|-
|3.2||
|-
|3.3||
|}

[[Category:Config Tag]]

"Trainz-build" tag

2010-03-08T12:44:14Z

Windwalkr (legacy 2550):

Trainz build is the numbering system allocated to each released version of Trainz. Content may be created for different versions, making use of the newer functions in a more recent release. Consequently, some assets will not function in earlier versions of the simulator.

It is important for assets to list the version of Trainz with which they are compatible. For older Trainz builds, this is done by entering a Trainz-Build number in the model config.txt file. [[Content Creator Plus]] will automatically add the correct trainz-build to the config.txt file.

A correctly-constructed asset built for an older version will usually function in a newer version of Trainz, but this is not always guaranteed, as there have been amendments made to subsequent versions. ''(TBD: List of known breaking changes.)'' A model using the latest functions will not work in an earlier version.
The [[Download Station]] identifies which version of Trainz you have installed and when you use the [[Content Manager]], it will not allow the download of a more recent model that is incompatible with your version.

The approved Trainz-Build version numbers are;

{| border=1 cellpadding=2 cellspacing=0
|'''trainz-build'''||'''First Trainz product to support this content version'''||
|-
|1.3||[[Trainz SP3]]
|-
|1.5||Ultimate Trainz Collection
|-
|1.6||Ultimate Trainz Collection SP1
|-
|2.0||[[TRS2004]]
|-
|2.1||[[TRS2004]] SP1
|-
|2.2||[[TRS2004]] SP2 - Passenger Pack
|-
|2.3||[[TRS2004]] SP3
|-
|2.4||[[TRS2004]] SP4
|-
|2.5||[[TRS2006]]
|-
|2.6||[[TRS2006]] SP1
|-
|2.7||Trainz Classics 1&2
|-
|2.8||Trainz Classics 3
|-
|2.9||[[TS2009]]
|-
|3.0||[[TS2009]] SP1
|-
|3.1||[[TS2009]] SP2
|-
|3.2||
|-
|3.3||
|}

[[Category:Config Tag]]

TagName Username

2010-03-08T12:34:54Z

Windwalkr (legacy 2550): TagName Username moved to "Username" tag

#REDIRECT [["Username" tag]]

"Username" tag

2010-03-08T12:34:54Z

Windwalkr (legacy 2550): TagName Username moved to "Username" tag

The human-readable English name of this asset. This is the name that will be visible in [[Content Manager]], the [[Download Station]], and [[Surveyor]]. The username tag is mandatory.

To compliment the English username, a variety of additional tags allow for equivalent usernames to be supported across other languages. It should be noted that the English "username" tag is mandatory, and must be in English. Localised tags are optional.

The complete set of supported description tags are as follows:

{| border=1 cellpadding=2 cellspacing=0
|username||English
|-
|username-cn||Chinese
|-
|username-cz||Czech
|-
|username-nl||Dutch
|-
|username-fr||French
|-
|username-de||German
|-
|username-hu||Hungarian
|-
|username-it||Italian
|-
|username-pl||Polish
|-
|username-ru||Russian
|-
|username-es||Spanish
|}

=See Also=
* [[Localization code]]

[[Category:Config Tag]]

TagName Trainz-build

2010-03-08T12:34:45Z

Windwalkr (legacy 2550): TagName Trainz-build moved to "Trainz-build" tag

#REDIRECT [["Trainz-build" tag]]

"Trainz-build" tag

2010-03-08T12:34:45Z

Windwalkr (legacy 2550): TagName Trainz-build moved to "Trainz-build" tag

Trainz build is the numbering system allocated to each released version of Trainz. Content may be created for different versions, making use of the newer functions in a more recent release. Consequently, some models will not
function in earlier versions of the simulator.

It is important for models to list the version of Trainz for which they are compatible. For older Trainz builds, this is done by entering a Trainz-Build number in the model config.txt file. The Content Creator Plus module will automatically add the correct trainz-build to the config.txt file.

A model constructed for an older version may function in a newer version, but this is not guaranteed, as there have been amendments made to subsequent versions. Likewise, a model using the latest functions will not work in an earlier version.
The Download Station identifies which version of Trainz you have installed and when you use the Download Helper option, it will not allow the download of a more recent model that is incompatible with your version.

The approved Trainz-Build version numbers are;

trainz-build 1.3 for Trainz SP3
trainz-build 1.5 for Ultimate Trainz Collection
trainz-build 1.6 for Ultimate Trainz Collection SP1
trainz-build 2.0 for Trainz Railroad Simulator 2004
trainz-build 2.1 for Trainz Railroad Simulator 2004 SP1
trainz-build 2.2 for Trainz Railroad Simulator 2004 SP2 - Passenger Pack
trainz-build 2.3 for Trainz Railroad Simulator 2004 SP3
trainz-build 2.4 for Trainz Railroad Simulator 2004 SP4
trainz-build 2.5 for Trainz Railroad Simulator 2006
trainz-build 2.6 for Trainz Railroad Simulator 2006 SP1
trainz-build 2.7 for Trainz Classics 1&2
trainz-build 2.8 for Trainz Classics 3
trainz-build 2.9 for Trainz Railroad Simulator 2009
trainz-build 3.0 for Trainz Railroad Simulator 2009 SP1
trainz-build 3.1 for Trainz Railroad Simulator 2009 SP2

[[Category:Config Tag]]

TagName Trackside

2010-03-08T12:34:35Z

Windwalkr (legacy 2550): TagName Trackside moved to "Trackside" tag

#REDIRECT [["Trackside" tag]]

TagName Texture

2010-03-08T12:34:25Z

Windwalkr (legacy 2550): TagName Texture moved to "Texture" tag

#REDIRECT [["Texture" tag]]

"Texture" tag

2010-03-08T12:34:25Z

Windwalkr (legacy 2550): TagName Texture moved to "Texture" tag

The texture file to be used in [[KIND_Texture|kind texture]] and [[KIND Groundtexture|kind groundtexture]]

[[Category:Config Tag]]

TagName Storm

2010-03-08T12:34:15Z

Windwalkr (legacy 2550): TagName Storm moved to "Storm" tag

#REDIRECT [["Storm" tag]]

TagName Normal

2010-03-08T12:33:55Z

Windwalkr (legacy 2550): TagName Normal moved to "Normal" tag

#REDIRECT [["Normal" tag]]

TagName Night

2010-03-08T12:33:47Z

Windwalkr (legacy 2550): TagName Night moved to "Night" tag

#REDIRECT [["Night" tag]]

TagName Description

2010-03-08T12:33:16Z

Windwalkr (legacy 2550): TagName Description moved to "Description" tag

#REDIRECT [["Description" tag]]

"Description" tag

2010-03-08T12:33:16Z

Windwalkr (legacy 2550): TagName Description moved to "Description" tag

The human-readable multi-line English description of this asset. It displays on the Download Station with your content, so please make it useful and informative.

To compliment the English description, a variety of additional tags allow for equivalent descriptions to be supported across other languages. It should be noted that the English "description" tag is mandatory, and must be in English. Localised tags are optional.

The complete set of supported description tags are as follows:

{| border=1 cellpadding=2 cellspacing=0
|description||English
|-
|description-cn||Chinese
|-
|description-cz||Czech
|-
|description-nl||Dutch
|-
|description-fr||French
|-
|description-de||German
|-
|description-hu||Hungarian
|-
|description-it||Italian
|-
|description-pl||Polish
|-
|description-ru||Russian
|-
|description-es||Spanish
|}

=See Also=
* [[Localization code]]

[[Category:Config Tag]]

TagName Clutter-Mesh

2010-03-08T12:33:06Z

Windwalkr (legacy 2550): TagName Clutter-Mesh moved to "Clutter-mesh" tag

#REDIRECT [["Clutter-mesh" tag]]

"junction-vertices" Container

2010-03-08T12:30:50Z

Windwalkr (legacy 2550): "junction-vertices" Container moved to "junction-vertices" container

#REDIRECT [["junction-vertices" container]]

"junction-vertices" container

2010-03-08T12:30:50Z

Windwalkr (legacy 2550): "junction-vertices" Container moved to "junction-vertices" container

The [["junction-vertices" Container]] is a top-level [[config.txt file]] entry used by [[KIND SceneryWithTrack]] assets.

The [["junction-vertices" Container]] is a list of junction subcontainers with no standalone tags. Each junction subcontainer uses the following format. Each junction derives its name from the subcontainer's tag name. These names are used to refer to specific junctions from script.

==Supported Tags==
Each junction subcontainer supports the following tags. Each tag is shown here with its default value.

junction-vertex ""
junction-lever-mesh ""
junction-mutex ""
junction-mutex-sharing-left 0
junction-mutex-sharing-forward 0
junction-mutex-sharing-right 0

The "junction-vertex" tag is compulsory and determines the track vertex at which this junction is to be create. This name must correspond to one of the vertices specified in the [["attached-track" Container]] and the vertex specified should form a valid junction (ie. should have more than two track stretches attached.)

The "junction-lever-mesh" tag optionally specifies the name of a [["mesh-table" Container]] entry to use for the junction lever. ''TBD: Animation? Multiple-state junction support?''

The "junction-mutex" tag optionally specifies the name of a [["mutexes" Container]] entry to use for the junction's mutex. This allows sharing a single mutex between multiple junctions, and requires a detailed understanding of the trainz [[Permit]] system. If ommitted, the junction will use a unqiue mutex.

The "junction-mutex-sharing-left", "junction-mutex-sharing-forward", and "junction-mutex-sharing-right" tags describe sharing masks for the junction's mutex. Two or more permits may be granted for a junction simultaneously if a ''bitwise and'' of their sharing masks gives a non-zero result. When a permit is requested by script for this junction's mutex, the appropriate sharing masks is selected based on the requested direction. If no direction is specified (eg. a legacy script is in use) then a sharing mask of zero is used.

==Junction-vertices Example==
The following is an example of a simple [["junction-vertices" Container]] which declares two named junctions.

junction-vertices
{
one-junction
{
junction-vertex "a.track0a"
}
another-junction
{
junction-vertex "a.track2a"
}
}

==Categories==
[[Category:Config Container]]

Config.txt file

2010-03-08T12:30:18Z

Windwalkr (legacy 2550): /* Localisation */

The config.txt file is the central descriptor for a Trainz content item. Every content item has a single filed named config.txt in its folder, which determines the name, kind and unique ID of the item, as well as various kind-specific details. All other files used by the content item are located via the config.txt file.

The config.txt file is stored in the [[ACS Text Format]]. When hand-editing the file, care must be taken to use correct syntax or the meaning of parts or the entirety of the file may become permanently lost. When content is installed into Trainz, or when it is archived (in [[CDP Format]] or similar) the config.txt file is stored in a machine-optimised binary format. If the content is later extracted using [[Content Manager]], the config.txt file is converted back to text format, however any custom formatting or erroneous syntax is already lost and cannot be restored.

==Standard Tags==
A variety of tags are available to all Trainz content items, regardless of the specific asset type. These tags are inherited from the [[KIND TrainzBaseSpec]] base asset type, and are described there.

==Localisation==
As the [[ACS Text Format]] uses UTF-8 encoding, non-english text entries may occur within any string field in the config.txt file. To allow for multiple locale support and to avoid confusion, the standard string tags which require localisation allow multiple entries and use the following conventon:

* ''username'' - The content's human-readable name, in American English. The English name for the asset must be present.
* ''username-de'' - The content's human-readable name, in German.
* ''username-cz'' - The content's human-readable name, in Czech.
* etc.

The following standard tags support this form of localization:

* [["Username" tag]]
* [["Description" tag]]
* [["String-table" container]]

==Common Containers==
* [["Attached-track" container]]
* [["Extensions" container]]
* [["Kuid-table" container]]
* [["Mesh-table" container]]
* [["Obsolete-table" container]]
* [["String-table" container]]
* [["Textures" container]]
* [["Thumbnails" container]]
* ...

==Related Links==
* [[Index of Tags & Containers]]
* [[Content Configuration]]
* [[Content Types]]

[[Category: File formats]]

"mesh-table" Container

2010-03-08T12:29:24Z

Windwalkr (legacy 2550): "mesh-table" Container moved to "mesh-table" container

#REDIRECT [["mesh-table" container]]

"mesh-table" container

2010-03-08T12:29:24Z

Windwalkr (legacy 2550): "mesh-table" Container moved to "mesh-table" container

The "mesh-table" container is a top-level [[config.txt file]] entry used by various [[Content Types]].

The mesh-table is a list of mesh subcontainers with no standalone tags. Each mesh subcontainer uses the following format. Tags are parsed in a standardised format, but not all [[Content Types]] support the full range of tags. Each mesh derives its name from the subcontainer's tag name. These names are used to refer to specific meshes from within the mesh-table and also from script.

=Supported Tags=
Each mesh subcontainer supports the following tags. Each tag is shown here with its default value.

mesh-asset <NULLKUID>
mesh ""
anim ""
lod-level 255
att ""
att-parent ""
opacity 1.0
position 0,0,0
orientation 0,0,0
auto-create 0
use-parent-bounds 0
animation-loop-speed 0
light 1
critical-animation 1
effects
{
}
night-mesh-base ""

====mesh-asset====
''TBD''

====mesh====
The ‘main’ mesh name. This may include a sub-path;
ie: mesh nightwindows/nightwindows.im, where the file nightwindows.im has been placed in the subdirectory nightwindows.

Use .im files exported from 3dsmax or gmax (as opposed to .pm.) or reference an .lm file if you wish your asset to have ‘Level of Detail’ mesh reduction.

Level of detail is a process of using different model meshes, depending on how far the viewer is from the model. A finer mesh is used for close up viewing in Trainz.

====anim====
The animation file (.kin) exported from 3dsmax or gmax. This may include a sub-path.

====lod-level====
The object LOD level at which this mesh is displayed. The default value (255) indicates that this mesh is visible at all detail levels. See also [[KIND Mesh]] for the 'mesh-detail-level' tag.''

====att====
The mesh (and animation if present) is inserted at a mesh attachment point rather than the origin (without this line the mesh is placed relative to the origin of the parent model).

====att-parent====
The tag tells Trainz in which mesh the attachment point is located. The insertion attachment point is located within the mesh ‘name’ , as listed in the config.txt.

====opacity====
''TBD'

====position====
''TBD'

====orientation====
''TBD'

====auto-create====
The model is generated automatically when placed, or when you load a map which includes the model. In some instances you don’t want the mesh visible (as this may be controlled through script). If auto-create is 0 the mesh will not be visible when placed.

====use-parent-bounds====
When enabled, this tag indicates that render culling should occur using the whole object's bounding box rather than this mesh's bounding box. Bounding boxes on individual meshes may not update correctly when animation moves the object's geometry any significant distance from the bind position. This flag can help mitigate such effects, at a tiny performance penalty.

====animation-loop-speed====
This tag must be here if the asset is to animate when placed. If this tag is not here when placed the animation will not play by default, but may play if controlled by script. A different value (e.g. 0.5, 2.0) may be used in the tag to play the animation at a different speed from that created in 3dsmax or gmax.

====light====
''TBD'

====critical-animation====
"critical-animation" indicates that this mesh's animation generates events which are critical to the script system's behavior. If your asset is not scripted, does not use scripted animation events, or only uses the events for display purposes and will not break if the occasional event is missed, this tag should be set to ''false''. Leaving this flag set to ''true'' is a '''significant''' performance penalty.

====night-mesh-base====
This night mesh is linked to the specified mesh and is visible only at night. It is invisible if the specified mesh is invisible, (if the auto-create 0 line were used so the specified mesh can be controlled by script).

=Effects Container=
The effects container also contains a list of effect subcontainers. The effect subcontainers support the following generic tags.

kind ""
name ""

The effect subcontainers support additional tags depending on the effect kind. The following effect kinds are supported:

* [[Corona Effect]]
* [[Name Effect]]
* [[Attachment Effect]]
* [[Animation Effect]]
* [[Texture-Replacement Effect]]

=Mesh-Table Example=
The following is an example of a simple mesh-table which implements two levels of detail.

mesh-table
{
default-lod0
{
mesh "example-lod0.im"
auto-create 1
lod-level 0
}
default-lod1
{
mesh "example-lod1.im"
auto-create 1
lod-level 1
}
}

[[Category:Config Container]]