TrainzOnline - User contributions [en]

ACS Coupling System

2015-05-12T00:34:29Z

Jamesmoody: /* The Attachment Points */

===Introduction===

There are many and varied problems with the existing BlueStar standard - but the main ones are the inflexibility beyond the initial application (coupling mineral wagons and transition era locos), and the rather arcane numeric values put into the config.txt.

A more readable, more flexible, and preferrably easily extensible datastructure in the config.txt was needed, and some way of standardising the logic (at the very minimum, an include file, but preferrably a library). It needed to support many more different types of coupler, vehicles with different couplers on each end, and so on.

The ACS System is an extension of the BlueStar coupling standard for TRS models (effectively BlueStar V2) and provides for the effect of working couplings on rolling stock. From version 5 of the ACSLib ACS vehicles are compatible with older BlueStar/CoupleStar ones.

To add ACS couplings it is necessary to edit the asset config file, add attachment points to the mesh (see below for an alternative which can sometimes be used) and to create a script or edit the existing one. Due to the fact that you need access to the source files of the asset and to be able to script it is an advanced technique that cannot easily be carried out by an end-user.

For couplers implemented as meshes in the mesh-table (usually but not always animated), position and orientation tags can be used to locate the attached meshes:

*For front couplings the tag 'position 0,Y,0' should be added.
*For back couplings two tags are needed, 'position 0,Y,0' and orientation '0,0,3.14159'
*in both cases the value Y is 0.46 metres inboard of the Y value of limfront and limback respectively.

===The Attachment Points===

All of the coupler, hoses and cables are attached to two points, one on the face of the front buffer beam (a.couple0) and one on the face of the rear beam (a.couple1). a.limfront should be 0.46m forward of a.couple0 and a.limback 0.46m rearward of a.couple1. a.couple0 and a.couple1 must be at x=0 and z=0.

Create a.couple0 in top view and move it into position. Then clone and position it to create a.couple1 and rotate it 180°. The Y axis of the two coupler points should point towards 0,0,0.

[[image:acs att points.jpg]]

===The Config File===
First off, here is an example config.txt fragment:

<pre>
extensions {
max_permitted_speed-60850 "125mph"
active-coupling-standard-60850 {
version-major "2"
version-minor "0"
brakes "air"
front {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
back {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
}
}
</pre>

So, what does all this do, and what are the options?
====Extension Container====
<pre>
extensions {
...
}
</pre>

This is for TRS2006 compatibility - it's all going in the extensions container. This does work in TRS2004 as well. Watch for the caveat at the end though...

====Max Permitted Speed====
<pre>
Max_Permitted_Speed-60850 "125mph"
</pre>

Not strictly part of the coupling code, but may as well mention it. This is for the Max Permitted Speed rule to tell how fast this vehicle should be permitted to travel. It will tell both AI drivers and the human driver (via the Custom HUD rule) what the maximum permitted speed is for the train they are driving, based on information from each vehicle. (And in a future version of the rule, more stuff too...)
====ACS Container====
<pre>
active-coupling-standard-60850 {
...
}
</pre>

This is the container within which all the config information will be held.

====ACS Version====
<pre>
version-major "2"
version-minor "0"
</pre>

Version numbers. This is useful when later code needs to read earlier format config files. Should make extending the standard a lot easier.

====Braking System====
<pre>
brakes "air"
</pre>

Defines what type of braking system is fitted to this vehicle. Options are:
*"air"
*"vac"
*"dual"
*"none"

This is independant of what hoses are available - unbraked but through piped stock is an entirely possible combination, and is representable.

====Position====
<pre>
front {
...
}
back {
...
}
</pre>

Containers for the front and back of the vehicle. 'Front' is defined as "the a.limfront end", and 'back' "the a.limback end". Available options for both are the same, so I'll describe them just once.
====Coupler Type====
<pre>
coupler "knuckle|screwlink|hook"
</pre>

What type of coupler do we have on this end of the vehicle? Options are:
* "hook" -- connects to screwlink/instanter/3link/hst-emergency-bar.
* "3link" -- connects to hook.
* "instanter" -- connects to hook.
* "screwlink" -- connects to hook.
* "hst-emergency-bar" -- connects to hook.
* "bar-full" -- connects to "bar-none". Half of a handed pair for when one vehicle has the entire bar coupling.
* "bar-none" -- connected to by "bar-full". The other half of the handed pair.
* "bar" -- connects to self only. Used when both vehicles have half the bar coupling.
* "knuckle" - standard knuckle coupler.
* "tightlock" -- different to a standard knuckle, refers to a knuckle style coupler often fitted to multiple unit trains that also include electrical connections.
* "wedgelock" -- London Underground coupler.
* "bsi" -- Found on Sprinter DMUs and derived designs.
* "dellner" -- Also compatible with scharfenberg coupling.
* "scharfenberg" -- Also compatible with dellner coupling.
* "(other string identifier)" -- Any string that is not recognised from the above list is assumed to be a symmetrical meet-in-the-middle type of coupler.

Certain couplers are purely compatible with other identical couplers, others are inter-compatible. Some produce handed pairs - e.g. a 3 link chain couples to a hook, and wagons with this coupling are typically fitted with both a hook and a chain.

Multiple coupler options can be specified, and are separated with a vertical bar character. The earlier option is used in preference, so list the best coupler option first.

A typical unfitted freight wagon with a 3 link coupling is specified as "3link|hook". A vehicle fitted with a knuckle, screwlink and hook (e.g. a swingknuckle fitted locomotive) is specified as "knuckle|screwlink|hook". A BR coaching stock dropknuckle (a knuckle and a hook, but no chain) is specified as "knuckle|hook". If the vehicle also has an emergency screwlink which is not permanently fitted, then "knuckle|hook|screwlink" would be appropriate -- this would cause ACS to prefer the chain type coupler from the adjacent vehicle rather than using the emergency screwlink, which would only be used when necessary. A Victorian Railways transitional coupler (which has a chain and a knuckle, but no hook) is specified as "knuckle|3link".

Dellner and Scharfenberg couplings are treated as compatible, so a dellner will also couple to a scharfenberg.

If your coupler type isn't listed, define a standard name for it, and start using it. ACS supports arbitrary extension - any new coupler it hasn't seen before will be treated as a symmetrical coupler. ACS will tell you if it has connected to an identical coupler on the adjacent vehicle.

If you need a new handed pair type (where the coupler on the end of one wagon is not the same as that on the end of another), then you will need to contact the ACS author to get one added.

====Gangways====
<pre>
gangway "gangway"
</pre>

Passenger gangway between vehicles. Options are:
*"none"
*"rubbing-plate"
*"gangway"

This is really intended for coaching stock - it is assumed that all gangways are compatible. I've been considering a 'one piece' gangway option - to aid with the centre of multiple unit trains, where there is no separation point (it will help with deciding which vehicle should display the gangway) - but I'm not sure whether this is of sufficient benefit to include, as it involves a whole new set of logic here that most people won't use, and for the cases it is interesting, the same person has made both vehicles, and can therefore do it themselves... Comments please.
====Pipes for Air Brakes====
<pre>
airbrake "twin"
</pre>

Brake pipes for air brakes. Options are:
*"twin"
*"single"
*"none"

Twin is the UK standard two pipe air brake system (train pipe and brake pipe). Single is the US standard air brake system where reservoirs are charged from the brake pipe rather than the train pipe (this has appeared on some modern freightcars for reasons unknown, so is included).
====Pipes for Vac Brakes====
<pre>
vacbrake "none"
</pre>

Brake pipes for Vacuum brakes. Options are:
*"twin"
*"single"
*"high"
*"none"

Single is the UK default for fitted stock, high connections seems to be the standard on UK steam locos. Twin pipes (operating at two different vacuum levels) has been tried in the UK - and while not much fitted stock has the twin pipe system, most air brake, through vac piped stock seems to have two vac pipes.
====Multiple Working Cables====
<pre>
multiple-working "none"
</pre>

Multiple working connections. Options are:
*"(color)-(shape)" -- e.g. "blue-star" or "red-diamond", etc
*"AAR" -- as used on GM locos
*"SR27" -- bagpipes
*"(other identifier string e.g. classname)"
====Train Heating====
<pre>
heating-type "electric"
</pre>

Coach heating. Options are:
*"none"
*"steam"
*"electric" -- standard ETH
*"dual" -- both Steam and standard ETH
*"southern-electric" -- The Southern, who pioneered electric train heating in the UK, fitted heating that was compatible with their DC powered EMUs, and thus ran from the same voltage as the DC power supply. When the rest of BR went ETH, different standards were adopted, resulting in the Southern having a different and incompatible ETH standard...

====Lighting Control Cables====
<pre>
rch "high"
</pre>

Through wiring for lighting control, to the Railway Clearing House standard. Also used more recently for other things - e.g. remote control via various methods - including TDM. I believe it is also used for signals to control doorlocks on stock so fitted - though I could be wrong on this. Options are:
*"high" -- positioned as is fairly standard on coaching stock
*"low" -- positioned as is fairly standard on streamlined locos, e.g. the front of a DVT, or a cl90
*"none"
====Notes====
For all of these where "none" is an option, entirely missing out that line is equivalent to stating "none". This should make stock which doesn't use most of the features much more palatable to produce. This will also help when extending the standard - as new features will automatically be assumed to be not present on stock built to older standards...

That's all very well and good, but how is this supposed to be backwards compatible with the old bluestar standard?

I'm making the code fall back to reading the old config entries if it can't find the new ones. The real problem is that new stock will also have to include config.txt entries for the old bluestar, so that old vehicles know what to do when they couple to this one. Yes, this means that the old tags will never actually go away, but at least TRS2006 doesn't whinge about them so hard as of SP1...

===The Script===

(under construction)

[[Category:Modeling]]

Talk:HowTo/Build T:ANE Track

2015-05-04T07:23:22Z

Jamesmoody:

I believe that the latest procedural track, build 74539, doesn't have the half sleeps and half chairs any more. --[[User:Pcas1986|pcas1986]] ([[User talk:Pcas1986|talk]]) 18:41, 28 April 2015 (AEST)

: It doesn't. Don't make track like this with the half sleepers - changing from one track type to another doesn't work properly if you do make half sleepers. --[[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 17:23, 4 May 2015 (AEST)

In my trials, I always used the older way of starting each mesh halfway between sleepers. --[[User:Pcas1986|pcas1986]] ([[User talk:Pcas1986|talk]]) 18:41, 28 April 2015 (AEST)

: This is what we use now also. I would advise against following this document as it exists. Our document will show different methods and alignments for nearly every component. --[[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 17:23, 4 May 2015 (AEST)

At first I inserted a hidden mesh underneath the sleepers and chairs to account for the actual distance but the new tags "spacing-length-before" and "spacing-length-after" seem to take care of that. Haven't discovered what the new tag "padding-length" does yet.

I have noticed some changes but am reluctant to make any changes to the tutorial just yet. Basically I'm waiting for N3V to publish some information.
--[[User:Pcas1986|pcas1986]] ([[User talk:Pcas1986|talk]]) 18:41, 28 April 2015 (AEST)

Talk:Techniques, tips, and tricks for route builders

2014-06-03T23:46:46Z

Jamesmoody: Created page with "Information on this page needs to be moved to here: Route_and_Session_Creation. Further information should be put on the relevant sub-pages of that page. --~~~~"

Information on this page needs to be moved to here: [[Route_and_Session_Creation]]. Further information should be put on the relevant sub-pages of that page.
--[[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 09:46, 4 June 2014 (EST)

Talk:Techniques, tips, and tricks for session developers

2014-06-03T23:45:01Z

Jamesmoody: Created page with "Any information you are planning to put here should actually go on this page: Route_and_Session_Creation --~~~~"

Any information you are planning to put here should actually go on this page: [[Route_and_Session_Creation]]
--[[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 09:45, 4 June 2014 (EST)

ACS Coupling System

2014-05-26T23:54:19Z

Jamesmoody: /* Train Heating */

===Introduction===

There are many and varied problems with the existing BlueStar standard - but the main ones are the inflexibility beyond the initial application (coupling mineral wagons and transition era locos), and the rather arcane numeric values put into the config.txt.

A more readable, more flexible, and preferrably easily extensible datastructure in the config.txt was needed, and some way of standardising the logic (at the very minimum, an include file, but preferrably a library). It needed to support many more different types of coupler, vehicles with different couplers on each end, and so on.

The ACS System is an extension of the BlueStar coupling standard for TRS models (effectively BlueStar V2) and provides for the effect of working couplings on rolling stock. From version 5 of the ACSLib ACS vehicles are compatible with older BlueStar/CoupleStar ones.

To add ACS couplings it is necessary to edit the asset config file, add attachment points to the mesh (see below for an alternative which can sometimes be used) and to create a script or edit the existing one. Due to the fact that you need access to the source files of the asset and to be able to script it is an advanced technique that cannot easily be carried out by an end-user.

For couplers implemented as meshes in the mesh-table (usually but not always animated), position and orientation tags can be used to locate the attached meshes:

*For front couplings the tag 'position 0,Y,0' should be added.
*For back couplings two tags are needed, 'position 0,Y,0' and orientation '0,0,3.14159'
*in both cases the value Y is 0.46 metres inboard of the Y value of limfront and limback respectively.

===The Attachment Points===

All of the coupler, hoses and cables are attached to two points, one on the face of the front buffer beam (a.couple0) and one on the face of the rear beam (a.couple1). a.limfront should be 0.46m forward of a.couple0 and a.limback 0.46m rearward of a.couple1. a.couple0 and a.couple1 must be at x=0 and z=0.

Create a.couple0 in top view and move it into position. Then clone and position it to create a.couple1 and rotate it 180°. The Y axis of the two coupler points should point towards 0,0,0.

[[image:acs_att_points]]

===The Config File===
First off, here is an example config.txt fragment:

<pre>
extensions {
max_permitted_speed-60850 "125mph"
active-coupling-standard-60850 {
version-major "2"
version-minor "0"
brakes "air"
front {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
back {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
}
}
</pre>

So, what does all this do, and what are the options?
====Extension Container====
<pre>
extensions {
...
}
</pre>

This is for TRS2006 compatibility - it's all going in the extensions container. This does work in TRS2004 as well. Watch for the caveat at the end though...

====Max Permitted Speed====
<pre>
Max_Permitted_Speed-60850 "125mph"
</pre>

Not strictly part of the coupling code, but may as well mention it. This is for the Max Permitted Speed rule to tell how fast this vehicle should be permitted to travel. It will tell both AI drivers and the human driver (via the Custom HUD rule) what the maximum permitted speed is for the train they are driving, based on information from each vehicle. (And in a future version of the rule, more stuff too...)
====ACS Container====
<pre>
active-coupling-standard-60850 {
...
}
</pre>

This is the container within which all the config information will be held.

====ACS Version====
<pre>
version-major "2"
version-minor "0"
</pre>

Version numbers. This is useful when later code needs to read earlier format config files. Should make extending the standard a lot easier.

====Braking System====
<pre>
brakes "air"
</pre>

Defines what type of braking system is fitted to this vehicle. Options are:
*"air"
*"vac"
*"dual"
*"none"

This is independant of what hoses are available - unbraked but through piped stock is an entirely possible combination, and is representable.

====Position====
<pre>
front {
...
}
back {
...
}
</pre>

Containers for the front and back of the vehicle. 'Front' is defined as "the a.limfront end", and 'back' "the a.limback end". Available options for both are the same, so I'll describe them just once.
====Coupler Type====
<pre>
coupler "knuckle|screwlink|hook"
</pre>

What type of coupler do we have on this end of the vehicle? Options are:
* "hook" -- connects to screwlink/instanter/3link/hst-emergency-bar.
* "3link" -- connects to hook.
* "instanter" -- connects to hook.
* "screwlink" -- connects to hook.
* "hst-emergency-bar" -- connects to hook.
* "bar-full" -- connects to "bar-none". Half of a handed pair for when one vehicle has the entire bar coupling.
* "bar-none" -- connected to by "bar-full". The other half of the handed pair.
* "bar" -- connects to self only. Used when both vehicles have half the bar coupling.
* "knuckle" - standard knuckle coupler.
* "tightlock" -- different to a standard knuckle, refers to a knuckle style coupler often fitted to multiple unit trains that also include electrical connections.
* "wedgelock" -- London Underground coupler.
* "bsi" -- Found on Sprinter DMUs and derived designs.
* "dellner" -- Also compatible with scharfenberg coupling.
* "scharfenberg" -- Also compatible with dellner coupling.
* "(other string identifier)" -- Any string that is not recognised from the above list is assumed to be a symmetrical meet-in-the-middle type of coupler.

Certain couplers are purely compatible with other identical couplers, others are inter-compatible. Some produce handed pairs - e.g. a 3 link chain couples to a hook, and wagons with this coupling are typically fitted with both a hook and a chain.

Multiple coupler options can be specified, and are separated with a vertical bar character. The earlier option is used in preference, so list the best coupler option first.

A typical unfitted freight wagon with a 3 link coupling is specified as "3link|hook". A vehicle fitted with a knuckle, screwlink and hook (e.g. a swingknuckle fitted locomotive) is specified as "knuckle|screwlink|hook". A BR coaching stock dropknuckle (a knuckle and a hook, but no chain) is specified as "knuckle|hook". If the vehicle also has an emergency screwlink which is not permanently fitted, then "knuckle|hook|screwlink" would be appropriate -- this would cause ACS to prefer the chain type coupler from the adjacent vehicle rather than using the emergency screwlink, which would only be used when necessary. A Victorian Railways transitional coupler (which has a chain and a knuckle, but no hook) is specified as "knuckle|3link".

Dellner and Scharfenberg couplings are treated as compatible, so a dellner will also couple to a scharfenberg.

If your coupler type isn't listed, define a standard name for it, and start using it. ACS supports arbitrary extension - any new coupler it hasn't seen before will be treated as a symmetrical coupler. ACS will tell you if it has connected to an identical coupler on the adjacent vehicle.

If you need a new handed pair type (where the coupler on the end of one wagon is not the same as that on the end of another), then you will need to contact the ACS author to get one added.

====Gangways====
<pre>
gangway "gangway"
</pre>

Passenger gangway between vehicles. Options are:
*"none"
*"rubbing-plate"
*"gangway"

This is really intended for coaching stock - it is assumed that all gangways are compatible. I've been considering a 'one piece' gangway option - to aid with the centre of multiple unit trains, where there is no separation point (it will help with deciding which vehicle should display the gangway) - but I'm not sure whether this is of sufficient benefit to include, as it involves a whole new set of logic here that most people won't use, and for the cases it is interesting, the same person has made both vehicles, and can therefore do it themselves... Comments please.
====Pipes for Air Brakes====
<pre>
airbrake "twin"
</pre>

Brake pipes for air brakes. Options are:
*"twin"
*"single"
*"none"

Twin is the UK standard two pipe air brake system (train pipe and brake pipe). Single is the US standard air brake system where reservoirs are charged from the brake pipe rather than the train pipe (this has appeared on some modern freightcars for reasons unknown, so is included).
====Pipes for Vac Brakes====
<pre>
vacbrake "none"
</pre>

Brake pipes for Vacuum brakes. Options are:
*"twin"
*"single"
*"high"
*"none"

Single is the UK default for fitted stock, high connections seems to be the standard on UK steam locos. Twin pipes (operating at two different vacuum levels) has been tried in the UK - and while not much fitted stock has the twin pipe system, most air brake, through vac piped stock seems to have two vac pipes.
====Multiple Working Cables====
<pre>
multiple-working "none"
</pre>

Multiple working connections. Options are:
*"(color)-(shape)" -- e.g. "blue-star" or "red-diamond", etc
*"AAR" -- as used on GM locos
*"SR27" -- bagpipes
*"(other identifier string e.g. classname)"
====Train Heating====
<pre>
heating-type "electric"
</pre>

Coach heating. Options are:
*"none"
*"steam"
*"electric" -- standard ETH
*"dual" -- both Steam and standard ETH
*"southern-electric" -- The Southern, who pioneered electric train heating in the UK, fitted heating that was compatible with their DC powered EMUs, and thus ran from the same voltage as the DC power supply. When the rest of BR went ETH, different standards were adopted, resulting in the Southern having a different and incompatible ETH standard...

====Lighting Control Cables====
<pre>
rch "high"
</pre>

Through wiring for lighting control, to the Railway Clearing House standard. Also used more recently for other things - e.g. remote control via various methods - including TDM. I believe it is also used for signals to control doorlocks on stock so fitted - though I could be wrong on this. Options are:
*"high" -- positioned as is fairly standard on coaching stock
*"low" -- positioned as is fairly standard on streamlined locos, e.g. the front of a DVT, or a cl90
*"none"
====Notes====
For all of these where "none" is an option, entirely missing out that line is equivalent to stating "none". This should make stock which doesn't use most of the features much more palatable to produce. This will also help when extending the standard - as new features will automatically be assumed to be not present on stock built to older standards...

That's all very well and good, but how is this supposed to be backwards compatible with the old bluestar standard?

I'm making the code fall back to reading the old config entries if it can't find the new ones. The real problem is that new stock will also have to include config.txt entries for the old bluestar, so that old vehicles know what to do when they couple to this one. Yes, this means that the old tags will never actually go away, but at least TRS2006 doesn't whinge about them so hard as of SP1...

===The Script===

(under construction)

[[Category:Modeling]]

Help:Mobile Driver

2014-05-25T23:08:28Z

Jamesmoody: /* Cab Controls */

<div style="float:right;">__TOC__</div>

Driver is the module which allows you to drive and operate trains and explore a "[[Help:Route|Route]]" by selecting (or creating) a "[[Help:Session|Session]]". You can enter Driver by using the [[Help:Mobile Main Menu:Select Route|Select Route]] tile on the main menu.

Each Driver Session is set up by the author. A very powerful feature in Trainz is that if you don't like the trains chosen, or want to add or remove objectives, it is a very simple process to edit a session to create a version customized to your particular tastes.

=Screen Layout=

[[File:mobile-driver-screen-layout.png|512px]]

The screen layout for Driver is as shown above. Various elements will change slightly during gameplay depending on the state of the simulation, however the overall layout remains consistent. Driving controls are toward the bottom of the screen, camera controls are on the left, the main menu button is on the top left and other utility buttons are on the top right. Each area is discussed in detail below.

=Driver Main Menu=

[[File:mobile-driver-main-menu.png|right|179px]]

[[File:mobile-driver-menu-button.png|72px]] At the top left of the Driver screen is a "pause" icon button, which pauses the game (in single player only) and displays the Driver Main Menu. The following options are available from this menu:

* "Back to Game" - Dismisses the menu and returns you to the game.
* "Options" - Displays the game options dialog.
* "Account Details" - Allows editing of the [[Planet Auran]] account details.
* "Achievements" - Shows the list of achievements, including the current progress toward further achievements.
* "Save Game" - Saves the current Driver Session. Saved sessions may be accessed later from within the [[Mobile-area-driving-select_route|Select Route menu]].
* "Find Object" - Allows you to find a named object on the route.
* "Exit Driver" - Exits the current game and returns to the [[Help:Mobile Main Menu|Main Menu]]. The game will offer to save any progress made in the current session.
 

=Camera Controls=
== Camera Mode Buttons ==
[[File:mobile-driver-camera-controls.png|right|49px]]
Depending on the current state of the game, there may be up to three camera control buttons on left side of the screen. These buttons are, from top to bottom:

* "Move Camera" - Tap this button to enter "move" mode. Drag anywhere on the 3D world to move the camera. If the camera was attached to a train, this will cause the camera to become detached from the train. This button is not available while using an interior camera view. If a lineside camera was active, manually adjusting the camera will swap to a free-roaming view. If the button is held instead of tapped, you can make a quick multi-touch adjustment to camera position without changing modes.
* "Rotate Camera" - Tap this button to enter "rotate" mode. Drag anywhere on the 3D world to rotate the camera without changing the center of focus. If the camera was attached to a train, it will remain attached. This button is not visible while using an interior camera view, as "rotate" mode is always active. If a lineside camera was active, manually adjusting the camera will swap to a free-roaming view. If the button is held instead of tapped, you can make a quick multi-touch adjustment to camera position without changing modes.
* "Return to Train" - Tap this button to return the camera view to the train which you are currently controlling. Where applicable, the train that you are controlling may be adjusted using the Driver Menu (see below.)

== Multitouch Gestures ==
In both camera adjustment modes, pinching will zoom the camera. At extreme distance, the camera will automatically adjust to face directly downward, and the view will transition between the local 3D view and a "minimap" overview.

In both camera adjustment modes, sliding two fingers vertically will cause the camera to tilt up or down, changing the angle of the horizon.

In the "move" camera mode, rotating two fingers in place on the screen will cause the camera to rotate around its point of focus.
 

== Camera Views ==
[[File:mobile-driver-camera-views.png|right|350px]]
Tapping on the "Camera View" icon button allows selection between the following camera view:

* Cab interior view - View the 3D world from the perspective of the Driver.
* Chase view - Attach the camera to the currently controlled train.
* Lineside view - Automatically select from cameras that are built into the route or session, where applicable. Not all routes and sessions have lineside cameras. Where no lineside cameras are available near the currently controlled train, the game will effectively use "chase view" instead.
* Free roaming view - Adjust the camera position and orientation manually. No attempt is made by the game to keep the currently controlled train in view. This mode is automatically selected whenever a manual adjustment is made which cannot be satisfied by the previously selected camera view. The "return to train" icon button will become visible while in this mode if you have a currently controlled train to return to.

You can tap on a train vehicle at any time to attach the camera view to that specific train vehicle.
 

=Simple Controls=
[[File:mobile-driver-dcc-controls.png|right|53px]]
Simple "DCC" controls.

The "DCC" control mode (also known as "arcade" control mode or "easy" control mode) allows you to control the train by providing a simple forward-backward speed slider on the bottom left of the screen. While the slider thumb is centred, the train will brake and come to a stop. When the slider thumb is moved toward the top of the slider, the train will accelerate forward. When the slider thumb is moved toward the bottom of the slider, the train will accelerate backward. The further from the center the slider is set, the faster the train will move.

A simplified physics model is used while in this control mode, which helps you to focus on the mechanics of the railroad rather than the specifics of driving the train.

 

=Cab Controls=
[[File:mobile-driver-cab-control.png|right|512px]]
More complicated "cab" controls.

Cab controls provide a realistic set of control levers and apply a realistic physics simulation to your train. This can be harder to master than the "DCC" control mode, however it can be more rewarding as it adds an additional element to the gameplay.

For diesel and diesel/electric locomotives, the controls are as follows, from left to right:

* Reverser (Yellow, Left side of screen) - This lever has three positions: Reverse (bottom), Neutral (middle) and Forward (top). The reverser can only be engaged while the throttle lever is in the neutral position.
* Throttle (Green, Left side of screen) - This lever has a number of notches, with neutral at the bottom and maximum throttle at the top. The reverser should have the appropriate direction selected before you apply the throttle.
* Dynamic Brake (Blue, Right side of screen) - This lever engages the dynamic brake. The off position is at the bottom. The dynamic brake is used to keep the train speed under control while descending a steep grade.
* Train Brake (Red, Right side of screen) - This lever operates the train brake. The release (off) position is at the bottom. The train brake is controlled at the locomotive, and the pressure propagates gradually to the rest of the train. The topmost setting of this lever engages the emergency brake, which stops the train as quickly as possible but which is not recommended for normal operations.
* Independent Brake (Red, Right side of screen) - This lever operates the independent brake. This brake affects the locomotive only. Careful use of the train and independent brakes can allow coupling slack to be built up or removed from the train.

 

=Information Panel=
[[File:mobile-driver-info-panel.png|right|260px]]
An information panel which relays the state of the next signal, the current speed, the current speed limit, approaching limit changes, and the current time or score.

When approach a restricted speed zone at excessive speed, the speed limit indicator will flash to warn you to slow down. You should attempt to slow the train prior to entering the new speed zone. The indicator will cease flashing once you are at an acceptable speed. It is easy to over-compensate for speed changes- it is often better to make small control changes and let the train settle at the new speed rather than nearly stop the train and then bring it back up to speed.

 

=Decoupling=
In order to decouple vehicles from your current train, you must enter decouple mode. This is achieved as follows:

1. Tap the user interface mode toggle at the bottom of the screen to cycle interface modes until you see the decouple icon.

:[[File:mobile-driver-ui-mode-switch.png|131px]]

2. Tap the decouple icon at the bottom right of the screen to enter decouple mode.

:[[File:mobile-driver-decouple-icon.png|80px]]

3. The camera will now rotate to the side of the train, coupling icons will show, and buttons will display at the left and right of the screen to move along the train. Move along the train and tap the appropriate coupler icons to lock or unlock the desired couplers.

:[[File:mobile-driver-decouple-view.png|512px]]

4. Tap the decouple icon at the bottom right of the screen to exit decouple mode. Optionally tap the user interface mode toggle to return to the driving controls.

Coupler icons which show in grey cannot be adjusted- this may be prevented by the current driving session, or may be the result of a simulated mechanical failure on your train due to excessive driving force.

=QuickDrive=

=Changing Drivers=

{{Platform_Mobile_Select_Area}}

Session Creation Guidelines

2014-05-16T05:14:57Z

Jamesmoody: Created page with "This document outlines the basic guidelines for Session creation for Trainz. =Types of Sessions= ==Multiplayer Sandbox Session== This type of session is a simple sandbo..."

This document outlines the basic guidelines for [[Session]] creation for Trainz.

=Types of Sessions=

==Multiplayer Sandbox Session==

This type of session is a simple sandbox with pre-arranged trains. It must include the multiplayer rule. The Multiplayer Rule lets the player decide if they want to play the game locally or host an online session. The session should contain no objectives, just various trains and drivers related to that route which the player can take over or assign to other players. This session may contain a brief introduction to the route and typical activities, but it is expected the players organise the gameplay for themselves.

==Linear driving sessions==

This type of session should provide the player with a train, and set them a series of linear tasks. There is only ever one action to be performed at any one time.

The Difficulty rating for a simple session is derived from the level of accuracy expected when following the session instructions.

===Easy difficulty===

A session with 'Easy' difficulty may ask the player to stop at stations or interact with industries.
It should not include yard work (specifically, no expectation to manually change junctions, or to couple or decouple the consist).
It should not feature tough terrain based challenges, e.g. a train that is underpowered to climb a hill.
It may score the user on any metric, but should allow a comfortable error margin.

===Medium (and higher) difficulties===

A session with a 'Medium' difficulty may add one additional challenge to an 'Easy' session.
'Hard' and 'Expert' ratings would require either a particularly stiff challenge, or multiple challenging aspects (e.g. both a tough climb AND difficult timekeeping elements).

==Non-linear sessions==

Non-linear sessions feature elements that the player can choose which order to complete. For example, the player may arrive in a yard, and be expected to make both a pick up and a set out. Both tasks will be assigned at once, and the player may choose which one to complete first. Relevant waypoints should be used to indicate both tasks are available. Instructions for the session should be clear and concise, but should not be overly hand-holdy. Tell the player where to make the set out, but don't walk them through how to uncouple a consist (that task should be handled by the tutorials). Sessions with non-linear elements are expected to start at 'medium' difficulty, and increase as additional challenges are added.

==Orienteering sessions==

An orienteering session is a fully non-linear session, where the entire session is one large set of parallel tasks. The session might be to perform a set of switching moves in a large yard. Provided all the vehicles end up in the right place, the moves can be done in any order. At the start of the session, the player is given the work list, but no sequence or schedule is imposed. It is up to the player to determine the most efficient way of achieving the requirements.

This type of session is welcome, but needs careful handling as it is very easy to overload the player with too much information at the start of the session. Trainz: A New Era will introduce an 'Objectives' system, and anyone wanting to create this type of session should plan to use Objectives to detail each parallel task. Each objective should use a sequence of navigation points and short display messages as required.

==Quick Drive==

Quick drive isn't really a session, but map creators still need to plan for it, so it does warrant some attention.

The map should not be left in an incomplete state if it is loaded with no session loaded. Specifically, the map should not require a "base session" of any kind to become functional.

The map should not include rolling stock. Rolling stock should be provided per session in session layers.

But what about industry settings, I hear you say. The map will contain a default set of industry parameters (whatever they were set to when you last saved the map). Each session will override this, but the map will retain a copy. No "base session" required.

If you are making a pack containing a map, some sessions, and some appropriate locomotives and rolling stock, make sure there are consist assets which provide suitable complete trains, made from the locos and rolling stock from the pack.

=Instructions and Messages=

==Session and Route Information==

The Session and Route Information is displayed in the game’s Route and Session menus. This information comes from the 'description' tag of the asset. Users can highlight a route from the route list to display the information for it.

===Route Information===

The Route Info should contain background information about the route. You might wish to describe the features of the route itself, the operating company, the era it is set, the history of it's construction and operation.

===Session Information===

Use this to summarize the session itself. Describe the part of the route used, the train consist used, and the kind of activities the player should expect to be doing.

The Session Information should not be used to give detailed instructions for the session’s objectives. The session should be playable without the user ever reading the Session Information. Detailed instructions should be displayed inside the session itself - and will be covered under the heading ''Player Instructions''.

The session creator should try to avoid the use of abbreviated words or forms of sentences. If this is impractical for some reason, then define the abbreviations.

==Session Introduction==

Each session should start with a brief introduction.

Use the Message Popup Rule (for the avoidance of doubt, that’s "Message Popup", <kuid:-25:964>) to display short messages to give instructions to players. Do not overload players with information - tell them only what they need to know to complete the current task. Correct use of Navigation Points created by the "Navigation Display" rules can eliminate 90% of what was previously written at the start of a session.

Use the Cinematic Camera rule during the session introduction to help set the scene and add a dynamic atmosphere to the introduction. It can also be used to direct the players attention to one or more specific locations.

All text for the session should use the Trainz default font size. Specifically, do not reduce the font size to fit text within a message popup window.

==Session Instructions==

Session instructions should be issued during the course of the session at appropropriate points instead of a chunk of text all at the same time. This allows the player to become engaged in the activity with minimal delay.

Messages displayed inside the session should be short and easy to understand. The messages displayed should be short enough to display completely within the message popup window, without the need for a scroll bar.

The session creator can tie in session instruction message popups with the completion or creation of relevant navigation points.

==Session Objectives==

Sessions for Trainz: A New Era should have an Objectives display using the new Objectives rules. Details of the Objectives system to follow.

==Navigation points==

Navigation Display rules should be added to assist the user to understand the required course of action at appropriate times during the session. It is recommended that these helpers are deployed sparingly and only at the relevant time in order to keep the number of Navigation Points on screen to a minimum.

Refer to the Navigation Display Example sessions for a guide on how to use navigation points.

==Additional Safety Systems==

Sessions may use prototypical in-cab safety features. If a session utilizes any safety systems (e.g. ATP or AWS) that are not fitted to the majority of default content, then this should be clearly mentioned in both the Session Information and the Session Introduction. The Session Introduction should have a single line mention (e.g. "This consist is fitted with the Metro-North ATP system."), with the words 'Metro-North ATP system' hyperlinked to a Wiki page on the specific system in use. The Wiki page itself should explain in detail about the system and how to operate it.

==Additional background information==

As the route and session information only support text, the Session Introduction may feature a link to the TrainzDev Wiki to provide further background information on the route and sessions. The wiki page allows greater control of formatting, images, videos, etc. Note that the wiki page should not provide any necessary session instructions. The session should be playable without the user ever visiting the wiki page.

Any help weblink will always redirect to it’s relevant page on Trainz Wiki and should use the format: “help://”
Example: help://KUID_123_456

==Languages and Translation==

All text in a session should be capable of being translated. This is handled for you by Trainz for any text that you entered into the surveyor UI, but if you made separate HTML assets, these need to read all text [[HowTo/Localize_an_Asset|from the string-table]].

The English string tables need to be written in English. You may optionally provide any other languages in the relevant string table for that language.

Note: Place names need not be translated. If the route has non-english place names, then the Session Summary, Instructions and Objectives should refer to the name as it is used in the map.

=Progress Verification=

The session should check the user’s progress against every objective and confirm the user’s action visually via the Navigation Display rules.

When the current set of navigation points are complete, the user has correctly completed the current objectives. The session can then display the next objective summary window giving the player the next set of instructions.

=Scoring=

Sessions should provide feedback to the player on how well they are doing. Criteria used to evaluate performance is at the discretion of the session creator.

Scoring should be done in a realistic manner. It doesn’t have to be “gamey” and unrealistic - we are a simulator after all. However, we do need to provide feedback to the users to indicate how well they are doing, and if their skills are improving.

As a session creator, you may wish to score purely on completion (successfully completing the tasks set) and rules observation (not breaking railroad rules, like speeding or running red lights). You may also wish to include timekeeping (keeping to a schedule), or maybe on something more adventurous like minimising fuel usage, or providing a smooth ride to passengers. Think of it like getting feedback from a supervisor or a railroad inspector.

A session variable should be added with the name ranking_points. This variable will be shown at all times on screen via a new "score" display. The variable ranking_points is increased or decreased during the session in response to the player's progress.

The reason for a change in the session score should be obvious to the player. If the player is penalised, it is important to provide feedback informing the player of the reason for the penalty. This applies both when points are deducted directly, or when a reduced reward is given for a less-than-perfect completion.

For sessions intended to be Trainz built-in content or payware DLC, we recommend using a consistent session variable called 'ranking_points' and a maximum value of 1000 for a perfect score.

==Penalties==

Minor infractions (e.g. low level speeding, poor timekeeping) should give the user some acceptable and logical buffer before applying penalty points. You may derive these from real world values if available, or use ball-park figures (e.g. 10% overspeed, 5 minutes delay) if not.

More serious infractions (passing red signals, failing to stop at a platform during a passenger run, moving the train while passengers are boarding) should be immediately and heavily penalized.

Early session termination should be used in circumstances when a train would be cancelled or the driver relieved of duty in real life. This should include serious safety failures (derailments or collisions), as well as major schedule issues (e.g. service terminated due to being so late it’s not worth running any more).

Ideally all other situations should allow the session to continue with an appropriate score penalty.

However, due to the session complexity introduced by the requirement to handle the users train getting out of a planned path should the user pass a red signal, this type of infraction may be punished by session termination. Note that the ‘signal passed at danger rule’ can differentiate between Absolute and Permissive reds - as represented in game by states “EX_STOP” and “EX_STOP_THEN_CONTINUE” aspects, and only Absolute reds (“EX_STOP”) should be punished in this way.

Where an absolute red light must be passed within the course of a session, the driver should be ‘talked past’ the red light using a message.

==Dynamic change for sub objective failure==

On certain conditions, the session creator can implement dynamic changes based on the user’s actions. For example, if he is late and not meeting his schedule, the session may make him wait at a signal until other traffic has passed, including routing AI traffic ahead of the player which will cause the player to become even further delayed.

If the session creator is using such a dynamic change, then a message window should inform the user about such changes when they occur.

==Achievements==

The Session Complete Rule (<kuid:447264:1011>) can be used to mark the session as complete in the achievements system. Add the rule to the session where the message for a successful completion is displayed.

==Star Ratings==

TBD.

=Automated sessions=

Fully automated sessions (often called a "Ride" or "Passenger" session) are not considered to add gameplay value by themselves.

However, sessions may offer the user a choice to drive themselves or have an AI complete the session. For sessions intended to be submitted as Trainz built-in or DLC content, this is highly recommended.

Note that if an AI option is used to automate the session, the user must be prevented from earning a completed session achievement.

=See Also=
* [[HowTo/Create_an_Interactive_Session]]
* [[Session]]
* [[KIND_Profile]]
* [[Session_Rules_Overview|Session Rules Overview for Programmers]]

Route and Session Creation

2014-05-16T05:06:22Z

Jamesmoody:

Unlike many other [[Content Creation]] techniques, route and session creation is performed in the Trainz [[Surveyor]] module. This page provides information ranging from planning out a new route through to creating gameplay [[session]]s. To get started quickly, please read [[HowTo/Create a session]].

==Route Creation==

* Researching a Prototypical Route
* Practical Limitations
* Shaping the Ground
* Ground Texturing
* Placing Water
* Laying Track
* Junctions
* Trackside Objects
* Interactive Industries
* Scenery Splines
* Scenery Objects
* Signalling
* Testing your Route
* Route Layers

==Session Creation==

* [[HowTo/Create_an_Interactive_Session|Session creation HowTo]]
* Session Layers
* Placing Trains in a Session
* Configuring Industries for a Session
* Configuring Junctions for a Session
* Configuring Environmental Options for a Session
* Triggers and Trackmarks
* The Surveyor Rules Editor
* Configuring Driver Commands for a Session
* [[Session Creation Guidelines|Guidelines for Session Creation]]
* [[Session Rules Overview|Session Rules Overview for Programmers]]
* [[:Category:Rules|The list of all documented rules]]

[[Category:Basic Trainz ]]
[[Category:Content creation]]

Modeling

2014-05-15T00:04:23Z

Jamesmoody: Reverted edits by Jamesmoody (talk) to last revision by Fabartus

{{ORP-top}}
N3V Games uses Autodesk 3DS Max for internal modeling needs. At the current time, this is the only N3V-supported tool for creating models for the Trainz environment. Details on exporters can be [[Max Exporters | found here]]. N3V does not support any other 3D modelling software or exporters at the current time. Third-party programmers looking to write exporters should investigate the [[Trainz Mesh Importer]] tool. Community members have also created exporters for the Blender and SketchUp modeling tools.

== Introduction to Trainz modeling ==

* [[Modeling Trains for Trainz]] - General Information for Artists
* [[Attachment Points]]
* [[Level of Detail]]

== Best Practices ==
The following guides describe best practices for modeling in various scenarios, including a discussion of techniques, polygon counts, etc.

* [[Modeling Guidelines]]
* [[Modeling Splines]]
* [[Modeling Scenery]]
* [[Runtime Performance Statistics]]

== Modern Content ==

Trainz is a long-running project and some content (both user-created, and supplied by N3V Games) is built to outdated standards. If you're new to content creation in Trainz, or have recently upgraded from an older version of the product, you should take some time to familiarise yourself with the capabilities of the product and the expectations placed on any new content. All content built for current versions of Trainz should comply with the following:

* 3D models require [[normal map]]s.
* [[KIND Groundtexture|Ground textures]] require normal maps and should have a texture resolution such as 1024x1024 or higher.
* Models should have high polygon detail, with [[Level of Detail|LOD]] fallbacks for older cards and distant objects.

==Examples==
[[TC & TS2009 Example Meshes]] - 3D Studio Max files provided to demonstrate features and techniques used by the Trainz team during TS2009 developement.

==Related Links==
[[Content Types]] - Using your models to build one of the supported Trainz content types, such as locomotives, scenery, and track.

[[ACS Coupling System]] - How to create models that use working couplings

[[Updating Steam Locos to TC3 Standards]] - Changing older models to use the new features introduced in TC3

[[Getting Started with Normal Mapping]] - Creating a simple model using normal mapping.

[[Material Types]] - Material types supported by Trainz.

[[Max Exporters]] - 3D Studio Max exporters.

[[Exporting with 3D Studio Max]] - Material setup and exporting with 3DS Max.

[[New Vs Old Exporter]] - Comparison and FAQ between the new and old 3D Studio Max exporters.

[[Trainz Mesh Importer]] - Trainz Mesh Importer a tool to assist importing models and animations from 3rd party applications.

[[.texture.txt Files]] - What goes into a .texture.txt file

[[Attachment Points]] - Information on attachment points

[[Category:Modeling| ]]
{{ORP-bot}}

Modeling

2014-05-13T04:47:12Z

Jamesmoody:

{{ORP-top}}
N3V Games uses Autodesk 3DS Max for internal modeling needs. At the current time, this is the only N3V-supported tool for creating models for the Trainz environment. Details on exporters can be [[Max Exporters | found here]]. N3V does not support any other 3D modelling software or exporters at the current time. Third-party programmers looking to write exporters should investigate the [[Trainz Mesh Importer]] tool. Community members have also created exporters for the Blender and SketchUp modeling tools.

== Introduction to Trainz modeling ==

* [[Modeling Trains for Trainz]] - General Information for Artists
* [[Attachment Points]]
* [[Level of Detail]]

== Best Practices ==
The following guides describe best practices for modeling in various scenarios, including a discussion of techniques, polygon counts, etc.

* [[Modeling Guidelines]]
* [[Modeling Splines]]
* [[Modeling Scenery]]
* [[Runtime Performance Statistics]]
* [[Session Guidelines]]

== Modern Content ==

Trainz is a long-running project and some content (both user-created, and supplied by N3V Games) is built to outdated standards. If you're new to content creation in Trainz, or have recently upgraded from an older version of the product, you should take some time to familiarise yourself with the capabilities of the product and the expectations placed on any new content. All content built for current versions of Trainz should comply with the following:

* 3D models require [[normal map]]s.
* [[KIND Groundtexture|Ground textures]] require normal maps and should have a texture resolution such as 1024x1024 or higher.
* Models should have high polygon detail, with [[Level of Detail|LOD]] fallbacks for older cards and distant objects.

==Examples==
[[TC & TS2009 Example Meshes]] - 3D Studio Max files provided to demonstrate features and techniques used by the Trainz team during TS2009 developement.

==Related Links==
[[Content Types]] - Using your models to build one of the supported Trainz content types, such as locomotives, scenery, and track.

[[ACS Coupling System]] - How to create models that use working couplings

[[Updating Steam Locos to TC3 Standards]] - Changing older models to use the new features introduced in TC3

[[Getting Started with Normal Mapping]] - Creating a simple model using normal mapping.

[[Material Types]] - Material types supported by Trainz.

[[Max Exporters]] - 3D Studio Max exporters.

[[Exporting with 3D Studio Max]] - Material setup and exporting with 3DS Max.

[[New Vs Old Exporter]] - Comparison and FAQ between the new and old 3D Studio Max exporters.

[[Trainz Mesh Importer]] - Trainz Mesh Importer a tool to assist importing models and animations from 3rd party applications.

[[.texture.txt Files]] - What goes into a .texture.txt file

[[Attachment Points]] - Information on attachment points

[[Category:Modeling| ]]
{{ORP-bot}}

HowTo/Create an Interactive Session

2014-01-24T02:12:53Z

Jamesmoody:

The Trainz [[session]] concept is very powerful. Unfortunately, all most people use it for is adding consists to a route, assigning some AI orders, and setting a few basic startup settings for the session in the default rules.

This document is a quick introduction to sessions aimed at getting people to think beyond this most basic level of session, and to take more advantage of the power and flexibility of the session concept.

It assumes you are familiar with Driver and basic Surveyor usage including placing scenery and trains. If this doesn't sound like you, then you may need a more basic introduction to Trainz [[Driver]] and [[Surveyor]] first.

=Your first interactive session=

It's time to create your first session.

In the routes menu, find the route 'Springfield Industrial District' (you may have to unselect 'show only favorite routes'). This example uses this route because it's small, and everyone has a copy. Show the sessions, and then click 'new session'.

Place a CHN ND5-1 on one of the turntable tracks, and a CHN G70K tanker in the yard next to the turntable.

==Setting the initial startup options==

Now open the 'Edit Session' dialog on the main menu. Change the session name and type something in for the description.

You should have something that looks roughly like this:

[[Image:Session-tutorial-1.jpg|640px]]

If you are using [[TS2010]], remove the 'ConsistDataHandler' and 'QuickDrive' rules. Nice though they are, we don't want the player of this session to be able to arbitrarily create new vehicles. To delete the rule, click on it to select it, and then click the 'Delete' button.

Note: If you are using [[TS12]] or [[Trainz Simulator Mac]], you won't have 'startup options' - '[[QuickDrive]]' has taken over this role. So instead of deleting those two rules, edit the 'QuickDrive' rule (highlight it and click the 'Edit' button), and tick the "Gameplay Session" option in the QuickDrive options. Save the changes.

==Adding a displayed score==

Add the [[Display Custom HUD Rule]] - click 'add', find 'Display Custom HUD' in the list, select it, and click the tick button.

Add a [[Variable Modify Rule]]. Once you've added this, click the 'Edit' button, and you can set the rule properties. Anything you can click on is underlined. Click on 'Add', and set this to 'Change'. Also set the number to '0'. It should look like this:

[[Image:Session-tutorial-2.jpg|640px]]

Confirm these changes by clicking the tick button on the 'Properties' dialog.

Add a [[Variable Show Rule]].

==Checking the user makes a train correctly==

Add a [[Consist Check Rule]]. Select 'Complete whenever a train matching the description exists'. This opens up several more options. Under 'Specific Vehicles', click the plus, and add our ND5. Repeat this and add the G70K as well. Also tick 'Enforce strict exclusive checking'. It should look like this:

[[Image:Session-tutorial-3.jpg|640px]]

'Enforce strict exclusive checking' will make the consist check rule check the consist more thoroughly - so if someone picks up too many vehicles in the yard, it won't trigger.

Confirm these changes by clicking the tick button on the 'Properties' dialog.

Finally, Add a 'Variable Modify' rule at the bottom, under 'Consist Check'. We will click the right arrow button once to indent the rule one level to the right.

This means this rule will not take effect immediately, but will be triggered by the 'Consist Check' rule, when the consist exists.

Now tick the 'Edit Session' dialog.

==Driving your first session==

Let's try this out in Driver now.

Click on the Driver button next to the main menu. Save the session. (If it asks to save the map, you've done something wrong - did you place the trains in the wrong layer?)

In Driver, you should see the 'Custom HUD' panel, and in it, an extra field labelled 'Score'. It should be zero.
Take the ND5 over to the G70K tanker, and couple up to it. If the rules are set up right, 'Score' should change to '1'.

[[Image:Session-tutorial-4.jpg|640px]]

==Adding a pickup task at an industry==

Okay, let's take this a stage further. Go back to surveyor, and set the current layer to the session layer in the layers tab.

==Configuring an industry==

Configure 'Palmer Chemicals', by clicking on the industry track (between the two arrows) with the question mark icon from the 'scenery' tab. This is a 'multiple industry new' track. As this is a new session, it won't have any configuration yet - so we'll need to add some. See [[HowTo/Configure an Interactive Industry]] for details.

==Checking the user uses the industry==

Go back to the 'Edit Session' dialog. At the bottom, add a 'Resource Check' rule. Edit the resource check rule.

Pick the 'Watch Vehicle Queue' option. Within this, set 'CHN G70K Tanker' as the target object. Set the queue to be 'liquid' (there should be only one option). Set the product to be Aviation Fuel. Set the amount to be '72040' (you can actually type in '99999' and it'll autocorrect to the maximum size of the queue if it's larger than what the queue can hold). Ensure 'Complete when the designated queue equals or exceeds required amount' is set. It should look like this:

[[Image:Session-tutorial-5.jpg|640px]]

Tick the Properties dialog.

Now add a 'Variable Modify' rule below the [[Resource Check Rule]], configure it to add one to the variable 'score', and indent it one step to the right. Your session rules should look like this:

[[Image:Session-tutorial-6.jpg|640px]]

==Testing the extended session==

Now let's try this out in Driver. Couple the ND5 to the tanker as before. The score should update to 1 when you do this. Now take the wagon up the hill to Palmer Chemicals.

Stop the wagon next to the three pink tanks, and wait for it to load. Once it is loaded, the score should update to 2.

[[Image:Session-tutorial-7.jpg|640px]]

==Adding a delivery task at an industry==

And another stage. Go back to surveyor, and reselect the session layer.

Go to the airport, and in it's properties, set it's Aviation Fuel queue to start at Zero and consume Zero.

Now in 'Edit Session', add another 'Resource Check' rule to the bottom of the list. Configure this one to watch an industry queue on 'Local Airport'. There will be several queues here - you want 'av_in_q', with product 'Aviation Fuel'. We're going to watch for 144000 units, and complete when the queue equals or exceeds the required amount.

It should look like this:

[[Image:Session-tutorial-8.jpg|640px]]

Underneath and indented beyond this, we're going to need another Variable Modify rule.

When we test this in Driver, we'll need to fill the tanker twice - and deliver two loads. Only at the second load will the score go to 3.

==Checking vehicles are left in designated places==
''TBD''

==Adding instructions==
''TBD''

==Penalising Speeding==
''TBD''

==Penalising Passing Red Signals==
''TBD''

==Penalising Derailments==
''TBD''

==Adding a 'session complete' achievement==
''TBD''

=Hints and Tips=

Some background information you may find useful.

==Layers==

TS2010 introduced the concept of layers to Trainz, and when working on a session, you will need to use them. The key thing is that this allows you to add most types of Trainz assets to the session, which previously could only be used in a route. As well as the usual Traincars, this can be scenery objects, trackside objects, even splines.

A good tip is to lock the route layer(s). This will help prevent accidental editing of the route layers.

Pay particular attention to layers if you use the 'quicklaunch' feature to launch Driver direct from Surveyor and return to Surveyor afterwards. The layer you had selected before probably won't still be selected afterwards, so you'll need to check it every time you return from Driver.

=='Base session' assets==

Some routes come with a 'base session'. This generally has pre-configured settings for industries and other scripted assets in it. You may find, should your chosen map depend heavily on multiple industry assets or other similar scripted content, that you may need to base your session on a 'base session' asset, rather than creating a new session.

In this case, the default rules list may differ - as it may have been created in a different version of Trainz, or the route creator may have decided to change a few things. Feel free to add any missing rules you want, or remove extras you don't.

==Default rules==

In the 'Edit Session' dialog in TS2010, we have six rules by default.
* '[[Startup Options Rule]]' allows us to specify the control mode for the session, the weather, the start time, and a few other bits'n'pieces.
* '[[Driver Setup Rule]]' allows us to assign drivers to trains, and optionally give those drivers AI orders.
* '[[Driver Commands Rule]]' allows us to specify what orders can be assigned to AI drivers in the session.
* '[[Clean up Derailed Trains Rule]]' will mop up derailed vehicles.
* '[[ConsistDataHandler Rule]]' is used by QuickDrive
* '[[QuickDrive Rule]]' provides the quick drive interface that allows you to create consists and so on in Driver.

TS12 and Trainz Simulator Mac does not have 'Startup Options' - 'QuickDrive' now performs that role.

As a general rule, for a pre-planned interactive session, you probably don't want to permit the human driver to issue AI orders, or to be able to use the features of QuickDrive.

However, you probably want to be able to issue AI orders to background AI traffic while making the session, and you'll certainly need to fix those orders later when it turns out they don't quite do what you wanted them to. If you turn them off now, you'll have to turn them back on again when doing these operations - so my advice would be to only turn them off (by unticking them all) in 'Driver Commands' at the end of the creation process, once the session is finished. It'll get too annoying to keep turning them on and off when you need to fix problems with the background AI otherwise.

With TS2010, QuickDrive will unfortunately have to be removed from the rules list. It'd be way too easy for people to cheat using it.

With TS12 and Trainz Mac, it is possible to disable the advanced features of quickdrive, but still use it's better Cab/DCC mode selection screen - simply tick the 'Gameplay Session' checkbox in the QuickDrive options. This will deny the player access to the parts of QuickDrive which would cause problems in an interactive session.

[[Category:How-to guides]]

HowTo/Create an Interactive Session

2014-01-24T02:11:27Z

Jamesmoody: Reverted edits by Fabartus (talk) to last revision by Mjolnir

{{FUN-top}}
The Trainz [[session]] concept is very powerful. The very name eponymously refers to a Session of Driving. Unfortunately, all most people use it for is adding consists to a route, assigning some AI orders, and setting a few basic start-up settings for the session in the default rules.

This document is a quick introduction to sessions aimed at getting people to think beyond this most basic level of session, and to take more advantage of the power and flexibility of the session concept.

It assumes you are familiar with Driver and basic Surveyor usage including placing scenery and trains. If this doesn't sound like you, then you may need a more basic introduction to Trainz [[Driver]] and [[Surveyor]] first.
==The best start==
The smartest way to gain some familiarity with a session rules organization and programming is to take a look under the hood of a well written Driver Session that piques your interest. Perhaps there's a passenger train schedule keeping tutorial you can't quite do well enough scoring on when running it, or a well prompted session with a variety of activities, like the venerable Highland Valley Industries (Tutorial 5)

==Your first interactive session==

It's time to create your first session.

In the routes menu, find the route 'Springfield Industrial District' (you may have to unselect 'show only favorite routes'). This example uses this route because it's small, and everyone has a copy. Show the sessions, and then click 'new session'.

Place a CHN ND5-1 on one of the turntable tracks, and a CHN G70K tanker in the yard next to the turntable.

==Setting the initial startup options==

Now open the 'Edit Session' dialog on the main menu. Change the session name and type something in for the description.

You should have something that looks roughly like this:

[[Image:Session-tutorial-1.jpg|640px]]

If you are using [[TS2010]], remove the 'ConsistDataHandler' and 'QuickDrive' rules. Nice though they are, we don't want the player of this session to be able to arbitrarily create new vehicles. To delete the rule, click on it to select it, and then click the 'Delete' button.

Note: If you are using [[TS12]] or [[Trainz Simulator Mac]], you won't have 'startup options' - '[[QuickDrive]]' has taken over this role. So instead of deleting those two rules, edit the 'QuickDrive' rule (highlight it and click the 'Edit' button), and tick the "Gameplay Session" option in the QuickDrive options. Save the changes.

==Adding a displayed score==

Add the [[Display Custom HUD Rule]] - click 'add', find 'Display Custom HUD' in the list, select it, and click the tick button.

Add a [[Variable Modify Rule]]. Once you've added this, click the 'Edit' button, and you can set the rule properties. Anything you can click on is underlined. Click on 'Add', and set this to 'Change'. Also set the number to '0'. It should look like this:

[[Image:Session-tutorial-2.jpg|640px]]

Confirm these changes by clicking the tick button on the 'Properties' dialog.

Add a [[Variable Show Rule]].

==Checking the user makes a train correctly==

Add a [[Consist Check Rule]]. Select 'Complete whenever a train matching the description exists'. This opens up several more options. Under 'Specific Vehicles', click the plus, and add our ND5. Repeat this and add the G70K as well. Also tick 'Enforce strict exclusive checking'. It should look like this:

[[Image:Session-tutorial-3.jpg|640px]]

'Enforce strict exclusive checking' will make the consist check rule check the consist more thoroughly - so if someone picks up too many vehicles in the yard, it won't trigger.

Confirm these changes by clicking the tick button on the 'Properties' dialog.

Finally, Add a 'Variable Modify' rule at the bottom, under 'Consist Check'. We will click the right arrow button once to indent the rule one level to the right.

This means this rule will not take effect immediately, but will be triggered by the 'Consist Check' rule, when the consist exists.

Now tick the 'Edit Session' dialog.

==Driving your first session==

Let's try this out in Driver now.

Click on the Driver button next to the main menu. Save the session. (If it asks to save the map, you've done something wrong - did you place the trains in the wrong layer?)

In Driver, you should see the 'Custom HUD' panel, and in it, an extra field labelled 'Score'. It should be zero.
Take the ND5 over to the G70K tanker, and couple up to it. If the rules are set up right, 'Score' should change to '1'.

[[Image:Session-tutorial-4.jpg|640px]]

==Adding a pickup task at an industry==

Okay, let's take this a stage further. Go back to surveyor, and set the current layer to the session layer in the layers tab.

==Configuring an industry==

Configure 'Palmer Chemicals', by clicking on the industry track (between the two arrows) with the question mark icon from the 'scenery' tab. This is a 'multiple industry new' track. As this is a new session, it won't have any configuration yet - so we'll need to add some. See [[HowTo/Configure an Interactive Industry]] for details.

==Checking the user uses the industry==

Go back to the 'Edit Session' dialog. At the bottom, add a 'Resource Check' rule. Edit the resource check rule.

Pick the 'Watch Vehicle Queue' option. Within this, set 'CHN G70K Tanker' as the target object. Set the queue to be 'liquid' (there should be only one option). Set the product to be Aviation Fuel. Set the amount to be '72040' (you can actually type in '99999' and it'll autocorrect to the maximum size of the queue if it's larger than what the queue can hold). Ensure 'Complete when the designated queue equals or exceeds required amount' is set. It should look like this:

[[Image:Session-tutorial-5.jpg|640px]]

Tick the Properties dialog.

Now add a 'Variable Modify' rule below the [[Resource Check Rule]], configure it to add one to the variable 'score', and indent it one step to the right. Your session rules should look like this:

[[Image:Session-tutorial-6.jpg|640px]]

==Testing the extended session==

Now let's try this out in Driver. Couple the ND5 to the tanker as before. The score should update to 1 when you do this. Now take the wagon up the hill to Palmer Chemicals.

Stop the wagon next to the three pink tanks, and wait for it to load. Once it is loaded, the score should update to 2.

[[Image:Session-tutorial-7.jpg|640px]]

==Adding a delivery task at an industry==

And another stage. Go back to surveyor, and reselect the session layer.

Go to the airport, and in it's properties, set it's Aviation Fuel queue to start at Zero and consume Zero.

Now in 'Edit Session', add another 'Resource Check' rule to the bottom of the list. Configure this one to watch an industry queue on 'Local Airport'. There will be several queues here - you want 'av_in_q', with product 'Aviation Fuel'. We're going to watch for 144000 units, and complete when the queue equals or exceeds the required amount.

It should look like this:

[[Image:Session-tutorial-8.jpg|640px]]

Underneath and indented beyond this, we're going to need another Variable Modify rule.

When we test this in Driver, we'll need to fill the tanker twice - and deliver two loads. Only at the second load will the score go to 3.

==Checking vehicles are left in designated places==
''TBD''

==Adding instructions==
''TBD''

==Penalising Speeding==
''TBD''

==Penalising Passing Red Signals==
''TBD''

==Penalising Derailments==
''TBD''

==Adding a 'session complete' achievement==
''TBD''

=Hints and Tips=

Some background information you may find useful.

==Layers==

TS2010 introduced the concept of layers to Trainz, and when working on a session, you will need to use them. The key thing is that this allows you to add most types of Trainz assets to the session, which previously could only be used in a route. As well as the usual Traincars, this can be scenery objects, trackside objects, even splines.

A good tip is to lock the route layer(s). This will help prevent accidental editing of the route layers.

Pay particular attention to layers if you use the 'quicklaunch' feature to launch Driver direct from Surveyor and return to Surveyor afterwards. The layer you had selected before probably won't still be selected afterwards, so you'll need to check it every time you return from Driver.

=='Base session' assets==

Some routes come with a 'base session'. This generally has pre-configured settings for industries and other scripted assets in it. You may find, should your chosen map depend heavily on multiple industry assets or other similar scripted content, that you may need to base your session on a 'base session' asset, rather than creating a new session.

In this case, the default rules list may differ - as it may have been created in a different version of Trainz, or the route creator may have decided to change a few things. Feel free to add any missing rules you want, or remove extras you don't.

==Default rules==

In the 'Edit Session' dialog in TS2010, we have six rules by default.
* '[[Startup Options Rule]]' allows us to specify the control mode for the session, the weather, the start time, and a few other bits'n'pieces.
* '[[Driver Setup Rule]]' allows us to assign drivers to trains, and optionally give those drivers AI orders.
* '[[Driver Commands Rule]]' allows us to specify what orders can be assigned to AI drivers in the session.
* '[[Clean up Derailed Trains Rule]]' will mop up derailed vehicles.
* '[[ConsistDataHandler Rule]]' is used by QuickDrive
* '[[QuickDrive Rule]]' provides the quick drive interface that allows you to create consists and so on in Driver.

TS12 and Trainz Simulator Mac does not have 'Startup Options' - 'QuickDrive' now performs that role.

As a general rule, for a pre-planned interactive session, you probably don't want to permit the human driver to issue AI orders, or to be able to use the features of QuickDrive.

However, you probably want to be able to issue AI orders to background AI traffic while making the session, and you'll certainly need to fix those orders later when it turns out they don't quite do what you wanted them to. If you turn them off now, you'll have to turn them back on again when doing these operations - so my advice would be to only turn them off (by unticking them all) in 'Driver Commands' at the end of the creation process, once the session is finished. It'll get too annoying to keep turning them on and off when you need to fix problems with the background AI otherwise.

With TS2010, QuickDrive will unfortunately have to be removed from the rules list. It'd be way too easy for people to cheat using it.

With TS12 and Trainz Mac, it is possible to disable the advanced features of quickdrive, but still use it's better Cab/DCC mode selection screen - simply tick the 'Gameplay Session' checkbox in the QuickDrive options. This will deny the player access to the parts of QuickDrive which would cause problems in an interactive session.

== Categories ==

[[Category:TBD]]
[[Category:How-to guides]]
{{FUN-bot}}

"mesh-table" container (interior version)

2014-01-20T04:58:52Z

Jamesmoody:

The "mesh-table" container is a top-level [[config.txt file]] entry used by various [[Content_Configuration#Content_Types|Content Types]]. Refer to the [["mesh-table" Container]] documentation for the standard tags - this document only describes the extensions available within the mesh table when it is used in a [[KIND_Interior|cab interior]] asset.

Most of the entries in a mesh-table for an interior will be cab controls. A cab control has a single value associated with it, which could be an input (e.g. a lever position) or an output (a dial or gauge position).

=Standard Mesh Names=

There are a number of standard mesh names that the trainz default cab script uses for it's controls. For a Diesel or Electric cab (either unscripted, or scripted and inheriting from the DefaultLocomotiveCabin class), the following are the default mesh names:

* speedo_needle -- speedometer
* speedo_needle2 -- speedometer
* bplocomain_needle -- loco main reservoir pressure gauge
* bptrainbrakecylinder_needle -- locomotive brake cylinder pressure gauge
* bptrainbrakecylinder_needle2 -- locomotive brake cylinder pressure gauge
* no3pipe_needle -- brake pressure gauge (currently loco brake cylinder -- but maybe intended for something else?)
* bptrainbrakecylinder2_needle -- brake pressure gauge (source unknown)
* bptrainbrakepipe_needle -- train brake pipe pressure gauge
* bptrainbrakepipe_needle2 -- train brake pipe pressure gauge
* bploco_equaliser -- brake equaliser pressure gauge
* flow_needle -- brake flow rate gauge
* ampmeter_needle -- traction ammeter gauge
* ampmeter2_needle -- traction ammeter gauge
* throttle_lever -- throttle lever control
* reverser_lever -- reverser lever control
* trainbrake_lever -- self-lapping train brake control
* trainbrakelap_lever -- non self-lapping train brake control
* independantbrake_lever -- locomotive independent brake control. Note the typo in the control name.
* dynamicbrake_lever -- dynamic brake control
* wheelslip_light -- wheelslip indicator
* horn -- horn control
* light_switch -- light control
* pantograph_lever -- pantograph control
* throttle_brake_lever -- combined throttle/self-lapping brake lever

For a Steam cab (either unscripted, or scripted and inheriting from the DefaultSteamCabin class), these default mesh names are available:

* speedo_needle -- speedometer
* bplocomain_needle -- loco main reservoir pressure gauge
* bptrainbrakecylinder_needle -- locomotive brake cylinder pressure gauge
* no3pipe_needle -- brake pressure gauge (currently loco brake cylinder -- but maybe intended for something else?)
* bptrainbrakecylinder2_needle -- brake pressure gauge (source unknown)
* bptrainbrakepipe_needle -- train brake pipe pressure gauge
* bploco_equaliser -- brake equaliser pressure gauge
* flow_needle -- brake flow rate gauge
* trainbrake_lever -- self-lapping train brake control
* trainbrakelap_lever -- non self-lapping train brake control
* independantbrake_lever -- locomotive independent brake control. Note the typo in the control name.
* horn -- horn control
* light_switch -- light control
* waterglass_left -- boiler water level
* waterglass_right -- boiler water level
* firebox -- the interior of the firebox (to show fire temperature)
* boiler_needle -- boiler pressure
* boiler_needle1 -- boiler pressure
* steam_chest_needle -- steam chest pressure
* regulator -- regulator (throttle) control
* reverser -- cutoff (reverser) control
* water_injector_0 -- primary water injector control
* water_injector_1 -- secondary water injector control
* blower -- steam blower control
* fire_plates -- the firebox door
* sanding_lever -- locomotive sander control
* blowdown_lever -- blowdown control (releases water out of the boiler)

=Supported Tags=
Each mesh subcontainer supports the following tags. Each tag is shown here with its default value. Standard tags inherited from the normal mesh table are omitted for brevity.

tooltip-text ""
tooltip-token ""
limits 0,1
angles 0,0
kind ""
collision-parent ""
mousemode ""
mousespeed 1
notches
invert 0
notchheight
onlight ""
value 0.0
font "swiss"
fontsize 12
fontcolor 1.0,1.0,1.0

====tooltip-text====
:Type: String
:Desc: OBSOLETE: DO NOT USE. This text will be used in the tooltip that appears when the mouse cursor hovers over a cab control.

====tooltip-token====
:Type: String
:Desc: The name of a string table entry. The contents of the named string table entry will be displayed as a tooltip that appears when the mouse cursor hovers over a cab control.

====limits====
:Type: Decimal Pair
:Desc: Specifies the minimum and maximum values for a cab control or needle at it's two endpoints of movement. In the case of a speedometer, this would be the range of speeds it can display - 0m/s to 50m/s, for example.

====angles====
:Type: Decimal Pair
:Desc: Specifies the minimum and maximum extents of movement for a control or needle. For control types that rotate, these values are in radians[[http://en.wikipedia.org/wiki/Radian]]. In the case of a speedometer, this would define the amount of angular movement of the needle - a speedometer running from horizontal left to horizontal right may use -1.57 to 1.57, for example. If the cab control needs to move the other way, put the higher number first.

====kind====
:Type: Selection
:Desc: The type of control this mesh table element represents.
:Options are:
:* ''animated-lever''
:Operates like a standard lever, only uses a named animation instead of the angles tag for movement.
:* ''animated-dial''
:Operates like a standard needle, only uses a named animation to represent the gauge readout instead of the angles tag.
:* ''collision-proxy''
:This element type defines a volume within the cab where the mouse pointer will be considered to be over the cab control. Generally used in conjunction with an animated-lever. Name of the animated lever is defined in the tag ''collision-parent''.
:* ''digital-dial-spd''
:Digital readout for a speedometer, and using speed units.
:* ''digital-dial-prs''
:Digital readout for a pressure gauge, using pressure units.
:* ''firebox''
:The animated firebox in a steam locomotive.
:* ''lever''
:A standard lever, often used for throttle and brake controls. Requires the user to click hold and move the mouse to move the lever between it's notches. This control will stay at any notch position when let go.
:* ''light''
:A light glow / overlay - this mesh is hidden when the light is off and shown when the light is on.
:* ''needle''
:An analogue gauge needle. Can be used to implement many different types of gauges.
:* ''pulllever''
:Like a lever, only sprung to return to it's initial position when the user lets go of the control. Useful for horns.
:* ''pullrope''
:Like a pulllever, only with linear (not rotational) movement.
:* ''switch''
:This control requires only a single click to move between it's two endpoints. It is better suited than a lever to small switches and buttons.
:* ''button''
:Similar to switch but requires the mouse be held down to keep the control active. I.e., press and hold the mouse button to push the control down, release the mouse and the control will return to the off position.

====collision-parent====
:Type: String
:Desc: A mesh of kind collision-proxy must specify a collision-parent - the mesh it is a collision proxy for. This is the name of another control in the mesh-table.

====mousemode====
:Type: String
:Desc: If set to "exact", will require the mouse to be positioned over the geometry of the control precisely to activate it. Otherwise a bounding volume is used. This is useful for large controls which would otherwise block access to smaller controls.

====notches====
:Type: Decimal List
:Desc: Specifies the positions of the notches for this control. Notches are discrete positions within the movement of the control where the lever can be stopped. If a lever does not have notches, it can be positioned at any location. There are two common uses for notches. Firstly, they can be used to define a control which has a number of discrete positions which mean specific things (e.g. a brake valve). Secondly, they are used to define pre-set discrete values that a control can provide (e.g. a throttle lever). A typical US diesel 8 notch throttle would have something like "notches 0.0,0.125,0.25,0.375,0.5,0.625,0.75,0.875,1.0", specifying nine positions (for 'off' and notches 1 thru 8).

====invert====
:Type: Boolean
:Desc: Invert mouse movement for this control. If the control moves the wrong way compared to the mouse, change this setting.

====notchheight====
:Type: Integer List
:Desc: Specifies the importance of the notches for this control. This affects how the graphical overlay draws each notch. This is useful for a combined brake and throttle controller, or any other control where you want to mark a specific position relative to the others. This should have the same number of values as the 'notches' list.
:Three styles are available:
:* '1' configures this bar to be a standard length and width bar.
:* '2' configures this bar to be shorter in length, and is often used for intermediate positions.
:* '3' configures this bar to be standard length, but thicker in width. This is often used for marking a specific position.

====onlight====
:Type: String
:Desc: Specify the name of a ''light'' kind mesh which is enabled when this switch/lever is in the ''on'' position, and disabled when it is in the ''off'' position.

====value====
:Type: Decimal
:Desc: Specifies the initial value for this control. For a lever or other input device, this will specify the initial position of the control before the user moves it.

====font====
:Type: String
:Desc: Font name to use for the readout of a digital control.
:Options are:
:* ''swiss'' (Default option. Renders with arial in PC builds.)
:* ''times_new_roman''
:* ''verdana''
:* ''century_gothic''
:* ''cordia''
:* ''courier''
:* ''helvetica''
:* ''arial''
:* ''comic_sans''
:* ''sans_serif''
:* ''impact''
:* ''console''
:* ''tohoma'' (renders using the ''Tahoma'' font on PC builds.)
:* ''garamond''
:These roughly correspond with Windows font names. Beware - not all fonts are available on all platforms, and where a font is not available, a different font may be substituted.

====fontsize====
:Type: Decimal
:Desc: Font size for the readout of a digital control. Default is 12.

====fontcolor====
:Type: Decimal Triplet
:Desc: RGB font color for the readout of a digital control. Colors are specified within the range 0.0 to 1.0, with 0.0 being black and 1.0 being full intensity. Default is 1.0,1.0,1.0 - white.

=Cab Interior Mesh-Table Example=
The following is an example of a mesh-table which implements a number of cab controls

mesh-table
{
default
{
mesh "interior.im"
auto-create 1
}

wheelslip_light
{
kind "light"
mesh "wheelslip_light.im"
auto-create 0
}

bptrainbrakepipe_needle2
{
kind "digital-dial-prs"
mesh "brakeneedle.im"
att "a.brakepipe2"
limits 0,55
font "arial"
fontsize 0.007
fontcolor 80,240,120
auto-create 1
}

speedo_needle2
{
kind "digital-dial-spd"
mesh "brakeneedle.im"
att "a.digispeedo"
limits 0,55
font "arial"
fontsize 0.01
fontcolor 0,0,0
auto-create 1
}

throttle_lever
{
kind "lever"
mesh "throttle.im"
att "a.throttle"
limits 0,8
angles 0,1.69
notches 0,0.125,0.25,0.375,0.5,0.625,0.75,0.875,1
notchheight 1,2,2,2,2,2,2,2,1
radius 0.35
mousespeed -1
auto-create 1
}

dynamicbrake_lever
{
kind "lever"
mesh "dynamic_handle.im"
att "a.dynamic"
limits 0,2
angles 0,-1.69
notches 0,1
notchheight 0.1,1
mousespeed -1
radius 0.35
auto-create 1
}

trainbrakelap_lever
{
kind "lever"
auto-create 1
mesh "trainbrake_handle.im"
att "a.trainbrake_handle"
limits 0,4
angles 0,-2
notches 0,0.25,0.5,0.75,1
notchheight 2,2,2,2,2
mousespeed 1
}

independantbrake_lever
{
kind "lever"
mesh "indy_handle.im"
att "a.ind"
limits 0,32
angles 0.94,0
notches 0,0.5,1
notchheight 1,1,1
radius 0.35
mousespeed 1
auto-create 1
}

flow_needle
{
kind "needle"
mesh "flowneedle.im"
att "a.bpflow"
limits 0,1050
auto-create 1
}

bplocomain_needle
{
kind "needle"
mesh "brakeneedlered.im"
att "a.mainres"
limits 0,1240
auto-create 1
}

bploco_equaliser
{
kind "needle"
mesh "brakeneedle.im"
att "a.eqres"
limits 0,1240
auto-create 1
}

bptrainbrakecylinder_needle
{
kind "needle"
mesh "brakeneedlered.im"
att "a.brakecyl"
limits -50,1390
auto-create 1
}

bptrainbrakepipe_needle
{
kind "needle"
mesh "brakeneedle.im"
att "a.brakepipe"
limits 0,1240
auto-create 1
}

speedo_needle
{
kind "needle"
mesh "speedo_pointer.im"
att "a.speedo"
limits 0,43
auto-create 1
}

ampmeter_needle
{
kind "needle"
mesh "needleamps.im"
att "a.ampmeter"
limits 0,1700
angles 0,3.02058
auto-create 1
}

reverser_lever
{
kind "lever"
mesh "reverser_handle.im"
att "a.throttle01"
limits 0,2
angles -0.55,0.55
notches 0,0.5,1
notchheight 1,1,1
mousespeed -1
auto-create 1
}

light_switch
{
kind "lever"
att "a.hdlt"
mesh "hdltswtch.im"
limits 0,1
angles 0,2
notches 0,1
notchheight 0.1,0.1
mousespeed -1
auto-create 1
}

horn
{
kind "pulllever"
mesh "horn.im"
att "a.horn"
auto-create 1
angles 0,-0.55
limits 0,1
mousespeed -1
radius -0.02
notches 0,1
notchheight 0,0
}

pantograph_lever
{
kind "lever"
mesh "pantograph_lever.im"
att "a.pantograph_lever"
limits 0,3
angles 1.4,0
notches 0,0.5,0.75,1.0
notchheight 0,0,1,1
mousespeed -1
onlight "line_power"
}

line_power
{
kind "light"
mesh "line_power.im"
att "a.line_power"
}
}

[[Category:Config Container]]

"Category-region" tag

2013-12-10T07:44:10Z

Jamesmoody: Code for australia is 'au', Fail.

{{FUN-beg}}{{ORP-top}}
==About Category-region codes==
'''Category-region codes''' are a single ("UK") or multiple codes ("AU;DE;UK;US") in a quoted string that is included in the config.txt file for user defined filters.
* Assets with narrow single country scope would contain a single code after the tagname.
* Assets which were widely found in many regions (e.g. ''''Caterpillar D7 bulldozer'''', will list the series of country codes of the region.)
** The codes have only a minor importance in TRAINZ and are primarily used in Trainz as a sort and selection criteria in user defined filters.
** These codes do show up under the region column in [[Content Manager]] where they can be included in defining filters one can also use in [[Surveyor]]. This eliminates looking at undesired assets when focuses on developing your routes.
* For content that exists in multiple areas, when creating new assets, select appropriate codes in [[Content Creator Plus]] (CCP) or hand edit them into the config.txt ini files.
; For example: a locomotive that was available in the United States and Canada would be specified as follows:

category-region     "US;CA"
: One that was available in Australia, Canada, the United States and in the United Kingdom would be specified as follows:

category-region     "AU;CA;UK;US"

==Tables of codes==
<big>'''The category-region codes below are in alphabetical order by sort criteria.

Legal codes that are recognized by Trainz are as follows:'''</big>

===by region code order===

{|
|-
! AD-EE || EG-LI || LK-SC || SD-ZZ
|-valign="top"
|
# AD Andorra
# AE United Arab Emirates
# AF Afghanistan
# AG Antigua and Barbuda
# AI Anguilla
# AL Albania
# AM Armenia
# AN Netherland Antilles
# AO Angola
# AQ Antarctica
# AR Argentina
# AS American Samoa
# AT Austria
# AU Australia
# AW Aruba
# AZ Azerbaidjan
# BA Bosnia-Herzegovina
# BB Barbados
# BD Bangladesh
# BE Belgium
# BF Burkina Faso
# BG Bulgaria
# BH Bahrain
# BI Burundi
# BJ Benin
# BM Bermuda
# BN Brunei Darussalam
# BO Bolivia
# BR Brazil
# BS Bahamas
# BT Buthan
# BV Bouvet Island
# BW Botswana
# BY Belarus
# BZ Belize
# CA Canada
# CC Cocos (Keeling) Isl.
# CF Central African Rep.
# CG Congo
# CH Switzerland
# CI Ivory Coast
# CK Cook Islands
# CL Chile
# CM Cameroon
# CN China
# CO Colombia
# CR Costa Rica
# CS Czechoslovakia
# CU Cuba
# CV Christmas Island
# CY Cyprus
# CZ Czech Republic
# DE Germany
# DJ Djibouti
# DK Denmark
# DM Dominica
# DO Dominican Republic
# DZ Algeria
# EC Ecuador
# EE Estonia
|
# EG Egypt
# EH Western Sahara
# ES Spain
# ET Ethiopia
# FI Finland
# FJ Fiji
# FK Falkland Isl.(Malvinas)
# FM Micronesia
# FO Faroe Islands
# FR France
# GA Gabon
# GB Great Britain
# GD Grenada
# GE Georgia
# GH Ghana
# GI Gibraltar
# GL Greenland
# GP Guadeloupe (Fr.)
# GQ Equatorial Guinea
# GF Guyana (Fr.)
# GM Gambia
# GN Guinea
# GR Greece
# GT Guatemala
# GU Guam (US)
# GW Guinea Bissau
# GY Guyana
# HK Hong Kong
# HM Heard & McDonald Isl.
# HN Honduras
# HR Croatia
# HT Haiti
# HU Hungary
# ID Indonesia
# IE Ireland
# IL Israel
# IN India
# IO British Indian O. Terr.
# IQ Iraq
# IR Iran
# IS Iceland
# IT Italy
# JM Jamaica
# JO Jordan
# JP Japan
# KE Kenya
# KG Kirgistan Ex-USSR
# KH Cambodia
# KI Kiribati
# KM Comoros
# KN St.Kitts Nevis Anguilla
# KP Korea (North)
# KR Korea (South)
# KW Kuwait
# KY Cayman Islands
# KZ Kazachstan
# LA Laos
# LB Lebanon
# LC Saint Lucia
# LI Liechtenstein
|
# LK Sri Lanka
# LR Liberia
# LS Lesotho
# LT Lithuania
# LU Luxembourg
# LV Latvia
# LY Libya
# MA Morocco
# MC Monaco
# MD Moldavia Ex-USSR
# MG Madagascar
# MH Marshall Islands
# ML Mali
# MM Myanmar
# MN Mongolia
# MO Martinique (Fr.)
# MR Mauritania
# MS Montserrat
# MT Malta
# MU Mauritius
# MV Maldives
# MW Malawi
# MX Mexico
# MY Malaysia
# MZ Mozambique
# NA Namibia
# NC New Caledonia (Fr.)
# NE Niger
# NF Norfolk Island
# NG Nigeria
# NI Nicaragua
# NL Netherlands
# NO Norway
# NP Nepal
# NR Nauru
# NT Neutral Zone
# NU Niue
# NZ New Zealand
# OM Oman
# PA Panama
# PE Peru
# PF Polynesia (Fr.)
# PG Papua New Guinea
# PH Philippines
# PK Pakistan
# PL Poland
# PM St. Pierre & Miquelon
# PN Pitcairn
# PT Portugal
# PR Puerto Rico (US)
# PW Palau
# PY Paraguay
# QA Qatar
# RE Reunion (Fr.)
# RO Romania
# RU Russian Federation Ex-USSR
# RW Rwanda
# SA Saudi Arabia
# SB Solomon Islands
# SC Seychelles
|
# SD Sudan
# SE Sweden
# SG Singapore
# SH St. Helena
# SI Slovenia
# SJ Svalbard & Jan Mayen Is
# SK Slovak Republic
# SL Sierra Leone
# SM San Marino
# SN Senegal
# SO Somalia
# SR Suriname
# ST St. Tome and Principe
# SU Soviet Union
# SV El Salvador
# SY Syria
# SZ Swaziland
# TC Turks & Caicos Islands
# TD Chad
# TF French Southern Terr.
# TG Togo
# TH Thailand
# TJ Tadjikistan Ex-USSR
# TK Tokelau
# TL East Timor
# TM Turkmenistan Ex-USSR
# TN Tunisia
# TO Tonga
# TR Turkey
# TT Trinidad & Tobago
# TV Tuvalu
# TW Taiwan
# TZ Tanzania
# UA Ukraine
# UG Uganda
# UK United Kingdom
# UM US Minor outlying Isl.
# US United States
# UY Uruguay
# UZ Uzbekistan Ex-USSR
# VA Vatican City State
# VC St.Vincent & Grenadines
# VE Venezuela
# VG Virgin Islands (British)
# VI Virgin Islands (US)
# VN Vietnam
# VU Vanuatu
# WF Wallis & Futuna Islands
# WS Samoa
# YE Yemen
# YU Yugoslavia
# ZA South Africa
# ZM Zambia
# ZR Zaire
# ZW Zimbabwe
|}

===by country name order===

{|
|''' Aa—Ear || Eas— Ecu || Les—Lib || San—Sau'''
|- valign="top"
|
# Afghanistan AF
# Albania AL
# Algeria DZ
# American Samoa AS
# Andorra AD
# Angola AO
# Anguilla AI
# Antarctica AQ
# Antigua and Barbuda AG
# Argentina AR
# Armenia AM
# Aruba AW
# Australia AU
# Austria AT
# Azerbaidjan AZ
# Bahamas BS
# Bahrain BH
# Bangladesh BD
# Barbados BB
# Belarus BY
# Belgium BE
# Belize BZ
# Benin BJ
# Bermuda BM
# Bolivia BO
# Bosnia-Herzegovina BA
# Botswana BW
# Bouvet Island BV
# Brazil BR
# British Indian O. Terr. IO
# Brunei Darussalam BN
# Bulgaria BG
# Burkina Faso BF
# Burundi BI
# Buthan BT
# Cambodia KH
# Cameroon CM
# Canada CA
# Cayman Islands KY
# Central African Rep. CF
# Chad TD
# Chile CL
# China CN
# Christmas Island CV
# Cocos (Keeling) Is CC
# Colombia CO
# Comoros KM
# Congo CG
# Cook Islands CK
# Costa Rica CR
# Croatia HR
# Cuba CU
# Cyprus CY
# Czech Republic CZ
# Czechoslovakia CS
# Denmark DK
# Djibouti DJ
# Dominica DM
# Dominican Republic DO
# East Timor TL
|
# Ecuador EC
# Egypt EG
# El Salvador SV
# Equatorial Guinea GQ
# Estonia EE
# Ethiopia ET
# Falkland Isl.(Malvinas) FK
# Faroe Islands FO
# Fiji FJ
# Finland FI
# France FR
# French Southern Terr. TF
# Gabon GA
# Gambia GM
# Georgia GE
# Germany DE
# Ghana GH
# Gibraltar GI
# Great Britain GB
# Greece GR
# Greenland GL
# Grenada GD
# Guadeloupe (Fr.) GP
# Guam (US) GU
# Guatemala GT
# Guinea GN
# Guinea Bissau GW
# Guyana GY
# Guyana (Fr.) GF
# Haiti HT
# Heard & McDonald Isl. HM
# Honduras HN
# Hong Kong HK
# Hungary HU
# Iceland IS
# India IN
# Indonesia ID
# Iran IR
# Iraq IQ
# Ireland IE
# Israel IL
# Italy IT
# Ivory Coast CI
# Jamaica JM
# Japan JP
# Jordan JO
# Kazachstan KZ
# Kenya KE
# Kirgistan Ex-USSR KG
# Kiribati KI
# Korea (North) KP
# Korea (South) KR
# Kuwait KW
# Laos LA
# Latvia LV
# Lebanon LB
# Lesotho LS
|
# Liberia LR
# Libya LY
# Liechtenstein LI
# Lithuania LT
# Luxembourg LU
# Madagascar MG
# Malawi MW
# Malaysia MY
# Maldives MV
# Mali ML
# Malta MT
# Marshall Islands MH
# Martinique (Fr.) MO
# Mauritania MR
# Mauritius MU
# Mexico MX
# Micronesia FM
# Moldavia Ex-USSR MD
# Monaco MC
# Mongolia MN
# Montserrat MS
# Morocco MA
# Mozambique MZ
# Myanmar MM
# Namibia NA
# Nauru NR
# Nepal NP
# Netherland Antilles AN
# Netherlands NL
# Neutral Zone NT
# New Caledonia (Fr.) NC
# New Zealand NZ
# Nicaragua NI
# Niger NE
# Nigeria NG
# Niue NU
# Norfolk Island NF
# Norway NO
# Oman OM
# Pakistan PK
# Palau PW
# Panama PA
# Papua New Guinea PG
# Paraguay PY
# Peru PE
# Philippines PH
# Pitcairn PN
# Poland PL
# Polynesia (Fr.) PF
# Portugal PT
# Puerto Rico (US) PR
# Qatar QA
# Reunion (Fr.) RE
# Romania RO
# Russian Federation Ex-USSR RU
# Rwanda RW
# Saint Lucia LC
# Samoa WS
# San Marino SM
|
# Saudi Arabia SA
# Senegal SN
# Seychelles SC
# Sierra Leone SL
# Singapore SG
# Slovak Republic SK
# Slovenia SI
# Solomon Islands SB
# Somalia SO
# South Africa ZA
# Soviet Union SU
# Spain ES
# Sri Lanka LK
# St. Helena SH
# St. Pierre & Miquelon PM
# St. Tome and Principe ST
# St.Kitts Nevis Anguilla KN
# St.Vincent & Grenadines VC
# Sudan SD
# Suriname SR
# Svalbard & Jan Mayen Is SJ
# Swaziland SZ
# Sweden SE
# Switzerland CH
# Syria SY
# Tadjikistan Ex-USSR TJ
# Taiwan TW
# Tanzania TZ
# Thailand TH
# Togo TG
# Tokelau TK
# Tonga TO
# Trinidad & Tobago TT
# Tunisia TN
# Turkey TR
# Turkmenistan Ex-USSR TM
# Turks & Caicos Islands TC
# Tuvalu TV
# Uganda UG
# Ukraine UA
# United Arab Emirates AE
# United Kingdom UK
# United States US
# Uruguay UY
# US Minor outlying Isl. UM
# Uzbekistan Ex-USSR UZ
# Vanuatu VU
# Vatican City State VA
# Venezuela VE
# Vietnam VN
# Virgin Islands (British) VG
# Virgin Islands (US) VI
# Wallis & Futuna Islands WF
# Western Sahara EH
# Yemen YE
# Yugoslavia YU
# Zaire ZR
# Zambia ZM
# Zimbabwe ZW
|}


==Notes==
==Categories==
[[Category:Config Tag|Category-region]]
{{ORP-bot|Category-region}}<div>{{FUN-bot|Category-region}}

Help:Trainz Content (Content Manager)

2013-12-10T07:41:23Z

Jamesmoody: Reverted edits by Fabartus (talk) to last revision by Vvmm

= Introduction =
Content Manager has a number of functions rolled into one integrated package giving you control and access to the hundreds of thousands of assets available for Trainz. The main functions that Content Manager offers are:

* Download Station Index
* Downloading Content
* Content Management
* Archiving/Backup
* Uploading Content
* Creating/Editing/Verifying Content

The following pages provide detail on using the Content Manager interface.

= Getting Started =
* [[Help:Content Manager:Menus]]
* [[Help:Content Manager:Bars]]
* [[Help:Content Manager:Main View Panel]]
* [[Help:Content Manager:Action Panels]]
* [[Help:Content Manager:Icons]]
* [[Help:Content Manager:Settings]]
* [[Help:Content Manager:First Class Ticket]]

= Sorting, Searching and Organizing Content =
* [[Help:Content Manager:Sorting]]
* [[Help:Content Manager:Searching]]
* [[Help:Content Manager:Default Search Filters]]
* [[Help:Content Manager:Adding a Search Parameter]]
* [[Help:Content Manager:Removing a Search Parameter]]
* [[Help:Content Manager:Current Search and Saving Search Filters]]
* [[Help:Content Manager:Keywords]]
* [[Help:Content Manager:Disabling, Enabling and Deleting Assets]]

= The Download Station and Downloading =
* [[Help:Content Manager:Selecting Assets to Download]]
* [[Help:Content Manager:A word about dependencies]]
* [[Help:Content Manager:Managing your Download Helper List]]
* [[Help:Content Manager:Starting and Stopping a Download]]

= Importing Content and CDPs =
* [[Help:Content Manager:Importing Content]]
* [[Help:Content Manager:Importing CDPs]]

= Exporting Content and CDPs =
* [[Help:Content Manager:Exporting Content]]
* [[Help:Content Manager:Exporting CDPs]]

= Archiving =
* [[Help:Content Manager:Creating Archives]]
* [[Help:Content Manager:Installing Assets from Archives]]

= Creating and Editing Content =
* [[Help:Content Manager:Creating Content]]
* [[Help:Content Manager:Editing Content]]
* [[Help:Content Manager:Reverting Content]]

= Uploading =
* [[Help:Content Manager:Uploading]]

[[Category:Help|Content Manager]]

Content Manager

2013-12-10T07:37:35Z

Jamesmoody: Reverted edits by Fabartus (talk) to last revision by Windwalkr

{{FUN-beg}}{{FUN-BOT}}{{ORP-top}}
==Content Manager==
'''Content Manager''' (abbreviated as '''CM''') is the included content management {{wp|Graphical user interface|GUI}} utility for managing assets, uploading and downloading content from the [[Download Station]], and for exporting and importing [[cdp file]]s for archiving or sharing. It has been part of Trainz releases since the debut of [[TRS2006]] (then called Content Manager Plus and '''CMP''') in the fall of 2005, and was the major improvement made to the four service packs that evolved [[TRS2004]]'s advances replacing several separate .exe file modules with a single common user interface to manipulate and manage assets and content. CM includes the ability to archive assets, disable them so they would not appear in Surveyor asset selection APIs and a filter definition and selection system which allowed the Trainz user to fine tune the selections presented in the menuing of the Surveyor module tools APIs.

==Functionality==

Content Manager is intended to address the following functions:
* Install and remove custom content.
* Archive custom content.
* Search both local and DLS content.
* Download DLS content.
* Create and edit custom content.
* Provide a platform for executing [[Content Manager Tools]].

==Ideology==

Content Manager is designed to allow content creators to produce new content, and to allow end-users to download with a minimal of hassle. It is tightly integrated with the Download Station (DLS) to allow content to be uploaded and downloaded in a reliable fashion.

Content Manager is specifically not intended for users to perform regular editing of content created by others; this behavior is considered fairly counter-productive for the following reasons:
* It is expected that DLS content will be available in a working format, and that Content Manager will transfer the content to the local machine in a working format.
** This is historically inaccurate, please see the [[Download Station Cleanup]] page. It was found that many legacy content items, had typos, misspellings, and formatting errors of one sort or another that were further linked to Trainz run-time crashes.
* Trainz software was revised to trap and expose these errors.
* It is required that local content maintains parity with the original DLS content, such that dependencies and updates continue to work appropriately.
** By editing DLS content locally, the user is establishing that they will take responsibility for maintaining not only the edited asset, but potentially all assets which share some kind of dependency on the edited asset.
* When a user downloads or purchases a new item of content, they have a reasonable expectation that it will work "out of the box".
** This expectation is in direct conflict with the user performing significant edits to other content.
There are some obvious cases where edits are harmless, and CMP attempts to allow for the most useful of these- such as renaming or hiding an asset.

==Ramifications-asset validation==
It is expected that the Trainz environment will be optimised and extended with each new version release. To allow existing custom content to work with newer versions of Trainz, N3V has adopted an "installation" process for custom content, in favor of the original "drop it in a folder" process. During this process, the Trainz environment performs the following steps:
* Validates that the content will work with the current Trainz installation.
* Precaches various metrics from the content that Trainz requires at runtime such that the entire item of content does not need to be loaded at game startup (as was the case in the earliest Trainz versions.)
* Upgrades files within the content to the latest file formats, such that the upgrade process does need to not occur during loading.
* Converts some files from human-readable form to a machine-optimized format.
* Moves the raw content files to storage within the Trainz Asset Database.
* Notifies running Trainz executables of any changes.

==Changes since TRS2004==
Users are no longer provided with direct access to installed custom content, for the following reasons, but such assets may be cloned under a user kuid code:
* Installed content may be stored in a custom internal format, rather than in the public distribution format.
* Edits made to files which have supposedly been pre-processed will result in runtime errors where the cached data no longer matches the actual content on disk.

Since direct access is not possible, Content Manager provides a mechanism for users to 'check out' items for editing, and to check them in again after the edits are complete. (Open for Edit, asset validation, and Committing the asset) The normal installation steps are performed during the check-in process allowing Trainz to use the updated content safely. Trainz will issue a query and warning when installed content has been modified, or as has sometimes happened, imported from an older version of Trainz, then the separate asset (now part of the new release) might be in the situation of overwriting an updated validated version.
{{ORP-bot}}

Template:FUN-beg

2013-12-10T07:33:31Z

Jamesmoody: Reverted edits by Fabartus (talk) to last revision by Windwalkr

"mesh-table" container

2013-11-22T03:49:56Z

Jamesmoody:

{{ORP-top}}
==KIND Heirarchy==
The "mesh-table" container is a top-level [[config.txt file]] entry used by various [[Content_Configuration#Content_Types|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_Configuration#Content_Types|Content Types]] support the full range of tags listed below. 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.

==Known Dependent Parent Types==
:''Main article, see: [[KIND Mesh]]''
The Content Types listed here use the mesh-table container as part of their definition.

* [[KIND Industry]]
* [[KIND MOJunction]]
* [[KIND Pantograph]]
* [[KIND Scenery]]
* [[KIND Track]]
* [[KIND Traincar]]

The following config containers also reference back to their Asset's mesh-table container in some fashion:
* [["junction-vertices" container]]
* [["track-lod-tree" container]]

'''See also'''{{bullR}} [[Modeling Guidelines]] {{bull}} [[Modeling Scenery]]
==Mesh subcontainer==
Each mesh subcontainer supports the following tags. Each tag is shown here with its default value. {{FAB-todo| Use Pseudo-table to recast as a real wikitable.}}

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
should-respond-to-clicks 1
animation-loop-speed 0
critical-animation 1
effects {
}
night-mesh-base ""

<big>*</big> The att-parent defaults to "default" which is the parent mesh. The att-parent tag can include a path.

==Supported Tags==
Each mesh subcontainer supports the following tags.

===mesh-asset===
Allows assets to be used as 'mesh libraries', the following container specifies that the mesh required (and its optional animation) is located relative to ''''''the root folder'''''' of <kuid:1234:5678>. CMP does not auto-check for the existence of these'' 'externally referenced files' ''when processing so you must ensure that they are present in the referenced kuid before using this tag. Subfolder paths within the asset can be used; folder names should be prefixed to the path with a forward slash ("/") separator in the usual fashion.

===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===
opacity x (float 0.0 - 1.0 default 1.0)

Specifies the overall transparency of a mesh. Values other than 0.0 or 1.0 employ alpha blending and a value of 0.0 has the same effect as hiding the mesh.

Note that this tag is buggy in TS2009 prior to SP4.

===mesh-scale===
This tag defines a minimum and maximum scaling value for the mesh, where 1.0 is the size as modelled. Each instance of the mesh that exists in the world will randomise within this range. Randomisation will not change between runs or between Trainz editions, but may change based on factors such as the position of the mesh in the world. This tag is currently only supported on SpeedTree assets; attempts to use this tag on other assets results in undefined behaviour.

===position===
position X,Y,Z (in metres, default 0,0,0)

Specifies the location of a mesh relative to its insertion point.

===orientation===
orientation X,Y,Z (radians default 0,0,0)

Allows a submesh to be rotated relative to its insertion point. To reverse a mesh by 180 degrees about the Z axis, add the tag:

orientation 0,0,3.14159

===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.

===should-respond-to-clicks===
Bool, optional, default True (1). If set to false (0) on a mesh that is part of an asset it will remove that mesh from the calculation of the 'bounding box' that will be used to check whether the user clicked on that particular asset. This is useful for light ray effects or animations which are significantly outside the normal bounding volume, and may cause movement to focus on the wrong asset. For instance, a traincar may need a mesh marked with should-respond-to-clicks set to false in order to ensure that the click is detected for the correct traincar when it is part of a consist. First introduced with TS12 SP1 HF4 (build 61388). Default value (True) is the prior behavior (the mesh ''will'' be considered part of the bounding box for the purpose of registering clicks).

===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===
If set (which it is by default), this tag causes the non-stitched mesh to be linked into the Trainz lighting model. This causes the mesh to respond to directional lighting changes, such as the angle of the sun or train headlights. This is also necessary for normal maps to work correctly. Zeroing this tag will remove the mesh from the Trainz lighting model. Generally speaking, you should never zero this tag- almost every effect that can be achieved through this approach can be better served by using an appropriate normal map or appropriate geometry detail.

This tag has no effect on stitched meshes, which are always affected by the Trainz lighting. Since the content creator has no direct influence over which meshes are subject to [[Mesh Stitching]], and all indirect influences are subject to change between Trainz editions, it is strongly recommended that this tag is avoided to ensure that results are consistent.

===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|mesh-table container]]
{{ORP-bot|mesh-table container}}

User talk:Jamesmoody

2013-11-22T03:36:02Z

Jamesmoody: /* Speak and write English to the audience! */

Please do not leave comments here. I am unlikely to spot them.

If you need to contact me, please send me an email. If you do not have my address, send a forum Private Message.

Note: Do not contact me directly for technical support. Technical support requests should be sent to the Helpdesk.

== See {{wp|Wikipedia:Etiquette}} ==

:: Please note that this isn't wikipedia. We might use the same software, but don't assume that their rules and conventions apply here. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)
:: In particular note that we are not "NPOV". Documents on this wiki should reflect N3V Games point of view. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:39, 21 August 2013 (EST)

* Sorry we seem to have a different definition of profanity and the appropriate. S***ty is a rather apt term when things don't work right. For example, I'll address wiki business on the wiki, and expect the same—wiki's are about collaborative efforts, it's fairly plain something you guys have done failed in that respect... things never took off. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
:: No, we don't have a different definition of profanity. You may see it as acceptable to use such words, but we don't. This includes "bleeping" words out; you're obviously aware of the words you're using, so just don't use them. If you feel the need to use such words, go outside and take a break instead of replying. Keep it up and you'll be banned. It's that simple. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)
::
:: Also, we used a wiki initially because it was easy for us to edit - I can come back and add a page whenever I have new information to publish. If we get some community assistance, that's great - but it really is a secondary consideration. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]])

: I think it embarrassing that a wiki started so long ago is in such a P*** Poor state, it wasn't even initialized with Public Domain standard help pages, and even ParserFunctions (which I badly need, I couldn't even begin to write [[Template:N3V-Help-Image]] and [[Template:Help-Image]] a while ago as I can't test conditions, files, parameters, so have a Sh***th temporary placeholder workaround... NOT HAPPY FACE MAKING! {{Tl|Tlx}} is not yet useable, which is pretty much needed for any smart template exposition and help... all that TAKES UP AND WASTES my freely donated TIME... So stop that!). // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
:: We're not trying to be wikipedia. We welcome collaboration, but this is NOT a community-owned site. This is a corporate site, with corporate goals. Where our goals align with your goals, that's great. If your goals work against our goals, then our goals take precedence. That may be a harsh way to put it, but I don't want you to misunderstand the reality of the situation here. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)

: Think Chris is or has gotten the picture that I only mean well, and if I wanted to be confrontational, I could really roast the company on the forum, and the Wikibook. I'm only trying to make you all look better, but ''that certainly means changing the status quo''. For starters, if someone comes out with a browser that requires HTML 5, the whole site is non-compliant. There's no Common.css and Common.js files in place. No classes to call, only HTML 4, which have been obsolescent now for what, five or six years?
: Coming in this spring after years of casual browsing to see in detail how little Trainz has progressed, how few changes and how dead this wiki is (Hasn't really progressed much since I first saw it back in late 2009, iirc) has been an eye opener. Not sure what you guys actually do, but I guess you can be proud you don't use coarse language. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
:: Thankfully, all common browsers work fine on our site, so it's not something that we're remotely concerned about at the current time. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)

On the other commentary/responses... [[Talk:TADDaemon]], I have to parse what you changed to understand all your answers. Wikiquette when interleaving is to indent in between 'voices' (responses). Numerous people can then address a paragraph's point... or just the two. Taking things out of order to change the original text makes it rather difficult to see the conversational flow. Breaking the context seems to be a bad thought habit in N4V group think. Sign each para/post with four tildes, that adds a date stamp and your sig, which you can customize under preferences. (See mine)
:: You're quite correct, but nobody here really cares. We don't see the wiki as a workable chat tool. The software is not built with that in mind, and while some conventions have developed on other wikis to make it work "as best possible" we have better tools at our disposal and thus have minimal interest in learning the hacks that people have come up with for dealing with communication in a wiki. James has already suggested you use our forums. If you choose to use a backwards chat process such as this rather than the better tools which we have available, then don't complain when it's hard to use. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)
::: I have gone back and fixed that chat page (with indenting and tildes). Please note though that what you posted is still purely a personal rant, and is still not welcome on a corporate site. You may wish to edit it... [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)

I have to reconstruct the original text to make sense of your rebuttal. Again... a time investment for me. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
: ... and a time investment for me to learn a new way of formatting text when writing using a tool for what appears to be /obviously/ the wrong purpose, and also by someone elses fairly arbitrary rules. And when I could have been working on something productive instead.

Regardless, as Chris understands, I'm here to help, and TADDaemon with all it's time wasting is [http://forums.auran.com/trainz/showthread.php?102671-Insight-into-periodic-pauses-in-Surveyor&p=1192261#post1192261 NOT something which is working well or properly] in the real user world. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
: I'm a real world Trainz user too. My first version of Trainz was 1.1.1. I became a betatester for UTC, a content creator for TRS2004, and joined Auran around the time of TC3. I see TADDaemon as an immense improvement over the problems we had previously - particularly from a content creator workflow. As an end user, I /vehemently disagree/ with your apparent viewpoint that TADDaemon is the spawn of satan and should be killed with fire, and that doing so would fix all problems ever. It saves me countless hours waiting for Trainz or CM to start up. I can run multiple CM windows in parallel, and even Trainz at the same time as well, none of which was even remotely practical before TADDaemon. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)

I'm like Chris there, what counts is what I see, the trouble for you guys is we have thousands of times the number of eyes, time on the job and places where we're seeing insufficient progress, or worse, a [http://forums.auran.com/trainz/showthread.php?102671-Insight-into-periodic-pauses-in-Surveyor&p=1192261#post1192261 lack of attention or acknowledgement] that there are serious issues. I know of three long time content creators, people with hundreds of DLS assets created between them that won't use [[TS2009 SP3]] and beyond because of all the time TADDaemon wastes reconnecting when it should be connected (assuming it's needed at all), why it's active at all when we're in surveyor is a mystery. Makes no sense. You go with the local data base, no one is upgrading or downloading from in surveyor. [http://commons.wikimedia.org/wiki/File:Collected-Trianz-Releases-2013-0727,about_half_the_EnglishLang_Releases.jpg As you can see], I've got a few Trainz versions to choose from, and TS12 is not one anyone should be happy with as an operator given all it's pauses and time wastes. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
: TADDaemon *is* the local database. It existed in pretty much the same form before we split it into it's own process, and we did that because:
: * A Trainz crash used to reliably require a DB repair afterwards. Trainz would do it during the loading process. Just a black screen, no progress report. User reports at the time often suggested that Trainz needed a reinstall after crashing because it was "broken". I personally experienced this in TRS2006.
: * Multiple processes can use the database at once - e.g. CM and Trainz in parallel, multiple CM windows, etc.
: * It frees up process space for Trainz to use for other things. Just "maintaining the database listings" was starting to be a significant drain on process space for people with large installs.
: * People *can* and *do* download within the game - the content updates menu, when getting DLC packs, and when joining multiplayer sessions, to name the obvious ones.
:
: To address some other points: TADDaemon is continually necessary because it provides asset listings. When you use the tabs in surveyor, or the filter dialog, or in fact /anything that asks for a list of assets/ (which is way more common than you think as asset scripts can do it), TADDaemon is what gives you that list back. And Trainz can use the process space (i.e. RAM) freed up by using TADDaemon for other things. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)

So sorry if you're offended by my casual choice in language, but do credit that we are from different societies. That language doesn't raise anyone's eyebrows over here. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
: That kind of language doesn't raise eyebrows in "general society" here either - particularly the more, ummm, bogan parts of society. But it does a lot more than raise eyebrows in some of our critical markets, so we obviously don't want it easily visible in our end user documentation. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)

But do get used to having other computer professionals taking a serious look at your work, for as far as I'm concerned if I did my job as you guys have seemed to have done yours, the F-22 Raptor would crash every 99th flight, the Patriot missile would turn around and blast it's launcher or control vans, Laser eye surgery would burn through into peoples' cornea, and the Trident missile wouldn't ever threaten to launch from Ohio class submarines... so you'd likely be forcibly learning Chinese or Russian there down under. Those are only a fraction of the complex things I've been part of in my career, and when something runs worse than the version three releases before, something smells.

BTW, Given the ridiculously annoying wait for Parserfunctions, interwikis and so forth, I'm perfectly happy to wait for a talk response here. If you turn on email notification (since you are a site bureaucrat, that's in your toolkit) you can then see when pages change without using a watchlist tab.

The N3V staff admin seems to have trouble changing a boolean value when given a link to the how-to, don't you know. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
:: You're making the assumption that he's remotely interested in taking advice on configuration from someone outside the company. Again, we work to our goals, not yours. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)

Perhaps you can help him appear competent in that little thing. Like much of N3V's visible output, it's leaving a bad taste at the moment. Chris wants me to put up new user pages, in the Help namespace, but I'm not about to start that without further cleanup and having things straight first. I've already tagged too much using {{tl|FAB-todo}}, and for [http://online.ts2009.com/mediaWiki/index.php/Special:WhatLinksHere/Template:FAB-todo every page there], there are three that don't have an overt tag that are dependent upon ParserFunctions.

Best regards // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)

== Small words and big pictures ==

If you can use some small words and big pictures to explain to me why N3V wouldn't want the power of parserfunctions I'd really appreciate it. Having one template do ten things is much preferable than ten doing ten when the same branching and testing logic that allows that, can allow things like having pop-open collapsed elements like the table {{Tl|TBS}}. I'd like to make that and other such table structures where it makes sense so people can expand them or not as it suits them, allowing them to see a big picture in the context. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 14:22, 12 October 2013 (EST)

: It's not that N3V wouldn't want ParserFunctions. It's that someone at N3V wouldn't want to stop what else they are doing long enough to look into it, decide if it's a sensible request, act on it, and test what breaks afterwards. And more to the point, explain what they were doing for the past 'N' hours to their boss, when there's something else more urgent they should have been working on. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 17:55, 14 October 2013 (EST)

== Please verify conclusion ==

Please verify the tag region is obsolescent as I inferred from config.txt entries whilst fixing errors. I made an appropriate [http://online.ts2009.com/mediaWiki/index.php/Index_of_Tags_%26_Containers#qu-rz annotation here] which should be verified. Thanks // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 12:18, 13 October 2013 (EST)

: The "region" tag is obsolete, and hasn't been used for many years. It's been replaced by "category-region" which has a well-defined format. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 17:55, 14 October 2013 (EST)

== Speak and write English to the audience! ==

re: [http://online.ts2009.com/mediaWiki/index.php?title=KIND_TrainzBaseSpec&diff=5701&oldid=5682 this edit], YOU may understand what the three or four of you may mean by Classes, but what percent of your users have the first clue? AND BTW... what root? Who understands what you mean by that outside of your cubicle area.

: You wrote that the parent class of "TrainzBaseSpec" is "config files". What the .... does that mean. "Config files" isn't a class! It can't be parent to anything. It makes /no sense/ whatsoever. Worse still, you've mis-used and abused so many technical terms with defined meanings so quickly in such a short sentence - that to anyone at the level to get the most out of this document, they'll assume it was written by an imbecile who has no knowledge of what they are talking about, and will assume that the entire contents are wrong. And go looking elsewhere for "better" information.
: As to "kinds being classes" -- kinds are closely related to classes, but they don't sit quite right as classes. Example: scenery and scenery-trackside, both exposed under the same 'kind', but both different classes. It's another tag that actually makes the distinction between the two. That's why we list the kind for each class. Is this thing here a class? Yes, it certainly is. It exists in the class structure quite clearly. It isn't a kind though, and I will admit that you can't make a 'trainzbasespec' asset by itself.
: As to 'root' - if people don't understand the root of a tree being the base, the starting point that every leaf is eventually connected back to via branches and trunks -- then I really don't know what to say. The point here is that whatever is said has to be /accurate/. You can't say "I edited this to make it more understandable" and leave it /wrong/. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

From the standpoint of the customers you guys are most anxious to seduce, land, and hook--the younger crowd who will indubitably be trying to make sense of this unfinished collection of documents (2500+ routes on the DLS are a big big attraction! And that means error fixing, and so you have a big big 250,000 asset problem as even Hilliam knows--and have wasted five years it might have been resolved), to those new customers, and to the old technically challenged... '''the ROOT to them ''in the heat of the moment of frustration at having to figure out what another friggin' error is''... is the fact each asset has a config text file''' which need certain items.

My presentation may not have been the best, but ''" Each of the TrainzBaseSpec file elements can be specified in any asset that has a defining [[Config.txt file]]."'' conveys the relationships far clearer than a school-boy abstraction of Classes.

: That information may be useful and important, but it clearly and obviously doesn't belong under the header of 'Parent class'. It tells me NOTHING about what the parent class is, nor relates to it in any way, shape or form.
: In fact, it should be so elsewhere, it's probably best placed in an "introduction to config files" type page - and not here /at all/. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

That certain of those elements in the spec are mandatory is enforced by error checking. It's addressed in any case, iirc. Similarly Parent and Child classes just muddle the understanding of the users. In point of fact, the config.txt files for a KIND require those common items to be defined, set the threshold level for warnings and errors and define how the text INI file is processed and considered... without a config file to hold it, all those tag labels in the TrainzBaseSpec have no substance, they are merely conjectural, ideas. Recording them in a config.txt file puts them in context.

: wut? Now you are confusing /me/. That's such a muddle of misused terms I'm not even sure what you mean. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

KINDs are your true classes

: No they aren't. Classes are our true classes. Most of them are also kinds, but there are classes that don't have a kind, and also others which share a 'kind'. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

the TrainzBaseSpec is just a collection of common elements defined within each, or sometimes not.

: Nope, it's the root of a literal programming class structure. It exists as a class in code and in validation. That class is inherited by other classes which do map onto kinds. You might consider it a virtual class from the end user perspective, as they can't define one directly. But that doesn't /stop it being a class/. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

The software system uses them to bootstrap the asset, in effect. Since they define all asset types in your software, calling such a disparate changeable set of data definitions a class, means your true classes are meaningless. I have a bit of trouble wrapping my head around such a reversal of cause and effect. Put another way, The trainzBaseSpec is a mix of things which must be defined and others which may optionally be defined (user ID, description, licenses, email, etc.) to make a KIND--which provides the commonality one can then classify as a class.

: Oh wow, you've gone off on a tangent again. The class system is primary. The kind system is laid across the top of that. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

Things in the TrainzBaseSpec can be defined in any asset

: Yes, because the other classes inherit from this one. That's how inheritance works. Inheritance is defined through parents and children. Part of the point of these pages is to list all the parent and child relationships - which we've done. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

or you guys really need to drop programming and work on the documentation before moving forward with anything. Perhaps you misread or interpreted the quoted string. If you guys understood that (and begin acting like) you are in a collaborative enterprise with thousands of interactive colleagues and associates, that you are, perhaps you could begin to see you aren't facilitating understanding with such an edit, but stepping on it. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 11:33, 22 November 2013 (EST)

: I disagree. That section is answering the question "what is the parent class of trainzbasespec" -- and the one and only correct answer is "nothing" no matter how much you debate it. I added one extra line to try to explain, in *correct* terms, why that was the case. Given you seemed to want to write a completely misplaced essay in that location.
: No matter how much you fail at understanding classes, inheritance and so on, it doesn't change the fact that trainzbasespec doesn't have a parent. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

User talk:Jamesmoody

2013-11-22T03:33:54Z

Jamesmoody:

Please do not leave comments here. I am unlikely to spot them.

If you need to contact me, please send me an email. If you do not have my address, send a forum Private Message.

Note: Do not contact me directly for technical support. Technical support requests should be sent to the Helpdesk.

== See {{wp|Wikipedia:Etiquette}} ==

:: Please note that this isn't wikipedia. We might use the same software, but don't assume that their rules and conventions apply here. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)
:: In particular note that we are not "NPOV". Documents on this wiki should reflect N3V Games point of view. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:39, 21 August 2013 (EST)

* Sorry we seem to have a different definition of profanity and the appropriate. S***ty is a rather apt term when things don't work right. For example, I'll address wiki business on the wiki, and expect the same—wiki's are about collaborative efforts, it's fairly plain something you guys have done failed in that respect... things never took off. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
:: No, we don't have a different definition of profanity. You may see it as acceptable to use such words, but we don't. This includes "bleeping" words out; you're obviously aware of the words you're using, so just don't use them. If you feel the need to use such words, go outside and take a break instead of replying. Keep it up and you'll be banned. It's that simple. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)
::
:: Also, we used a wiki initially because it was easy for us to edit - I can come back and add a page whenever I have new information to publish. If we get some community assistance, that's great - but it really is a secondary consideration. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]])

: I think it embarrassing that a wiki started so long ago is in such a P*** Poor state, it wasn't even initialized with Public Domain standard help pages, and even ParserFunctions (which I badly need, I couldn't even begin to write [[Template:N3V-Help-Image]] and [[Template:Help-Image]] a while ago as I can't test conditions, files, parameters, so have a Sh***th temporary placeholder workaround... NOT HAPPY FACE MAKING! {{Tl|Tlx}} is not yet useable, which is pretty much needed for any smart template exposition and help... all that TAKES UP AND WASTES my freely donated TIME... So stop that!). // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
:: We're not trying to be wikipedia. We welcome collaboration, but this is NOT a community-owned site. This is a corporate site, with corporate goals. Where our goals align with your goals, that's great. If your goals work against our goals, then our goals take precedence. That may be a harsh way to put it, but I don't want you to misunderstand the reality of the situation here. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)

: Think Chris is or has gotten the picture that I only mean well, and if I wanted to be confrontational, I could really roast the company on the forum, and the Wikibook. I'm only trying to make you all look better, but ''that certainly means changing the status quo''. For starters, if someone comes out with a browser that requires HTML 5, the whole site is non-compliant. There's no Common.css and Common.js files in place. No classes to call, only HTML 4, which have been obsolescent now for what, five or six years?
: Coming in this spring after years of casual browsing to see in detail how little Trainz has progressed, how few changes and how dead this wiki is (Hasn't really progressed much since I first saw it back in late 2009, iirc) has been an eye opener. Not sure what you guys actually do, but I guess you can be proud you don't use coarse language. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
:: Thankfully, all common browsers work fine on our site, so it's not something that we're remotely concerned about at the current time. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)

On the other commentary/responses... [[Talk:TADDaemon]], I have to parse what you changed to understand all your answers. Wikiquette when interleaving is to indent in between 'voices' (responses). Numerous people can then address a paragraph's point... or just the two. Taking things out of order to change the original text makes it rather difficult to see the conversational flow. Breaking the context seems to be a bad thought habit in N4V group think. Sign each para/post with four tildes, that adds a date stamp and your sig, which you can customize under preferences. (See mine)
:: You're quite correct, but nobody here really cares. We don't see the wiki as a workable chat tool. The software is not built with that in mind, and while some conventions have developed on other wikis to make it work "as best possible" we have better tools at our disposal and thus have minimal interest in learning the hacks that people have come up with for dealing with communication in a wiki. James has already suggested you use our forums. If you choose to use a backwards chat process such as this rather than the better tools which we have available, then don't complain when it's hard to use. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)
::: I have gone back and fixed that chat page (with indenting and tildes). Please note though that what you posted is still purely a personal rant, and is still not welcome on a corporate site. You may wish to edit it... [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)

I have to reconstruct the original text to make sense of your rebuttal. Again... a time investment for me. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
: ... and a time investment for me to learn a new way of formatting text when writing using a tool for what appears to be /obviously/ the wrong purpose, and also by someone elses fairly arbitrary rules. And when I could have been working on something productive instead.

Regardless, as Chris understands, I'm here to help, and TADDaemon with all it's time wasting is [http://forums.auran.com/trainz/showthread.php?102671-Insight-into-periodic-pauses-in-Surveyor&p=1192261#post1192261 NOT something which is working well or properly] in the real user world. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
: I'm a real world Trainz user too. My first version of Trainz was 1.1.1. I became a betatester for UTC, a content creator for TRS2004, and joined Auran around the time of TC3. I see TADDaemon as an immense improvement over the problems we had previously - particularly from a content creator workflow. As an end user, I /vehemently disagree/ with your apparent viewpoint that TADDaemon is the spawn of satan and should be killed with fire, and that doing so would fix all problems ever. It saves me countless hours waiting for Trainz or CM to start up. I can run multiple CM windows in parallel, and even Trainz at the same time as well, none of which was even remotely practical before TADDaemon. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)

I'm like Chris there, what counts is what I see, the trouble for you guys is we have thousands of times the number of eyes, time on the job and places where we're seeing insufficient progress, or worse, a [http://forums.auran.com/trainz/showthread.php?102671-Insight-into-periodic-pauses-in-Surveyor&p=1192261#post1192261 lack of attention or acknowledgement] that there are serious issues. I know of three long time content creators, people with hundreds of DLS assets created between them that won't use [[TS2009 SP3]] and beyond because of all the time TADDaemon wastes reconnecting when it should be connected (assuming it's needed at all), why it's active at all when we're in surveyor is a mystery. Makes no sense. You go with the local data base, no one is upgrading or downloading from in surveyor. [http://commons.wikimedia.org/wiki/File:Collected-Trianz-Releases-2013-0727,about_half_the_EnglishLang_Releases.jpg As you can see], I've got a few Trainz versions to choose from, and TS12 is not one anyone should be happy with as an operator given all it's pauses and time wastes. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
: TADDaemon *is* the local database. It existed in pretty much the same form before we split it into it's own process, and we did that because:
: * A Trainz crash used to reliably require a DB repair afterwards. Trainz would do it during the loading process. Just a black screen, no progress report. User reports at the time often suggested that Trainz needed a reinstall after crashing because it was "broken". I personally experienced this in TRS2006.
: * Multiple processes can use the database at once - e.g. CM and Trainz in parallel, multiple CM windows, etc.
: * It frees up process space for Trainz to use for other things. Just "maintaining the database listings" was starting to be a significant drain on process space for people with large installs.
: * People *can* and *do* download within the game - the content updates menu, when getting DLC packs, and when joining multiplayer sessions, to name the obvious ones.
:
: To address some other points: TADDaemon is continually necessary because it provides asset listings. When you use the tabs in surveyor, or the filter dialog, or in fact /anything that asks for a list of assets/ (which is way more common than you think as asset scripts can do it), TADDaemon is what gives you that list back. And Trainz can use the process space (i.e. RAM) freed up by using TADDaemon for other things. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)

So sorry if you're offended by my casual choice in language, but do credit that we are from different societies. That language doesn't raise anyone's eyebrows over here. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
: That kind of language doesn't raise eyebrows in "general society" here either - particularly the more, ummm, bogan parts of society. But it does a lot more than raise eyebrows in some of our critical markets, so we obviously don't want it easily visible in our end user documentation. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 12:27, 21 August 2013 (EST)

But do get used to having other computer professionals taking a serious look at your work, for as far as I'm concerned if I did my job as you guys have seemed to have done yours, the F-22 Raptor would crash every 99th flight, the Patriot missile would turn around and blast it's launcher or control vans, Laser eye surgery would burn through into peoples' cornea, and the Trident missile wouldn't ever threaten to launch from Ohio class submarines... so you'd likely be forcibly learning Chinese or Russian there down under. Those are only a fraction of the complex things I've been part of in my career, and when something runs worse than the version three releases before, something smells.

BTW, Given the ridiculously annoying wait for Parserfunctions, interwikis and so forth, I'm perfectly happy to wait for a talk response here. If you turn on email notification (since you are a site bureaucrat, that's in your toolkit) you can then see when pages change without using a watchlist tab.

The N3V staff admin seems to have trouble changing a boolean value when given a link to the how-to, don't you know. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)
:: You're making the assumption that he's remotely interested in taking advice on configuration from someone outside the company. Again, we work to our goals, not yours. [[User:Windwalkr|Windwalkr]] ([[User talk:Windwalkr|talk]]) 09:54, 21 August 2013 (EST)

Perhaps you can help him appear competent in that little thing. Like much of N3V's visible output, it's leaving a bad taste at the moment. Chris wants me to put up new user pages, in the Help namespace, but I'm not about to start that without further cleanup and having things straight first. I've already tagged too much using {{tl|FAB-todo}}, and for [http://online.ts2009.com/mediaWiki/index.php/Special:WhatLinksHere/Template:FAB-todo every page there], there are three that don't have an overt tag that are dependent upon ParserFunctions.

Best regards // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 09:11, 21 August 2013 (EST)

== Small words and big pictures ==

If you can use some small words and big pictures to explain to me why N3V wouldn't want the power of parserfunctions I'd really appreciate it. Having one template do ten things is much preferable than ten doing ten when the same branching and testing logic that allows that, can allow things like having pop-open collapsed elements like the table {{Tl|TBS}}. I'd like to make that and other such table structures where it makes sense so people can expand them or not as it suits them, allowing them to see a big picture in the context. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 14:22, 12 October 2013 (EST)

: It's not that N3V wouldn't want ParserFunctions. It's that someone at N3V wouldn't want to stop what else they are doing long enough to look into it, decide if it's a sensible request, act on it, and test what breaks afterwards. And more to the point, explain what they were doing for the past 'N' hours to their boss, when there's something else more urgent they should have been working on. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 17:55, 14 October 2013 (EST)

== Please verify conclusion ==

Please verify the tag region is obsolescent as I inferred from config.txt entries whilst fixing errors. I made an appropriate [http://online.ts2009.com/mediaWiki/index.php/Index_of_Tags_%26_Containers#qu-rz annotation here] which should be verified. Thanks // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 12:18, 13 October 2013 (EST)

: The "region" tag is obsolete, and hasn't been used for many years. It's been replaced by "category-region" which has a well-defined format. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 17:55, 14 October 2013 (EST)

== Speak and write English to the audience! ==

re: [http://online.ts2009.com/mediaWiki/index.php?title=KIND_TrainzBaseSpec&diff=5701&oldid=5682 this edit], YOU may understand what the three or four of you may mean by Classes, but what percent of your users have the first clue? AND BTW... what root? Who understands what you mean by that outside of your cubicle area.

: You wrote that the parent class of "TrainzBaseSpec" is "config files". What the .... does that mean. "Config files" isn't a class! It can't be parent to anything. It makes /no sense/ whatsoever. Worse still, you've mis-used and abused so many technical terms with defined meanings so quickly in such a short sentence - that to anyone at the level to get the most out of this document, they'll assume it was written by an imbecile who has no knowledge of what they are talking about, and will assume that the entire contents are wrong. And go looking elsewhere for "better" information.
: As to "kinds being classes" -- kinds are closely related to classes, but they don't sit quite right as classes. Example: scenery and scenery-trackside, both exposed under the same 'kind', but both different classes. It's another tag that actually makes the distinction between the two. That's why we list the kind for each class. Is this thing here a class? Yes, it certainly is. It exists in the class structure quite clearly. It isn't a kind though, and I will admit that you can't make a 'trainzbasespec' asset by itself.
: As to 'root' - if people don't understand the root of a tree being the base, the starting point that every leaf is eventually connected back to via branches and trunks -- then I really don't know what to say. The point here is that whatever is said has to be /accurate/. You can't say "I edited this to make it more understandable" and leave it /wrong/. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

From the standpoint of the customers you guys are most anxious to seduce, land, and hook--the younger crowd who will indubitably be trying to make sense of this unfinished collection of documents (2500+ routes on the DLS are a big big attraction! And that means error fixing, and so you have a big big 250,000 asset problem as even Hilliam knows--and have wasted five years it might have been resolved), to those new customers, and to the old technically challenged... '''the ROOT to them ''in the heat of the moment of frustration at having to figure out what another friggin' error is''... is the fact each asset has a config text file''' which need certain items.

My presentation may not have been the best, but ''" Each of the TrainzBaseSpec file elements can be specified in any asset that has a defining [[Config.txt file]]."'' conveys the relationships far clearer than a school-boy abstraction of Classes.

: That information may be useful and important, but it clearly and obviously doesn't belong under the header of 'Parent class'. It tells me NOTHING about what the parent class is, nor relates to it in any way, shape or form.
: In fact, it should be so elsewhere, it's probably best placed in an "introduction to config files" type page - and not here /at all/. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

That certain of those elements in the spec are mandatory is enforced by error checking. It's addressed in any case, iirc. Similarly Parent and Child classes just muddle the understanding of the users. In point of fact, the config.txt files for a KIND require those common items to be defined, set the threshold level for warnings and errors and define how the text INI file is processed and considered... without a config file to hold it, all those tag labels in the TrainzBaseSpec have no substance, they are merely conjectural, ideas. Recording them in a config.txt file puts them in context.

: wut? Now you are confusing /me/. That's such a muddle of misused terms I'm not even sure what you mean. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

KINDs are your true classes

: No they aren't. Classes are our true classes. Most of them are also kinds, but there are classes that don't have a kind, and also others which share a 'kind'. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

the TrainzBaseSpec is just a collection of common elements defined within each, or sometimes not.

: Nope, it's the root of a literal programming class structure. It exists as a class in code and in validation. That class is inherited by other classes which do map onto kinds. You might consider it a virtual class from the end user perspective, as they can't define one directly. But that doesn't /stop it being a class/. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

The software system uses them to bootstrap the asset, in effect. Since they define all asset types in your software, calling such a disparate changeable set of data definitions a class, means your true classes are meaningless. I have a bit of trouble wrapping my head around such a reversal of cause and effect. Put another way, The trainzBaseSpec is a mix of things which must be defined and others which may optionally be defined (user ID, description, licenses, email, etc.) to make a KIND--which provides the commonality one can then classify as a class.

: Oh wow, you've gone off on a tangent again. The class system is primary. The kind system is laid across the top of that. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

Things in the TrainzBaseSpec can be defined in any asset

: Yes, because the other classes inherit from this one. That's how inheritance works. Inheritance is defined through parents and children. Part of the point of these pages is to list all the parent and child relationships - which we've done. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

or you guys really need to drop programming and work on the documentation before moving forward with anything. Perhaps you misread or interpreted the quoted string. If you guys understood that (and begin acting like) you are in a collaborative enterprise with thousands of interactive colleagues and associates, that you are, perhaps you could begin to see you aren't facilitating understanding with such an edit, but stepping on it. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 11:33, 22 November 2013 (EST)

: I disagree. That section is answering the question "what is the parent class of trainzbasespec" -- and the one and only correct answer is "nothing" no matter how much you debate it. I added one extra line to try to explain, in *correct* terms, why that was the case. Given you seemed to want to write a completely misplaced essay in that location.
: No matter how much you fail at understand classes, inheritance and so on, it doesn't change the fact that trainzbasespec doesn't have a parent. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]]) 13:33, 22 November 2013 (EST)

Build Numbers

2013-10-14T23:59:58Z

Jamesmoody: Correction to chronology of TADDaemon first appearance.

{{ORP-top}}
=Code build number=
The '''Code build number''' or '''Trainz build version''' (two names meaning the identical 'tracking number') is the unique software level identifier that increments not only with 'named' main retail releases, but with each release for specific language groups, and by {{wp|Hotfix}}es, as well as by {{wp|Service_pack}} releases. 

Initial Trainz code build versions are not released in initial retail release versions for all world wide languages at the same time, but these are produced as available translations, so typically, non-English releases lag by some months, but may have hot fixes or service packs already installed. As the translation needs are satisfied and an overall ''release stabilizes'', subsequent service pack releases apply to those code build numbers and effectively combine language releases into a merged common product. At the end of the process, the final service pack produces a ''single stable '''code build version''''', creating the final corresponding Trainz (two digit) version number and corresponding identical [["Trainz-build" tag]] level found in assets config.txt.

=Currently Supported Releases=
Trainz versions are known best by their ''''''Retail Release name'''''', after which N3V Games/Auran, following general software industry practices subsequently release bug fixing '''hot fixes''' and usually a succession of service packs. Each

:'''Note:''' ''Legacy version releases and build numbers are listed at the bottom of the page, reserving this area for currently supported versions.''
The following builds exist for [[TS2009]]. Where patches are available, these are noted beside the build number.
==TS2009 - Trainz 2009==
{{anchor|TRS2009|TS2009|Trainz2009|TRS 2009|TS 2009|Trainz 2009}}
:<big>'''Trainz 2009: World Builder Edition'''</big> 
{| border=1 cellpadding=2 cellspacing=0 style="text-align:center; "
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 37625||auto-patch to 40040||English Online Release
|-
|Build 38017||auto-patch to 40040||[[TS2009 SP1]]
|-
|Build 38411||auto-patch to 40040||English Retail
|-
|Build 38599||auto-patch to 40040||[[TS2009 SP1]] hotfix
|-
|Build 38610||PROTECTED||Steam English Retail
|-
|Build 38808||auto-patch to 41590||French Retail
|-
|Build 38824||-||Dutch Retail
|-
|Build 38869||PROTECTED||UK Retail
|-
|Build 39176||-||German Retail
|-
|Build 39413||auto-patch to 40040||Czech, Polish, Hungarian Retail
|-
|Build 39561||-||Spanish Retail
|-
|Build 39979||auto-patch to 40040
|[[TS2009 SP2]]
|-
|<big>Build 40040</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP2]] + hotfix </big>
|-
|Build 40357||-||Cabon City English Online Release
|-
|Build 40542||-||Russian Retail
|-
|Build 40702||-||Cabon City English Online Release
|-
|Build 40702||-||Treez English Online Release
|-
|Build 40762||-||Murchison English Online Release
|-
|Build 40837||-||S&C English Online Release
|-
|Build 40895||-||Spanish pre-SP3
|-
|Build 41497||-||Dutch, German pre-SP3
|-
|Build 41546||-||Italian Retail
|-
|Build 41590||-||French pre-SP3
|-
|<big>Build 41844</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP3]]</big>
|-
|<big>Build 44653</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP4]]</big> [[TADDaemon]] ("Trainz Asset Database Daemon") introduced
|}

==TS2010 - Trainz 2010==
:<big>'''Trainz 2010: Engineers Edition'''</big>
The following builds exist for [[TS2010]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description''' || '''[[Trainz-build]]* version No.'''
|-
|'''Build 41491''' ||manual patch to 41615 || [[TS2010| TS2010 GM]], English Online Release
| Ver: 3.2
|-
|Build 41615||manual patch to 43434 || [[TS2010 SP1]]
| Ver: 3.2
|-
|Build 41622||manual patch to 43434 || English Online Release
|
|-
! || ||
|
|-
|'''Build 42203'''||manual patch to 43434||[[TS2010 SP2]] English, Swedish DVD Retail Release
| Ver: 3.2
|-
|Build 42534||-||French Retail
|
|-
|Build 42763||-||German Retail
|
|-
|Build 42831||-||Dutch Retail
|
|-
|Build 42953||-||Russian Retail
|
|-
|Build 43030||-||Czech, Polish Retail
|
|-
|Build 43233||-||Spanish Retail
|
|-
| || || ||
|-
|Build 43434||-||[[TS2010 SP3]]
| Ver: 3.3
|-
|Build 44088||-||[[TS2010 SP3]] Minor revision
|
|-
| || || ||
|-
|Build 45467||auto patch to 46170||[[TS2010 SP4]] (including Trainz Multiplayer Beta)
| Ver: 3.4
|-
|Build 45607||auto patch to 46170||[[TS2010 SP4]] patch 1 (including Trainz Multiplayer Beta)
|
|-
|Build 46170||manual patch to 49938||[[TS2010 SP4]] patch 2 (including Trainz Multiplayer Beta)
|
|-
|Build 49933||-||[[TS2010 SP3]] Minor revision, added support for Aerotrain DLC
| Ver: 3.3
|-
|Build 49938||-||[[TS2010 SP4]] patch 3 (including Trainz Multiplayer Beta), added support for Aerotrain DLC
| Ver: 3.4
|-
|}
<big>'''*'''</big> The tag trainz-build assigned value will reflect the tech-level assigned the release or that under which an asset is first made; the version is now listed on the title bar of the [[Content Manager]] screen, and that of individual items is one of the column listings. The trainz-build version is also list on the DLS web page.

==TS12 - Trainz 2012==
:'''Trainz 2012: Anniversary Edition'''</big>
The following builds exist for [[TS12]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 46957||auto-patch to 48054||Planet Auran release version
|-
|Build 47059||auto-patch to 48054||Minor revision
|-
|Build 47103||-||Steam release
|-
|Build 47452||auto-patch to 48054||Just Trainz release version
|-
|Build 47772||auto-patch to 48054||Just Trainz release version (minor revision)
|-
|Build 48054||manual patch to 48249||Minor revision
|-
|Build 48249||manual patch to 49922||Minor revision
|-
|Build 49849||-||Czech Release
|-
|Build 49922||-||Minor revision, added support for Aerotrain DLC
|-
|Build 50027||-||German Release
|-
|Build 50406||-||French Release
|-
|Build 51054||-||Dutch Release
|-
|Build 52143||-||Russian, Japanese, Polish Release
|-
|Build 57720||-||TS12 SP1 English
|-
|Build 57825||-||TS12 SP1 Hotfix 1 English
|-
|Build 57898||-||TS12 SP1 Hotfix 2 English
|-
|Build 58414||-||TS12 SP1 Hotfix 3 English
|}

==Trainz Simulator Mac==
:<big>'''Trainz MAC'''</big>
The following builds exist for [[Trainz Simulator Mac]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 47652||-||Planet Auran Digital Store release
|-
|Build 47770||-||Third-party Digital Store release
|-
|Build 48159||-||Feral retail release
|}

= Content Builds =

Auran's newer patch technology developed for TRS2009 has the capability of updating the base Trainz version and installed add-on content independently. The following is a list of released content build versions for add-on content since the advent of TRS2009's technology. Legacy versions (Trainz UTC, Trainz TCC discussed below)

{| border=1 cellpadding=2 cellspacing=0
|'''Content Build Number'''||'''Content Patches available'''||'''Build description'''
|-
|Content Build 40355||-||Cabon City English Online Release
|-
|Content Build 40400||-||Cabon City English Online Release
|-
|Content Build 40563||-||Treez English Online Release
|-
|Content Build 40761||-||Murchison English Online Release
|-
|Content Build 40836||-||S&C English Online Release
|-
|Content Build 49210||-||Duchess Online Release
|-
|Content Build 49474||-||Duchess Steam Release
|-
|Content Build 49631||-||Coronation Scot Online Release
|-
|Content Build 49694||-||Coronation Scot Steam Release
|}
==Legacy build versions==
:''This section is being provided by the user community to make as complete a reference as possible, so is currently incomplete and may remain so.''
===Trainz 1.x===
:<big>'''Trainz 1.3'''</big>
{| border=1 cellpadding=2 cellspacing=0
|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|0.9||Build 0009 || {{center|Trainz Beta}} ||<center>wholly replaced by [[Trainz 1.0]] </center>||released in November 2000 for testing purposes to Model Railroaders.
|-
|1.0||Build 0010|| {{center|[[Trainz 1.0]]}} ||{{cdash}} || ''''''Trainz Community Edition'''''', released in December 2001
|-
|1.0||Build 0019? || {{center|[[Trainz 1.0]], non-English}} ||{{cdash}} || Trainz Community Edition 2
|-
|1.1||Build ???? || {{Cdash}} || {{center|[[Trainz 1.0| SP1]]}} || released in 2002 (April ?)
|-
|1.2||Build 0??? || {{cdash}} || {{center|[[Trainz 1.0| SP2]]}} || ''''''Trainz Retail Edition'''''' was released in June 2002 aimed at the North American markets.
|-
|1.3||Build 0263 || {{center|aka '''Trainz 1.3'''}} || {{center|[[Trainz SP3]]}} || First with TrainzScript.exe, and Scenarios, November 2002
|-
|1.0||Build 0277 || {{center|[[Trainz 1.0]], non-English}} ||{{cdash}} || Trainz Community Edition 2
|-
|1.5||Build 0377 || {{center|Trainz UTC 3 CD set}} || {{cdash}} || Ultimate Trainz Collection, released 26 November 2002 w/expanded content
|-
|1.6||Build 0404 || {{cdash}} || {{center|Trainz UTC SP1}} || Ultimate Trainz Collection SP1
|-
|1.6||Build 0033 || {{center|Paintshed}} || {{cdash}} ||1st released as part of Ultimate Trainz Collection SP1
|-
|}
===TRS2004===
'''TRS2004''' had a relatively large number of separate builds as Auran worked out methods for international names handling in various languages, plus went through a related succession of Service Packs.
{| border=1 cellpadding=2 cellspacing=1
|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|2.0||Build 668 || [[TRS2004|Trainz Railroad Simulator 2004]] || || International version (Australia and USA). Released in September 2003.
|-
|2.0||Build 686 || [[TRS2004|Trainz Railway Simulator 2004]] || || Just Trains version (UK). Requires disk in drive.
|-
|2.1||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] SP1 || || International (USA/Australia) release
|-
|2.1||Build ???? || [[TRS2004|Trainz Railway Simulator 2004]] SP1 || || Just Trains release (UK). Requires disk in drive.
|-
|2.2||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] "Passenger Edition" (SP2)|| || International (USA/Australia) release
|-
|2.2||Build 2285 || [[TRS2004|Trainz Railway Simulator 2004]] "Passenger Edition" (SP2)|| || Just Trains release (UK). Requires disk in drive.
|-
|2.3||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] SP3 || || International (USA/Australia) release
|-
|2.3||Build ???? || [[TRS2004|Trainz Railway Simulator 2004]] SP3 || ||
|-
|2.3||Build ???? || [[TRS2004#Deluxe|TRS2004 Deluxe]] || ||Trainz 2004: Deluxe Edition. Includes SP3 and additional content. Different regions received different additional content.
|-
|2.4||Build 2365 || [[TRS2004|Trainz Railroad Simulator 2004]] SP4 || || International (USA/Australia) release
|-
|2.4||Build 2370 || [[TRS2004|Trainz Railway Simulator 2004]] SP4 || || Just Trains release (UK). Requires disk in drive.
|-
|2.4||Build 2370 || [[TRS2004|Trainz Railway Simulator 2004]] SP4 || || Included in ''Trainz Collection'', but ''without'' the requirement for a disk in the drive.
|-
|}

===TRS2006 & etc.===

'''TRS2006''' had a relatively large number of separate builds as Auran worked out methods for international names handling in various languages, plus went into partnership with various 3rd party distributors giving a host of releases in various markets but only one series of related Service Packs.

{| border=1 cellpadding=2 cellspacing=1 width="100%"
|col-width="8%"|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|  2.5||Build 2761 || {{center
|[[TRS2006|TRS2006 GM]] }} ||{{cdash}} ||  Original release for Australia and USA. [[Content Creator Plus]] and [[Content Manager|Content Manager Plus]] first introduced.
|-
|  2.5||colspan="3" |'''Other Builds:''' UK release - 2773; French - 2883; Dutch - 2967;German - 2970; Spanish - 3007 ||German - was also called Pro Train Perfect or PTP
|-
|  2.5|| Build 3096 &Merscom's build 3104|| '''{{center|Trainz Driver Edition (TDE)''' ('demo version')}}|| {{cdash}} || UK release date of Trainz Driver was 24 February 2005. {{bullR}}TDE did not have CMP nor Surveyor, but did include Railyard
|-
|  2.6 || build 3092 || {{cdash}} || {{center|[[TRS2006|TRS2006 SP1]] }} || TRS2006 - Australia and North American markets
|-
|  2.6||colspan="4" |'''Other SP1 Builds:''' United Kingdom-SP1= build 3099; Spanish-SP1= build 3118
|-
|  2.6||Build 3335 || {{cdash}} || {{center|[[TRS2006#SP1|TRS2006 SP1]] }} || Vista support. Released in September 2007. Used for bundle packs - Trainz Railwayz (North American release bundled with TC1) and Trainz Complete Collection (bundled with TRS2004 SP4, UTC and Trainz Routes 1 to 4).
|-
|  2.6||Build ????|| {{center|[[TRS2007]] }} || {{cdash}} ||  French retail, equivalent to TRS2006+SP1, with some additional French content.
|-
|  2.6||Build ????|| {{center|[[TRS2007]] }} || {{cdash}} ||  German retail, equivalent to TRS2006+SP1, with a lot of additional German content.
|-
|}

===Trainz Classics===

'''Trainz Classics''' was series of releases each featuring a single route. New code features were added to each version to support that route.

{| border=1 cellpadding=2 cellspacing=1 width="100%"
|col-width="8%"|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|  2.7||Build 3337|| {{center|[[TC1|'''Trainz Classics''']]}} || {{cdash}} ||  English Retail. Released July 9th, 2007 as a bundle with both [[TC1]] and [[TC2]] content included. Released as '''Trainz Railwayz''' (bundled with an updated TRS2006) in North America.
|-
|  2.7||Build ????|| {{center|[[TRS2008]] }} || {{cdash}} ||  French Retail. Includes both TC1/TC2 and also the French 2007 content in a single build.
|-
|  2.8||Build 3529|| {{center|[[TC3|Trainz Classics 3]]}} || {{cdash}} ||  TC3 English Retail, released on July 23, 2008.
|-
|}

==Notes and references==
<big><big><code>*</code></big></big> Name usages matching information posted on {{wp|Trainz}} and the {{plain link|http://en.wikibooks.org/wiki/Trainz/Version_And_Build_Numbers|Trainz Wikibook}} Version and Build Numbers pages.

{{ORP-bot}}{{TBKr}}

Build Numbers

2013-10-14T23:58:16Z

Jamesmoody: Correct version numbers. FWIW: v2.9, v3.0 and v3.1 are TS2009, TS2009 SP1 and TS2009 SP2+SP3. TS2010 GM started at v3.2.

{{ORP-top}}
=Code build number=
The '''Code build number''' or '''Trainz build version''' (two names meaning the identical 'tracking number') is the unique software level identifier that increments not only with 'named' main retail releases, but with each release for specific language groups, and by {{wp|Hotfix}}es, as well as by {{wp|Service_pack}} releases. 

Initial Trainz code build versions are not released in initial retail release versions for all world wide languages at the same time, but these are produced as available translations, so typically, non-English releases lag by some months, but may have hot fixes or service packs already installed. As the translation needs are satisfied and an overall ''release stabilizes'', subsequent service pack releases apply to those code build numbers and effectively combine language releases into a merged common product. At the end of the process, the final service pack produces a ''single stable '''code build version''''', creating the final corresponding Trainz (two digit) version number and corresponding identical [["Trainz-build" tag]] level found in assets config.txt.

=Currently Supported Releases=
Trainz versions are known best by their ''''''Retail Release name'''''', after which N3V Games/Auran, following general software industry practices subsequently release bug fixing '''hot fixes''' and usually a succession of service packs. Each

:'''Note:''' ''Legacy version releases and build numbers are listed at the bottom of the page, reserving this area for currently supported versions.''
The following builds exist for [[TS2009]]. Where patches are available, these are noted beside the build number.
==TS2009 - Trainz 2009==
{{anchor|TRS2009|TS2009|Trainz2009|TRS 2009|TS 2009|Trainz 2009}}
:<big>'''Trainz 2009: World Builder Edition'''</big> 
{| border=1 cellpadding=2 cellspacing=0 style="text-align:center; "
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 37625||auto-patch to 40040||English Online Release
|-
|Build 38017||auto-patch to 40040||[[TS2009 SP1]]
|-
|Build 38411||auto-patch to 40040||English Retail
|-
|Build 38599||auto-patch to 40040||[[TS2009 SP1]] hotfix
|-
|Build 38610||PROTECTED||Steam English Retail
|-
|Build 38808||auto-patch to 41590||French Retail
|-
|Build 38824||-||Dutch Retail
|-
|Build 38869||PROTECTED||UK Retail
|-
|Build 39176||-||German Retail
|-
|Build 39413||auto-patch to 40040||Czech, Polish, Hungarian Retail
|-
|Build 39561||-||Spanish Retail
|-
|Build 39979||auto-patch to 40040
|[[TS2009 SP2]]
|-
|<big>Build 40040</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP2]] + hotfix </big>
|-
|Build 40357||-||Cabon City English Online Release
|-
|Build 40542||-||Russian Retail
|-
|Build 40702||-||Cabon City English Online Release
|-
|Build 40702||-||Treez English Online Release
|-
|Build 40762||-||Murchison English Online Release
|-
|Build 40837||-||S&C English Online Release
|-
|Build 40895||-||Spanish pre-SP3
|-
|Build 41497||-||Dutch, German pre-SP3
|-
|Build 41546||-||Italian Retail
|-
|Build 41590||-||French pre-SP3
|-
|<big>Build 41844</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP3]]</big> [[TADDaemon]] ("Trainz Asset Database Daemon") introduced
|-
|<big>Build 44653</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP4]]</big>
|}

==TS2010 - Trainz 2010==
:<big>'''Trainz 2010: Engineers Edition'''</big>
The following builds exist for [[TS2010]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description''' || '''[[Trainz-build]]* version No.'''
|-
|'''Build 41491''' ||manual patch to 41615 || [[TS2010| TS2010 GM]], English Online Release
| Ver: 3.2
|-
|Build 41615||manual patch to 43434 || [[TS2010 SP1]]
| Ver: 3.2
|-
|Build 41622||manual patch to 43434 || English Online Release
|
|-
! || ||
|
|-
|'''Build 42203'''||manual patch to 43434||[[TS2010 SP2]] English, Swedish DVD Retail Release
| Ver: 3.2
|-
|Build 42534||-||French Retail
|
|-
|Build 42763||-||German Retail
|
|-
|Build 42831||-||Dutch Retail
|
|-
|Build 42953||-||Russian Retail
|
|-
|Build 43030||-||Czech, Polish Retail
|
|-
|Build 43233||-||Spanish Retail
|
|-
| || || ||
|-
|Build 43434||-||[[TS2010 SP3]]
| Ver: 3.3
|-
|Build 44088||-||[[TS2010 SP3]] Minor revision
|
|-
| || || ||
|-
|Build 45467||auto patch to 46170||[[TS2010 SP4]] (including Trainz Multiplayer Beta)
| Ver: 3.4
|-
|Build 45607||auto patch to 46170||[[TS2010 SP4]] patch 1 (including Trainz Multiplayer Beta)
|
|-
|Build 46170||manual patch to 49938||[[TS2010 SP4]] patch 2 (including Trainz Multiplayer Beta)
|
|-
|Build 49933||-||[[TS2010 SP3]] Minor revision, added support for Aerotrain DLC
| Ver: 3.3
|-
|Build 49938||-||[[TS2010 SP4]] patch 3 (including Trainz Multiplayer Beta), added support for Aerotrain DLC
| Ver: 3.4
|-
|}
<big>'''*'''</big> The tag trainz-build assigned value will reflect the tech-level assigned the release or that under which an asset is first made; the version is now listed on the title bar of the [[Content Manager]] screen, and that of individual items is one of the column listings. The trainz-build version is also list on the DLS web page.

==TS12 - Trainz 2012==
:'''Trainz 2012: Anniversary Edition'''</big>
The following builds exist for [[TS12]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 46957||auto-patch to 48054||Planet Auran release version
|-
|Build 47059||auto-patch to 48054||Minor revision
|-
|Build 47103||-||Steam release
|-
|Build 47452||auto-patch to 48054||Just Trainz release version
|-
|Build 47772||auto-patch to 48054||Just Trainz release version (minor revision)
|-
|Build 48054||manual patch to 48249||Minor revision
|-
|Build 48249||manual patch to 49922||Minor revision
|-
|Build 49849||-||Czech Release
|-
|Build 49922||-||Minor revision, added support for Aerotrain DLC
|-
|Build 50027||-||German Release
|-
|Build 50406||-||French Release
|-
|Build 51054||-||Dutch Release
|-
|Build 52143||-||Russian, Japanese, Polish Release
|-
|Build 57720||-||TS12 SP1 English
|-
|Build 57825||-||TS12 SP1 Hotfix 1 English
|-
|Build 57898||-||TS12 SP1 Hotfix 2 English
|-
|Build 58414||-||TS12 SP1 Hotfix 3 English
|}

==Trainz Simulator Mac==
:<big>'''Trainz MAC'''</big>
The following builds exist for [[Trainz Simulator Mac]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 47652||-||Planet Auran Digital Store release
|-
|Build 47770||-||Third-party Digital Store release
|-
|Build 48159||-||Feral retail release
|}

= Content Builds =

Auran's newer patch technology developed for TRS2009 has the capability of updating the base Trainz version and installed add-on content independently. The following is a list of released content build versions for add-on content since the advent of TRS2009's technology. Legacy versions (Trainz UTC, Trainz TCC discussed below)

{| border=1 cellpadding=2 cellspacing=0
|'''Content Build Number'''||'''Content Patches available'''||'''Build description'''
|-
|Content Build 40355||-||Cabon City English Online Release
|-
|Content Build 40400||-||Cabon City English Online Release
|-
|Content Build 40563||-||Treez English Online Release
|-
|Content Build 40761||-||Murchison English Online Release
|-
|Content Build 40836||-||S&C English Online Release
|-
|Content Build 49210||-||Duchess Online Release
|-
|Content Build 49474||-||Duchess Steam Release
|-
|Content Build 49631||-||Coronation Scot Online Release
|-
|Content Build 49694||-||Coronation Scot Steam Release
|}
==Legacy build versions==
:''This section is being provided by the user community to make as complete a reference as possible, so is currently incomplete and may remain so.''
===Trainz 1.x===
:<big>'''Trainz 1.3'''</big>
{| border=1 cellpadding=2 cellspacing=0
|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|0.9||Build 0009 || {{center|Trainz Beta}} ||<center>wholly replaced by [[Trainz 1.0]] </center>||released in November 2000 for testing purposes to Model Railroaders.
|-
|1.0||Build 0010|| {{center|[[Trainz 1.0]]}} ||{{cdash}} || ''''''Trainz Community Edition'''''', released in December 2001
|-
|1.0||Build 0019? || {{center|[[Trainz 1.0]], non-English}} ||{{cdash}} || Trainz Community Edition 2
|-
|1.1||Build ???? || {{Cdash}} || {{center|[[Trainz 1.0| SP1]]}} || released in 2002 (April ?)
|-
|1.2||Build 0??? || {{cdash}} || {{center|[[Trainz 1.0| SP2]]}} || ''''''Trainz Retail Edition'''''' was released in June 2002 aimed at the North American markets.
|-
|1.3||Build 0263 || {{center|aka '''Trainz 1.3'''}} || {{center|[[Trainz SP3]]}} || First with TrainzScript.exe, and Scenarios, November 2002
|-
|1.0||Build 0277 || {{center|[[Trainz 1.0]], non-English}} ||{{cdash}} || Trainz Community Edition 2
|-
|1.5||Build 0377 || {{center|Trainz UTC 3 CD set}} || {{cdash}} || Ultimate Trainz Collection, released 26 November 2002 w/expanded content
|-
|1.6||Build 0404 || {{cdash}} || {{center|Trainz UTC SP1}} || Ultimate Trainz Collection SP1
|-
|1.6||Build 0033 || {{center|Paintshed}} || {{cdash}} ||1st released as part of Ultimate Trainz Collection SP1
|-
|}
===TRS2004===
'''TRS2004''' had a relatively large number of separate builds as Auran worked out methods for international names handling in various languages, plus went through a related succession of Service Packs.
{| border=1 cellpadding=2 cellspacing=1
|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|2.0||Build 668 || [[TRS2004|Trainz Railroad Simulator 2004]] || || International version (Australia and USA). Released in September 2003.
|-
|2.0||Build 686 || [[TRS2004|Trainz Railway Simulator 2004]] || || Just Trains version (UK). Requires disk in drive.
|-
|2.1||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] SP1 || || International (USA/Australia) release
|-
|2.1||Build ???? || [[TRS2004|Trainz Railway Simulator 2004]] SP1 || || Just Trains release (UK). Requires disk in drive.
|-
|2.2||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] "Passenger Edition" (SP2)|| || International (USA/Australia) release
|-
|2.2||Build 2285 || [[TRS2004|Trainz Railway Simulator 2004]] "Passenger Edition" (SP2)|| || Just Trains release (UK). Requires disk in drive.
|-
|2.3||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] SP3 || || International (USA/Australia) release
|-
|2.3||Build ???? || [[TRS2004|Trainz Railway Simulator 2004]] SP3 || ||
|-
|2.3||Build ???? || [[TRS2004#Deluxe|TRS2004 Deluxe]] || ||Trainz 2004: Deluxe Edition. Includes SP3 and additional content. Different regions received different additional content.
|-
|2.4||Build 2365 || [[TRS2004|Trainz Railroad Simulator 2004]] SP4 || || International (USA/Australia) release
|-
|2.4||Build 2370 || [[TRS2004|Trainz Railway Simulator 2004]] SP4 || || Just Trains release (UK). Requires disk in drive.
|-
|2.4||Build 2370 || [[TRS2004|Trainz Railway Simulator 2004]] SP4 || || Included in ''Trainz Collection'', but ''without'' the requirement for a disk in the drive.
|-
|}

===TRS2006 & etc.===

'''TRS2006''' had a relatively large number of separate builds as Auran worked out methods for international names handling in various languages, plus went into partnership with various 3rd party distributors giving a host of releases in various markets but only one series of related Service Packs.

{| border=1 cellpadding=2 cellspacing=1 width="100%"
|col-width="8%"|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|  2.5||Build 2761 || {{center
|[[TRS2006|TRS2006 GM]] }} ||{{cdash}} ||  Original release for Australia and USA. [[Content Creator Plus]] and [[Content Manager|Content Manager Plus]] first introduced.
|-
|  2.5||colspan="3" |'''Other Builds:''' UK release - 2773; French - 2883; Dutch - 2967;German - 2970; Spanish - 3007 ||German - was also called Pro Train Perfect or PTP
|-
|  2.5|| Build 3096 &Merscom's build 3104|| '''{{center|Trainz Driver Edition (TDE)''' ('demo version')}}|| {{cdash}} || UK release date of Trainz Driver was 24 February 2005. {{bullR}}TDE did not have CMP nor Surveyor, but did include Railyard
|-
|  2.6 || build 3092 || {{cdash}} || {{center|[[TRS2006|TRS2006 SP1]] }} || TRS2006 - Australia and North American markets
|-
|  2.6||colspan="4" |'''Other SP1 Builds:''' United Kingdom-SP1= build 3099; Spanish-SP1= build 3118
|-
|  2.6||Build 3335 || {{cdash}} || {{center|[[TRS2006#SP1|TRS2006 SP1]] }} || Vista support. Released in September 2007. Used for bundle packs - Trainz Railwayz (North American release bundled with TC1) and Trainz Complete Collection (bundled with TRS2004 SP4, UTC and Trainz Routes 1 to 4).
|-
|  2.6||Build ????|| {{center|[[TRS2007]] }} || {{cdash}} ||  French retail, equivalent to TRS2006+SP1, with some additional French content.
|-
|  2.6||Build ????|| {{center|[[TRS2007]] }} || {{cdash}} ||  German retail, equivalent to TRS2006+SP1, with a lot of additional German content.
|-
|}

===Trainz Classics===

'''Trainz Classics''' was series of releases each featuring a single route. New code features were added to each version to support that route.

{| border=1 cellpadding=2 cellspacing=1 width="100%"
|col-width="8%"|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|  2.7||Build 3337|| {{center|[[TC1|'''Trainz Classics''']]}} || {{cdash}} ||  English Retail. Released July 9th, 2007 as a bundle with both [[TC1]] and [[TC2]] content included. Released as '''Trainz Railwayz''' (bundled with an updated TRS2006) in North America.
|-
|  2.7||Build ????|| {{center|[[TRS2008]] }} || {{cdash}} ||  French Retail. Includes both TC1/TC2 and also the French 2007 content in a single build.
|-
|  2.8||Build 3529|| {{center|[[TC3|Trainz Classics 3]]}} || {{cdash}} ||  TC3 English Retail, released on July 23, 2008.
|-
|}

==Notes and references==
<big><big><code>*</code></big></big> Name usages matching information posted on {{wp|Trainz}} and the {{plain link|http://en.wikibooks.org/wiki/Trainz/Version_And_Build_Numbers|Trainz Wikibook}} Version and Build Numbers pages.

{{ORP-bot}}{{TBKr}}

"Trainz-build" tag

2013-10-14T08:12:54Z

Jamesmoody: Improve accuracy. Remove redundancy. Corrected voicing to first party from 3rd party. Moved the meat of the page back to the middle, not stuffed in some tiny little side area. Etc, etc.

{{ORP-top}}
==Trainz-build tag number==
The '''Trainz-build tag''' number indicates the minimum '''Trainz Version''' required to use the asset. Trainz will not attempt to load an asset which has a trainz-build tag that is newer than it's own version number.
This tag is also an indication of the age of the asset, and the standards to which it is built. Assets with old Trainz-build numbers are not built to take advantage of new Trainz features that did not exist in the version of Trainz that the asset was built for.
 
{{UserTip|The word ''version'' is used in Trainz to refer to three different concepts. There is the '''Trainz Retail Version''', the '''Trainz Version''' and the '''Trainz Build Number'''.
The '''Trainz Retail Version''' is a text string for a product release, such as ''Trainz Simulator 2009''.
The '''Trainz version''' is a numeric code (e.g ''2.4'' or ''3.6'') which is incremented for each major release. This code is updated whenever a significant change to Trainz is made. Most service packs (which introduce significant functionality changes) will have a new ''Trainz Version'', but hotfixes (which do not introduce significant functionality changes) do not see a ''Trainz version'' number change. Different language versions of the same product will also generally share the same ''Trainz Version''.
The '''Trainz Build Number''' is a unique number (e.g. ''44653'' or ''58414'') that identifies an individual Trainz release. All releases (including minor changes and language translations) have a different ''Trainz Build Number''.
The '''Trainz-build''' tag uses the ''Trainz Version'' numeric code.
}}

Trainz-Build version numbers and their mapping to official Trainz release versions are as follows:
{| border=2 cellpadding=5 cellspacing=2
|'''trainz-build''' || Trainz product for which the asset was designed
|-
| {{center|1.3 }} || [[Trainz SP3|Trainz SP3]]
|-
| {{center|1.5 }} || Ultimate Trainz Collection
|-
| {{center|1.6 }} || Ultimate Trainz Collection SP1
|-
| {{center|2.0 }} || [[TRS2004]]
|-
| {{center|2.1 }} || [[TRS2004]] SP1
|-
| {{center|2.2 }} || [[TRS2004]] SP2 - Passenger Pack
|-
| {{center|2.3 }} || [[TRS2004]] SP3
|-
| {{center|2.4 }} || [[TRS2004]] SP4
|-
| {{center|2.5 }} || [[TRS2006]]
|-
| {{center|2.6 }} || [[TRS2006]] SP1
|-
| {{center|2.7 }} || Trainz Classics 1&2
|-
| {{center|2.8 }} || Trainz Classics 3
|-
| {{center|2.9 }} || [[TS2009]]
|-
| {{center|3.0 }} || [[TS2009 SP1]]
|-
| {{center|3.1 }} || [[TS2009 SP2]] / [[TS2009 SP3]]
|-
| {{center|3.2 }} || [[TS2010]] / [[TS2010 SP1]]
|-
| {{center|3.3 }} || [[TS2010 SP2]] / [[TS2010 SP3]] / [[TS2009 SP4]]
|-
| {{center|3.4 }} || [[TS2010 SP4]]
|-
| {{center|3.5 }} || [[TS12]]
|-
| {{center|3.6 }} || [[TS12]] and [[Trainz Simulator Mac]]
|-
| {{center|3.7 }} || [[TS12 SP1]]
|}

==Asset compatibility==
It is important for an asset to list the correct Trainz-build in the [[config.txt file]]. It specifies the version of Trainz the asset was intended to be used with. An earlier version of Trainz will refuse to load the asset. A later version of Trainz will enable appropriate backwards compatibility workarounds (e.g. using different validation requirements) as required.
 

A correctly-constructed asset built for an older version will usually function in a newer version of Trainz. However, Trainz content validation is improved over time, and newer versions of Trainz detect errors that older versions did not pick up on. Some content may be detected as 'faulty' in a current Trainz version that was missed in the version it was originally created for.
 

It should be noted that content that is uploaded to the [[Download Station]] is validated by the most recent version of Trainz, using the validation compatibility for the trainz-build specified by the asset.
 

If [[Content Creator Plus]] is used to modify an asset, it will automatically update the trainz-build version in the config.txt file to the current Trainz version. If this version has changed significantly, other changes to the config.txt file will probably be required.
Assets which are manually edited will need the appropriate version entered. If the line is omitted entirely, the lowest possible version is assumed. This is currently ''Trainz-build 1.3''.
 

==Obsolete Versions==
Trainz-build numbers up to and including 2.8 are considered obsolete as of September 2012 and can no longer be uploaded to the [[Download Station]]. See the [[Trainz Life-Cycle Policy]] for additional details.

{{TBKR|trainz-build tag}}
[[Category:Config Tag|trainz-build tag]]
[[Category:Trainz fundamentals pages|trainz-build tag]]
{{ORP-bot|trainz-build tag}}

User talk:Jamesmoody

2013-10-14T06:57:29Z

Jamesmoody:

User talk:Jamesmoody

2013-10-14T06:55:41Z

Jamesmoody:

"mesh-table" container

2013-10-14T06:47:08Z

Jamesmoody: /* Mesh subcontainer */ Accuracy correction. The default values are empty strings. This is intentional, and documents default behaviour. The description of what each one /does/ is below, in the following section.

{{ORP-top}}
==KIND Heirarchy==
The "mesh-table" container is a top-level [[config.txt file]] entry used by various [[Content_Configuration#Content_Types|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_Configuration#Content_Types|Content Types]] support the full range of tags listed below. 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.

==Known Dependent Parent Types==
:''Main article, see: [[KIND Mesh]]''
The Content Types listed here use the mesh-table container as part of their definition.

* [[KIND Industry]]
* [[KIND MOJunction]]
* [[KIND Pantograph]]
* [[KIND Scenery]]
* [[KIND Track]]
* [[KIND Traincar]]

The following config containers also reference back to their Asset's mesh-table container in some fashion:
* [["junction-vertices" container]]
* [["track-lod-tree" container]]

'''See also'''{{bullR}} [[Modeling Guidelines]] {{bull}} [[Modeling Scenery]]
==Mesh subcontainer==
Each mesh subcontainer supports the following tags. Each tag is shown here with its default value. {{FAB-todo| Use Pseudo-table to recast as a real wikitable.}}

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
critical-animation 1
effects {
}
night-mesh-base ""

<big>*</big> The att-parent defaults to "default" which is the parent mesh. The att-parent tag can include a path.

==Supported Tags==
Each mesh subcontainer supports the following tags.

===mesh-asset===
Allows assets to be used as 'mesh libraries', the following container specifies that the mesh required (and its optional animation) is located relative to ''''''the root folder'''''' of <kuid:1234:5678>. CMP does not auto-check for the existence of these'' 'externally referenced files' ''when processing so you must ensure that they are present in the referenced kuid before using this tag. Subfolder paths within the asset can be used; folder names should be prefixed to the path with a forward slash ("/") separator in the usual fashion.

===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===
opacity x (float 0.0 - 1.0 default 1.0)

Specifies the overall transparency of a mesh. Values other than 0.0 or 1.0 employ alpha blending and a value of 0.0 has the same effect as hiding the mesh.

Note that this tag is buggy in TS2009 prior to SP4.

===mesh-scale===
This tag defines a minimum and maximum scaling value for the mesh, where 1.0 is the size as modelled. Each instance of the mesh that exists in the world will randomise within this range. Randomisation will not change between runs or between Trainz editions, but may change based on factors such as the position of the mesh in the world. This tag is currently only supported on SpeedTree assets; attempts to use this tag on other assets results in undefined behaviour.

===position===
position X,Y,Z (in metres, default 0,0,0)

Specifies the location of a mesh relative to its insertion point.

===orientation===
orientation X,Y,Z (radians default 0,0,0)

Allows a submesh to be rotated relative to its insertion point. To reverse a mesh by 180 degrees about the Z axis, add the tag:

orientation 0,0,3.14159

===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===
If set (which it is by default), this tag causes the non-stitched mesh to be linked into the Trainz lighting model. This causes the mesh to respond to directional lighting changes, such as the angle of the sun or train headlights. This is also necessary for normal maps to work correctly. Zeroing this tag will remove the mesh from the Trainz lighting model. Generally speaking, you should never zero this tag- almost every effect that can be achieved through this approach can be better served by using an appropriate normal map or appropriate geometry detail.

This tag has no effect on stitched meshes, which are always affected by the Trainz lighting. Since the content creator has no direct influence over which meshes are subject to [[Mesh Stitching]], and all indirect influences are subject to change between Trainz editions, it is strongly recommended that this tag is avoided to ensure that results are consistent.

===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|mesh-table container]]
{{ORP-bot|mesh-table container}}

KIND TrainzBaseSpec

2013-10-14T06:33:03Z

Jamesmoody: /* Parent Classes */ -- TrainzBaseSpec is not derived from "Config file".

{{FUN-beg}}
{{ORP-top}}
==KIND Hierarchy==
[[KIND TrainzBaseSpec]] provides the basis for all Trainz asset types. It provides for a number of "Standard Tags" which are common to (or at least, can legally be defined) for any and all Trainz assets. Some of these are mandatory, most are optional and a defining line using the tag may be omitted in most sub-assets.

===Parent Classes===
* None. TrainzBaseSpec is a root class from which other Trainz Asset classes are derived.

===Table of KIND Child Classes===
{|
|-valign="top"
|
*  [[KIND Achievement-category]]
*  [[KIND Achievement-group]]
*  [[KIND Activity]]
*  [[KIND Asset-group]]
*  [[KIND Behavior]]
*  [[KIND Bogey]]
*  [[KIND Buildable]]
*  [[KIND Controlset]]
*  [[KIND Consist]]
*  [[KIND Drivercharacter]]
*  [[KIND Drivercommand]]
*  [[KIND Engine]]
*  [[KIND Enginesound]]
*  [[KIND Environment]]
*  [[KIND Fixedtrack]]
*  [[KIND Gameplaymenu]]
|
*  [[KIND Groundbrush]]
*  [[KIND Groundtexture]]
*  [[KIND Hornsound]]
*  [[KIND HTML-asset]]
*  [[KIND Industry]]
*  [[KIND Interior]]
*  [[KIND Library]]
*  [[Class Library]]
*  [[KIND Map]]
*  [[KIND Mesh]]
*  [[KIND Module]]
*  [[KIND MOCrossing]]
*  [[KIND MOJunction]]
*  [[KIND MOSignal]]
*  [[KIND MOSpeedboard]]
*  [[KIND Pantograph]]
|
*  [[KIND Product]]
*  [[KIND Product-category]]
*  [[KIND Profile]]
*  [[KIND Region]]
*  [[KIND Scenariobehavior]]
*  [[KIND Scenery]]
*  [[KIND Scenery-trackside]]
*  [[KIND SceneryWithTrack]]
*  [[KIND Servlet]]
*  [[KIND Steam-engine]]
*  [[KIND Texture]]
*  [[KIND Texture-group]]
*  [[KIND Track]]
*  [[KIND Tracksound]]
*  [[KIND Traincar]]
*  [[KIND Turntable]]
*  [[KIND Water2]]
|}

 
==Obsolescent tags==
These tag names will occur in older content, and newer conventions have replaced their usages. They are listed here to delineate the discouragement of their use.
*tag: region
:example: region "England"
:era: Obsoleted in TRS2006 as this quote CCP: "The country region to which this asset belongs, not used for TRS2006 - ''[[category-region]]''' is used instead"
notes: This tag antedates TRS2006's introduction of [[Content Manager Plus]] with the capability to set up selection and grouping filters; the older form was a simple string without any real bounds, so could be defined as just about anything.

 

==Obsolete Containers and tags==
These data type names will be seen in older content, and newer conventions have replaced their usages. They are listed here to delineate their replacement is mandantory as errors will be generated on the occasion of their use.

 
==Supported Tags==
The [[KIND TrainzBaseSpec]] [[config.txt file]] supports the following tags. Each tag is show here with its ''default value'':

kind ""
kuid <NULL>
trainz-build ?
script ""
class ""
script-include-table
{
}
username ""
username-XX ""
description ""
description-XX ""
kuid-table
{
}
obsolete-table
{
}
string-table
{
}
string-table-XX
{
}
category-region ""
category-class ""
category-era ""
category-keyword ""
custom-category-list ""
must-have-product-rights ""
must-not-have-product-rights ""
privileges
{
}
thumbnails
{
}
extensions
{
}
license ""
author ""
organisation ""
contact-email ""
contact-website ""
member-of-groups
{
}

 
{{UserTip|1=The [[Template:TBS]] can be placed on any of the terse KIND pages in this Wiki to enable a local viewing of the following table.
*Once N3V turns on WikiMedia ParserFunctions and installs a suitable [[:MetaWiki:Common.css]] and [[:MetaWiki:Common.js]] pages, these local versions will stay small but pop-up when clicked-on in the appropriate place. [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 17:49, 1 July 2013 (EST)
}}

 
===kind===
:''type:'' string.
:''desc:'' The asset type which this [[config.txt file]] represents. See the list: [[KIND_TrainzBaseSpec#Table_of_KIND_Child_Classes|here (above)]]

===kuid===
:''type:'' [[KUID]]
:''desc:'' The unique asset ID referencing this asset.

===[[trainz-build]]===
:''type:'' floating point number (must exactly match a released Trainz version number.)
:''desc:'' The file format version to which this asset is built. This number should generally be set to the trainz version number of the Trainz installation on which the asset is being created and tested. Some asset kinds are parsed significantly differently depending on their ''trainz-build'' version tag. NOTE: The ''trainz-build'' tag is compulsory. If not specified, Trainz will make a primitive attempt to guess at a legacy Trainz version based on the contents of the [[config.txt file]].

===script===
:''type:'' string.
:''desc:'' Indicates the filepath of the primary script file for this asset, if any. This filepath should always end in a ".gs" extension - the runtime will attempt to add or substitute a ".gs" extension if the filepath has an alternative extension.

===class===
:''type:'' string.
:''desc:'' Indicates the script class name to load as the primary class for this asset, if any. This class is loaded from the primary script file for this asset.

===script-include-table===
:''type:'' The [["script-include-table" container]].
:''desc:'' A key-value table of scripted assets which are searched for script includes when compiling this asset's script file(s). The key is currently unused but must be unique; the value indicates the KUID of the asset to include.

===username===
:''type:'' UTF-8 string, [["Username" tag]].
:''desc:'' The '''English''' human-visible name for this asset. This field should never contain non-English text, except where the asset name is a Proper Noun (eg. a place name) with no English localized variant.

===username-XX===
:''type:'' UTF-8 string, [["Username" tag]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) The localized human-visible name for this asset. This field is similar to the ''username'' field except representing a non-English locale. Multiple ''username-XX'' tags may be present in an asset, once for each supported locale. If the appropriate 'username-XX' tag is not present to represent this asset on a given end-user system, the English ''username'' tag is used instead.

===description===
:''type:'' UTF-8 multi-line string, [["Description" tag]].
:''desc:'' The '''English''' human-visible descriptive summary for this asset. This field should be kept to a short (1-2 paragraph) blurb describing the asset. Extended details should be provided via an ''info-url'' page. This field must be comprised of English descriptive text, although the text may reference non-English Proper Nouns as explained above.

===description-XX===
:''type:'' UTF-8 multi-line string, [["Description" tag]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) The localized human-visible descriptive summary for this asset. This field is similar to the ''description'' field except representing a non-English locale. Multiple ''description-XX'' tags may be present in an asset, once for each supported locale. If the appropriate 'description-XX' tag is not present to represent this asset on a given end-user system, the English ''description'' tag is used instead.

===string-table===
:''type:'' UTF-8 string list container, the [["String-table" container]].
:''desc:'' A key-value list of '''English''' strings. Each key is a meaningful script identifier. Each value is an '''English''' string. As described above, an English string may comprise of or reference a non-English Proper Noun.

===string-table-XX===
:''type:'' UTF-8 string list container, the [["String-table" container]].
:''desc:'' (Where ''XX'' is replaced with the appropriate [[localization code]] for the language being represented.) This field is similar to the ''string-table'' field except representing a non-English locale. Multiple ''string-table-XX'' tags may be present in an asset, once for each supported locale. Each should contain a list of strings with the same Keys as in the ''string-table'' list, but with different Values. If the appropriate 'string-table-XX' tag is not present to represent this asset on a given end-user system, or the appropriate string is missing from the that list, the English ''string-table'' container is referenced instead.

===kuid-table===
:''type:'' KUID list container, the [["Kuid-table" container]].
:''desc:'' A key-value list of assets upon which this asset is dependent. The keys may be any unique value (typically, sequential integers if the keys are meaningless, or script identifiers if the asset is to be referenced from script.) Entries in this table serve two purposes - firstly, to ensure that the game systems are aware of the dependency such that installing and loading this asset will successfully install and load any dependencies, and secondly to allow scripts to locate relevant child assets. Only first-level dependencies are included. Circular dependencies are legal. An asset cannot be listed as a dependency if it is also marked as an obsolete version of this asset. An asset cannot be listed as its own dependency.

===obsolete-table===
:''type:'' KUID list container, the [["Kuid-table" container]].
:''desc:'' A key-value list of assets which are made obsolete by this asset. Any attempt to load an asset referenced in this list will result in this asset being loaded instead. The assets referenced in this list must have the same creator as this asset. It is illegal for two assets to both mark a third asset obsolete, unless one of the two also marks the other as obsolete. Circular obsolete references are illegal. All lower-numbered KUID2 versions of this asset are implied as obsolete and need not be included in this list. It is illegal to mark a higher-numbered KUID2 version of this asset as obsolete as that creates an implicit circular reference.

===category-region===
:''type:'' string.
:''desc:'' A list of two-character [[Category Region]] codes, separated by semi-colons (';'). No other characters (including whitespace, etc.) should be present in the string. This asset is considered relevant to each of the specified regions - this is most relevant for [[KIND Traincar]] and [[KIND MOSignal]] assets, but may be supplied for any asset.

===category-class===
:''type:'' string.
:''desc:'' A single 2-3 character [[Category Class]] code which describes this content item. The ''category-class'' tag is used to provide additional human sub-categorization beyond what is implicit from the Asset Kind. Note that many category-class codes are only relevant to specific Asset Kinds - category-class codes must not be applied to assets of an inappropriate Kind.

===category-era===
:''type:'' string.
:''desc:'' A list of five-character [[era code]]s, separated by semi-colons (';'). Each era code token must be an exact match for one of the specified legal [[era code]]s. No other characters (including whitespace, etc.) should be present in the string. This asset is considered relevant to the specified era range.

===category-keyword===
:''type:'' UTF-8 string.
:''desc:'' A list of natural-language keywords, separated by semi-colons (';'). No other characters (including whitespace or irrelevant punctuation) should be present in the string. These keywords form the basis for asset keyword searching. The asset's name need not be repeated in the ''category-keyword'' list. Various [[default search keywords]] are supplied automatically based on the asset type.

===custom-category-list===
:''type:'' ascii string.
:''desc:'' A list of custom category identifiers, separated by semi-colons (';'). Each [[custom category identifier]] should be a short (eg. 3-6 character) alphanumeric token. No other characters (including whitespace) should be present in the string. These custom categories are used to enable scripts to rapidly locate certain classes of asset. It is strongly recommended that new custom category identifiers are introduced sparingly. The ''custom-category-list'' tag value may have no more than 64 characters total. This tag should be left blank unless there is an existing specific script requirement that can only be fulfilled via the custom-category-list approach.

===must-have-product-rights===
:''type:'' ascii string.
:''desc:'' A list of required product rights, separated by semi-colons (';'). If the local installation does not have the required product rights then the asset may not be loaded by certain game systems.

===must-not-have-product-rights===
:''type:'' ascii string.
:''desc:'' A list of conflicting product rights, separated by semi-colons (';'). If the local installation has one of the listed product rights then the asset may not be loaded by certain game systems.

===privileges===
:''type:'' The [["privileges" container]].
:''desc:'' A set of privileges set by the asset creator to control how this asset can be used.

===thumbnails===
:''type:'' The [["Thumbnails" container]].
:''desc:'' The thumbnail(s) which are used to represent this asset in 2D preview boxes, lists, and icon form throughout the game environment (including in-game, in [[Content Manager]], and on the [[Download Station]].)

===extensions===
:''type:'' The [["Extensions" container]].
:''desc:'' A set of extended attributes which provide additional information to scripts beyond the [[Config.txt file]] specifications defined for this asset type. Care should be taken to abide by the extensions naming guidelines when creating a new extension, and to abide by the extension-creator's guidelines when providing data for an existing extension. Auran reserves the right to add validation for specific entries in the [["Extensions" container]] at a later date, based on the extension-creator's guidelines.

===license===
:''type:'' UTF-8 multi-line string.
:''desc:'' A license describing how the asset creator would like this asset to be used. The meaning of the ''license'' tag is ambiguous and its usage is not recommended. Content uploaded to the [[Download Station]] or provided for inclusion into the game may be under a specific redistribution contract or license agreement which supersedes any text in this field. The license field does not provide for localization support. The text of the license field is not validated or enforced by Auran and may or may not be legally binding to end users.

===author===
:''type:'' UTF-8 string.
:''desc:'' The author's name or mark. The use of this field is not recommended as attribution can be determined programmatically.

===organisation===
:''type:'' UTF-8 string.
:''desc:'' The name or mark of the organization responsible for the creation of this asset. The use of this field is not recommended as attribution can be determined programmatically.

===contact-email===
:''type:'' email address string.
:''desc:'' The contact email address for the creator of this asset. The use of this field is not recommended as attribution can be determined programmatically and contact details can be registered against the creator's [[Planet Auran account]] where they can be limited or updated as necessary.

===contact-website===
:''type:'' URL string.
:''desc:'' The contact website for the creator of this asset. The use of this field is not recommended as attribution can be determined programmatically and contact details can be registered against the creator's [[Planet Auran account]] where they can be limited or updated as necessary.

===info-url===
:''type:'' URL string.
:''desc:'' A link to an online description of this asset. The URL must resolve to a site within the [[Trainz Online Security Zone]]. The use of custom [[Trainz Short URL]] formats is recommended to future-proof the URL against possible future site layout changes. Where this tag is present, in-game buttons are provided to allow the user to view the asset description without leaving the game environment. It is recommended that generic group pages are used for entire classes of asset in any case where the assets provide similar functionality but minor differences in appearance. This reduces the time-expense of creating, maintaining and localizing such documentation.

===member-of-groups===
:''type:'' [["Member-of-groups" container]].
:''desc:'' A list of [[KIND Asset-group]] assets to which this asset belongs. See the [[KIND Asset-group]] documentation for details on how and when this is used.
{{void|
===Downloads===
''Attach sample files here''
}}

==Categories==
[[Category:Asset KIND|$BaseSpec]]
{{ORP-bot|$BaseSpec}}
<div>{{FUN-bot|$BaseSpec}}

"Category-region" tag

2013-10-14T06:27:49Z

Jamesmoody: Fix example region code to be valid

{{FUN-beg}}{{ORP-top}}
==About Category-region codes==
'''Category-region codes''' are a single ("UK") or multiple codes ("AU;DE;UK;US") in a quoted string that is included in the config.txt file for user defined filters.
* Assets with narrow single country scope would contain a single code after the tagname.
* Assets which were widely found in many regions (e.g. ''''Caterpillar D7 bulldozer'''', will list the series of country codes of the region.)
** The codes have only a minor importance in TRAINZ and are primarily used in Trainz as a sort and selection criteria in user defined filters.
* For content that exists in multiple areas, when creating new assets, select appropriate codes in [[Content Creator Plus]] (CCP).
** For example, a locomotive that was available in the United States and Canada would be specified as follows:

category-region "US;CA"

==Tables of codes==
<big>'''The category-region codes below are in alphabetical order by sort criteria.

Legal codes that are recognized by Trainz are as follows:'''</big>

===by region code order===
{|
|-
! AD-EE || EG-LI || LK-SC || SD-ZZ
|-valign="top"
|
# AD Andorra
# AE United Arab Emirates
# AF Afghanistan
# AG Antigua and Barbuda
# AI Anguilla
# AL Albania
# AM Armenia
# AN Netherland Antilles
# AO Angola
# AQ Antarctica
# AR Argentina
# AS American Samoa
# AT Austria
# AU Australia
# AW Aruba
# AZ Azerbaidjan
# BA Bosnia-Herzegovina
# BB Barbados
# BD Bangladesh
# BE Belgium
# BF Burkina Faso
# BG Bulgaria
# BH Bahrain
# BI Burundi
# BJ Benin
# BM Bermuda
# BN Brunei Darussalam
# BO Bolivia
# BR Brazil
# BS Bahamas
# BT Buthan
# BV Bouvet Island
# BW Botswana
# BY Belarus
# BZ Belize
# CA Canada
# CC Cocos (Keeling) Isl.
# CF Central African Rep.
# CG Congo
# CH Switzerland
# CI Ivory Coast
# CK Cook Islands
# CL Chile
# CM Cameroon
# CN China
# CO Colombia
# CR Costa Rica
# CS Czechoslovakia
# CU Cuba
# CV Christmas Island
# CY Cyprus
# CZ Czech Republic
# DE Germany
# DJ Djibouti
# DK Denmark
# DM Dominica
# DO Dominican Republic
# DZ Algeria
# EC Ecuador
# EE Estonia
|
# EG Egypt
# EH Western Sahara
# ES Spain
# ET Ethiopia
# FI Finland
# FJ Fiji
# FK Falkland Isl.(Malvinas)
# FM Micronesia
# FO Faroe Islands
# FR France
# GA Gabon
# GB Great Britain
# GD Grenada
# GE Georgia
# GH Ghana
# GI Gibraltar
# GL Greenland
# GP Guadeloupe (Fr.)
# GQ Equatorial Guinea
# GF Guyana (Fr.)
# GM Gambia
# GN Guinea
# GR Greece
# GT Guatemala
# GU Guam (US)
# GW Guinea Bissau
# GY Guyana
# HK Hong Kong
# HM Heard & McDonald Isl.
# HN Honduras
# HR Croatia
# HT Haiti
# HU Hungary
# ID Indonesia
# IE Ireland
# IL Israel
# IN India
# IO British Indian O. Terr.
# IQ Iraq
# IR Iran
# IS Iceland
# IT Italy
# JM Jamaica
# JO Jordan
# JP Japan
# KE Kenya
# KG Kirgistan Ex-USSR
# KH Cambodia
# KI Kiribati
# KM Comoros
# KN St.Kitts Nevis Anguilla
# KP Korea (North)
# KR Korea (South)
# KW Kuwait
# KY Cayman Islands
# KZ Kazachstan
# LA Laos
# LB Lebanon
# LC Saint Lucia
# LI Liechtenstein
|
# LK Sri Lanka
# LR Liberia
# LS Lesotho
# LT Lithuania
# LU Luxembourg
# LV Latvia
# LY Libya
# MA Morocco
# MC Monaco
# MD Moldavia Ex-USSR
# MG Madagascar
# MH Marshall Islands
# ML Mali
# MM Myanmar
# MN Mongolia
# MO Martinique (Fr.)
# MR Mauritania
# MS Montserrat
# MT Malta
# MU Mauritius
# MV Maldives
# MW Malawi
# MX Mexico
# MY Malaysia
# MZ Mozambique
# NA Namibia
# NC New Caledonia (Fr.)
# NE Niger
# NF Norfolk Island
# NG Nigeria
# NI Nicaragua
# NL Netherlands
# NO Norway
# NP Nepal
# NR Nauru
# NT Neutral Zone
# NU Niue
# NZ New Zealand
# OM Oman
# PA Panama
# PE Peru
# PF Polynesia (Fr.)
# PG Papua New Guinea
# PH Philippines
# PK Pakistan
# PL Poland
# PM St. Pierre & Miquelon
# PN Pitcairn
# PT Portugal
# PR Puerto Rico (US)
# PW Palau
# PY Paraguay
# QA Qatar
# RE Reunion (Fr.)
# RO Romania
# RU Russian Federation Ex-USSR
# RW Rwanda
# SA Saudi Arabia
# SB Solomon Islands
# SC Seychelles
|
# SD Sudan
# SE Sweden
# SG Singapore
# SH St. Helena
# SI Slovenia
# SJ Svalbard & Jan Mayen Is
# SK Slovak Republic
# SL Sierra Leone
# SM San Marino
# SN Senegal
# SO Somalia
# SR Suriname
# ST St. Tome and Principe
# SU Soviet Union
# SV El Salvador
# SY Syria
# SZ Swaziland
# TC Turks & Caicos Islands
# TD Chad
# TF French Southern Terr.
# TG Togo
# TH Thailand
# TJ Tadjikistan Ex-USSR
# TK Tokelau
# TL East Timor
# TM Turkmenistan Ex-USSR
# TN Tunisia
# TO Tonga
# TR Turkey
# TT Trinidad & Tobago
# TV Tuvalu
# TW Taiwan
# TZ Tanzania
# UA Ukraine
# UG Uganda
# UK United Kingdom
# UM US Minor outlying Isl.
# US United States
# UY Uruguay
# UZ Uzbekistan Ex-USSR
# VA Vatican City State
# VC St.Vincent & Grenadines
# VE Venezuela
# VG Virgin Islands (British)
# VI Virgin Islands (US)
# VN Vietnam
# VU Vanuatu
# WF Wallis & Futuna Islands
# WS Samoa
# YE Yemen
# YU Yugoslavia
# ZA South Africa
# ZM Zambia
# ZR Zaire
# ZW Zimbabwe
|}

===by country name order===

{|
|''' Aa—Ear || Eas— Ecu || Les—Lib || San—Sau'''
|- valign="top"
|
# Afghanistan AF
# Albania AL
# Algeria DZ
# American Samoa AS
# Andorra AD
# Angola AO
# Anguilla AI
# Antarctica AQ
# Antigua and Barbuda AG
# Argentina AR
# Armenia AM
# Aruba AW
# Australia AU
# Austria AT
# Azerbaidjan AZ
# Bahamas BS
# Bahrain BH
# Bangladesh BD
# Barbados BB
# Belarus BY
# Belgium BE
# Belize BZ
# Benin BJ
# Bermuda BM
# Bolivia BO
# Bosnia-Herzegovina BA
# Botswana BW
# Bouvet Island BV
# Brazil BR
# British Indian O. Terr. IO
# Brunei Darussalam BN
# Bulgaria BG
# Burkina Faso BF
# Burundi BI
# Buthan BT
# Cambodia KH
# Cameroon CM
# Canada CA
# Cayman Islands KY
# Central African Rep. CF
# Chad TD
# Chile CL
# China CN
# Christmas Island CV
# Cocos (Keeling) Is CC
# Colombia CO
# Comoros KM
# Congo CG
# Cook Islands CK
# Costa Rica CR
# Croatia HR
# Cuba CU
# Cyprus CY
# Czech Republic CZ
# Czechoslovakia CS
# Denmark DK
# Djibouti DJ
# Dominica DM
# Dominican Republic DO
# East Timor TL
|
# Ecuador EC
# Egypt EG
# El Salvador SV
# Equatorial Guinea GQ
# Estonia EE
# Ethiopia ET
# Falkland Isl.(Malvinas) FK
# Faroe Islands FO
# Fiji FJ
# Finland FI
# France FR
# French Southern Terr. TF
# Gabon GA
# Gambia GM
# Georgia GE
# Germany DE
# Ghana GH
# Gibraltar GI
# Great Britain GB
# Greece GR
# Greenland GL
# Grenada GD
# Guadeloupe (Fr.) GP
# Guam (US) GU
# Guatemala GT
# Guinea GN
# Guinea Bissau GW
# Guyana GY
# Guyana (Fr.) GF
# Haiti HT
# Heard & McDonald Isl. HM
# Honduras HN
# Hong Kong HK
# Hungary HU
# Iceland IS
# India IN
# Indonesia ID
# Iran IR
# Iraq IQ
# Ireland IE
# Israel IL
# Italy IT
# Ivory Coast CI
# Jamaica JM
# Japan JP
# Jordan JO
# Kazachstan KZ
# Kenya KE
# Kirgistan Ex-USSR KG
# Kiribati KI
# Korea (North) KP
# Korea (South) KR
# Kuwait KW
# Laos LA
# Latvia LV
# Lebanon LB
# Lesotho LS
|
# Liberia LR
# Libya LY
# Liechtenstein LI
# Lithuania LT
# Luxembourg LU
# Madagascar MG
# Malawi MW
# Malaysia MY
# Maldives MV
# Mali ML
# Malta MT
# Marshall Islands MH
# Martinique (Fr.) MO
# Mauritania MR
# Mauritius MU
# Mexico MX
# Micronesia FM
# Moldavia Ex-USSR MD
# Monaco MC
# Mongolia MN
# Montserrat MS
# Morocco MA
# Mozambique MZ
# Myanmar MM
# Namibia NA
# Nauru NR
# Nepal NP
# Netherland Antilles AN
# Netherlands NL
# Neutral Zone NT
# New Caledonia (Fr.) NC
# New Zealand NZ
# Nicaragua NI
# Niger NE
# Nigeria NG
# Niue NU
# Norfolk Island NF
# Norway NO
# Oman OM
# Pakistan PK
# Palau PW
# Panama PA
# Papua New Guinea PG
# Paraguay PY
# Peru PE
# Philippines PH
# Pitcairn PN
# Poland PL
# Polynesia (Fr.) PF
# Portugal PT
# Puerto Rico (US) PR
# Qatar QA
# Reunion (Fr.) RE
# Romania RO
# Russian Federation Ex-USSR RU
# Rwanda RW
# Saint Lucia LC
# Samoa WS
# San Marino SM
|
# Saudi Arabia SA
# Senegal SN
# Seychelles SC
# Sierra Leone SL
# Singapore SG
# Slovak Republic SK
# Slovenia SI
# Solomon Islands SB
# Somalia SO
# South Africa ZA
# Soviet Union SU
# Spain ES
# Sri Lanka LK
# St. Helena SH
# St. Pierre & Miquelon PM
# St. Tome and Principe ST
# St.Kitts Nevis Anguilla KN
# St.Vincent & Grenadines VC
# Sudan SD
# Suriname SR
# Svalbard & Jan Mayen Is SJ
# Swaziland SZ
# Sweden SE
# Switzerland CH
# Syria SY
# Tadjikistan Ex-USSR TJ
# Taiwan TW
# Tanzania TZ
# Thailand TH
# Togo TG
# Tokelau TK
# Tonga TO
# Trinidad & Tobago TT
# Tunisia TN
# Turkey TR
# Turkmenistan Ex-USSR TM
# Turks & Caicos Islands TC
# Tuvalu TV
# Uganda UG
# Ukraine UA
# United Arab Emirates AE
# United Kingdom UK
# United States US
# Uruguay UY
# US Minor outlying Isl. UM
# Uzbekistan Ex-USSR UZ
# Vanuatu VU
# Vatican City State VA
# Venezuela VE
# Vietnam VN
# Virgin Islands (British) VG
# Virgin Islands (US) VI
# Wallis & Futuna Islands WF
# Western Sahara EH
# Yemen YE
# Yugoslavia YU
# Zaire ZR
# Zambia ZM
# Zimbabwe ZW
|}
==Notes==
==Categories==
[[Category:Config Tag]]
{{ORP-bot}}<div>{{FUN-bot}}

TRS2004

2013-10-09T03:09:32Z

Jamesmoody: List of included routes

{{TOL-ref-top}}
{{FUN-beg}}
{{TOCright}}

==TRS2004==

As Engineer, immerse yourself in a totally interactive, realistic world. Choose from high-speed passenger runs, shunting cars in a busy industrial yard, or carefully navigating a 200 ton logging train down a steep mountain range.

As Yardmaster, manage your Drivers as they carry out their daily tasks. Ensure your trains are in the right place at the right time to keep pace with supply and demand of the interactive industries.

As Route Builder, create your own stunning routes and worlds.
As Operations Manager, set industry production levels, commodity requirements and create multiple task lists for your Drivers in a few simple steps

==New Features since UTC==
===Interactive Industries===
*Industry resource model with goods and resources are produced and consumed
*Adjustable industry output rates and capacity
*Industries that automatically generate waybills when goods and resources are required
*Animated loading and unloading
*Cars get heavier when loaded
*Set limits on which cars can pick up which goods
===AI Drivers===
*Allocate drivers and give them orders to load, unload, decouple etc
*Queue orders and repeat
*Name your drivers and even customize their photographs
*Run multiple trains simultaneously with AI trains path-finding their way to destinations
===Create your own Activities===
*Rules system brings the power of scripting to the average user
*Add new rules to expand functionality
*Create Html web pages to introduce your driver sessions to others
*Create and save different driver sessions for each route with different locos, start times and industry parameters
*Hotkey to jump straight from Surveyor to Driver
*Driver Sessions can be exported with your route

===Integration of locos and rolling stock into Surveyor===
*Place locos and rolling stock in Surveyor
*Name and save favorite consists for quick placement
*Test overpass heights and signals, track lengths and more
*Favorites listing from Railyard (My Collection) carried over to Surveyor
===Steam===
*Steam engines fully supported including real world physics
*Scripted Signaling for advanced functionality
*Semaphore Signals introduced
===Other features===
*Multiple save game slots
*Free roaming camera in Driver
*Per axle track sounds
*Synchronized steam engine sounds
*Long horn blasts
*New adjustable water system (color, wave height, reflection)
*Gamma slider to adjust game brightness
*New Trainz Helper downloading utility finds and installs all dependent items

===New improvements===
*Improved graphics such as bump mapping and specular highlights
*Improved headlights
*Overall lighting model improved
*Improved particle effects
*Performance on like-for-like routes improved by 10-50% (depending on your system)
*2D Map View - labels, switches and signals easier to see
*Online systems improved for searching and uploading
*Content Dispatcher allows which version to install into for custom content
*AI stops closer to red lights
*Wider field of view in cab

==Routes Included==

*Banks Heath
*British Midlands
*British Midlands 2
*City and Country USA
*City and Country USA 2
*Electric Commuter
*Glasgow to Falkirk
*Highland Valley
*Highland Valley Industries
*Industrial Wasteland
*Outback Australia
*Outback Australia 2
*Queensland
*Robe River Iron
*Rosworth Vale SP2
*The Black Forest
*Tidewater Point Rail
*Wadalbavale to Karrah Bay
*Winter in the Alps

[[Category:Trainz Versions]]

{{FUN-bot}}
{{TOL-ref-bot}}

User talk:Jamesmoody

2013-08-21T02:39:17Z

Jamesmoody: TrainzDev doesn't follow NPOV.

User talk:Jamesmoody

2013-08-21T02:27:28Z

Jamesmoody: :facepalm:

Talk:TADDaemon

2013-08-21T00:10:27Z

Jamesmoody: /* Flawed design */

==Flawed design==
If this is true about the shut-down

: ... which it isn't.
:
: Hard killing any database is problematic, and this is no exception. But in normal usage this condition won't be encountered. You'd have to either 'end task' or hard power the machine off with the database still running. You've got a window of about 5 seconds between Trainz or CM closing and TADDaemon shutting down. Even then, TADdaemon generally just does a quick database repair and picks up where it left off. A full repair is very rarely necessary.
: Same issue was seen before we split the database into TADDaemon - sometimes Trainz would just take forever to start with a black screen, normally associated with a game crash. At least if Trainz does manage to crash now TADDaemon (and the database) is still fine.
:
: Oh, and TADDaemon existing means running Trainz and CM at the same time (or even multiple copies of CM) is absolutely fine. Previously it would be a whole nasty series of black screen pauses waiting for access to the files. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]])

You need to modify it so ''there is a busy indication'' visible in widows and a popup reminder message requiring a Button click to leave Trainz screens... telling the user to not shut down window until and unless the TADDaemon tab closes is good programming. Leaving people guessing when they may need to reboot is (profanity removed) programming.

: ... also a completely untrue statement. Doing a normal shut down (i.e. just clicking 'shut down' and waiting) is fine. Trainz and CM honour the normal windows requested shutdown commands, and TADDaemon will quit before Windows gets to the prompt for 'end task'. I've tested this - I /know/ it works. However, Immediately hard-powering off the machine (not shutting down) going through task manager and doing an 'end task' on TADDaemon will cause a database repair on next startup. [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]])

* Another case of (... please quit it with the profanity already... ) programming: Both ASSETS.* files were killed and Zero length on my tower July 3rd by an unexpected line surge, causing a hard computer shut down. Please note, the CM 3.3 version running had been up CONSTANTLY for over 36 hours, with no activity asked for or requested. I never got back to look at it. IT WAS TOTALLY IDLE AND '''''should never have'' updated anything!'''

WHAT USE IS A BACKUP THAT IS OPEN AT THE AME TIME AS A SOURCE/USE FILE!
# You should start Trainz renaming Assets.bku to a safe name
# COPYING the current unchanged Assets.tdx (ONLY ONCE IT'S '''about to be''' CHANGED!) to the Assets.bku name in the cache.
# Then play with Assets.tdx and leave the .BKU alone.
You programmers need to leave windows files with the right time stamps in general. There is no excuse to be affecting modification time WHATEVER unless CM is writing the file with an auto-fix. CM doesn't do that and shouldn't outside of Hot fixes and service packs. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 14:05, 5 July 2013 (EST)

: There are many stages between code calling flush and actually getting a solid representation on disk. Most of them an arms race between reliability, performance, and over use of the various flush calls that have happened between 1976 and now. No modern operating system fully respects the original intention of Flush() any more - and even the hardware doesn't truly do that any more. SSD's "write" data into a circular buffer, and then go and re-write it into the actual location later, for example. There has been reports of specific SSDs bricking if hard powered off at exactly the wrong moment. You'd hope they'd have enough capacitors in them to avoid that - but apparently not even that is guaranteed.
:
: Also, please note that one unfortunate incident for one user where a power surge required an (apparently extended) DB repair isn't something to be adding to our official documentation. Particularly in what appears to be a profanity filled rant. Nor, when I delete said rant, is it to be restored citing "vandalism"... [[User:Jamesmoody|Jamesmoody]] ([[User talk:Jamesmoody|talk]])

Talk:TADDaemon

2013-08-21T00:06:30Z

Jamesmoody: /* Flawed design */

==Flawed design==
If this is true about the shut-down

:: ... which it isn't.

:: Hard killing any database is problematic, and this is no exception. But in normal usage this condition won't be encountered. You'd have to either 'end task' or hard power the machine off with the database still running. You've got a window of about 5 seconds between Trainz or CM closing and TADDaemon shutting down. Even then, TADdaemon generally just does a quick database repair and picks up where it left off. A full repair is very rarely necessary.

:: Same issue was seen before we split the database into TADDaemon - sometimes Trainz would just take forever to start with a black screen, normally associated with a game crash. At least if Trainz does manage to crash now TADDaemon (and the database) is still fine.

:: Oh, and TADDaemon existing means running Trainz and CM at the same time (or even multiple copies of CM) is absolutely fine. Previously it would be a whole nasty series of black screen pauses waiting for access to the files.

You need to modify it so ''there is a busy indication'' visible in widows and a popup reminder message requiring a Button click to leave Trainz screens... telling the user to not shut down window until and unless the TADDaemon tab closes is good programming. Leaving people guessing when they may need to reboot is (profanity removed) programming.

:: ... also a completely untrue statement. Doing a normal shut down (i.e. just clicking 'shut down' and waiting) is fine. Trainz and CM honour the normal windows requested shutdown commands, and TADDaemon will quit before Windows gets to the prompt for 'end task'. I've tested this - I /know/ it works. However, Immediately hard-powering off the machine (not shutting down) going through task manager and doing an 'end task' on TADDaemon will cause a database repair on next startup.

* Another case of (... please quit it with the profanity already... ) programming: Both ASSETS.* files were killed and Zero length on my tower July 3rd by an unexpected line surge, causing a hard computer shut down. Please note, the CM 3.3 version running had been up CONSTANTLY for over 36 hours, with no activity asked for or requested. I never got back to look at it. IT WAS TOTALLY IDLE AND '''''should never have'' updated anything!'''

WHAT USE IS A BACKUP THAT IS OPEN AT THE AME TIME AS A SOURCE/USE FILE!
# You should start Trainz renaming Assets.bku to a safe name
# COPYING the current unchanged Assets.tdx (ONLY ONCE IT'S '''about to be''' CHANGED!) to the Assets.bku name in the cache.
# Then play with Assets.tdx and leave the .BKU alone.
You programmers need to leave windows files with the right time stamps in general. There is no excuse to be affecting modification time WHATEVER unless CM is writing the file with an auto-fix. CM doesn't do that and shouldn't outside of Hot fixes and service packs. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 14:05, 5 July 2013 (EST)

:: There are many stages between code calling flush and actually getting a solid representation on disk. Most of them an arms race between reliability, performance, and over use of the various flush calls that have happened between 1976 and now. No modern operating system fully respects the original intention of Flush() any more - and even the hardware doesn't truly do that any more. SSD's "write" data into a circular buffer, and then go and re-write it into the actual location later, for example. There has been reports of specific SSDs bricking if hard powered off at exactly the wrong moment. You'd hope they'd have enough capacitors in them to avoid that - but apparently not even that is guaranteed.

:: Also, please note that one unfortunate incident for one user where a power surge required an (apparently extended) DB repair isn't something to be adding to our official documentation. Particularly in what appears to be a profanity filled rant. Nor, when I delete said rant, is it to be restored citing "vandalism"...

"Username" tag

2013-08-20T06:36:33Z

Jamesmoody: Rollback - The most important page content was moved across to the right hand edge, which is undesirable.

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

"Thumbnails" container

2013-08-20T03:07:55Z

Jamesmoody: references to old names may assist older content creators to realise how to link old data into this datastructure. Particularly, the reference to 'DLS' in the filename of the 512x512 is confusing - it has never been associated with the DLS.

{{ORP-beg}}
The '''thumbnail''' container is part of the [[TrainzBaseSpec]] so any asset may specify a thumbnail or preview image. This obviously makes more sense in some cases than in others, but certain circumstances, such as DLS requirements requires some imagery for even sounds. The exact usage of this image may vary depending on the asset kind and the build of Trainz, but the following usages are historically common:

* 32x32 - standard icon representation for display in lists.
* 128x64 - ‘kind traincar’ list icon in Surveyor.
* 512x512 - ‘kind traincar’ preview image in Surveyor.
* 240x180 - Download Station thumbnail image - mandatory, and must be in JPEG format.
**For assets which have no physical appearance (engine-specs, scenery sounds, etc.) content creators tend to make up a stock splash screen sort of self-advertising image.

''Note: The Art files directory used in old versions of Trainz should no longer be used- the Thumbnails container replaces and extends this functionality.''

Any number of thumbnail entries may be present, however it is recommended that no more than 3 images are used. The specified width and height must match the actual width and height of the image file in pixels.

The DLS thumbnail is a general view of the asset, and may include identifying text or logos.

The minimum for rolling stock is the DLS thumbnail (240x180, JPEG) and the list icon for Surveyor (128x64). The list icon should show the rolling stock asset in a full side-on view, with a transparent background. The image should be centered horizontally, and with the base of the asset (the track level) at the vertical center. This arrangement means that the asset displays correctly in the Surveyor list, in the drivers list in QuickDrive, and also in the consist display that is provided at the bottom of the Surveyor screen. Since a transparent background is required, a 32-bit tga file format (referenced from a .texture.txt file) is recommended.

Supported image formats include:
* 32-bit uncompressed targa (.tga) - this supports an alpha channel
* 24-bit windows bitmap (.bmp)
* JPEG (.jpg) - a 240x180 JPEG format thumbnail is required for the download station.
* [[Texture file]] (.texture.txt) - strongly recommended. This format should be used for everything other than the DLS format thumbnail.

When displaying an image, the closest-sized image required by the function (in terms of pixel dimensions) will generally be used in Trainz.
The container numbers are simply identifiers and have no meaning in themselves.

thumbnails
{
0
{
width 32
height 32
image "icon-32.texture"
}
1
{
width 128
height 64
image "vehicle-art-icon.texture"
}
2
{
width 240
height 180
image "$screenshot$.jpg"
}
3
{
width 512
height 512
image "vehicle-art-512.texture"
}
}

[[Category:Config Container|thumbnails container]]
{{ORP-bot|thumbnails container}}

"Thumbnails" container

2013-08-20T03:00:34Z

Jamesmoody: For best results, in-game icons should use references to textures, rather than direct to images.

{{ORP-beg}}
The '''thumbnail''' container is part of the [[TrainzBaseSpec]] so any asset may specify a thumbnail or preview image. This obviously makes more sense in some cases than in others, but certain circumstances, such as DLS requirements requires some imagery for even sounds. The exact usage of this image may vary depending on the asset kind and the build of Trainz, but the following usages are historically common:

* 32x32 - standard icon representation for display in lists.
* 128x64 - ‘kind traincar’ list icon in Surveyor.
* 512x512 - ‘kind traincar’ preview image in Surveyor.
* 240x180 - Download Station thumbnail image - mandatory, and must be in JPEG format.
**For assets which have no physical appearance (engine-specs, scenery sounds, etc.) content creators tend to make up a stock splash screen sort of self-advertising image.

''Note: The Art files directory used in old versions of Trainz should no longer be used- the Thumbnails container replaces and extends this functionality.''

Any number of thumbnail entries may be present, however it is recommended that no more than 3 images are used. The specified width and height must match the actual width and height of the image file in pixels.

The DLS thumbnail is a general view of the asset, and may include identifying text or logos.

The minimum for rolling stock is the DLS thumbnail (240x180, JPEG) and the list icon for Surveyor (128x64). The list icon should show the rolling stock asset in a full side-on view, with a transparent background. The image should be centered horizontally, and with the base of the asset (the track level) at the vertical center. This arrangement means that the asset displays correctly in the Surveyor list, in the drivers list in QuickDrive, and also in the consist display that is provided at the bottom of the Surveyor screen. Since a transparent background is required, a 32-bit tga file format (referenced from a .texture.txt file) is recommended.

Supported image formats include:
* 32-bit uncompressed targa (.tga) - this supports an alpha channel
* 24-bit windows bitmap (.bmp)
* JPEG (.jpg)
* [[Texture file]] (.texture.txt) - strongly recommended.

When displaying an image, the closest-sized image required by the function (in terms of pixel dimensions) will generally be used in Trainz.
The container numbers are simply identifiers and have no meaning in themselves.

thumbnails
{
0
{
width 32
height 32
image "thumbnail-32.texture"
}
1
{
width 128
height 64
image "Surveyor-thumb-128.texture"
}
2
{
width 240
height 180
image "$screenshot$.jpg"
}
3
{
width 512
height 512
image "Big4DLS_screenshot.jpg"
}
}

[[Category:Config Container|thumbnails container]]
{{ORP-bot|thumbnails container}}

Talk:TADDaemon

2013-08-20T02:51:13Z

Jamesmoody:

==Flawed design==
If this is true about the shut-down

... which it isn't.

Hard killing any database is problematic, and this is no exception. But in normal usage this condition won't be encountered. You'd have to either 'end task' or hard power the machine off with the database still running. You've got a window of about 5 seconds between Trainz or CM closing and TADDaemon shutting down. Even then, TADdaemon generally just does a quick database repair and picks up where it left off. A full repair is very rarely necessary.

Same issue was seen before we split the database into TADDaemon - sometimes Trainz would just take forever to start with a black screen, normally associated with a game crash. At least if Trainz does manage to crash now TADDaemon (and the database) is still fine.

Oh, and TADDaemon existing means running Trainz and CM at the same time (or even multiple copies of CM) is absolutely fine. Previously it would be a whole nasty series of black screen pauses waiting for access to the files.

You need to modify it so ''there is a busy indication'' visible in widows and a popup reminder message requiring a Button click to leave Trainz screens... telling the user to not shut down window until and unless the TADDaemon tab closes is good programming. Leaving people guessing when they may need to reboot is (profanity removed) programming.

... also a completely untrue statement. Doing a normal shut down (i.e. just clicking 'shut down' and waiting) is fine. Trainz and CM honour the normal windows requested shutdown commands, and TADDaemon will quit before Windows gets to the prompt for 'end task'. I've tested this - I /know/ it works. However, Immediately hard-powering off the machine (not shutting down) going through task manager and doing an 'end task' on TADDaemon will cause a database repair on next startup.

* Another case of (... please quit it with the profanity already... ) programming: Both ASSETS.* files were killed and Zero length on my tower July 3rd by an unexpected line surge, causing a hard computer shut down. Please note, the CM 3.3 version running had been up CONSTANTLY for over 36 hours, with no activity asked for or requested. I never got back to look at it. IT WAS TOTALLY IDLE AND '''''should never have'' updated anything!'''

WHAT USE IS A BACKUP THAT IS OPEN AT THE AME TIME AS A SOURCE/USE FILE!
# You should start Trainz renaming Assets.bku to a safe name
# COPYING the current unchanged Assets.tdx (ONLY ONCE IT'S '''about to be''' CHANGED!) to the Assets.bku name in the cache.
# Then play with Assets.tdx and leave the .BKU alone.
You programmers need to leave windows files with the right time stamps in general. There is no excuse to be affecting modification time WHATEVER unless CM is writing the file with an auto-fix. CM doesn't do that and shouldn't outside of Hot fixes and service packs. // [[User:Fabartus|Fra]][[User talk:Fabartus|nkB]] 14:05, 5 July 2013 (EST)

There are many stages between code calling flush and actually getting a solid representation on disk. Most of them an arms race between reliability, performance, and over use of the various flush calls that have happened between 1976 and now. No modern operating system fully respects the original intention of Flush() any more - and even the hardware doesn't truly do that any more. SSD's "write" data into a circular buffer, and then go and re-write it into the actual location later, for example. There has been reports of specific SSDs bricking if hard powered off at exactly the wrong moment. You'd hope they'd have enough capacitors in them to avoid that - but apparently not even that is guaranteed.

Also, please note that one unfortunate incident for one user where a power surge required an (apparently extended) DB repair isn't something to be adding to our official documentation. Particularly in what appears to be a profanity filled rant. Nor, when I delete said rant, is it to be restored citing "vandalism"...

User talk:Jamesmoody

2013-08-20T02:08:32Z

Jamesmoody:

Talk:TADDaemon

2013-08-20T01:47:54Z

Jamesmoody: Blanked the page

TADDaemon

2013-08-20T01:47:10Z

Jamesmoody:

== General ==

TADDaemon.exe is found in the "bin" folder and comes from ''Trainz Asset Database [http://en.wikipedia.org/wiki/Daemon_%28computing%29 Daemon]''. TADDaemon manages the database of all Trainz assets known to the installation. Trainz, Content Manager and other Trainz programs depend on it.

In addition to it's main task (maintaining the local database of Trainz assets), it is also responsible for asset validation, most internet communication, and other background tasks.

== Technical Details ==

TADDaemon ''must'' be allowed through firewall because it has to connect to the internet and to communicate with other Trainz Components.

TADDaemon will shut down when Trainz is not running. If Windows prompts to 'Wait' or 'End Task' while shutting down, choose to wait for TADDaemon to finish. Avoid using 'End Task' on TADDaemon, or it will likely need a database repair on the next start. Also avoid hard powering off the machine while TADDaemon is running, for the same reasons.

Build Numbers

2013-08-20T01:30:00Z

Jamesmoody: /* TS2009 - Trainz 2009 */

{{ORP-top}}
=Code build number=
The '''Code build number''' or '''Trainz build version''' (two names meaning the identical 'tracking number') is the unique software level identifier that increments not only with 'named' main retail releases, but with each release for specific language groups, and by {{wp|Hotfix}}es, as well as by {{wp|Service_pack}} releases. 

Initial Trainz code build versions are not released in initial retail release versions for all world wide languages at the same time, but these are produced as available translations, so typically, non-English releases lag by some months, but may have hot fixes or service packs already installed. As the translation needs are satisfied and an overall ''release stabilizes'', subsequent service pack releases apply to those code build numbers and effectively combine language releases into a merged common product. At the end of the process, the final service pack produces a ''single stable '''code build version''''', creating the final corresponding Trainz (two digit) version number and corresponding identical [["Trainz-build" tag]] level found in assets config.txt.

=Currently Supported Releases=
Trainz versions are known best by their ''''''Retail Release name'''''', after which N3V Games/Auran, following general software industry practices subsequently release bug fixing '''hot fixes''' and usually a succession of service packs. Each

:'''Note:''' ''Legacy version releases and build numbers are listed at the bottom of the page, reserving this area for currently supported versions.''
The following builds exist for [[TS2009]]. Where patches are available, these are noted beside the build number.
==TS2009 - Trainz 2009==
{{anchor|TRS2009|TS2009|Trainz2009|TRS 2009|TS 2009|Trainz 2009}}
:<big>'''Trainz 2009: World Builder Edition'''</big> 
{| border=1 cellpadding=2 cellspacing=0 style="text-align:center; "
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 37625||auto-patch to 40040||English Online Release
|-
|Build 38017||auto-patch to 40040||[[TS2009 SP1]]
|-
|Build 38411||auto-patch to 40040||English Retail
|-
|Build 38599||auto-patch to 40040||[[TS2009 SP1]] hotfix
|-
|Build 38610||PROTECTED||Steam English Retail
|-
|Build 38808||auto-patch to 41590||French Retail
|-
|Build 38824||-||Dutch Retail
|-
|Build 38869||PROTECTED||UK Retail
|-
|Build 39176||-||German Retail
|-
|Build 39413||auto-patch to 40040||Czech, Polish, Hungarian Retail
|-
|Build 39561||-||Spanish Retail
|-
|Build 39979||auto-patch to 40040
|[[TS2009 SP2]]
|-
|<big>Build 40040</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP2]] + hotfix </big>
|-
|Build 40357||-||Cabon City English Online Release
|-
|Build 40542||-||Russian Retail
|-
|Build 40702||-||Cabon City English Online Release
|-
|Build 40702||-||Treez English Online Release
|-
|Build 40762||-||Murchison English Online Release
|-
|Build 40837||-||S&C English Online Release
|-
|Build 40895||-||Spanish pre-SP3
|-
|Build 41497||-||Dutch, German pre-SP3
|-
|Build 41546||-||Italian Retail
|-
|Build 41590||-||French pre-SP3
|-
|<big>Build 41844</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP3]]</big> [[TADDaemon]] ("Trainz Asset Database Daemon") introduced
|-
|<big>Build 44653</big>
|<big>{{center|-auto-patch Common version-}}</big>
|<big>[[TS2009 SP4]]</big>
|}

==TS2010 - Trainz 2010==
:<big>'''Trainz 2010: Engineers Edition'''</big>
The following builds exist for [[TS2010]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 41491||manual patch to 41615||English Online Release
|-
|Build 41615||manual patch to 43434||[[TS2010 SP1]]
|-
|Build 41622||manual patch to 43434||English Online Release
|-
|Build 42203||manual patch to 43434||[[TS2010 SP2]] English, Swedish Retail Release
|-
|Build 42534||-||French Retail
|-
|Build 42763||-||German Retail
|-
|Build 42831||-||Dutch Retail
|-
|Build 42953||-||Russian Retail
|-
|Build 43030||-||Czech, Polish Retail
|-
|Build 43233||-||Spanish Retail
|-
|Build 43434||-||[[TS2010 SP3]]
|-
|Build 44088||-||[[TS2010 SP3]] Minor revision
|-
|Build 45467||auto patch to 46170||[[TS2010 SP4]] (including Trainz Multiplayer Beta)
|-
|Build 45607||auto patch to 46170||[[TS2010 SP4]] patch 1 (including Trainz Multiplayer Beta)
|-
|Build 46170||manual patch to 49938||[[TS2010 SP4]] patch 2 (including Trainz Multiplayer Beta)
|-
|Build 49933||-||[[TS2010 SP3]] Minor revision, added support for Aerotrain DLC
|-
|Build 49938||-||[[TS2010 SP4]] patch 3 (including Trainz Multiplayer Beta), added support for Aerotrain DLC
|-
|}

==TS12 - Trainz 2012==
:'''Trainz 2012: Anniversary Edition'''</big>
The following builds exist for [[TS12]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 46957||auto-patch to 48054||Planet Auran release version
|-
|Build 47059||auto-patch to 48054||Minor revision
|-
|Build 47103||-||Steam release
|-
|Build 47452||auto-patch to 48054||Just Trainz release version
|-
|Build 47772||auto-patch to 48054||Just Trainz release version (minor revision)
|-
|Build 48054||manual patch to 48249||Minor revision
|-
|Build 48249||manual patch to 49922||Minor revision
|-
|Build 49849||-||Czech Release
|-
|Build 49922||-||Minor revision, added support for Aerotrain DLC
|-
|Build 50027||-||German Release
|-
|Build 50406||-||French Release
|-
|Build 51054||-||Dutch Release
|-
|Build 52143||-||Russian, Japanese, Polish Release
|-
|Build 57720||-||TS12 SP1 English
|-
|Build 57825||-||TS12 SP1 Hotfix 1 English
|-
|Build 57898||-||TS12 SP1 Hotfix 2 English
|-
|Build 58414||-||TS12 SP1 Hotfix 3 English
|}

==Trainz Simulator Mac==
:<big>'''Trainz MAC'''</big>
The following builds exist for [[Trainz Simulator Mac]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 47652||-||Planet Auran Digital Store release
|-
|Build 47770||-||Third-party Digital Store release
|-
|Build 48159||-||Feral retail release
|}

= Content Builds =

Auran's newer patch technology developed for TRS2009 has the capability of updating the base Trainz version and installed add-on content independently. The following is a list of released content build versions for add-on content since the advent of TRS2009's technology. Legacy versions (Trainz UTC, Trainz TCC discussed below)

{| border=1 cellpadding=2 cellspacing=0
|'''Content Build Number'''||'''Content Patches available'''||'''Build description'''
|-
|Content Build 40355||-||Cabon City English Online Release
|-
|Content Build 40400||-||Cabon City English Online Release
|-
|Content Build 40563||-||Treez English Online Release
|-
|Content Build 40761||-||Murchison English Online Release
|-
|Content Build 40836||-||S&C English Online Release
|-
|Content Build 49210||-||Duchess Online Release
|-
|Content Build 49474||-||Duchess Steam Release
|-
|Content Build 49631||-||Coronation Scot Online Release
|-
|Content Build 49694||-||Coronation Scot Steam Release
|}
==Legacy build versions==
:''This section is being provided by the user community to make as complete a reference as possible, so is currently incomplete and may remain so.''
===Trainz 1.x===
:<big>'''Trainz 1.3'''</big>
{| border=1 cellpadding=2 cellspacing=0
|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|0.9||Build 0009 || {{center|Trainz Beta}} ||<center>wholly replaced by [[Trainz 1.0]] </center>||released in November 2000 for testing purposes to Model Railroaders.
|-
|1.0||Build 0010|| {{center|[[Trainz 1.0]]}} ||{{cdash}} || ''''''Trainz Community Edition'''''', released in December 2001
|-
|1.0||Build 0019? || {{center|[[Trainz 1.0]], non-English}} ||{{cdash}} || Trainz Community Edition 2
|-
|1.1||Build ???? || {{Cdash}} || {{center|[[Trainz 1.0| SP1]]}} || released in 2002 (April ?)
|-
|1.2||Build 0??? || {{cdash}} || {{center|[[Trainz 1.0| SP2]]}} || ''''''Trainz Retail Edition'''''' was released in June 2002 aimed at the North American markets.
|-
|1.3||Build 0263 || {{center|aka '''Trainz 1.3'''}} || {{center|[[Trainz SP3]]}} || First with TrainzScript.exe, and Scenarios, November 2002
|-
|1.0||Build 0277 || {{center|[[Trainz 1.0]], non-English}} ||{{cdash}} || Trainz Community Edition 2
|-
|1.5||Build 0377 || {{center|Trainz UTC 3 CD set}} || {{cdash}} || Ultimate Trainz Collection, released 26 November 2002 w/expanded content
|-
|1.6||Build 0404 || {{cdash}} || {{center|Trainz UTC SP1}} || Ultimate Trainz Collection SP1
|-
|1.6||Build 0033 || {{center|Paintshed}} || {{cdash}} ||1st released as part of Ultimate Trainz Collection SP1
|-
|}
===TRS2004===
'''TRS2004''' had a relatively large number of separate builds as Auran worked out methods for international names handling in various languages, plus went through a related succession of Service Packs.
{| border=1 cellpadding=2 cellspacing=1
|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|2.0||Build 668 || [[TRS2004|Trainz Railroad Simulator 2004]] || || International version (Australia and USA). Released in September 2003.
|-
|2.0||Build 686 || [[TRS2004|Trainz Railway Simulator 2004]] || || Just Trains version (UK). Requires disk in drive.
|-
|2.1||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] SP1 || || International (USA/Australia) release
|-
|2.1||Build ???? || [[TRS2004|Trainz Railway Simulator 2004]] SP1 || || Just Trains release (UK). Requires disk in drive.
|-
|2.2||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] "Passenger Edition" (SP2)|| || International (USA/Australia) release
|-
|2.2||Build 2285 || [[TRS2004|Trainz Railway Simulator 2004]] "Passenger Edition" (SP2)|| || Just Trains release (UK). Requires disk in drive.
|-
|2.3||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] SP3 || || International (USA/Australia) release
|-
|2.3||Build ???? || [[TRS2004|Trainz Railway Simulator 2004]] SP3 || ||
|-
|2.3||Build ???? || [[TRS2004#Deluxe|TRS2004 Deluxe]] || ||Trainz 2004: Deluxe Edition. Includes SP3 and additional content. Different regions received different additional content.
|-
|2.4||Build 2365 || [[TRS2004|Trainz Railroad Simulator 2004]] SP4 || || International (USA/Australia) release
|-
|2.4||Build 2370 || [[TRS2004|Trainz Railway Simulator 2004]] SP4 || || Just Trains release (UK). Requires disk in drive.
|-
|2.4||Build 2370 || [[TRS2004|Trainz Railway Simulator 2004]] SP4 || || Included in ''Trainz Collection'', but ''without'' the requirement for a disk in the drive.
|-
|}

===TRS2006 & etc.===

'''TRS2006''' had a relatively large number of separate builds as Auran worked out methods for international names handling in various languages, plus went into partnership with various 3rd party distributors giving a host of releases in various markets but only one series of related Service Packs.

{| border=1 cellpadding=2 cellspacing=1 width="100%"
|col-width="8%"|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|  2.5||Build 2761 || {{center
|[[TRS2006|TRS2006 GM]] }} ||{{cdash}} ||  Original release for Australia and USA. [[Content Creator Plus]] and [[Content Manager|Content Manager Plus]] first introduced.
|-
|  2.5||colspan="3" |'''Other Builds:''' UK release - 2773; French - 2883; Dutch - 2967;German - 2970; Spanish - 3007 ||German - was also called Pro Train Perfect or PTP
|-
|  2.5|| Build 3096 &Merscom's build 3104|| '''{{center|Trainz Driver Edition (TDE)''' ('demo version')}}|| {{cdash}} || UK release date of Trainz Driver was 24 February 2005. {{bullR}}TDE did not have CMP nor Surveyor, but did include Railyard
|-
|  2.6 || build 3092 || {{cdash}} || {{center|[[TRS2006|TRS2006 SP1]] }} || TRS2006 - Australia and North American markets
|-
|  2.6||colspan="4" |'''Other SP1 Builds:''' United Kingdom-SP1= build 3099; Spanish-SP1= build 3118
|-
|  2.6||Build 3335 || {{cdash}} || {{center|[[TRS2006#SP1|TRS2006 SP1]] }} || Vista support. Released in September 2007. Used for bundle packs - Trainz Railwayz (North American release bundled with TC1) and Trainz Complete Collection (bundled with TRS2004 SP4, UTC and Trainz Routes 1 to 4).
|-
|  2.6||Build ????|| {{center|[[TRS2007]] }} || {{cdash}} ||  French retail, equivalent to TRS2006+SP1, with some additional French content.
|-
|  2.6||Build ????|| {{center|[[TRS2007]] }} || {{cdash}} ||  German retail, equivalent to TRS2006+SP1, with a lot of additional German content.
|-
|}

===Trainz Classics===

'''Trainz Classics''' was series of releases each featuring a single route. New code features were added to each version to support that route.

{| border=1 cellpadding=2 cellspacing=1 width="100%"
|col-width="8%"|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|  2.7||Build 3337|| {{center|[[TC1|'''Trainz Classics''']]}} || {{cdash}} ||  English Retail. Released July 9th, 2007 as a bundle with both [[TC1]] and [[TC2]] content included. Released as '''Trainz Railwayz''' (bundled with an updated TRS2006) in North America.
|-
|  2.7||Build ????|| {{center|[[TRS2008]] }} || {{cdash}} ||  French Retail. Includes both TC1/TC2 and also the French 2007 content in a single build.
|-
|  2.8||Build 3529|| {{center|[[TC3|Trainz Classics 3]]}} || {{cdash}} ||  TC3 English Retail, released on July 23, 2008.
|-
|}

==Notes and references==
<big><big><code>*</code></big></big> Name usages matching information posted on {{wp|Trainz}} and the {{plain link|http://en.wikibooks.org/wiki/Trainz/Version_And_Build_Numbers|Trainz Wikibook}} Version and Build Numbers pages.

{{ORP-bot}}{{TBKr}}

User talk:Jamesmoody

2013-08-20T01:23:52Z

Jamesmoody:

ACS Coupling System

2013-08-16T02:02:13Z

Jamesmoody: /* Coupler Type */

===Introduction===

There are many and varied problems with the existing BlueStar standard - but the main ones are the inflexibility beyond the initial application (coupling mineral wagons and transition era locos), and the rather arcane numeric values put into the config.txt.

A more readable, more flexible, and preferrably easily extensible datastructure in the config.txt was needed, and some way of standardising the logic (at the very minimum, an include file, but preferrably a library). It needed to support many more different types of coupler, vehicles with different couplers on each end, and so on.

The ACS System is an extension of the BlueStar coupling standard for TRS models (effectively BlueStar V2) and provides for the effect of working couplings on rolling stock. From version 5 of the ACSLib ACS vehicles are compatible with older BlueStar/CoupleStar ones.

To add ACS couplings it is necessary to edit the asset config file, add attachment points to the mesh and to create a script or edit the existing one. Due to the fact that you need access to the source files of the asset and to be able to script it is an advanced technique that cannot easily be carried out by an end-user.

===The Attachment Points===

All of the coupler, hoses and cables are attached to two points, one on the face of the front buffer beam (a.couple0) and one on the face of the rear beam (a.couple1). a.limfront should be 0.46m forward of a.couple0 and a.limback 0.46m rearward of a.couple1. a.couple0 and a.couple1 must be at x=0 and z=0.

Create a.couple0 in top view and move it into position. Then clone and position it to create a.couple1 and rotate it 180°. The Y axis of the two coupler points should point towards 0,0,0.

[[image:acs_att_points]]

===The Config File===
First off, here is an example config.txt fragment:

<pre>
extensions {
max_permitted_speed-60850 "125mph"
active-coupling-standard-60850 {
version-major "2"
version-minor "0"
brakes "air"
front {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
back {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
}
}
</pre>

So, what does all this do, and what are the options?
====Extension Container====
<pre>
extensions {
...
}
</pre>

This is for TRS2006 compatibility - it's all going in the extensions container. This does work in TRS2004 as well. Watch for the caveat at the end though...

====Max Permitted Speed====
<pre>
Max_Permitted_Speed-60850 "125mph"
</pre>

Not strictly part of the coupling code, but may as well mention it. This is for the Max Permitted Speed rule to tell how fast this vehicle should be permitted to travel. It will tell both AI drivers and the human driver (via the Custom HUD rule) what the maximum permitted speed is for the train they are driving, based on information from each vehicle. (And in a future version of the rule, more stuff too...)
====ACS Container====
<pre>
active-coupling-standard-60850 {
...
}
</pre>

This is the container within which all the config information will be held.

====ACS Version====
<pre>
version-major "2"
version-minor "0"
</pre>

Version numbers. This is useful when later code needs to read earlier format config files. Should make extending the standard a lot easier.

====Braking System====
<pre>
brakes "air"
</pre>

Defines what type of braking system is fitted to this vehicle. Options are:
*"air"
*"vac"
*"dual"
*"none"

This is independant of what hoses are available - unbraked but through piped stock is an entirely possible combination, and is representable.

====Position====
<pre>
front {
...
}
back {
...
}
</pre>

Containers for the front and back of the vehicle. 'Front' is defined as "the a.limfront end", and 'back' "the a.limback end". Available options for both are the same, so I'll describe them just once.
====Coupler Type====
<pre>
coupler "knuckle|screwlink|hook"
</pre>

What type of coupler do we have on this end of the vehicle? Options are:
* "hook" -- connects to screwlink/instanter/3link/hst-emergency-bar.
* "3link" -- connects to hook.
* "instanter" -- connects to hook.
* "screwlink" -- connects to hook.
* "hst-emergency-bar" -- connects to hook.
* "bar-full" -- connects to "bar-none". Half of a handed pair for when one vehicle has the entire bar coupling.
* "bar-none" -- connected to by "bar-full". The other half of the handed pair.
* "bar" -- connects to self only. Used when both vehicles have half the bar coupling.
* "knuckle" - standard knuckle coupler.
* "tightlock" -- different to a standard knuckle, refers to a knuckle style coupler often fitted to multiple unit trains that also include electrical connections.
* "wedgelock" -- London Underground coupler.
* "bsi" -- Found on Sprinter DMUs and derived designs.
* "dellner" -- Also compatible with scharfenberg coupling.
* "scharfenberg" -- Also compatible with dellner coupling.
* "(other string identifier)" -- Any string that is not recognised from the above list is assumed to be a symmetrical meet-in-the-middle type of coupler.

Certain couplers are purely compatible with other identical couplers, others are inter-compatible. Some produce handed pairs - e.g. a 3 link chain couples to a hook, and wagons with this coupling are typically fitted with both a hook and a chain.

Multiple coupler options can be specified, and are separated with a vertical bar character. The earlier option is used in preference, so list the best coupler option first.

A typical unfitted freight wagon with a 3 link coupling is specified as "3link|hook". A vehicle fitted with a knuckle, screwlink and hook (e.g. a swingknuckle fitted locomotive) is specified as "knuckle|screwlink|hook". A BR coaching stock dropknuckle (a knuckle and a hook, but no chain) is specified as "knuckle|hook". If the vehicle also has an emergency screwlink which is not permanently fitted, then "knuckle|hook|screwlink" would be appropriate -- this would cause ACS to prefer the chain type coupler from the adjacent vehicle rather than using the emergency screwlink, which would only be used when necessary. A Victorian Railways transitional coupler (which has a chain and a knuckle, but no hook) is specified as "knuckle|3link".

Dellner and Scharfenberg couplings are treated as compatible, so a dellner will also couple to a scharfenberg.

If your coupler type isn't listed, define a standard name for it, and start using it. ACS supports arbitrary extension - any new coupler it hasn't seen before will be treated as a symmetrical coupler. ACS will tell you if it has connected to an identical coupler on the adjacent vehicle.

If you need a new handed pair type (where the coupler on the end of one wagon is not the same as that on the end of another), then you will need to contact the ACS author to get one added.

====Gangways====
<pre>
gangway "gangway"
</pre>

Passenger gangway between vehicles. Options are:
*"none"
*"rubbing-plate"
*"gangway"

This is really intended for coaching stock - it is assumed that all gangways are compatible. I've been considering a 'one piece' gangway option - to aid with the centre of multiple unit trains, where there is no separation point (it will help with deciding which vehicle should display the gangway) - but I'm not sure whether this is of sufficient benefit to include, as it involves a whole new set of logic here that most people won't use, and for the cases it is interesting, the same person has made both vehicles, and can therefore do it themselves... Comments please.
====Pipes for Air Brakes====
<pre>
airbrake "twin"
</pre>

Brake pipes for air brakes. Options are:
*"twin"
*"single"
*"none"

Twin is the UK standard two pipe air brake system (train pipe and brake pipe). Single is the US standard air brake system where reservoirs are charged from the brake pipe rather than the train pipe (this has appeared on some modern freightcars for reasons unknown, so is included).
====Pipes for Vac Brakes====
<pre>
vacbrake "none"
</pre>

Brake pipes for Vacuum brakes. Options are:
*"twin"
*"single"
*"high"
*"none"

Single is the UK default for fitted stock, high connections seems to be the standard on UK steam locos. Twin pipes (operating at two different vacuum levels) has been tried in the UK - and while not much fitted stock has the twin pipe system, most air brake, through vac piped stock seems to have two vac pipes.
====Multiple Working Cables====
<pre>
multiple-working "none"
</pre>

Multiple working connections. Options are:
*"(color)-(shape)" -- e.g. "blue-star" or "red-diamond", etc
*"AAR" -- as used on GM locos
*"SR27" -- bagpipes
*"(other identifier string e.g. classname)"
====Train Heating====
<pre>
heating-type "electric"
</pre>

Coach heating. Options are:
*"none"
*"steam"
*"electric" -- standard ETH
*"dual" -- both Steam and standard ETH*"southern-electric" -- The Southern, who pioneered electric train heating in the UK, fitted heating that was compatible with their DC powered EMUs, and thus ran from the same voltage as the DC power supply. When the rest of BR went ETH, different standards were adopted, resulting in the Southern having a different and incompatible ETH standard...
====Lighting Control Cables====
<pre>
rch "high"
</pre>

Through wiring for lighting control, to the Railway Clearing House standard. Also used more recently for other things - e.g. remote control via various methods - including TDM. I believe it is also used for signals to control doorlocks on stock so fitted - though I could be wrong on this. Options are:
*"high" -- positioned as is fairly standard on coaching stock
*"low" -- positioned as is fairly standard on streamlined locos, e.g. the front of a DVT, or a cl90
*"none"
====Notes====
For all of these where "none" is an option, entirely missing out that line is equivalent to stating "none". This should make stock which doesn't use most of the features much more palatable to produce. This will also help when extending the standard - as new features will automatically be assumed to be not present on stock built to older standards...

That's all very well and good, but how is this supposed to be backwards compatible with the old bluestar standard?

I'm making the code fall back to reading the old config entries if it can't find the new ones. The real problem is that new stock will also have to include config.txt entries for the old bluestar, so that old vehicles know what to do when they couple to this one. Yes, this means that the old tags will never actually go away, but at least TRS2006 doesn't whinge about them so hard as of SP1...

===The Script===

(under construction)

[[Category:Modeling]]

ACS Coupling System

2013-08-14T03:48:24Z

Jamesmoody:

===Introduction===

There are many and varied problems with the existing BlueStar standard - but the main ones are the inflexibility beyond the initial application (coupling mineral wagons and transition era locos), and the rather arcane numeric values put into the config.txt.

A more readable, more flexible, and preferrably easily extensible datastructure in the config.txt was needed, and some way of standardising the logic (at the very minimum, an include file, but preferrably a library). It needed to support many more different types of coupler, vehicles with different couplers on each end, and so on.

The ACS System is an extension of the BlueStar coupling standard for TRS models (effectively BlueStar V2) and provides for the effect of working couplings on rolling stock. From version 5 of the ACSLib ACS vehicles are compatible with older BlueStar/CoupleStar ones.

To add ACS couplings it is necessary to edit the asset config file, add attachment points to the mesh and to create a script or edit the existing one. Due to the fact that you need access to the source files of the asset and to be able to script it is an advanced technique that cannot easily be carried out by an end-user.

===The Attachment Points===

All of the coupler, hoses and cables are attached to two points, one on the face of the front buffer beam (a.couple0) and one on the face of the rear beam (a.couple1). a.limfront should be 0.46m forward of a.couple0 and a.limback 0.46m rearward of a.couple1. a.couple0 and a.couple1 must be at x=0 and z=0.

Create a.couple0 in top view and move it into position. Then clone and position it to create a.couple1 and rotate it 180°. The Y axis of the two coupler points should point towards 0,0,0.

[[image:acs_att_points]]

===The Config File===
First off, here is an example config.txt fragment:

<pre>
extensions {
max_permitted_speed-60850 "125mph"
active-coupling-standard-60850 {
version-major "2"
version-minor "0"
brakes "air"
front {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
back {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
}
}
</pre>

So, what does all this do, and what are the options?
====Extension Container====
<pre>
extensions {
...
}
</pre>

This is for TRS2006 compatibility - it's all going in the extensions container. This does work in TRS2004 as well. Watch for the caveat at the end though...

====Max Permitted Speed====
<pre>
Max_Permitted_Speed-60850 "125mph"
</pre>

Not strictly part of the coupling code, but may as well mention it. This is for the Max Permitted Speed rule to tell how fast this vehicle should be permitted to travel. It will tell both AI drivers and the human driver (via the Custom HUD rule) what the maximum permitted speed is for the train they are driving, based on information from each vehicle. (And in a future version of the rule, more stuff too...)
====ACS Container====
<pre>
active-coupling-standard-60850 {
...
}
</pre>

This is the container within which all the config information will be held.

====ACS Version====
<pre>
version-major "2"
version-minor "0"
</pre>

Version numbers. This is useful when later code needs to read earlier format config files. Should make extending the standard a lot easier.

====Braking System====
<pre>
brakes "air"
</pre>

Defines what type of braking system is fitted to this vehicle. Options are:
*"air"
*"vac"
*"dual"
*"none"

This is independant of what hoses are available - unbraked but through piped stock is an entirely possible combination, and is representable.

====Position====
<pre>
front {
...
}
back {
...
}
</pre>

Containers for the front and back of the vehicle. 'Front' is defined as "the a.limfront end", and 'back' "the a.limback end". Available options for both are the same, so I'll describe them just once.
====Coupler Type====
<pre>
coupler "knuckle|screwlink|hook"
</pre>

What type of coupler do we have on this end of the vehicle? Options are:
*"fixed-bar"
*"hook"
*"3link"
*"instanter"
*"screwlink"
*"knuckle"
*"tightlock" -- different to a standard knuckle, refers to a knuckle style coupler often fitted to multiple unit trains that also include electrical connections
*"wedgelock" -- London Underground specific
*"bsi"
*"dellner"
*"scharfenberg"
*"(other string identifier)"

Certain types are purely compatible with other identical couplers, others are inter-compatible to produce handed pairs - so a 3 link couples to a hook, and wagons are typically fitted with both.

Multiple coupler options can be specified, and are separated with a vertical bar character. A typical unfitted freight wagon with a 3 link coupling is specified as "3link|hook". The earlier option is used in preference, so list the best coupler option first.

A BR coaching stock dropknuckle is specified as "knuckle|hook". A swingknuckle is specified as "knuckle|screwlink|hook". A Victorian Railways transitional coupler is specified as "knuckle|3link" (this coupler doesn't have a hook, but does have a chain attached to the top of the knuckle).

Dellner and Scharfenberg couplings are treated as compatible. Other types that only connect to themselves can be added arbitrarily via the "other string identifier" method. Just write the standard name of the coupler in, and ACS will tell you if it has connected to an identical coupler on the adjacent vehicle.

====Gangways====
<pre>
gangway "gangway"
</pre>

Passenger gangway between vehicles. Options are:
*"none"
*"rubbing-plate"
*"gangway"

This is really intended for coaching stock - it is assumed that all gangways are compatible. I've been considering a 'one piece' gangway option - to aid with the centre of multiple unit trains, where there is no separation point (it will help with deciding which vehicle should display the gangway) - but I'm not sure whether this is of sufficient benefit to include, as it involves a whole new set of logic here that most people won't use, and for the cases it is interesting, the same person has made both vehicles, and can therefore do it themselves... Comments please.
====Pipes for Air Brakes====
<pre>
airbrake "twin"
</pre>

Brake pipes for air brakes. Options are:
*"twin"
*"single"
*"none"

Twin is the UK standard two pipe air brake system (train pipe and brake pipe). Single is the US standard air brake system where reservoirs are charged from the brake pipe rather than the train pipe (this has appeared on some modern freightcars for reasons unknown, so is included).
====Pipes for Vac Brakes====
<pre>
vacbrake "none"
</pre>

Brake pipes for Vacuum brakes. Options are:
*"twin"
*"single"
*"high"
*"none"

Single is the UK default for fitted stock, high connections seems to be the standard on UK steam locos. Twin pipes (operating at two different vacuum levels) has been tried in the UK - and while not much fitted stock has the twin pipe system, most air brake, through vac piped stock seems to have two vac pipes.
====Multiple Working Cables====
<pre>
multiple-working "none"
</pre>

Multiple working connections. Options are:
*"(color)-(shape)" -- e.g. "blue-star" or "red-diamond", etc
*"AAR" -- as used on GM locos
*"SR27" -- bagpipes
*"(other identifier string e.g. classname)"
====Train Heating====
<pre>
heating-type "electric"
</pre>

Coach heating. Options are:
*"none"
*"steam"
*"electric" -- standard ETH
*"dual" -- both Steam and standard ETH*"southern-electric" -- The Southern, who pioneered electric train heating in the UK, fitted heating that was compatible with their DC powered EMUs, and thus ran from the same voltage as the DC power supply. When the rest of BR went ETH, different standards were adopted, resulting in the Southern having a different and incompatible ETH standard...
====Lighting Control Cables====
<pre>
rch "high"
</pre>

Through wiring for lighting control, to the Railway Clearing House standard. Also used more recently for other things - e.g. remote control via various methods - including TDM. I believe it is also used for signals to control doorlocks on stock so fitted - though I could be wrong on this. Options are:
*"high" -- positioned as is fairly standard on coaching stock
*"low" -- positioned as is fairly standard on streamlined locos, e.g. the front of a DVT, or a cl90
*"none"
====Notes====
For all of these where "none" is an option, entirely missing out that line is equivalent to stating "none". This should make stock which doesn't use most of the features much more palatable to produce. This will also help when extending the standard - as new features will automatically be assumed to be not present on stock built to older standards...

That's all very well and good, but how is this supposed to be backwards compatible with the old bluestar standard?

I'm making the code fall back to reading the old config entries if it can't find the new ones. The real problem is that new stock will also have to include config.txt entries for the old bluestar, so that old vehicles know what to do when they couple to this one. Yes, this means that the old tags will never actually go away, but at least TRS2006 doesn't whinge about them so hard as of SP1...

===The Script===

(under construction)

[[Category:Modeling]]

ACS Coupling System

2013-08-14T03:46:37Z

Jamesmoody:

===Introduction===

There are many and varied problems with the existing BlueStar standard - but the main ones are the inflexibility beyond the initial application (coupling mineral wagons and transition era locos), and the rather arcane numeric values put into the config.txt.

A more readable, more flexible, and preferrably easily extensible datastructure in the config.txt was needed, and some way of standardising the logic (at the very minimum, an include file, but preferrably a library). It needed to support many more different types of coupler, vehicles with different couplers on each end, and so on.

The ACS System is an extension of the BlueStar coupling standard for TRS models (effectively BlueStar V2) and provides for the effect of working couplings on rolling stock. From version 5 of the ACSLib ACS vehicles are compatible with older BlueStar/CoupleStar ones.

To add ACS couplings it is necessary to edit the asset config file, add attachment points to the mesh and to create a script or edit the existing one. Due to the fact that you need access to the source files of the asset and to be able to script it is an advanced technique that cannot easily be carried out by an end-user.

===The Attachment Points===

All of the coupler, hoses and cables are attached to two points, one on the face of the front buffer beam (a.couple0) and one on the face of the rear beam (a.couple1). a.limfront should be 0.46m forward of a.couple0 and a.limback 0.46m rearward of a.couple1. a.couple0 and a.couple1 must be at x=0 and z=0.

Create a.couple0 in top view and move it into position. Then clone and position it to create a.couple1 and rotate it 180°. The Y axis of the two coupler points should point towards 0,0,0.

[[image:acs_att_points]]

===The Config File===
First off, here is an example config.txt fragment:

<pre>
extensions {
max_permitted_speed-60850 "125mph"
active-coupling-standard-60850 {
version-major "2"
version-minor "0"
brakes "air"
front {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
back {
coupler "knuckle|screwlink|hook"
gangway "gangway"
airbrake "twin"
vacbrake "none"
multiple-working "none"
heating-type "electric"
rch "high"
}
}
}
</pre>

So, what does all this do, and what are the options?
====Extension Container====
<pre>
extensions {
...
}
</pre>

This is for TRS2006 compatibility - it's all going in the extensions container. This does work in TRS2004 as well. Watch for the caveat at the end though...

====Max Permitted Speed====
<pre>
Max_Permitted_Speed-60850 "125mph"
</pre>

Not strictly part of the coupling code, but may as well mention it. This is for the Max Permitted Speed rule to tell how fast this vehicle should be permitted to travel. It will tell both AI drivers and the human driver (via the Custom HUD rule) what the maximum permitted speed is for the train they are driving, based on information from each vehicle. (And in a future version of the rule, more stuff too...)
====ACS Container====
<pre>
active-coupling-standard-60850 {
...
}
</pre>

This is the container within which all the config information will be held.

====ACS Version====
<pre>
version-major "2"
version-minor "0"
</pre>

Version numbers. This is useful when later code needs to read earlier format config files. Should make extending the standard a lot easier.

====Braking System====
<pre>
brakes "air"
</pre>

Defines what type of braking system is fitted to this vehicle. Options are:
*"air"
*"vac"
*"dual"
*"none"

This is independant of what hoses are available - unbraked but through piped stock is an entirely possible combination, and is representable.

====Position====
<pre>
front {
...
}
back {
...
}
</pre>

Containers for the front and back of the vehicle. 'Front' is defined as "the a.limfront end", and 'back' "the a.limback end". Available options for both are the same, so I'll describe them just once.
====Coupler Type====
<pre>
coupler "knuckle|screwlink|hook"
</pre>

What type of coupler do we have on this end of the vehicle? Options are:
*"fixed-bar"
*"hook"
*"3link"
*"instanter"
*"screwlink"
*"knuckle"
*"tightlock" -- different to a fixed knuckle, as I'm using this to refer to the ones fitted to multiple units that include electrical connections
*"wedgelock" -- London Underground specific
*"bsi"
*"dellner"
*"scharfenberg"
*"retractable-dellner"
*"(other string identifier)"

Certain types are purely compatible with other identical couplers, others are inter-compatible to produce handed pairs - so a 3 link couples to a hook, and wagons are typically fitted with both.

Multiple coupler options can be specified, and are separated with a vertical bar character. A typical unfitted freight wagon with a 3 link coupling is specified as "3link|hook". The earlier option is used in preference, so list the best coupler option first.

A BR coaching stock dropknuckle is specified as "knuckle|hook". A swingknuckle is specified as "knuckle|screwlink|hook". A Victorian Railways transitional coupler is specified as "knuckle|3link" (this coupler doesn't have a hook, but does have a chain attached to the top of the knuckle).

Dellner and Scharfenberg couplings are treated as compatible. Other types that only connect to themselves can be added arbitrarily via the "other string identifier" method. Just write the standard name of the coupler in, and ACS will tell you if it has connected to an identical coupler on the adjacent vehicle.

====Gangways====
<pre>
gangway "gangway"
</pre>

Passenger gangway between vehicles. Options are:
*"none"
*"rubbing-plate"
*"gangway"

This is really intended for coaching stock - it is assumed that all gangways are compatible. I've been considering a 'one piece' gangway option - to aid with the centre of multiple unit trains, where there is no separation point (it will help with deciding which vehicle should display the gangway) - but I'm not sure whether this is of sufficient benefit to include, as it involves a whole new set of logic here that most people won't use, and for the cases it is interesting, the same person has made both vehicles, and can therefore do it themselves... Comments please.
====Pipes for Air Brakes====
<pre>
airbrake "twin"
</pre>

Brake pipes for air brakes. Options are:
*"twin"
*"single"
*"none"

Twin is the UK standard two pipe air brake system (train pipe and brake pipe). Single is the US standard air brake system where reservoirs are charged from the brake pipe rather than the train pipe (this has appeared on some modern freightcars for reasons unknown, so is included).
====Pipes for Vac Brakes====
<pre>
vacbrake "none"
</pre>

Brake pipes for Vacuum brakes. Options are:
*"twin"
*"single"
*"high"
*"none"

Single is the UK default for fitted stock, high connections seems to be the standard on UK steam locos. Twin pipes (operating at two different vacuum levels) has been tried in the UK - and while not much fitted stock has the twin pipe system, most air brake, through vac piped stock seems to have two vac pipes.
====Multiple Working Cables====
<pre>
multiple-working "none"
</pre>

Multiple working connections. Options are:
*"(color)-(shape)" -- e.g. "blue-star" or "red-diamond", etc
*"AAR" -- as used on GM locos
*"SR27" -- bagpipes
*"(other identifier string e.g. classname)"
====Train Heating====
<pre>
heating-type "electric"
</pre>

Coach heating. Options are:
*"none"
*"steam"
*"electric" -- standard ETH
*"dual" -- both Steam and standard ETH*"southern-electric" -- The Southern, who pioneered electric train heating in the UK, fitted heating that was compatible with their DC powered EMUs, and thus ran from the same voltage as the DC power supply. When the rest of BR went ETH, different standards were adopted, resulting in the Southern having a different and incompatible ETH standard...
====Lighting Control Cables====
<pre>
rch "high"
</pre>

Through wiring for lighting control, to the Railway Clearing House standard. Also used more recently for other things - e.g. remote control via various methods - including TDM. I believe it is also used for signals to control doorlocks on stock so fitted - though I could be wrong on this. Options are:
*"high" -- positioned as is fairly standard on coaching stock
*"low" -- positioned as is fairly standard on streamlined locos, e.g. the front of a DVT, or a cl90
*"none"
====Notes====
For all of these where "none" is an option, entirely missing out that line is equivalent to stating "none". This should make stock which doesn't use most of the features much more palatable to produce. This will also help when extending the standard - as new features will automatically be assumed to be not present on stock built to older standards...

That's all very well and good, but how is this supposed to be backwards compatible with the old bluestar standard?

I'm making the code fall back to reading the old config entries if it can't find the new ones. The real problem is that new stock will also have to include config.txt entries for the old bluestar, so that old vehicles know what to do when they couple to this one. Yes, this means that the old tags will never actually go away, but at least TRS2006 doesn't whinge about them so hard as of SP1...

===The Script===

(under construction)

[[Category:Modeling]]

Build Numbers

2013-07-30T04:18:21Z

Jamesmoody:

{{ORP-top}}
=Code build number=
The '''Code build number''' or '''Trainz build version''' (two names meaning the identical 'tracking number') is the unique software level identifier that increments not only with 'named' main retail releases, but with each release for specific language groups, and by {{wp|Hotfix}}es, as well as by {{wp|Service_pack}} releases. 

Initial Trainz code build versions are not released in initial retail release versions for all world wide languages at the same time, but these are produced as available translations, so typically, non-English releases lag by some months, but may have hot fixes or service packs already installed. As the translation needs are satisfied and an overall ''release stabilizes'', subsequent service pack releases apply to those code build numbers and effectively combine language releases into a merged common product. At the end of the process, the final service pack produces a ''single stable '''code build version''''', creating the final corresponding Trainz (two digit) version number and corresponding identical [["Trainz-build" tag]] level found in assets config.txt.

=Currently Supported Releases=
Trainz versions are known best by their ''''''Retail Release name'''''', after which N3V Games/Auran, following general software industry practices subsequently release bug fixing '''hot fixes''' and usually a succession of service packs. Each

:'''Note:''' ''Legacy version releases and build numbers are listed at the bottom of the page, reserving this area for currently supported versions.''
The following builds exist for [[TS2009]]. Where patches are available, these are noted beside the build number.
==TS2009 - Trainz 2009==
:<big>'''Trainz 2009: World Builder Edition'''</big> 
{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 37625||auto-patch to 40040||English Online Release
|-
|Build 38017||auto-patch to 40040||[[TS2009 SP1]]
|-
|Build 38411||auto-patch to 40040||English Retail
|-
|Build 38599||auto-patch to 40040||[[TS2009 SP1]] hotfix
|-
|Build 38610||PROTECTED||Steam English Retail
|-
|Build 38808||auto-patch to 41590||French Retail
|-
|Build 38824||-||Dutch Retail
|-
|Build 38869||PROTECTED||UK Retail
|-
|Build 39176||-||German Retail
|-
|Build 39413||auto-patch to 40040||Czech, Polish, Hungarian Retail
|-
|Build 39561||-||Spanish Retail
|-
|Build 39979||auto-patch to 40040||[[TS2009 SP2]]
|-
|Build 40040||-||[[TS2009 SP2]] hotfix
|-
|Build 40357||-||Cabon City English Online Release
|-
|Build 40542||-||Russian Retail
|-
|Build 40702||-||Cabon City English Online Release
|-
|Build 40702||-||Treez English Online Release
|-
|Build 40762||-||Murchison English Online Release
|-
|Build 40837||-||S&C English Online Release
|-
|Build 40895||-||Spanish pre-SP3
|-
|Build 41497||-||Dutch, German pre-SP3
|-
|Build 41546||-||Italian Retail
|-
|Build 41590||-||French pre-SP3
|-
|Build 41844||-||[[TS2009 SP3]]
|-
|Build 44653||-||[[TS2009 SP4]]
|}

==TS2010 - Trainz 2010==
:<big>'''Trainz 2010: Engineers Edition'''</big>
The following builds exist for [[TS2010]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 41491||manual patch to 41615||English Online Release
|-
|Build 41615||manual patch to 43434||[[TS2010 SP1]]
|-
|Build 41622||manual patch to 43434||English Online Release
|-
|Build 42203||manual patch to 43434||[[TS2010 SP2]] English, Swedish Retail Release
|-
|Build 42534||-||French Retail
|-
|Build 42763||-||German Retail
|-
|Build 42831||-||Dutch Retail
|-
|Build 42953||-||Russian Retail
|-
|Build 43030||-||Czech, Polish Retail
|-
|Build 43233||-||Spanish Retail
|-
|Build 43434||-||[[TS2010 SP3]]
|-
|Build 44088||-||[[TS2010 SP3]] Minor revision
|-
|Build 45467||auto patch to 46170||[[TS2010 SP4]] (including Trainz Multiplayer Beta)
|-
|Build 45607||auto patch to 46170||[[TS2010 SP4]] patch 1 (including Trainz Multiplayer Beta)
|-
|Build 46170||manual patch to 49938||[[TS2010 SP4]] patch 2 (including Trainz Multiplayer Beta)
|-
|Build 49933||-||[[TS2010 SP3]] Minor revision, added support for Aerotrain DLC
|-
|Build 49938||-||[[TS2010 SP4]] patch 3 (including Trainz Multiplayer Beta), added support for Aerotrain DLC
|-
|}

==TS12 - Trainz 2012==
:'''Trainz 2012: Anniversary Edition'''</big>
The following builds exist for [[TS12]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 46957||auto-patch to 48054||Planet Auran release version
|-
|Build 47059||auto-patch to 48054||Minor revision
|-
|Build 47103||-||Steam release
|-
|Build 47452||auto-patch to 48054||Just Trainz release version
|-
|Build 47772||auto-patch to 48054||Just Trainz release version (minor revision)
|-
|Build 48054||manual patch to 48249||Minor revision
|-
|Build 48249||manual patch to 49922||Minor revision
|-
|Build 49849||-||Czech Release
|-
|Build 49922||-||Minor revision, added support for Aerotrain DLC
|-
|Build 50027||-||German Release
|-
|Build 50406||-||French Release
|-
|Build 51054||-||Dutch Release
|-
|Build 52143||-||Russian, Japanese, Polish Release
|-
|Build 57720||-||TS12 SP1 English
|-
|Build 57825||-||TS12 SP1 Hotfix 1 English
|-
|Build 57898||-||TS12 SP1 Hotfix 2 English
|-
|Build 58414||-||TS12 SP1 Hotfix 3 English
|}

==Trainz Simulator Mac==
:<big>'''Trainz MAC'''</big>
The following builds exist for [[Trainz Simulator Mac]]. Where patches are available, these are noted beside the build number.

{| border=1 cellpadding=2 cellspacing=0
|'''Build Number'''||'''Patches available'''||'''Build description'''
|-
|Build 47652||-||Planet Auran Digital Store release
|-
|Build 47770||-||Third-party Digital Store release
|-
|Build 48159||-||Feral retail release
|}

= Content Builds =

Auran's newer patch technology developed for TRS2009 has the capability of updating the base Trainz version and installed add-on content independently. The following is a list of released content build versions for add-on content since the advent of TRS2009's technology. Legacy versions (Trainz UTC, Trainz TCC discussed below)

{| border=1 cellpadding=2 cellspacing=0
|'''Content Build Number'''||'''Content Patches available'''||'''Build description'''
|-
|Content Build 40355||-||Cabon City English Online Release
|-
|Content Build 40400||-||Cabon City English Online Release
|-
|Content Build 40563||-||Treez English Online Release
|-
|Content Build 40761||-||Murchison English Online Release
|-
|Content Build 40836||-||S&C English Online Release
|-
|Content Build 49210||-||Duchess Online Release
|-
|Content Build 49474||-||Duchess Steam Release
|-
|Content Build 49631||-||Coronation Scot Online Release
|-
|Content Build 49694||-||Coronation Scot Steam Release
|}
==Legacy build versions==
:''This section is being provided by the user community to make as complete a reference as possible, so is currently incomplete and may remain so.''
===Trainz 1.x===
:<big>'''Trainz 1.3'''</big>
{| border=1 cellpadding=2 cellspacing=0
|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|0.9||Build 0009 || {{center|Trainz Beta}} ||<center>wholly replaced by [[Trainz 1.0]] </center>||released in November 2000 for testing purposes to Model Railroaders.
|-
|1.0||Build 0010|| {{center|[[Trainz 1.0]]}} ||{{cdash}} || ''''''Trainz Community Edition'''''', released in December 2001
|-
|1.0||Build 0019? || {{center|[[Trainz 1.0]], non-English}} ||{{cdash}} || Trainz Community Edition 2
|-
|1.1||Build ???? || {{Cdash}} || {{center|[[Trainz 1.0| SP1]]}} || released in 2002 (April ?)
|-
|1.2||Build 0??? || {{cdash}} || {{center|[[Trainz 1.0| SP2]]}} || ''''''Trainz Retail Edition'''''' was released in June 2002 aimed at the North American markets.
|-
|1.3||Build 0263 || {{center|aka '''Trainz 1.3'''}} || {{center|[[Trainz SP3]]}} || First with TrainzScript.exe, and Scenarios, November 2002
|-
|1.0||Build 0277 || {{center|[[Trainz 1.0]], non-English}} ||{{cdash}} || Trainz Community Edition 2
|-
|1.5||Build 0377 || {{center|Trainz UTC 3 CD set}} || {{cdash}} || Ultimate Trainz Collection, released 26 November 2002 w/expanded content
|-
|1.6||Build 0404 || {{cdash}} || {{center|Trainz UTC SP1}} || Ultimate Trainz Collection SP1
|-
|1.6||Build 0033 || {{center|Paintshed}} || {{cdash}} ||1st released as part of Ultimate Trainz Collection SP1
|-
|}
===TRS2004===
'''TRS2004''' had a relatively large number of separate builds as Auran worked out methods for international names handling in various languages, plus went through a related succession of Service Packs.
{| border=1 cellpadding=2 cellspacing=1
|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|2.0||Build 668 || [[TRS2004|Trainz Railroad Simulator 2004]] || || International version (Australia and USA). Released in September 2003.
|-
|2.0||Build 686 || [[TRS2004|Trainz Railway Simulator 2004]] || || Just Trains version (UK). Requires disk in drive.
|-
|2.1||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] SP1 || || International (USA/Australia) release
|-
|2.1||Build ???? || [[TRS2004|Trainz Railway Simulator 2004]] SP1 || || Just Trains release (UK). Requires disk in drive.
|-
|2.2||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] "Passenger Edition" (SP2)|| || International (USA/Australia) release
|-
|2.2||Build 2285 || [[TRS2004|Trainz Railway Simulator 2004]] "Passenger Edition" (SP2)|| || Just Trains release (UK). Requires disk in drive.
|-
|2.3||Build ???? || [[TRS2004|Trainz Railroad Simulator 2004]] SP3 || || International (USA/Australia) release
|-
|2.3||Build ???? || [[TRS2004|Trainz Railway Simulator 2004]] SP3 || ||
|-
|2.3||Build ???? || [[TRS2004#Deluxe|TRS2004 Deluxe]] || ||Trainz 2004: Deluxe Edition. Includes SP3 and additional content. Different regions received different additional content.
|-
|2.4||Build 2365 || [[TRS2004|Trainz Railroad Simulator 2004]] SP4 || || International (USA/Australia) release
|-
|2.4||Build 2370 || [[TRS2004|Trainz Railway Simulator 2004]] SP4 || || Just Trains release (UK). Requires disk in drive.
|-
|2.4||Build 2370 || [[TRS2004|Trainz Railway Simulator 2004]] SP4 || || Included in ''Trainz Collection'', but ''without'' the requirement for a disk in the drive.
|-
|}

===TRS2006 & etc.===

'''TRS2006''' had a relatively large number of separate builds as Auran worked out methods for international names handling in various languages, plus went into partnership with various 3rd party distributors giving a host of releases in various markets but only one series of related Service Packs.

{| border=1 cellpadding=2 cellspacing=1 width="100%"
|col-width="8%"|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|  2.5||Build 2761 || {{center
|[[TRS2006|TRS2006 GM]] }} ||{{cdash}} ||  Original release for Australia and USA. Content Creator Plus and Content Manager Plus first introduced.
|-
|  2.5||colspan="3" |'''Other Builds:''' UK release - 2773; French - 2883; Dutch - 2967;German - 2970; Spanish - 3007 ||German - was also called Pro Train Perfect or PTP
|-
|  2.6 || build 3092 || {{cdash}} || {{center|[[TRS2006|TRS2006 SP1]] }} || TRS2006 - Australia and North American markets
|-
|  2.6||colspan="4" |'''Other SP1 Builds:''' United Kingdom-SP1= build 3099; Spanish-SP1= build 3118
|-
|  2.5|| Build 3096 || {{center|Trainz Driver Demo}}|| {{cdash}} || UK release date of Trainz Driver was 24 February 2005.
|-
|  2.6||Build 3335 || {{cdash}} || {{center|[[TRS2006#SP1|TRS2006 SP1]] }} || Vista support. Released in September 2007. Used for bundle packs - Trainz Railwayz (North American release bundled with TC1) and Trainz Complete Collection (bundled with TRS2004 SP4, UTC and Trainz Routes 1 to 4).
|-
|  2.6||Build ????|| {{center|[[TRS2007]] }} || {{cdash}} ||  French retail, equivalent to TRS2006+SP1, with some additional French content.
|-
|  2.6||Build ????|| {{center|[[TRS2007]] }} || {{cdash}} ||  German retail, equivalent to TRS2006+SP1, with a lot of additional German content.
|-
|}

===Trainz Classics===

'''Trainz Classics''' was series of releases each featuring a single route. New code features were added to each version to support that route.

{| border=1 cellpadding=2 cellspacing=1 width="100%"
|col-width="8%"|'''Ver#:'''|| <big>{{center|'''Build Number'''}} || {{center|'''Trainz Retail Release Name'''}} ||'''Patches available''' || {{center|'''Build description'''<big>*</big>}}</big>
|-
|  2.7||Build 3337|| {{center|[[TC1|'''Trainz Classics''']]}} || {{cdash}} ||  English Retail. Released July 9th, 2007 as a bundle with both [[TC1]] and [[TC2]] content included. Released as '''Trainz Railwayz''' (bundled with an updated TRS2006) in North America.
|-
|  2.7||Build ????|| {{center|[[TRS2008]] }} || {{cdash}} ||  French Retail. Includes both TC1/TC2 and also the French 2007 content in a single build.
|-
|  2.8||Build 3529|| {{center|[[TC3|Trainz Classics 3]]}} || {{cdash}} ||  TC3 English Retail, released on July 23, 2008.
|-
|}

==Notes and references==
<big><big><code>*</code></big></big> Name usages matching information posted on {{wp|Trainz}} and the {{plain link|http://en.wikibooks.org/wiki/Trainz/Version_And_Build_Numbers|Trainz Wikibook}} Version and Build Numbers pages.

{{ORP-bot}}{{TBKr}}

.texture.txt Files

2013-07-30T02:52:06Z

Jamesmoody: /* Anisotropy */

=Introduction=
Files with '''*.texture.txt''' suffix and extension are used to configure texture behavior in Trainz. These files may also control how textures are processed by [[Content Manager]]. These files are located in the same folder as the source texture files, typically .bmp, .tga or .jpg, and make reference to them. These files are generated automatically by the exporter or importer but may be edited by hand when specialization is required.

'''TODO: Merge this document into the [[Texture file]] page and erase this page.'''

=Syntax=
Each token is specified on a new line. There is no white space on either side of the '=' sign. A empty value is sometimes valid. The syntax is:

<token>=<value>

Example:
Primary=WayCoolTexture.tga
Alpha=WayCoolTexture.tga
Tile=st
AlphaHint=masked
Anisotropy=16
MagFilter=linear
MinFilter=linear
MipFilter=linear
''(Example only, not recommended settings)''

=Tokens=
Here is a list of supported tokens. Any other values should not be used.

==Primary==
Specify texture file name
* '''<texture name>''' - Primary texture. Filename including extension.

==Alpha==
Specify alpha channel for texture. Note that if there is only one 32bit file with RGB and A channels, this must still be specified with the same name used in Primary
* '''<texture name>''' - Alpha texture, may be the same or different from the primary

==Tile==
Wrap texture addressing horizontally, vertically or both. Otherwise texture is clamped.
* <empty> - '''(default)''' No wrapping
* '''s''' - Wrap horizontally
* '''t''' - Wrap vertically
* '''st''' - Wrap both horizontally and vertically

==Dimension==
Number of dimensions the texture has. Not required since only 2D textures are currently supported.
* '''two''' - '''(default)''' Two dimensional
* '''cube''' - (unsupported)
* '''volume''' - (unsupported)
* '''one''' - (unsupported)

==Compression==
Compression format used by CMP. '''If this is not supplied, format is chosen automatically'''.
* '''none''' - Do not compress. Warning: Uncompressed textures consume large amounts of memory and slow performance.
* '''DXT1''' - Suitable for opaque or alpha masked textures
* '''DXT3''' - Alternately the best for alpha blended textures if the texture contains sharp contrasts. Try DXT5 first.
* '''DXT5''' - Usually the best for alpha blended textures

==Hint==
Texture usage hint, '''for internal use only'''. Note this should NOT be used to try and disble mip mapping.
* '''static''' - '''(default)''' Standard texture resource
* '''dynamic''' - Texture will be modified in memory

==NormalMapHint==
Hint about texture being a normal map. Important to use as this will affect final texture quality. Compression, mip map generation and renormalization of XYZ (RGB) is effected.
* '''none''' - '''(default)''' This is not a normal map
* '''normalmap''' - This is a normal map

==ModifyMap==
Allows the texture to be modified when the texture.txt file is read. Currently this is to allow the green channel (Y axis) to be flipped for normal maps.
* '''none''' - '''(default)''' Do not modify texture
* '''flipgreen''' - flip green channel which is Y Axis of normal map

==AlphaHint==
Specify how the alpha channel is used. Affects final alpha quality. May also affect texture compression and mip generation.
* '''opaque''' - '''(default with no alpha present)''' No alpha channel used.
* '''semitransparent''' - '''(default with alpha present)''' Alpha blended
* '''masked''' - Alpha masked

==Anisotropy==
Anisotropic sampling quality. The higher the number, the better the visual quality but at significant performance cost. Where texture quality is needed specify a higher value. Trainz can now control anisotropy via a slider, so the highest setting is used by default.
* '''1''' - No anisotropic filtering
* '''2''' - Low
* '''4''' - Medium
* '''8''' - High
* '''16''' - '''(default)''' Very High

==AutoMip==
Auto mip map generation. Chris, is this depricated? CMP now generates mip maps at highest quality instead of game load/run time.
* '''none''' - Don't generate mip maps
* '''default''' - '''(default)''' Whatever the default method is
* '''fastest''' - Attempt to improve load time at expense of quality
* '''nicest''' - Attempt to improve quality regardless of time

==MagFilter==
Texture sampling filter used when texture is magnified
* '''nearest''' - No blending with neighboring texels
* '''linear''' - '''(game default)''' Blends with neighboring texels for smooth zoom effect
* '''default''' - '''(default)''' Game default

==MinFilter==
Texture sampling filter used when texture is minified
* '''nearest''' - No blending with neighboring texels
* '''linear''' - '''(game default)''' Blends with neighboring texels for smooth shrink effect
* '''default''' - '''(default)''' Game default

==MipFilter==
Texture sampling filter used on mip map selection
* '''nearest''' - No blending with other mip maps
* '''linear''' - '''(game default)''' Smooth blendig between mip maps (Note, operates independently but should be used in conjunction with anisotropic sampling)
* '''default''' - '''(default)''' Game default
* '''none''' - Disable mip map generation in CMP and use in game. Specifically for user interface elements.

=Comments & Suggestions=
* ''Hint'' is mentioned even though it is intended for internal use only, because it has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for interface textures.

Texture file

2013-07-04T11:14:28Z

Jamesmoody:

{{ORP-top}}
'''Scope:''' This guideline applies to each of the following Trainz {{wp|data type|type specifications}}:
:''[[KIND Texture]], [[KIND Groundtexture]], [[Alpha masking]], [[.texture.txt Files|Miscellaneous.texture.txt Files]], and the [["Thumbnails" container]]''.

:''Related data types: "Texture-variants" container'' (asset provides alternative material configurations for the texture to display as seasonal variants.)

;Descripton
Trainz '''Texture files''' are ASCII text format specification files describing a single texture. Texture files have a ".texture.txt" name extension, however when a texture file is specified within a [[Config.txt file]] or similar, the ".txt" must be omitted, leaving the ".texture" extension.

Files with '''*.texture.txt''' suffix and extension are used to configure texture behavior in Trainz. These files may also control how textures are processed by [[Content Manager]]. These files are located in the same folder as the source texture files, typically .bmp, .tga or .jpg, and make reference to them. These files are generated automatically by the exporter or importer but may be edited by hand when specialization is required.

==File format==

The user-editable *.texture.txt files are ASCII text formatted key-value pairs with the following options. Please note that this format is not the same (despite some similarities) as other text-based formats used by Trainz. Please be aware of the [[filename character restrictions]] when naming texture and image files.

;Syntax
Each token is specified on a new line. There is no white space on either side of the '=' sign. A empty value is sometimes valid. The syntax is:

<token>=<value>

;Example:
Primary=WayCoolTexture.tga
Alpha=WayCoolTexture.tga
Tile=st
AlphaHint=masked
Anisotropy=16
MagFilter=linear
MinFilter=linear
MipFilter=linear
''(Example only, not recommended settings)''

===Tokens and Values===

Primary=diffusemap.bmp

This tag specifies the filename of the image file representing the color (R, G, B) channels of the texture. Any alpha channel in the image file is ignored. The resultant texture will have a pure white (100%) alpha channel.

Primary=diffusemap.jpg
Alpha=diffusemap.bmp

This tag combination specifies the filenames of the image file representing the color (R, G, B) channels of the texture and the image file representing the alpha (A) channel of the texture. The alpha channel image should be grayscale. Neither file should contain an alpha channel.

Primary=diffusemap.tga
Alpha=diffusemap.tga

This tag combination specifies the filename of a single image file representing the color and alpha (R, G, B, A) channels of the texture. In this case both tags must reference the same filename. The image file must contain an alpha channel.

Compression=dxt1

This tag forces the usage of a particular texture compression scheme. If omitted, Trainz will choose an appropriate texture compression scheme based on the contents of the supplied image files. If you don't have a specific effect in mind, don't include this tag. Valid options are 'none', 'dxt1', 'dxt3', 'dxt5'. Refer [[DXT Compression]].

NormalMapHint=normalmap

The 'NormalMapHint' tag allows the texture to be specified as a [[normal map]]. By default, Trainz will assume that your texture is a [[diffuse map]] and will apply some processing options which are not appropriate for normal maps. You must specify this option for normal maps. Valid options are 'none' and 'normalmap'.

ModifyMap=flipgreen

The 'ModifyMap' option allows a texture's green color channel to be flipped. Some programs such as 3ds Max create [[normal map]]s with the Y axis facing the opposite way to what is expected by the Trainz shaders. This option can be used to make the bump effect look correct in Trainz. The option is applied by the [[Content Manager]] upon Commit. Valid options are 'none' and 'flipgreen'.

AlphaHint=opaque

The 'AlphaHint' tag allows you to force a particular alpha mode on the texture. Valid options are 'opaque' (meaning that the alpha channel is unused and effectively pure white), 'semitransparent' (meaning that the alpha channel is a grayscale blend) and 'masked' (meaning that the alpha channel is a pure black&white bitmap.) If omitted, Trainz will supply an appropriate value for this tag based on the Alpha channel. Specifying this option prevents slight discoloration in a mask texture from triggering the blended alpha path.

Anisotropy=1

Anisotropic sampling quality. The higher the number, the better the visual quality but at significant performance cost. Where texture quality is needed specify a higher value. Trainz currently defaults to Very High anisotropic filtering, which is then subsequently restricted by the in-game Anisotropy slider. Valid values are integers
"1" (default) - No anisotropic filtering, "2" - Low, "4" - Medium, "8" - High, and "16" - Very High

MagFilter=linear

Controls the filtering style for texel magnification. This is used when a texel is displayed at larger than real size (eg. a single texel is represented with more than a single pixel.) Valid settings for the magnification filter are 'nearest', 'linear', and 'default'. Trainz currently defaults to linear interpolation. Selecting 'nearest' will use a nearest-neighbor filtering mode which results in a "pixelated" output.

MinFilter=linear

Controls the filtering style for texel minification. This is used when a texel is displayed at smaller than real size (eg. a single pixel is represented with more than a single texel.) Valid settings for the minification filter are 'nearest', 'linear', and 'default'. Trainz currently defaults to linear interpolation. Selecting 'nearest' will use a quantized filtering mode which results in a "noisy" output.

MipFilter=linear

Controls the filtering style for texture mipmap selection. Mipmaps are used during minification to help prevent the moire effect pattern. The cost of using mipmaps is that the resultant image will blur slightly. The benefits of using mipmaps are reduced quantization noise and reduced memory footprint (since the higher detail mip levels can be unloaded when not in use.) Valid settings for the mip filter are 'nearest', 'linear', 'default' and 'none'. Trainz currently defaults to trilinear interpolation. Selecting 'nearest' will cause the hardware to select a single mipmap for each pixel, which results in visible banding at mipmap boundaries. Selecting 'none' will disable mipmaps, resulting in lower performance, higher memory usage, and "noisy" output.

Tile=st

Tiling refers to the ability for texture coordinates outside the range of (0.0 .. 1.0) to be treated as valid coordinates on an infinitely tiled texture. With tiling active, coordinates which pass the right/bottom side of the texture effectively wrap back onto the left/top side, and so on. Valid options include 's' (tile horizontally), 't' (tile vertically), 'st' (tile both horizontally and vertically), and 'none' (do not tile the image).

==Comments & Suggestions==
The token ''Hint'' is intended for internal use only, but has been used and abused by well meaning people since its discovery. ''Anisotropy'' should be used to improve texture quality, and ''MipFilter=none'' should be used to disable mip mapping only for ''interface textures''.

==Image formats==
The following image formats are acceptable as source data for the Texture file:

* Targa (.tga) files. Targa is a lossless image format with optional compression and optional alpha channel.
* JPEG (.jpg) files. JPEG is a lossy image compression format with no alpha channel support.
* Windows Bitmap (.bmp) files. BMP is a lossless image format with no compression and optional alpha channel.

These images in association with the appropriate *.texture.txt file are used by [[Content Manager]] to create the N3V binary textures that are used in the simulator. The N3V binary textures use [[DXT Compression]] and contain image LOD information.

All built-in content has only N3V binary textures that cannot be opened with normal imaging software. Appropriate tools to view these can be found on the [[Tools]] page.

==Notes on Image Editors==
* The Targa Exporter plugin shipped with some older versions of Adobe Photoshop is broken and silently corrupts or discards alpha channels; a free update is available which resolves this issue.
* Some image editors do not support alpha channels on BMP files.

==.txt file extension==
Texture files have a ".texture.txt" name extension, however when a texture file is specified within a [[Config.txt file]] or similar, the ".txt" must be omitted, leaving the ".texture" extension.
For example, a texture file named ''grass.texture.txt'' is specified in a [[KIND Groundtexture]] config file using the syntax ''texture "grass.texture"''.

==Use of image files in place of texture files==
Trainz has historically supported using ''any supported image file'' type in place of a [[Texture file]]. This technique has obvious limitations and <code>is no longer recommended.</code>{{FAB-todo|What limitations, explain!}}{{N3V-todo|What limitations, explain!}}

[[Category:File formats]]
{{ORP-bot}}

KIND Environment

2013-03-12T15:08:33Z

Jamesmoody:

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

==KIND Hierarchy==
===Parent Classes===
* [[KIND TrainzBaseSpec]]
===Child Classes===
* ''none.''

==Supported Tags==

The [[KIND Environment]] [[config.txt file]] supports the following tags. Each tag is show here with its default value.

normal ""
storm ""
night ""

====normal====
:''type:'' string.
:''desc:'' File name of the texture used for the sky in normal conditions - clear weather during the day.
Note: Unusually, the file name should not contain the '.texture' part of the filename. If your texture is "mediumclouds.texture.txt", then this tag should be "mediumclouds".

====storm====
:''type:'' string.
:''desc:'' File name of the texture used for the sky during stormy weather.
Note: Unusually, the file name should not contain the '.texture' part of the filename. If your texture is "mediumclouds_storm.texture.txt", then this tag should be "mediumclouds_storm".

====night====
:''type:'' string.
:''desc:'' File name of the texture used for the sky at night.
Note: Unusually, the file name should not contain the '.texture' part of the filename. If your texture is "mediumclouds_night.texture.txt", then this tag should be "mediumclouds_night".

==Example Config.txt==

kuid <kuid:56113:1227>
trainz-build 2.5
category-class "ES"
category-region "00"
category-era "2010s"
username "testEnvironment"
kind "environment"
normal "norm"
storm "storm"
night "night"
thumbnails
{
0
{
image "thumb.jpg"
width 240
height 180
}
}

==Categories==
[[Category:Asset KIND]]

KIND Environment

2013-03-12T15:07:47Z

Jamesmoody:

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

==KIND Hierarchy==
===Parent Classes===
* [[KIND TrainzBaseSpec]]
===Child Classes===
* ''none.''

==Supported Tags==

=Supported Tags=
The [[KIND Environment]] [[config.txt file]] supports the following tags. Each tag is show here with its default value.

normal ""
storm ""
night ""

====normal====
:''type:'' string.
:''desc:'' File name of the texture used for the sky in normal conditions - clear weather during the day.
Note: Unusually, the file name should not contain the '.texture' part of the filename. If your texture is "mediumclouds.texture.txt", then this tag should be "mediumclouds".

====storm====
:''type:'' string.
:''desc:'' File name of the texture used for the sky during stormy weather.
Note: Unusually, the file name should not contain the '.texture' part of the filename. If your texture is "mediumclouds_storm.texture.txt", then this tag should be "mediumclouds_storm".

====night====
:''type:'' string.
:''desc:'' File name of the texture used for the sky at night.
Note: Unusually, the file name should not contain the '.texture' part of the filename. If your texture is "mediumclouds_night.texture.txt", then this tag should be "mediumclouds_night".

==Example Config.txt==

kuid <kuid:56113:1227>
trainz-build 2.5
category-class "ES"
category-region "00"
category-era "2010s"
username "testEnvironment"
kind "environment"
normal "norm"
storm "storm"
night "night"
thumbnails
{
0
{
image "thumb.jpg"
width 240
height 180
}
}

==Categories==
[[Category:Asset KIND]]