TrainzOnline - User contributions [en]

HowTo/Upgrade obsolete script functions - simple examples

2022-08-27T15:32:27Z

Pencil42: added class HTMLWindow

These are examples of solutions for common and simple obsolete Trainzscript functions. This is not an exhaustive list. Solutions for more complex obsolete functions can be found (TBD).

'''Under Development''' The contents and the layout of this page is under development.

=class Crossing=

==SetCrossingAutomatic()==
==SetCrossingState()==

Error: VE197: Syntax error in script 'somescript.gs' for asset <kuid:0000:0000> "Asset Name". 
Error: VE267: somescript.gs(48) : function SetCrossingAutomatic is obsolete in object Crossing. 
Error: VE267: somescript.gs(48) : function SetCrossingState is obsolete in object Crossing.

This method now requires a SecrityToken as a parameter to the function call

'''Repair'''

You need to initialize a SecurityToken, then add it as a parameter to your function calls.

'''Usage example:'''

In your header add

SecurityToken stoken;

Then in your function calls add your token.

SetCrossingAutomatic(stoken, false);
SetCrossingState(stoken, 1);

More information on [[Class Crossing]]

=class HTMLWindow=

==GetCompleteIndustryViewDetailsHTMLCode()==

VE267: somescript.gs(linenumber) : function GetCompleteIndustryViewDetailsHTMLCode is obsolete in object HTMLWindow. 

This error occurs when trying to use this method with an obsolete class. In this case, class GenericIndustry has been obsoleted and replaced with BaseIndustry.

'''Repair'''

Change all instances of 'GenericIndustry' in the code to 'BaseIndustry'.

'''Usage example:'''

include "BaseIndustry.gs"
class <myclass> isclass BaseIndustry>

=class Train=

==GetVelocity()==

GetVelocity obsolete error or warning: <kuid:0000:0000> : VE267: somescript.gs(299) : function GetVelocity is obsolete in object Train.

'''Repair'''

You have two replacement options in the Train class (train.gs):

''float GetSmoothedVelocity(void);''

This function return the train's velocity in metres per second and is suitable for human viewing such as a cab display.

''float GetTrainVelocity(void);''

This function provides the instantaneous velocity for vehicles in this train, which is good for physics calculations but not good for human-readable display. 

'''Usage example:'''

float mySpeed;
mySpeed = GetSmoothedVelocity(); // this is the more likely option but depends on what the overall script is trying to do.

// or the more accurate version
mySpeed = GetTrainVelocity();

=class Vehicle=

==GetFacingRelativeToTrain()==

???GetFacingRelativeToTrain obsolete error or warning: <kuid:0000:0000> : VE267: somescript.gs(450) : function GetFacingRelativeToTrain is obsolete in object Vehicle.

'''Repair'''

You have one replacement option in the Vehicle class (vehicle.gs):

''bool GetDirectionRelativeToTrain(void);''

This function returns true if the vehicle faces the same way as the Train, false otherwise. This function is a bit tricky to understand and especially when a vehicle, such as a coach/carriage, is involved.

'''Usage example1:'''

Vehicle myVehicle;
bool sameDirectionAsTrain;

sameDirectionAsTrain = GetDirectionRelativeToTrain();

'''Usage example2:'''

Vehicle[] trainVehicles;
Vehicle myVehicle;
bool sameDirectionAsTrain;
int i;

trainVehicles = GetMyTrain().GetVehicles();

if (trainVehicles) { //unlikely to be null but ...

for (i = 0; i < trainVehicles.size(); ++i) {
//get direction of this vehicle in the train
sameDirectionAsTrain = trainVehicles[i].GetDirectionRelativeToTrain();
if (sameDirectionAsTrain) {
// do what is necessary here
Interface.Print("Vehicle "+ (i+1) + " is facing forward"); // add 1 so that the first vehicle is number 1 and not 0 (zero)
} else {
Interface.Print("Vehicle "+ (i+1) + " is facing backwards");
}
}

}

Help:Surveyor Topology Tools

2019-08-26T22:51:36Z

Pencil42: typo

The Topology Menu provides
the tools for creating various
types of terrain. In this section
you will learn how to make
hills, valleys, mountains, lakes
and rivers.

Click on the Topology Tab (or
press the F1 key) to open the
Topology Menu. Here you
will see a number of different
tools that can be used to shape
the terrain. Hold your mouse
cursor over each one to see a
short description as well as the
appropriate Hotkey to press. To
see the whole menu as in the
iamge below, click on the
“Advanced” button to expand
the menu.

[[File:Topology.jpeg]]
{{clear}}

* The three top buttons allow you to activate the basic tools to raise and lower terrain.
* The knobs below that alter the area the tool will affect and the sensitivity of the tool.

For an overview of how the topology tools work [[Help:Topology_editing|click here]]

=TANE=
== Main menu ==
=== [[File:Height up.jpg]] Height up (U) ===
Use this tool to create mounds, hills and mountains.
Click on the Height Up tool icon to change to Height Up mode. Move your cursor from the tool tab onto the 3D world and you will see a "circle of influence". Left click and drag your mouse around the 3D world to raise the terrain.
Use Radius and Sensitivity to adjust the size and sensitivity of this tool. To adjust your view of the world as you mould the terrain, right-click on the terrain to move your camera focal point and use your cursor arrow keys to move the camera. Use Undo if you don't like the results you see.

=== [[File:Height down.jpg]] Height down (D) ===
Use this tool to modify the terrain height. Make hollows, valleys, rivers, lakes and oceans.

Click on the Height Down tool icon to change to Height Down mode. Move your cursor from the tool tab onto the 3D world and you will see a "circle of influence". Left click and drag your mouse around the 3D world to lower the terrain.

Use Radius and Sensitivity to adjust the size and sensitivity of this tool. To adjust your view of the world as you mould the terrain, right-click on the terrain to move your camera focal point and use your cursor arrow keys to move the camera. Use Undo if you don't like the results you see.

=== [[File:Height adjust.jpg]] Adjust height (A) ===
Adjust Height allows finer control of the up and down movement. Click LMB and hold then push your mouse away from you to raise the terrain. Click LMB and hold then pull the mouse towards you to lower the terrain.
Generally used for finer adjustments.
Use in conjunction with the Radius and Sensitivity tools.

=== [[File:Radius.jpg]] Radius ===
Click LMB on the Radius Tool and move to either side to change the circle of influence. Move the dial right to enlarge the circle (HOTKEY “+”), left to minimize (HOTKEY “-”).
The size of the circle determines the outer limit of influence of the tool.
Whichever tool you have selected (highlighted) will be applied within the area defined by the circle.

=== [[File:Sensitivity.jpg]] Sensitivity ===
Click LMB on the Sensitivity Tool and move to either side to change the amount of height changed each time the circle of influence is affected. Move the dial right to make more sensitive (HOTKEY “+”), left to reduce the sensitivity (HOTKEY “-”).

=== [[File:Height get.jpg]] Get height (G) ===
Select Get Height (G), then Click RMB on the side of a hill. Notice that the number in the Height Value field changes. You have captured the height of the terrain at the point your compass appears.
Use in conjunction with the plateau tool to flatten an area to a certain height.

=== [[File:Height use.jpg]] Use height (H) ===
Click on Use Height (H) then Click LMB to apply the selected Height Value to the terrain. The Use Height tool creates a plateau at your selected height and the radius of your cursor circle determines the amount of land that is leveled at one time.
Click and hold LMB then move your mouse around the terrain to level out a broader section.
This tool is not affected by the sensitivity dial.

=== [[File:Plateu.jpg]] Plateau (P) ===
Plateau (P) creates a plateau at the current height of the
compass. Click LMB on the side of a hill to create
a plateau at that level by raising or lowering the
terrain.

This tool is affected by the sensitivty dial. Moving your cursor around over pre-existing hills will create a smoothing effect. Adjust the sensitivity to flatten/smooth areas quicker or slower.

=== [[File:Height value field.jpg]] Height value field ===
You can manually enter in the height to apply. Click on the number showing between Get Height and Use Height and manually type in a value.
To apply the selected Height Value to the terrain, click on the Use Height tool then LMB on the terrain.

=== [[File:Water add.jpg]] Add water (W) ===
Click LMB on Add Water (W)
and paint the water texture along the
desired area by moving
your mouse around. The radius of the
cursor circle determines the texture panel size.

=== [[File:Water remove.jpg]] Remove water (Q) ===
Click LMB on Remove Water (Q) and you then delete
the water texture one panel at a time by Clicking
LMB on each water panel.

=== [[File:Water adjust height.jpg]] Adjust Water Height (E) ===
Select the Adjust Water Height
tool and Click LMB and hold (on the water texture) then drag
your mouse forward and back, adjusting the water texture
height until it is the appropriate
height.

=== [[File:Height value field.jpg]] Water Height Field ===
Enter the height at which you wish to apply the water, then click on Use Water Height. LMB and move your cursor around the terrain to paint the water texture at the height entered.

=== [[File:Ground add.jpg]] Add ground (X) ===
Select the Add Ground
(X) tool. Click LMB in the void just off the edge of
the baseboard to add another baseboard in that direction.

By default ground sections use a 10m grid, where each adjustable terrain 'point' is 10m apart. If your route requires finer detail you can create sections which use a 5m grid. These ground sections will use four times more memory than the standard 10m grid and should be reserved for when fine detail is absolutely required.

To create a section with a 5m grid, click on the drop down list to the right of the Add Ground button, and select the 5m option. Now add the terrain as normal. You can also update existing sections by clicking on them whilst the 5m grid option is selected.

=== [[File:Ground remove.jpg]] Delete ground ===
Click LMB on the Delete Section button, then Click
LMB on any baseboard section to delete it. This action cannot be undone, and should be used with care. Deleting a section may also delete splines that cross section boundaries. If the zoom is too far from the surface, this option might me disabled.

== Advanced ==
The Advanced features menu can be opened and closed by
using Shift-F1 or clicking on the Advanced Tab.
=== [[File:Displacement map.jpg]] Displacement map ===
A displacement map is a grayscale image
used to create an instant height map.

=== [[File:Direction.jpg]] Direction ===
Move the direction dial in the directon you wish the grayscale map to be put down on the baseboard.

=== [[File:Threshold.jpg]] Threshold ===
Move the Threshold dial to increase the size of the height change set on the displacement map.

=== [[File:Area select.jpg]] Select area (B) ===
Click on Select Area (B). Click LMB and drag the
mouse to make a large square as shown below.
The size of the square (or rectangle)
determines the area that will be affected by the next
operation.

=== [[File:Area fill.jpg]] Fill area (F) ===
Scroll through the Displacement Maps, then click on Fill Area (F). The
terrain is instantly transformed into the shape determined by
the grayscale images of the displacement map chosen.

=== [[File:Area cancel.jpg]] Cancel selection (D) ===
Click LMB on Cancel Selection (D) to cancel the
selection.

=== [[File:Area grab.jpg]] Get displacement (B) ===
Click on Select Area (B). Click LMB on the baseboard
and drag the mouse to make a large square that
covers an existing area of modified terrain. Now
click the “Get Displacement” button and you’ll notice that a
displacement map has been derived from the shape of the
terrain. This can now be used to apply the same terrain effect
in another area.

=TRS2019=

For a basic overview on the Topology Tools in TRS19 you can view the tutorial video [[https://youtu.be/O8n0Z5jQ9q8 HERE]].

TRS2019 introduces several new features in the Topology tools, mostly relating to the new Clutter and TurfFX effects.

[[File:Trs2019-topology-tab.JPG]]

== Main menu (Terrain Mode) ==
=== [[File:Trs2019-topology-tab-height-up.jpg]] Height up (U) ===
Use this tool to create mounds, hills and mountains.
Click on the Height Up tool icon to change to Height Up mode. Move your cursor from the tool tab onto the 3D world and you will see a "circle of influence". Left click and drag your mouse around the 3D world to raise the terrain.
Use Radius and Sensitivity to adjust the size and sensitivity of this tool. To adjust your view of the world as you mould the terrain, right-click on the terrain to move your camera focal point and use your cursor arrow keys to move the camera. Use Undo if you don't like the results you see.

=== [[File:Trs2019-topology-tab-height-down.jpg]] Height down (D) ===
Use this tool to modify the terrain height. Make hollows, valleys, rivers, lakes and oceans.

Click on the Height Down tool icon to change to Height Down mode. Move your cursor from the tool tab onto the 3D world and you will see a "circle of influence". Left click and drag your mouse around the 3D world to lower the terrain.

Use Radius and Sensitivity to adjust the size and sensitivity of this tool. To adjust your view of the world as you mould the terrain, right-click on the terrain to move your camera focal point and use your cursor arrow keys to move the camera. Use Undo if you don't like the results you see.

=== [[File:Trs2019-topology-tab-height-adjust.jpg]] Adjust height (A) ===
Adjust Height allows finer control of the up and down movement. Click LMB and hold then push your mouse away from you to raise the terrain. Click LMB and hold then pull the mouse towards you to lower the terrain.
Generally used for finer adjustments.
Use in conjunction with the Radius and Sensitivity tools.

=== [[File:Trs2019-topology-tab-radius.jpg]] Radius ===
Click LMB on the Radius Tool and move to either side to change the circle of influence. Move the dial right to enlarge the circle (HOTKEY “+”), left to minimize (HOTKEY “-”).
The size of the circle determines the outer limit of influence of the tool.
Whichever tool you have selected (highlighted) will be applied within the area defined by the circle.

=== [[File:Trs2019-topology-tab-sensitivity.jpg]] Sensitivity ===
Click LMB on the Sensitivity Tool and move to either side to change the amount of height changed each time the circle of influence is affected. Move the dial right to make more sensitive (HOTKEY “+”), left to reduce the sensitivity (HOTKEY “-”).

=== [[File:Trs2019-topology-tab-get-height.jpg|48px]] Get height (G) ===
Select Get Height (G), then Click RMB on the side of a hill. Notice that the number in the Height Value field changes. You have captured the height of the terrain at the point your compass appears.
Use in conjunction with the plateau tool to flatten an area to a certain height.

=== [[File:Trs2019-topology-tab-use-height.jpg|48px]] Use height (H) ===
Click on Use Height (H) then Click LMB to apply the selected Height Value to the terrain. The Use Height tool creates a plateau at your selected height and the radius of your cursor circle determines the amount of land that is leveled at one time.
Click and hold LMB then move your mouse around the terrain to level out a broader section.
This tool is not affected by the sensitivity dial.

=== [[File:Trs2019-topology-tab-plateau.jpg|48px]] Plateau (P) ===
Plateau (P) creates a plateau at the current height of the
compass. Click LMB on the side of a hill to create
a plateau at that level by raising or lowering the
terrain.

This tool is affected by the sensitivty dial. Moving your cursor around over pre-existing hills will create a smoothing effect. Adjust the sensitivity to flatten/smooth areas quicker or slower.

=== [[File:Trs2019-topology-tab-height-entry.jpg|48px]] Height value field ===
You can manually enter in the height to apply. Click on the number showing between Get Height and Use Height and manually type in a value.
To apply the selected Height Value to the terrain, click on the Use Height tool then LMB on the terrain.

=== [[File:Trs2019-topology-tab-add-water.jpg|48px]] Add water (W) ===
Click LMB on Add Water (W)
and paint the water texture along the
desired area by moving
your mouse around. The radius of the
cursor circle determines the texture panel size.

=== [[File:Trs2019-topology-tab-delete-water.jpg|48px]] Remove water (Q) ===
Click LMB on Remove Water (Q) and you then delete
the water texture one panel at a time by Clicking
LMB on each water panel.

=== [[File:Trs2019-topology-tab-water-height.jpg|48px]] Adjust Water Height (E) ===
Select the Adjust Water Height
tool and Click LMB and hold (on the water texture) then drag
your mouse forward and back, adjusting the water texture
height until it is the appropriate
height.

=== [[File:Trs2019-topology-tab-water-height-value.jpg|48px]] Water Height Field ===
Enter the height at which you wish to apply the water, then click on Use Water Height. LMB and move your cursor around the terrain to paint the water texture at the height entered.

=== [[File:Trs2019-topology-tab-add-ground.jpg|48px]] Add ground (X) ===
Select the Add Ground (X) tool. Click LMB in the void just off the edge of the baseboard to add another baseboard in that direction.

By default ground sections use a 10m grid, where each adjustable terrain 'point' is 10m apart. If your route requires finer detail you can create sections which use a 5m grid. These ground sections will use four times more memory than the standard 10m grid and should be reserved for when fine detail is absolutely required.

=== [[File:Trs2019-topology-tab-select-grid-size.jpg|48px]] Change Grid Size ===
To create a section with a 5m grid, click on the drop down list to the right of the Add Ground button, and select the 5m option. Now add the terrain as normal. You can also update existing sections by clicking on them whilst the 5m grid option is selected.

=== [[File:Trs2019-topology-tab-delete-ground.jpg|48px]] Delete ground ===
Click LMB on the Delete Section button, then Click
LMB on any baseboard section to delete it. This action cannot be undone, and should be used with care. Deleting a section may also delete splines that cross section boundaries. If the zoom is too far from the surface, this option might be disabled.

== Advanced ==
The Advanced features menu can be opened and closed by
using Shift-F1 or clicking on the Advanced Tab.

The Advanced tab provides access to the Displacement Map tools, and the new Clutter Effects/TurfFX tools.

===Effect Layers===
====[[File:Trs2019-topology-tab-effect-layer.jpg]] Effects Layers ====
Use this drop down menu to select between Displacement Map mode, and Effects Layers mode.

Effect Layers will only be shown if there are Effect Layers configured for the route.

When an Effect Layer is selected, the following tools are used to apply, adjust, or remove the effect layer on the route:

* [[#Height_up_(U)_2|Height Up (U)]] tool will paint the effect onto the terrain; with density growing the more it is 'painted' on.
* [[#Height_down_(D)_2|Height Down (D)]] tool will erase the effect from the terrain, with density reducing the more it is 'erased'.
* [[#Adjust_height_(A)_2|Adjust Height (A)]] tool will adjust the density of the effect on the terrain.
* [[#Radius_2|Radius]] sets the radius for the brush to paint the effect onto the terrain.
* [[#Sensitivity_2|Sensitivity]] sets the density/rate of the brush (the higher the sensitivity, the quicker it will paint the effect up to full density)
* [[#Get_height_(G)_2|Get Height (G)]] gets the current density at the location of the compass.
* [[#Use_height_(H)_2|Use Height (H)]] applies the selected effect density shown in the 'height value field'
* [[#Plateau_(P)_2|Plateau (P)]] applies the effect density from one location to another. To use, left click and hold in one location and then drag to other locations to apply that effect density.
* [[#Height_value_field_2|Height Value Field]] allows you to set a effect density value between 0 and 1, and then use the [[#Use_height_(H)_2|Use Height (H)]] tool to apply that effect density.
* [[#Select_area_(B)_2|Select Area (B)]] allows you to select an area, to then use the [[#Fill_area_(F)_2|Fill Area (F)]] tool to 'fill' that area with the selected effect.
* [[#Fill_area_(F)_2|Fill Area (F)]] allow you to fill the selected area with the selected effect.
* [[#Cancel_selection_(D)_2|Cancel Selection (D)]] allows you to cancel the selection.

See [[Effect_Layer|Effect Layers]] for further information on creating, using, and editing Effect Layers.

====[[File:Trs2019-topology-tab-edit-add-effect-layer.jpg|48px]] Edit/Add Effect Layers====
Opens the Edit/Add Effects Layers tool.

===Displacement Maps===
==== [[File:Trs2019-topology-tab-displacement-map.jpg]] Displacement map ====
Select 'Ground' in the drop down menu to access the displacement map tools. A displacement map is a Trainz [[KIND Groundbrush]] asset that is used to create terrain features quickly and easily. When the displacement map tools are selected there is a second drop down menu that lists the displacement maps that are available. The default is None which is a null displacement. Select an item from the menu to make it the current displacement map: the map will appear in the preview pane. Click the 'x' in the preview pane to reset the map to None.

==== Direction ====
Click the direction arrows at the bottom of the Displacement Map preview to change in the direction you wish the grayscale map to be put down on the baseboard.

==== Displacement Scale====
Move the Displacement Scale slider, below the Displacement Map view, to change the height scale for the displacement map.

==== [[File:Trs2019-topology-tab-select-area.jpg|48px]] Select area (B) ====
Click on Select Area (B). Click LMB and drag the mouse to select the rectangular area to which the displacement will be applied.

==== [[File:Trs2019-topology-tab-fill-area.jpg|48px]] Fill area (F) ====
Scroll through the Displacement Maps, then click on Fill Area (F). The
terrain is instantly transformed into the shape determined by
the grayscale images of the displacement map chosen.

==== [[File:Trs2019-topology-tab-cancel-selection.jpg|48px]] Cancel selection (D) ====
Click LMB on Cancel Selection (D) to cancel the
selection.

==== [[File:Trs2019-topology-tab-get-displacement.jpg|48px]] Get displacement (B) ====
Click LMB on Select Area (B). Click LMBH-d on the baseboard and drag the mouse to select a rectangular area of the terrain. Now click LMB on the “Get Displacement” button and a custom displacement map will be created using the height profile of the selected area, and will show in the preview window. This displacement map can now be used to apply the same terrain effect in another area, using rotation and scaling as required. Click LMB on the tick mark in the preview window and supply a name for the new displacement map - it will be saved with the supplied name and will be available for use in any route.

;<big> See Also </big>
* [[Help:Surveyor_Tools|Surveyor Tools]]
* [[Help:Surveyor|Surveyor]]
* [[Effect_Layer|Effect Layer]]

Return to [[Help:TRS19|TRS19 Help Page]]
[[Category:TRS19]]
[[Category: Help]]

Art Recommendations

2017-11-27T23:48:35Z

Pencil42: /* Modeling Overview */

This document seeks to provide guidance for content creators working at the [[TRS18]] modeling standard. This is a living document and will be updated based on our real-world experiences. That said, content creators should avoid the temptation to ignore the recommendations put forward in this document "for this model only" as that type of thinking quickly leads to an inefficient content set and poor overall performance. Performance is a holistic subject which requires an ongoing commitment.

It is also important to understand the intent of each recommendation, rather than to blindly follow each. There are frequently conflicting demands which only the individual creator can balance. Religiously following the rules without understand why is suitable for beginner creators who are building simple variations on a fixed template, but more advanced creators will need to understand the benefits and tradeoffs of each decision that they make.

=Who is this Document for?=
This document is aimed at all Trainz content creators- whether that be a prolific creator of high-quality scenery, an esteemed creator of train models, a route builder on a long-running and large-scale route project, or just somebody who likes to tinker at home (in some cases all of these are one person!)

Trainz lives or dies by the quality of the third-party content. We expect content creators creating payware or engaging in large-scale freeware content release to take this document to heart, as it is the only way that Trainz can continue to evolve as a product. We understand completely that there are many members of our community to whom much of this document is largely theoretical, because they work in isolation on small home projects, however we hope that the guidelines here will also help these users gain the most from their Trainz experience.

This document provides guidelines on how to use well-known techniques; it does not attempt to teach those techniques. Information on the various techniques described in this document can be found elsewhere on this wiki. Information on general modeling techniques can be found all over the internet.

=Terminology=
This document subdivides Trainz assets into various categories, such as "Major Scenery". These are not necessarily terms found outside this document, but are simply the way that this document describes the category. Do not expect to find these terms used in other documents, within the content config files, or within the game.

=Scene Budget=
* TBD

=Modeling Overview=
All TRS18 art should be built with the following principles in mind:
* There are very few items close to the camera at any time, yet paradoxically these items are typically the most important in the scene. It is very important to ensure that every item looks excellent at extreme close range. The highest [[Level of Detail|LODs]] can afford to be fairly excessive, as long as the extra detail is removed quickly in lower LODs.
* "Background-only" low quality scenery should not exist. Trainz is an open-ended game where users can use any scenery for any purpose, so the original intentions of the content creator cannot be enforced. Trainz offers efficient LOD and stitching systems, so there are no performance gains from creating "low LOD only" models. This is simply lazy modeling. Similarly, we discourage serious route creators from using such models - even if the models are used appropriately in their route - because this causes the scenery to be installed on the end-user's computer when we'd prefer to discourage the use of these items.
* All scenery must have LOD. There are exceedingly few exceptions to this requirement. If your scenery is less than a few hundred polygons, please consider whether the above principle applies to you. For everybody else- you need to be using LOD. Well-built LOD does not make individual content look substantially worse, and allows the overall scene to look much better by significantly increasing the number of items which may be displayed simultaneously.
* You should use [[Physically Based Rendering|PBR materials]] at all times. Our older materials are emulated using the PBR code, so there is no benefit at all in using the older materials, and there are significant gains to be had through the PBR materials.
* Use [[parallax mapping]] wherever it makes sense. There is a performance cost, however it is expected that users will switch it on or off as appropriate for their machine. Parallax is not a miracle-cure for low-polygon modeling, but it can substantially improve the visual quality of an already-decent model.

When modeling:
* Don't create polygons which are not visible. This is pure wastage. An example of this is a cube attached to a wall. A normal cube requires 6 faces (12 polygons). A cube attached to a wall requires 5 faces (10 polygons). This can be a substantial source of wasted performance- not just because of the extra polygons (maybe only a 20% cost), but because of [[overdraw]] (up to 100% cost).
* Avoid creating large polygons where substantial parts of the polygon are not visible. This can introduce expensive overdraw. There is often a tradeoff between overdraw and polygon count which you will need to balance. Adding a small number of extra polygons to halve the overdraw is very worthwhile. Adding thousands of polygons for a small gain in overdraw is probably not.
* Remember that overdraw is paid each time a [[fragment]] is hit. If a given fragment is overlapped by 50 polygons, you are paying up to 5000% cost for that fragment.
* [[Vertex Buffer|Vertices]] are more expensive than fragments, but there is a balance point at which the cost of adding more fragments outweighs the cost of adding more vertices. For example, if you have 100 vertices drawing 100000 fragments, it is substantially cheaper to add 10% more vertices than 10% more fragments.
* Fragments are not [[texel]]s. Both should be optimised, but optimising one does not directly affect the other.
* All polygons are triangles. If your modeling program is working in higher-order polygons, be aware that this is being converted to triangles before it reaches the GPU. Trainz always works in triangles, so there is no separation of these terms in Trainz.
* Vertices are not polygons. A contiguous [[mesh]] gives close to a 1:1 relationship between polygons and vertices. In cases where the meshes are not contiguous (including open edges, or unsmoothed edges) this can move closer to 3 vertices to 1 polygon. There are costs to both vertices and polygons.

When texturing:
* Reduce the number of [[material]]s in your asset. This is true at any detail level, but especially true at lower LOD levels.
* Each separate color [[texture]] usage forces a new material, so the more textures you have, the more materials you have. Reduce the number of textures.
* If you have a large amount of fully-opaque geometry, and a small amount of transparent or masked geometry, this may be a worthwhile reason to split into two separate materials for the higher LODs. In the lower LODs, remember that you're unlikely to have much of either on screen (since the overall screen size is tiny) so it's no longer worth the extra material and you should just go with the transparency-capable one for everything.
* Texture space is reasonably expensive. Don't repeat the same large feature ten times over when you can just texture it once and map the same texture onto several different polygons.
* On the flipside, there is a point at which geometry becomes more expensive. Don't spend thousands of polygons on something that you could implement cheaply in the texture.
* [[Texture tiling]] is a great way to cheaply fill a large polygon with detail, however it has a number of downsides. For starters, it can make it harder (one-way tiling) or impossible (two-way tiling) to share the texture with other geometry. Secondly, each repeat is identical (unless you're using a detail texture) and so the overall result can feel quite unnatural. Be careful about what you choose to tile, to ensure that the gains outweigh the downsides.
* Avoid texture tiling at the lowest LODs. It's typically not a major saving (because even a uniquely-mapped object will only be a handful of texels) and it prevents atlasing (whether by hand, or automated). It is likely to be flagged as an error condition in the future.
* [[Texture Atlas|Atlas]] where it makes sense. All else being equal, if you're going to have three meshes on the screen at the same time, it's better to share a single texture between them rather than use three separate textures.
* Don't atlas where it makes no sense. If you build a [[Mesh Libraries|library]] of assets which share an [[Texture Atlas|atlas texture]], the entire atlas must be loaded at full resolution even if only a single of the assets is loaded. If you know that assets are unlikely to be used together in the same scene, don't atlas them.
* Keep the [[texels-to-meters ratio]] roughly constant across your mesh for best visual results. This is especially important within any given material, as the texture LOD algorithms work with a single pre-calculated ratio per [[render chunk]].
* If your model has painted lines, as often happens with train liveries, consider aligning your texture map such that the lines flow vertically or horizontally along the texture. This may help reduce aliasing, causing your texture to look crisper. Where the lines are lightly curved, you may be able to get away with "cutting out" the line in a small number of rectangular segments, each of which holds a nearly straight line. By aligning each to the texture, you not only straighten the line along the grain of the texture but also reduce the area of texture required to map the line. Remember that you can arbitrarily cut the line at the texture edges, in a similar manner to the lines of text on this page. Straighter lines are likely to give far superior visual results when texture compression is in use.

Texture Compression
* By default, Trainz compresses all textures. You can adjust the texture compression algorithm or turn it off entirely.
* Texture compression saves space (boosting performance and load times and reducing VRAM usage) but reduces quality, sometimes substantially. Natural images tend to fare well, whereas two patches of contrasting colours meeting at a sharp edge can distort noticeably.
* One way to look at texture compression is not that it gains you performance, but rather than it lets you raise the texture resolution while maintaining performance. Seen in this light, texture quality improves while space (performance/etc) stays unchanged.
* Regardless of which way you look at it, texture compression is something that needs to be understood and tuned.
* If you can tune the texture compression settings to improve your result, or adjust how your texture is laid out to avoid the worst artifacts, your visual outcomes can be substantially improved.
* For many textures the default is good enough, but if you're struggling with texture quality, then a reasonable place to start is to turn off texture compression and see what happens. If you're suddenly happy with the result, then try turning it back on and tweaking things.
* While one outcome is that texture compression should be switched off for a given texture, this should only be used once all other avenues have been unsuccessfully exhausted:
** Have you tried raising the texture resolution?
** Have you tried applying the texture map differently; for example changing the angle of the texture features with respect to the texture axes?
** Have you tried different texture compression options in your [[texture.txt file]]?
** If you are only having trouble with particular areas on your model, have you considered changing your mapping to dedicate more texels to these areas?
** Finally, if you really must turn off texture compression, are you able to split the texture into two smaller ones- one which avoids compression for those areas which need maximum quality, and one which is compressed and contains the details where compression doesn't hurt.
*** But be careful of [[draw call]] count. Don't add more textures if you're trying to reduce draw call count.

When it comes to building LODs, the following should be kept in mind:
* LOD transitions take CPU time, GPU time, and may distract the user. Avoid unnecessary transitions. Try to time the transitions so that they can occur at reasonable spacing and shave off a significant number of polygons (etc) with each step. Maximise the gain from each amount of pain.
* Texture LOD is automatic. Do not manually introduce lower-detail textures as this will simply lower performance.
* [[Mesh stitching]] can bring massive performance gains when large numbers of low-polygon meshes with identical materials are used in the scene.
** Mesh stitching does not work on LM meshes.
** Mesh stitching does not work on animated meshes.
** Mesh stitching does not operate on regularly-moving objects such as train vehicles.
** Mesh stitching may not work where modifications have been made to the meshes, such as texture replacement or scripted emissive.
** Mesh stitching requires [[material sharing|shared materials]], but does not require identical meshes.
** [[Texture atlas|Low-LOD atlases]] can benefit mesh stitching because they introduce sharing between meshes which are otherwise not using shared materials.
* [[Hardware instancing]] can bring modest performance gains where many identical meshes exist in the scene which are not otherwise eligible for mesh stitching.
** Hardware instancing does not work on animated meshes.
** Hardware instancing does not work where modifications have been made to the meshes, such as texture replacement or scripted emissive.
** Hardware instancing requires identical meshes, not just shared materials.
* Do not use "lower quality" materials at lowest LOD.
** Material cost is in proportion with the number of fragments, meaning that it is typically negligible for low LOD objects.
*** Unless you're talking about an entire city of buildings, or a forest of trees perhaps.
** The heaviest materials often LOD internally with distance, meaning that they are not as expensive on low LOD (distant) objects anyway.
** You can often use the better materials to maintain graphical quality while the polygon count drops. Dropping polygon count at low LOD is much more important than using cheaper materials.
* Do not test your LOD models at close range and then say "well, it doesn't look any good, this isn't working". Use [[Preview Asset]] on "auto" mode, then zoom in and out to see what the various transitions look like, when they occur, and how many polygons, draw calls, and animations are saved. Or just test the asset in-game. The end-user will never see your low-LOD model up close, so being concerned over its look at close range is entirely missing the point.
* Do zoom in to the low-LOD models using [[preview asset]] manual LOD distance control in order to take a close look at how your LOD models are put together. The end-user will never see this, so it's not what you're actually tuning for, but seeing the model zoomed in like this can help identify problems which are present-but-hard-to-identify at the actual view range.
* TBD: polys vs normals.

Normal Maps:
* Providing a correct [[normal map]] is nearly as important as providing the correct [[albedo]] (surface color) texture and is often more important the providing quality geometry. If your normal map is not suitable, you will end up with incorrect lighting conditions, with dark areas where you expect light or vice versa.
* Normal maps and geometry are traditionally created simultaneously by:
** Building an ultra-high-detail source model.
** Creating a LOD0 game model with a suitably reduce polygon count; this process is often partly automated by the modelling tool, but also typically requires hand adjustment to get optimum efficiency.
** Baking the mesh normals from the high-detail source model into a normal map for the LOD0 game model.
** Rinse and repeat for the other LODs, with the process likely getting more manual as the polygon count gets lower.
* Normal maps are NOT simply color textures. Editing them in photoshop or a similar tool is likely to give poor (and often unexpected) results. If you must edit them per-pixel, be sure to use a linear color space. Photoshop color space is NOT linear by default, and working in a linear color space is non-trivial for beginners. [http://therenderblog.com/how-to-linearize-textures-in-photoshop/ Read this page] for more details. If you get this wrong, your normals will be distorted and probably lean to one side. This may or may not be enough to be noticed immediately in-game, but it will be enough to reduce the visual quality of the overall scene. Additionally, normal maps should contain normalised color values only (ie. the RGB channels must add up to 1.0). Trainz will renormalise your normal maps when they are submitted, however if you are supplying non-normalised values then the end result may not match what you are expecting.
* Normal maps cause the lighting model to act as if additional geometry is present. They do not cause self-shadowing, but do affect the intensity of directional light, they do affect the position of specular reflection, they do affect the direction of cube-mapped reflections, and so on. They are essential when performing LOD because each LOD step replaces a number of polygons with a singular polygon, distorting the remaining normals to an average of those removed. This means that lighting becomes "averaged" over the model, rather than having light and dark in the appropriate areas. The normal map serves to exactly reverse this effect- it distorts the normal data to match the original model on a per-texel basis, thus preserving the play of light across your model as if the original shape was still present.
* Normal maps cannot help your model retain its silhouette. It is important when creating LOD that you preserve the silhouette in your geometry (or perhaps consider alpha masking). The normal map can help with everything else.
* Normal maps are stored in [[tangent space]] and are dependent on the actual geometry present in the LOD as well as the simulated geometry that is represented by the map. This means that it is not appropriate to take a normal map created for one LOD and use it for another substantially different LOD, even if the simulated geometry is identical. "Substantially different" in this case is one in which the [[vertex normals]] or [[UV mapping]] are noticeably different.

Animation:
* Care should be taken when exporting animated meshes to ensure that low-LOD variants or non-animated variants do not still contain bones or other animation data. Even if an animation is not actively being played, costs are incurred by the presence of bones.
* [[LM.txt file]]s allow you to switch off playback of animation past a certain distance. This is a separate decision to whether each submesh of the LM contains bones. An animation can be playing even though no bones are present to visualise it. Separately, an animation can be paused even though bones are present and displaying it. You should take care to both pause the animation at an appropriate distance and also to remove bones from the lowest LOD meshes.
* [[Mesh-table]]s apply animation per submesh. Unlike LM files, they do not share animations between submeshes. If the same animation file is applied to multiple submeshes, this will load several animation instances which will then play independently. This means that mesh-table animations are typically only appropriate where the highest LOD is animated but all lower LODs are not animated. This might be useful where the animation is very subtle (so that the user can notice it when extremely close to the object, but doesn't notice it vanish and doesn't miss it while it's some distance away) but should not be used where the animation makes obvious changes to the mesh- for example on a crane. Subtle foliage wind animations, human/animal idle animations, and fan rotation might be reasonable under these limitations.

General guidelines:
* Don't rely on assumptions that you are doing the right things. There are many ways to make mistakes, and many optimisations are affected by the exact construction of your asset, so it's possible to "tick all the right boxes" and still end up with a poor-performing asset because you aren't using the optimisations you were aiming at.
* Do use the [[preview asset]] in-game. If you are seeing "wrong" results from [[preview asset]] then it is very, very likely that the results are correct and that you are making incorrect assumptions. Do not simply assume that [[preview asset]] is feeding you incorrect information and ignore it: it works by measuring the actual results, not by estimating what should happen.
* Do test your asset in a variety of scenarios, to find any weaknesses: unexpectedly high polygon counts or draw calls, animations active past the point where you can actually see them, overly-visible LOD transitions, etc.
* If you're in doubt about using a texture atlas, err in favor of not using it. Future optimisations may be incompatible with manual atlasing. If you have a clear case where the atlas is a significant benefit, use it- you will win now, and the manual atlas can be removed in the future if it becomes unnecessary.
* The guidelines given in this document are intended to allow you to produce excellent visual results while still maintaining solid performance. If you focus on the maximum polygon count guidelines but ignore the efficiency guidelines, it is of course possible to make terrible-looking content that is still quite expensive for what you get. Don't do this. Before, during, and after creating each asset you should be spending some time to review the performance concerns and ensure that you have built the best model that you can reasonably make.
* A good-looking asset which performs poorly is no more useful than a poor-looking asset that performs well. Don't fall into the trap of making a good-looking mesh and thinking your work is done.

=Route-Building Overview=
* Avoid having the route baseboards end suddenly within line-of-sight of the track. Even if you choose not to fully detail the outer baseboards, at least provide basic geometric detail out to the maximum draw distance. Especially avoid any situation where the baseboard wall is visible.
* Build a palette of scenery and ground textures that is appropriate for your route, and work from that. Don't simply select new scenery from the DLS each time you need to place something. Using a restricted set of content has multiple benefits:
** You can ensure that each selection is visually and functionally appropriate for your route.
** You can test the performance and visuals of your selected content and avoid any poor-performing scenery without having to re-test each placement.
** If it later turns out that some of your scenery needs updating, it is much easier to update a small selection of content which is reused than hundreds of items that are used only once each.
** Performance improves when scenery is used multiple times and reduces when each scenery item is different.
** If you wish to redistribute your route, it is easier to secure the necessary rights and the overall download size is smaller.
* Avoid heavily blending ground textures. It performs poorly and doesn't look good. If the textures that you are using don't look appropriate individually, consider selecting better textures instead.
* Avoid using too many ground textures in a small area. Try to keep to 3-4 textures within any given ~240m x 240m area.
* Use PBR ground textures with parallax. While mixing PBR ground textures with legacy ground texture is possible, it doesn't look as good.
* Carefully read the per-asset guidelines, and select assets which follow the guidelines over those which don't.
* Test your route's performance as you go. Achieving a good selection of assets, good object density, and so on up front is far easier than retrofitting performance once you're done.

=Trains=
==LOD Recommendations==
LM is the appropriate technique for all train vehicles. Mesh stitching is never used, so mesh-table LOD does not provide major benefits, and LM offers more control.
===Locomotives===
The following ranges are appropriate for primary locomotives. All numbers here are as per [[preview asset]]- they include any bogeys, effects, and other attachments. Distances indicate the approximate range in which the LOD will be visible. The exact distances will vary per model- if pushing LOD3 back to start at 350m allows you to bake in the bogeys, for example, the tradeoff is likely worthwhile.

* LOD0: Used at extreme close range (0m-20m). Typically there will only be 1-2 vehicles on screen at this range. Primarily used for inspecting the vehicle and fussing over how pretty it looks. Performance is (within reason) a lesser concern here.
** 100k-150k polygons total.
** Consider using attachments for small heavily-repeated features such as lamps, boxes, fans, etc. This is appropriate for 10-20 features, not for thousands of features. The advantages include the ability to individually LOD the attachments (reducing the overall polygon count active in the scene), the reduction in polygon count on disk (reduced file size) and the possibility of hardware instancing accelerating the rendering (not applicable if animated). There is an associated increase in CPU cost and in draw call count, so this technique should not be used for very-low-poly-count meshes.
** The object will be large on the screen, so reducing overdraw is quite important.
** No more than 50 draw calls total.
** Corona attachment, Particle Effects, etc.
** Animated small details (moving fans, swinging hoses or chains, etc.)
** Modelled interior should be present where there are windows. The interior should have reasonable geometric detail (chairs, etc) but is obviously not seen from inside so should be more representative than precise. Texture detail should be low, as the window should hide most details. The interior will typically be darker than the outside world during daylight conditions, and overbright in nighttime conditions.
** Effects such as font replacement for running numbers and emissive strength adjustment for the interior material may be appropriate.
** Scripted control of the various effects may be appropriate.
* LOD1: Used at close range (20m-50m). There will be several vehicles on the screen in this range but the detail must remain high, so performance is a significant concern. Primarily used when the player is actively working with or around the vehicle.
** 50k-100k polygons total. You can typically knock 30-50% of your LOD0 polygons away.
** Consider reducing or removing your attachments, animations, and effects.
** No more than 20 draw calls total.
** Fully modelled interiors are no longer necessary, but the silhouette seen through the window should be maintained (ie. the opposite wall of the interior should still be visible; if a chair was blocking the view then a low-poly version may still be present, etc. Interior floors and roofs are probably unnecessary.
* LOD2: Used at medium range (50m-250m). There will be a lot of vehicles on the screen, and detail is no longer a major concern.
** 10k-30k polygons.
** 3-8 draw calls.
** If you are finding it hard to reduce detail from LOD1 without a visible change, break this into two transitions (eg. a 30k and a 10k).
** Remove all attachments.
** Remove all non-essential animations. This may mean keeping the bogey wheels (or not) but losing all fans etc.
** Switch off most particle effects, coronas, texture replacement, running numbers, names, etc.
* LOD3: Used at long range (250m-1km).
** 1k-5k polygons.
** 1-3 draw calls.
** Remove all attachments, animations, and effects.
** Optionally bake the bogeys into the mesh.
** This LOD still has the basic shape and texture of the full vehicle, but lacks finesse. Fine details that consume significant polygon counts (eg. pipes, tubes, rails) may be removed entirely and/or burned into the texture. Detail which is still visible but no longer clear can be simplified or converted from geometry to an alpha mask.
** At this level, you're aiming at numbers low enough that things which were noise before are now starting to be problematic. Attachments such as bogeys require at least one draw call, even if their polygon count is tiny at this point, so it's time to consider baking them in.
* LOD4: Extreme range (1km-15km).
** 50-200 polygons.
** 1 draw call.
** No effects.
** Fully baked.
** This LOD is very literally a box. The silhouette needs to be accurate enough to represent the vehicle while occupying only a handful of pixels, so details smaller than about 50cm are entirely invisible.
===Rolling Stock===
The process of modeling rolling stock is fundamentally similar to that of locomotives. Polygon counts "per detail" are expected to be similar. Most rolling stock is considerably simpler than most locomotives however, so as a result the typical rolling stock models will be substantially lower polygon at the same distance when compared to a locomotive. When modelling rolling stock which is as heavily detailed as a typical locomotive, it is acceptable to approach the locomotive detail recommendations instead of staying at the typical rolling stock limits.

As always, avoid the temptation to claim that your asset is special and deserves special attention. Most rolling stock does not require super-high detail, and these numbers are generous:

* LOD0: 30k-60k, 5-20 draw calls.
* LOD1: 10k-30k, 5-15 draw calls.
* LOD2: 5k-10k, 3-8 draw calls.
* LOD3: 1k-3k, 1-3 draw calls, no animation.
* LOD4: 50-200, 1 draw call, no animation, fully baked.

==Scripting==
* TBD

=Flagship Scenery=
A flagship scenery item fits the following criteria:
* Highly detailed.
* Visible over a reasonable range.
** A small statue or plaque, no matter how interesting, is not a flagship.
** The Statue of Liberty is a flagship.
* Only one present in the scene at a time.
** This is obviously under the control of the route creator, not the original modeller, however intentions are telling.
** A business or house that can't easily be identified as different from others is not a flagship.
** An overpass is not a flagship.
** A train station may be a flagship. (But an individual platform is not.)

Flagship scenery items are considered a separate class of object simply because there are times when you might want to build at a detail level which exceeds the guidelines for regular scenery objects. This is obviously something that can be considered, but only in the context of "we will only do this once in the scene". If you were to place several flagship objects together in the scene, performance will obviously suffer.

At the end of the day, we can't stop people making poor-performing content. But having guidelines helps conscientious creators to make decisions about when they should play strictly by the rules, and when they have a little leeway. We consider "Flagship Scenery Items" to be that leeway. It's reasonable to build a truly iconic building (one of the seven wonders, for example, or even something that is iconic only in the local sense) at a higher detail than the average apartment building. But if you find yourself building (or using) run-of-the-mill items without sticking to the scenery budgets below, you're just being lazy.

=Large Scenery=
Large Scenery is anything from roughly the size of a house upward. It's going to be visible from quite some distance away. It's large enough that if you're standing right next to it, it's going to tower above you, or stretch out in each direction. It's something that you're going to want at moderate detail.

Scenery should never be unnecessarily large. There are a number of negatives to creating large scenery. Performance can suffer. Usability can suffer. LOD is less effective since you're "close to the object" for a much larger distance.

In normal usage, it is reasonable to model any singular object as one scenery object, but you should not typically bake several unrelated or semi-related objects into one scenery object. If you have performance concerns with using multiple smaller objects, consider material sharing and/or atlasing, however keep in mind that this is pointless for multi-thousand-polygon meshes (it may still be useful at lower LODs).

In the past, creators (including [[Auran]]) have modelled large composites (eg. an airport, including the terminal building, runway, ancillary buildings, planes, and land vehicles) as a single scenery object. This may have been appropriate at the time but is strongly discouraged in recent versions of Trainz.

Some creators have also attempted to "optimise" their scenery by creating "configurable" scenery objects, such as a house which is scripted so that you can configure the number of windows, floors, roof color, etc. This approach is strongly discouraged as it restricts the game's ability to optimise the content. As time goes on, new methods of optimisation are introduced which are inevitably incompatible with these "optimisation tricks", so they fall rapidly behind in terms of both performance and usability.

Mesh-table LOD gives substantially better performance on scenery objects than LM.

* LOD0: Large scenery is expected to be of substantially lower complexity than a train vehicle, and also of somewhat lower importance to the game environment. As such, despite being physically larger than a train vehicle, it will have less polygons, less draw calls, and less effects.
** 10k-30k polygons.
** 1-5 draw calls.
** No animation.
* LOD1:
** 1k-5k polygons.
** 1-3 draw calls
** No animation.
* LOD2:
** 300-1k polygons.
** 1 draw call.
** No animation.
* LOD3:
** 10-300 polygons.
** 1 draw call.
** No animation.

Large scenery should generally not be animated. Where an animation is required, it should be provided by the use of minor scenery items (that users may then use in conjunction with the large scenery or separately as they wish).

In some cases, large scenery simply must be animated. An example of this is a large (building-sized) crane. In this case, a decision must be made as to how much of the scenery object to animate. If the object is high-poly, and only a small amount of the object is to be animated, it may be worth splitting it into two meshes- one static and one animated. Both meshes may be components of the single Large Scenery asset, but reducing the animated footprint in this fashion can help improve performance and robustness. LM may be used for the animated meshes.

You may consider using similar techniques to those describe under the Locomotive LOD recommendations, such as using attached meshes at higher LODs.

==Scripting==
* TBD

=Trees=
Trees are typically handled different from other scenery, so they're given their own category in this document.
==SpeedTree==
Trainz typically uses [[SpeedTree]] for tree rendering. This is not mandatory, however it is currently the simplest way to build an efficient-but-attractive tree. The SpeedTree tools take care of wind animation, LOD (using an attractive fade transition), atlased billboarding (a technique not currently available to other Trainz assets) and a custom form of mesh stitching.

SpeedTree assets may be constructed with an appropriately licensed copy of the SpeedTree Modeler software from IDV. The SRT file format is version-specific and so the appropriate software versions must be used. [[N3V Games]] is typically unable to assist with acquiring the necessary licenses, however if you are a well-established content creator with specific needs, feel free to contact us on this topic.

SpeedTree assets are relatively performant although it is still possible to overload a scene by adding too many trees. The worst-case scenario tends to be when a large number of trees are placed in very close proximity to the camera, as a distance-based LOD is used and leaf overdraw can be expensive. A SpeedTree-specific performance slider is available in the in-game video settings which allows adjusting the LOD distance separately from other scenery.

Other performance gotchas include using too many different types of tree within one scene, and using too many trees in the scene total (ie. stretching a "horizon to horizon" forest at high density).
==Mesh Trees==
It is also possible to create a tree as a regular scenery asset. In this scenario, it will be your responsibility to create the necessary animations, LOD, etc.

* LOD0: The tree should look as attractive as possible up close. It should minimise the use of tricks and billboards, while staying within the overall polygon budget.
** 1k-4k polygons.
** 1-2 draw calls.
** Optionally animated.
* LOD1: The main difficulty with manual tree scenery creation is maintaining the look of the tree over several LODs while shedding polygons. This tends to be much harder than with manmade objects. You will need to combine smaller leaf cards into larger leaf cards without substantially changing the overall look of the tree. Pay special attention to the silhouette of the tree and the normal map.
** 250-500 polygons.
** 1 draw call.
** Not animated.
* LOD2: The lowest LOD needs to be hugely efficient.
** 1-20 polygons.
** 1 draw call.
** Not animated.

You may find that you need to introduce additional LODs between these steps in order to soften the transitions.

For performance reasons, mesh-table LOD should be used, at least for the lowest LOD.
==Scripting==
* TBD

=Minor Scenery=
Minor Scenery is anything larger than a rock or pot-plant or garbage can, but smaller than a house. This includes cars, camper trailers, commercial garbage bins, boulders, large statues, utility poles, street signs, animals and people, etc.

* LOD0:
** 500-4k polygons.
** 1 draw call.
** Optionally animated.
* LOD1:
** 250-500 polygons.
** 1 draw call.
** Not animated.
* LOD2:
** 1-20 polygons.
** 1 draw call.
** Not animated.

You may find that you need to introduce additional LODs between these steps in order to soften the transitions.

For performance reasons, mesh-table LOD should be used.

Scenery objects in Trainz are not expected to move (animate) over large distances. Any animation should typically stay within a few meters of the object origin.
==Scripting==
* TBD

=Detail Scenery=
Detail Scenery is the smallest class of standalone scenery object in Trainz. This includes small rocks, ferns, small plants and tufts of grass, litter and refuse, toolboxes, etc. Where multiple objects are going to be placed over a wide area, clutter should be used rather than Detail Scenery, however there are many cases where individual placement is desired.

* LOD0:
** 20-2k polygons.
** 1 draw call.
** Optionally animated.
* LOD1:
** 20-200 polygons.
** 1 draw call.
** Not animated.
* Abbreviated draw distance.
==Scripting==
* TBD

=Ground Textures=
Ground Textures are an efficient way to provide a base coverage for the Trainz environment, whether that coverage is grass, sand, rock, gravel, shrubs.. the list goes on. Ground textures come with many benefits but also many tradeoffs.

Ground Textures are a fundamental aspect of Trainz rendering; it is not possible to switch them off entirely. There are however various ways that you can influence the performance and quality of the ground rendering.

TRS18 introduces [[KIND Groundtexture|PBR ground textures]]. These are much higher quality than traditional Trainz ground textures and (if properly constructed) don't suffer from regular tiling in the same way that older textures could. This means that you don't need to continuously change texture and cross-blend textures in order to avoid tiling. In fact, it is very strongly recommended that you do not do this as it may severely impact both visual quality and performance.

PBR ground textures support Parallax rendering. This is an expensive but effective technique which introduces a per-texel heightmap and uses it to deform the ground texture. From most perspectives, this is indistinguishable from actual geometry. The heightmap is self-shadowing and self-occluding. The heightmap will intersect correctly with surrounding geometry.

There are a few flaws in the effect, however:
* Shadowcasting (other than self-shadowing) does not use the heightmap. This is typically not a big concern with ground textures, although if you have the sun shining over a rocky ledge, you may see a hard edged shadow where you expected to see a slightly bumpy shadow.
* As with any fragment shading effect, the geometry is not truly deformed. While you can't tell it at all when looking near 90° to the ground, if you manage to get side-on with a parallax polygon you will see that it is completely flat. What's worse, as you approach close to that state, the geometry (which up to that point seemed solid 3D) will start to deform towards the flat state. Again, this isn't typically a massive concern with ground textures, but it can be visible with certain sharp edges, or on hills some distance away.
* Heightmaps don't allow overlapped geometry, only an upper surface like a shrinkwrap. While some shapes (pebbles, for example) lend themselves to heightmap techniques, other shapes are not possible to accurately represent. This doesn't mean that heightmaps can't be used to give the impression of that shape, but the end result will be representative rather than an exact match.
* Subtlety is the name of the game. This technique is a simulation of depth, and the more that you try to pronounce this, the more the user will notice any flaws. Parallax is best used to give an extra hint of depth rather than trying to replace geometry altogether. Small sticks, roughness, pebbles and flat grass are fine. Large rocks and upright tufts of grass won't work well.

One of the techniques that PBR Ground Textures use to avoid tiling is a "detail map". Instead of applying a single color map repeatedly, the ground textures use two different color maps at different scales. The primary map can also control (per texel) how much it is affected by the detail map. This allows a number of different effects:

* The primary map can be used as a normal ground (eg. grass) texture, repeating every 10m, while the detail map can provide very low resolution noise over 111.1m. The end result tiles once every 11km meters.
* The primary map can be used to display a tiled path. The detail texture can provide a very high resolution cracking and roughness texture. The primary map masks this to apply to the tile areas only, not the gaps or grout. The end result appears to have nearly infinite resolution- even fully zoomed in, the texture still has plenty of detail.

Users may switch off the parallax effect in order to save performance, in which case the PBR ground texture will still look similar but without the effect of the height map. The ground height collapses to a "mid level" without any raising or lowering. The detail map still operates.
==Ground Texture Blending==
Trainz allows multiple textures to be applied to each ground vertex. Since rendering is triangle-based, three vertices worth of textures must be applied to each triangle that is rendered. If we assume that Trainz allows three textures per vertex, then this means that there are up to 9 possible textures applied to any ground triangle simultaneously. Each texture is drawn in a separate pass, so this has the potential to cause a massive amount of [[overdraw]]. Even in older versions of Trainz the performance of ground rendering could vary substantially depending on the route creator's choices. With PBR Ground Textures, this problem would become substantially worse as the materials are much heavier to start with. This is one reason to avoid blending multiple textures. Trainz performance will be substantially improved if single textures are used over wide areas, with blending only occurring at the changeover point (and only between two textures rather than 9 or so).

Because Trainz ground uses a multipass rendering technique, it's not possible to simply take heightmap data from each texture and add them up to determine an overall height. Instead, each parallax texture is processed separately, and only the final color values are added. This can lead to blends between parallax textures having "floating" elements, or ghostly transparencies. The effect isn't a dealbreaker, but nor is it something that we want to have occur too frequently. So this is another reason to avoid blending.

Finally, because of [[z-fighting]] concerns, and also to benefit performance, we only apply parallax on a single texture pass on any given ground triangle. Any secondary texture passes used for blending will revert to a flat surface. Another reason to avoid blending.
=Splines=
Spline assets provide a flexible mechanism for procedurally placing geometry to fit a curved line. Spline assets are typically more expensive to load into the scene than scenery objects, but have various benefits in usability and may have performance benefits.

When used over large areas, Splines offer the ability to define how much distance is covered by each LOD submesh (as opposed to scenery objects, which have a fixed size regardless of LOD). In theory this ability gives a spline the ability to drop to very low polygons-per-meter counts at lower LODs. In practice, this is heavily dependant on the spline creator doing a good job of the LOD, so while it is certainly possible for a spline to be more efficient than equivalent scenery objects, this does not necessarily translate into reality for any given spline asset.

Some key points when creating spline assets include:
* Remember that by far the majority of your most of your spline will be in the far distance. While it's important to keep the high-LOD polygon count under control, it's equally important to ensure that the super-low-LOD has an extremely low polygons-per-meter count. This is typically achieved by using long mesh lengths and subdividing at high LOD.
* Avoid using multiple materials. A single draw call per spline is ideal.
* Avoid using unnecessary child splines. There's no harm in this if you need it, but in many cases it's feasible to build all the geometry into a single spline. If you do use child splines, use a [[texture atlas]] if possible to enable [[mesh stitching]] between the splines.
* Use a good-quality texture with parallax in preference to excessive numbers of polygons. Have enough polygons to provide the basic silhouette, but don't try to model every nook and cranny with geometry.
* Use [[preview asset]] performance analysis mode to test your spline's performance.
==Bridge Splines==
TBD.

==Track Splines==
TBD.

==Road Splines==
Road splines can come in many variations. This section specifically refers to road splines with negligible depth, as opposed to elevated highways or similar (which could probably be considered 'large splines').

* TBD: z-fighting and ground penetration

* LOD0 - polygons, meters?
* LOD1 - polygons, meters?
* LOD2 - polygons, meters?

* TBD: crossroads
* TBD: train crossings
==Large Splines==
This includes splines such as high-voltage transmission towers, large dam walls, etc. These are items which will be visible from a substantial distance, but of which there are unlikely to be a large number in the scene. These are items which are naturally splines- not things like a line of discrete trees which could equally be built as a non-spline object.

* LOD0 - polygons, meters?
* LOD1 - polygons, meters?
* LOD2 - polygons, meters?
==Minor Splines==
This includes splines such as fences, residential power-lines, hedges, small cliffs, etc. These are items which may be visible from a moderate distance, but aren't overly prominent. These are items which are naturally splines- not things like a line of discrete trees which could equally be built as a non-spline object.

* LOD0 - polygons, meters?
* LOD1 - polygons, meters?
* LOD2 - polygons, meters?
==Detail Splines==
A "Detail Spline" is a scenery-only spline which is used to represent a line of some repeating mesh such as shrubs, flowers, cars, etc. It is typically either used to simplify placement (two clicks rather than one click per mesh) or in an attempt (often misguided) to improve performance by rendering large sections of geometry with a single object.

Using splines to represent fine details is not recommended. This approach tends to be slow to load and is often expensive to render. That's not to say that it's impossible, but any such splines should be used with caution as they can severely impact performance if misused, overused, or simply if poorly created.

Where detail splines are used, care must be taken to:

* Minimise the number of spline instances placed in a given scene.
* Minimise the number of detail spline assets used in the route.
* Minimise the polygon count per meter of the spline through efficient use of LOD.
* Use only a single draw call per spline asset. (ie. Only one material.)

KIND Texture-group

2015-06-22T15:19:32Z

Pencil42: Updated to reference .texture files instead of image files directly

[[KIND Texture-group]] defines a group of textures as an asset that can be referenced from another asset or via scripting.

[[Image:Example.jpg]]

==KIND Hierarchy==
===Parent Classes===
* [[KIND TrainzBaseSpec]]
===Child Classes===
* ''none.''

==Supported Tags==
''TBD''

==Example Config.txt==

kuid <kuid:171456:100034>
trainz-build 3.5
category-class "JO"
category-region "AU"
category-era "1810s"
username "testTextureGroup"
kind "texture-group"
description "Test texture group."
textures
{
0 "1.texture"
1 "2.texture"
2 "3.texture"
}
thumbnails
{
0
{
image "thumb.jpg"
width 240
height 180
}
}
An example for the use of "texture-group" is a destination board system. See [[HowTo/Implement_a_Destination_Sign_System|How to Implement a Destination Sign System]].

Note that as of TANE, all textures must be referenced as .texture files, not the image file (.bmp, .tga, etc) itself.

==Categories==
[[Category:Asset KIND|T]]
[[Category:TBD]]

Class World

2011-04-18T20:54:12Z

Pencil42: /* PlaySound */ changed return value as per TS12

*[[TrainzScript Language Reference|API Hierarchy]]
**World
 
*World is a static class used to access various aspects of the Trainz environment.
 

==Constants==
*These constants are used to define various values and can be used as mnenomics.
*If accessed from scripts the values must be prefixed ''World.'', for example:
World.SetWeather(World.WEATHER_TYPE_LIGHT_SNOW,World.WEATHER_CHANGEABILITY_PERIODIC);
 

===Camera View Modes===
----
*These values can be used either to choose the current camera viewing mode through World.SetCameraMode(), or to restrict certain camera modes from being accessed through methods such as World.SetCamera().

{{TableHeader|width=95%|margin=15px}}
|width=375|public define int CAMERA_INTERNAL = 1||Internal cabin camera view.
|-
|public define int CAMERA_EXTERNAL = 2||External train camera view
|-
|public define int CAMERA_TRACKING = 4||External tracking camera view.
|-
|public define int CAMERA_ROAMING = 128||Roaming camera view.
|}
 

===Camera Flags===
----
*These flags are used in addition to the Camera Mode Flags to allow or disallow specific camera actions.
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int CAMERA_SWITCH_VIEWS = 8||User permitted to swap between the camera views.
|-
|public define int CAMERA_SWITCH_VEHICLES = 16||User permitted to swap vehicles within the current train.
|-
|public define int CAMERA_SWITCH_TRAINS = 32||User permitted to swap to other trains which are in the consist menu.
|-
|public define int CAMERA_LOCKED = 64||User is NOT permitted to adjust camera (i.e. zoom, pan etc.).
|-
|public define int CAMERA_NORMAL = * ||Normal camera mode where everything is permitted.
|-
|colspan=2|* NOTE: CAMERA_NORMAL = CAMERA_INTERNAL | CAMERA_EXTERNAL | CAMERA_TRACKING | CAMERA_SWITCH_VIEWS | CAMERA_SWITCH_VEHICLES | CAMERA_SWITCH_TRAINS
|}
 

===Weather Type Constants===
----
*Define the current state of the weather in Trainz.
*A variety of weather conditions are supported and can be changed by using one of these values with the World.SetWeather() method.
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int WEATHER_TYPE_CLEAR = 0||Clear weather, no clouds, rain or snow.
|-
|public define int WEATHER_TYPE_CLOUDY = 1||Cloudy weather, no rain.
|-
|public define int WEATHER_TYPE_DRIZZLE = 2||Drizzle, light rain.
|-
|public define int WEATHER_TYPE_RAIN = 3||Rainy weather.
|-
|public define int WEATHER_TYPE_STORMY = 4||Stormy weather that includes lightning and thunder.
|-
|public define int WEATHER_TYPE_LIGHT_SNOW = 5||Snowing lightly.
|-
|public define int WEATHER_TYPE_MEDIUM_SNOW = 6||Medium level snow fall.
|-
|public define int WEATHER_TYPE_HEAVY_SNOW = 7||Heavy snow fall.
|}
 

===Weather Changeability Constants===
----
*Define the changeability settings for the weather.
*Weather changeability refers to variability of weather conditions rather than to a specific weather type.
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int WEATHER_CHANGEABILITY_NONE = 0||Weather remains static.
|-
|public define int WEATHER_CHANGEABILITY_PERIODIC = 1||Periodic changes in weather.
|-
|public define int WEATHER_CHANGEABILITY_EXTREME = 2||Extreme and frequent changes in weather.
|}
 

===Time Values===
----
*Time constants defined in seconds.
{{TableHeader|width=95%|margin=15px}}
|width=375|public define float TIME_SECOND = 1.0f||One second.
|-
|public define float TIME_MINUTE = TIME_SECOND * 60.0f||One minute, 60.0 seconds.
|-
|public define float TIME_HOUR = TIME_MINUTE * 60.0f||One hour, 60.0 minutes, 3600.0 seconds.
|-
|public define float TIME_DAY = TIME_HOUR * 24.0f||One day, 24 hours, 1440.0 minutes, 86400.0 seconds.
|}
 

===Time Rate Constants===
----
*Values that define the time rates relative to normal time.
*These constants can be used to set the time rate that Trainz runs out through the World.SetGameTimeRate() method.
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int TIME_RATE_1X = 0||Real time (i.e. time in Trainz passes at the same rate as in the real world)
|-
|public define int TIME_RATE_2X = 1||Time passes at twice normal speed.
|-
|public define int TIME_RATE_4X = 2||
|-
|public define int TIME_RATE_8X = 3||
|-
|public define int TIME_RATE_16X = 4||
|-
|public define int TIME_RATE_32X = 5||
|-
|public define int TIME_RATE_60X = 6||
|-
| public define int TIME_RATE_120X = 7||
|-
| public define int TIME_RATE_240X = 8||
|-
|public define int TIME_RATE_360X = 9||
|-
|public define int TIME_RATE_480X = 10||
|-
|public define int TIME_RATE_720X = 11||
|-
|public define int TIME_RATE_960X = 12||
|-
|public define int TIME_RATE_1200X = 13||
|-
|public define int TIME_RATE_1440X = 14||
|}
 

===Trainz Modules===
----
*Trainz module mode constants.
*These values define the various module environments that Trainz can be in.
{{TableHeader|width=95%|margin=15px}}
|width=375|public define int NO_MODULE = 0||Trainz not running in a module.
|-
|public define int SURVEYOR_MODULE = 1||Trainz is currently running in Surveyor.
|-
|public define int DRIVER_MODULE = 2||Trainz is currently running in Driver.
|}
 

==Related Messages==
* [[TrainzScript Message Reference]] 
* [[Camera Messages]] 
* [[Interface Messages]] 
* [[ModuleInit Message]] 
 

==AddDriverCharacter==
{{MethodHeader|public native DriverCharacter AddDriverCharacter(Asset driverCharacterAsset)}}
;Parameters
*'''driverCharacterAsset''' = Asset containing character to be added.
;Returned Value
*Reference to the DriverCharacter if successful, null otherwise.
;Syntax
DriverCharacter Casey = World.AddDriverCharacter(CaseyJones);
;Notes
 

==AddDriverCommand==
{{MethodHeader|public native DriverCommand AddDriverCommand(Asset driverCommandAsset)}}
;Parameters
*'''driverCommandAsset''' = Asset containing command to be added.
;Returned Value
*Reference to the DriverCommand if successful, null otherwise.
;Syntax
DriverCommand GoFaster = World.AddDriverCommand(accelerate);
;Notes
 

==CreateBehavior==
{{MethodHeader|public native ScenarioBehavior CreateBehavior(KUID kuid, Soup initialProperties)}}
;Parameters
*'''kuid''' = KUID of scenario.
'''initialProperties''' = Soup object containing initial properties for scenario.
;Returned Value
*Reference to the ScenarioBehavior created if successful, null otherwise.
;Syntax
ScenarioBehavior scenario = World.CreateBehavior(scenarioAsset, scenarioSoup);
;Notes
*The returned ScenarioBehavior object may be ended by releasing all references to it (resetting all references to null).
 

==CreateTrain==
{{MethodHeader|public native Train CreateTrain(KUID[ ] consist, string trackmarkName, bool direction) public native Train CreateTrain(KUID[ ] consist, TrackMark trackmark, bool direction) public native Train CreateTrain(KUID[ ] consist, Buildable buildable, string trackName, float position, bool direction)}}
;Parameters
*'''consist''' = An array of vehicle KUIDs used to describe the required Train object.
*'''trackmarkName''' = Name of Trackmark at which the consist is to be formed.
*'''buildable''' = Buildable on which the consist is to be formed.
*'''trackName''' = Name of track within Buildable object.
*'''position''' = Distance at which the Train is to be placed relative to the start of the track.
*'''trackmark''' = Reference to Trackmark at which the consist is to be formed.
*'''direction''' = Orientation of Train relative to direction of track or trackmark.
;Returned Value
*Reference to the Train created if successful, null otherwise.
;Syntax
Train train = World.CreateTrain(consist, buildable, "Track 1", 10.0, true);
;Notes
*These methods create a train from a list of vehicles in a consist array.
*Depending on the variant of the method used, the train can be created at a Trackmark, specified by name or reference, or at a Buildable or Industry object.
*It is the responsibility of the script programmer to ensure that sufficient track exists at the given location to allow the train to be created.
 

==DeleteTrain==
{{MethodHeader|public native void DeleteTrain(Train train)}}
;Parameters
*'''train''' = train to be deleted from map.
;Returned Value
*None
;Syntax
World.DeleteTrain(flyingScotsman);
;Notes
*Once a train has been deleted, care should be taken to avoid using its reference.
 

==DeleteVehicle==
{{MethodHeader|public native void DeleteVehicle(Vehicle vehicle)}}
;Parameters
*'''vehicle''' = vehicle to be deleted from its train.
;Returned Value
*None
;Syntax
World.DeleteVehicle(vehicles[vehicles.size()-1]);
;Notes
*Use Train.GetVehicles() to obtain an array of vehicles for a given train.
*Use Vehicle.GetMyTrain() to obtain a train reference for a given vehicle.
 

==FindAsset==
{{MethodHeader|public native Asset FindAsset(KUID kuid)}}
;Parameters
*'''kuid''' = KUID of Asset to return.
;Returned Value
*Given a valid KUID parameter, this method return an Asset reference if successful, null otherwise.
;Syntax
Asset asset = World.FindAsset(kuid);
;Notes
*See also Asset.FindAsset()
 

==FindDriverCommand==
{{MethodHeader|public native DriverCommand FindDriverCommand(Asset driverCommandAsset)}}
;Parameters
*'''driverCommandAsset''' = Asset containing command to be added.
;Returned Value
*Reference to the DriverCommand if successful, null otherwise.
;Syntax
DriverCommand GoFaster = World.FindDriverCommand(accelerate);
;Notes
 

==GetAssetList==
{{MethodHeader|public native Asset[ ] GetAssetList(string kind)}}
;Parameters
*'''kind''' = String representing the Kind of asset to return.
;Returned Value
*A list of all assets of the given ''kind''
;Syntax
Asset[] Libraries = World.GetAssetList("Library");
;Notes
*All installed assets of the given ''kind'' are returned, irrespective of whether or not they are in use on the current map.
 

==GetBadWeatherFog==
{{MethodHeader|public native float GetBadWeatherFog(void)}}
;Parameters
*None
;Returned Value
*Bad weather fog distance as a float in the range 0.0..1.0.
;Syntax
float dist = World.GetBadWeatherFog();
;Notes
 

==GetBehaviors==
{{MethodHeader|public native ScenarioBehavior[ ] GetBehaviors(void)}}
;Parameters
*None
;Returned Value
*A list of top-level behaviors or rules on the currently loaded route.
;Syntax
ScenarioBehavior[] rules = World.GetBehaviors();
;Notes
 

==GetCameraPositionX==
{{MethodHeader|public native float GetCameraPositionX(void)}}
;Parameters
*None
;Returned Value
*X Coordinate of the current camera position.
;Syntax
float X = World.GetCameraPositionX();
*Notes
 

==GetCameraPositionY==
{{MethodHeader|public native float GetCameraPositionY(void)}}
;Parameters
*None
;Returned Value
*Y Coordinate of the current camera position.
;Syntax
float Y = World.GetCameraPositionY();
*Notes
 

==GetCameraPositionZ==
{{MethodHeader|public native float GetCameraPositionZ(void)}}
;Parameters
*None
;Returned Value
*Z Coordinate of the current camera position.
;Syntax
float Z = World.GetCameraPositionZ();
*Notes
 

==GetCurrentModule==
{{MethodHeader|public native int GetCurrentModule(void)}}
;Parameters
*None
;Returned Value
*An integer representing the current Trainz module.
;Syntax
int module = World,GetCurrentModule();
;Notes
* See [[#Trainz Modules|Trainz Modules]] for details of the constants associated with this method.
* See [[ModuleInit Message]] for further details.
 

==GetDriverCharacterList==
{{MethodHeader|public native DriverCharacter[ ] GetDriverCharacterList(void)}}
;Parameters
*None
;Returned Value
*An array of DriverCharacter objects installed in the current world.
;Syntax
DriverCharacter[] drivers = World.GetDriverCharacterList();
;Notes
 

==GetDriverCommandList==
{{MethodHeader|public native DriverCommand[ ] GetDriverCommandList(void)}}
;Parameters
*None
;Returned Value
*An array of DriverCommand objects installed in the current world.
;Syntax
DriverCommand[] commands = World.GetDriverCommandList();
;Notes
 

==GetGameTime==
{{MethodHeader|public native float GetGameTime(void)}}
;Parameters
*None
;Returned value
*Current game time.
;Syntax
float Now = World.GetGameTime();
;Notes
*The returned time is normalised to a value between 0.0 and 1.0
*0.0 = midday.
*0.5 = midnight
*Use the [[#Time_Values|Time Value]] constants to convert the normalised values to human readable times.
 

==GetGoodWeatherFog==
{{MethodHeader|public native float GetGoodWeatherFog(void)}}
;Parameters
*None
;Returned Value
*Good weather fog distance as a float in the range 0.0..1.0.
;Syntax
float dist = World.GetGoodWeatherFog();
;Notes
 

==GetGroundDrawDistance==
{{MethodHeader|public native float GetGroundDrawDistance(void)}}
;Parameters
*None
;Returned Value
*Ground draw distance in metres.
;Syntax
float dist = World.GetGroundDrawDistance();
;Notes
 

==GetIndustryList==
{{MethodHeader|public native GameObject[ ] GetIndustryList(void)}}
;Parameters
*None
;Returned Value
*An array of references to all of the Industry objects for the current route.
;Syntax
GameObject[] Industries = World.GetIndustryList();
;Notes
 

==GetJunctionList==
{{MethodHeader|public native Junction[ ] GetJunctionList(void)}}
;Parameters
*None
;Returned Value
*An array of references to all of the trackside junction objects for the current route.
;Syntax
Junction[] junctions = World.GetJunctionList();
;Notes
*Junction objects attached to fixed track junctions are not currently returned by this method.
 

==GetLibrary==
{{MethodHeader|public native Library GetLibrary(KUID kuid)}}
;Parameters
*'''kuid''' = KUID of script library asset to load.
;Returned Value
*A reference to the script library asset if successful, null otherwise.
;Syntax
Library codelib = World.GetLibrary(LibraryKUID);
;Notes
*The [[Class Library|Library]] asset is initialised when this method is first called in a session.
*Since only one instance can exist, subsequent calls return a reference to the existing Library object.
*See [[Class Library|Library]] for notes on how to use this method.
 

==GetSceneryDrawDistance==
{{MethodHeader|public native float GetSceneryDrawDistance(void)}}
;Parameters
*None
;Returned Value
*Scenery draw distance in metres.
;Syntax
float dist = World.GetSceneryDrawDistance();
;Notes
 

==GetSeconds==
{{MethodHeader|public native float GetSeconds(void)}}
;Parameters
*None
;Returned Value
*The current value of a floating point number incrementing once per second in real time.
;Syntax
float start = World.GetSeconds();
// do stuff
float finish = World.GetSeconds();
float period = finish - start;
;Notes
*Each call will return a float value containing the current value of an internal counter.
*Subtracting a later value from a value saved at an earlier call will enable the delay between the two calls to be established.
 

==GetSignalList==
{{MethodHeader|public native Signal[ ] GetSignalList(void)}}
;Parameters
*None
;Returned Value
*An array of references to all of the signal objects for the current route.
;Syntax
Signal[] signals = World.GetSignalList();
;Notes
 

==GetStringTable==
{{MethodHeader|public native StringTable GetStringTable(void)}}
;Parameters
*None
;Returned Value
*The StringTable for the current session.
;Syntax
StringTable data = World.GetStringTable();
;Notes
 

==GetSurveyorSavedConsist==
{{MethodHeader|public native Soup GetSurveyorSavedConsistList(string name)}}
;Parameters
*'''name''' = Name of the consist to retireiev.
;Returned Value
*Returns a Soup definition of the named consist if it exists, null otherwise.
;Syntax
Soup consist = World.GetSurveyorSavedConsist("Brighton Belle");
;Notes
*Remember that the returned data is in a Soup format, which is not the same thing as a Train.
*TrainUtil.CreateTrainFormSoup() can be used to create a train from the returned Soup.
*This method only works in Surveyor.
 

==GetSurveyorSavedConsistList==
{{MethodHeader|public native string[ ] GetSurveyorSavedConsistList()}}
;Parameters
*None
;Returned Value
*An array of names of all the saved consist objects in Surveyor.
;Syntax
string[] consists = World.GetSurveyorSavedConsistList();
;Notes
*This method only works in Surveyor.
 

==GetTrackmarkList==
{{MethodHeader|public native TrackMark[ ] GetTrackmarkList(void)}}
;Parameters
*None
;Returned Value
*An array of references to all of the trackmark objects for the current route.
;Syntax
Trackmark[] trackmarks = World.GetTrackmarkList();
;Notes
 

==GetTrainList==
{{MethodHeader|public native Train[ ] GetTrainList(void)}}
;Parameters
*None
;Returned Value
*An array of references to all of the trains for the current route.
;Syntax
Train[] trains = World.GetTrainList();
;Notes
 

==GetTrainzBuild==
{{MethodHeader|public native int GetTrainzBuild(void)}}
;Parameters;
*None
;Returned Value
*Gets the current build number of Trainz.
;Syntax
int build = World.GetTrainzBuild();
;Notes
*The value returned corresponds to the build number you can see in the bottom-right side of the main Trainz menu screen.
 

==GetTrainzVersion==
{{MethodHeader|public native float GetTrainzVersion(void)}}
;Parameters
*None
;Returned Value
*The TRS version number.
;Syntax
float version = World.GetTrainzVersion();
;Notes
*The value returned corresponds to the version number you can see in the bottom-right side of the main Trainz menu screen.
 

==GetTriggerList==
{{MethodHeader|public native Trigger[ ] GetTriggerList(void)}}
;Parameters
*None
;Returned Value
*An array of references to all of the trigger objects for the current route.
;Syntax
Trigger[] triggers = World.GetTriggerList();
;Notes
*This method does not return scenery triggers, ie those attached to SceneryWithTrack objects and their descendants.
 

==GetVehicleList==
{{MethodHeader|public native Vehicle[ ] GetVehicleList(void)}}
;Parameters
*None
;Returned Value
*An array of references to all of the vehicles in the current route.
;Syntax
Vehicle[] vehicles = World.GetVehicleList();
;Notes
 

==GetWeatherChangeability==
{{MethodHeader|public native int GetWeatherChangeability(void)}}
;Parameter
*None
;Returned Value
*One of the [[#Weather_Changeability_Constants|Weather Changeability Constants]] denoting the variability of weather conditions.
;Syntax
int variability = World.GetWeatherChangeability();
;Notes
 

==GetWeatherType==
{{MethodHeader|public native int GetWeatherType(void)}}
;Parameter
*None
;Returned Value
*One of the [[#Weather_Type_Constants|Weather Type Constants]] denoting the current weather conditions.
;Syntax
int weather = World.GetWeatherType();
;Notes
 

==LoadMap==
{{MethodHeader|public native bool LoadMap(KUID kuid)}}
;Parameters
*'''kuid''' = KUID of map to load.
;Returned Value
*True if successful, false otherwise.
;Syntax
if (World.LoadMap(mapKUID) Interface.Print("Map loaded OK");
else Interface.Print("Map load failed");
;Notes
 

==Play2DSound==
{{MethodHeader|public float Play2DSound(Asset asset, string wave)}}
;Parameters
*'''asset''' = Asset where the sound file is located.
*'''wave''' = Name of the ''*.wav'' file to be played, a relative path can be included.
;Returned Value
*The length of the sound file in seconds.
;Syntax
// Play the sound and continues script execution.
World.Play2DSound(soundAsset,"sounds/allaboard.wav");
// Wait until sound has completed before continuing.
Sleep(World.Play2DSound(soundAsset,"sounds/allaboard.wav"));
;Notes
*Plays a ''.wav" sound file from the given asset's folder.
*The sound is non directional and can be mono or stereo.
*This method does not return after the sound has finished playing, it returns with the length of the sound as soon as it is called.
*This means your code will keep on executing while Trainz is playing the sound.
*If you want to wait for the sound to complete playing before moving on, wrap the Play2DSound() call up in a Sleep() call.
*Remember that Sleep() can't always be used.
 

==PlaySound==
{{MethodHeader|public native float PlaySound     (Asset asset, string wave, float vol, float near, float far, GameObject target, string pt)     (Asset asset, string wave, float vol, float near, float far, GameObject target, string pt, bool loop)}}
;Parameters
*'''asset''' = Asset where the sound file is located.
*'''wave''' = Name of the ''*.wav'' file to be played, a relative path can be included.
*'''vol''' = Volume level to play the sound at
*'''near''' = Distance from the target asset at which the sound will be played at maximum volume.
*'''far''' = Distance from the target asset at which the sound will become inaudible.
*'''target''' = GameObject to which the sound will be attached if a 3d sound is required, null for 2D.
*'''pt''' = Name of attachment point in the target object if a 3d sound is required, null for 2D.
*'''loop''' = (Optional) If true the sound will loop continuously.
;Returned Value
*<strike>The length of the sound file in seconds.</strike>
*NOTE: In TS12, the returned value is now undefined, and currently always returns '10'. This is to remove the performance cost of having to read the file from disk immediately to determine the sound length before the function can complete.
;Syntax
// Play the sound and continues script execution.
World.PlaySound(soundAsset,"sounds/allaboard.wav",1000.0,10.0,100.0,Station,"a.loudspeaker");
// Wait until sound has completed before continuing.
Sleep(World.PlaySound(soundAsset,"sounds/allaboard.wav",1000.0,10.0,100.0,Station,"a.loudspeaker"));
;Notes
*Plays a ''.wav'' sound file from the given asset's folder.
*If the sound is to be directional a mono sound file is required.
*This method does not return after the sound has finished playing, it returns with the length of the sound as soon as it is called.
*This means your code will keep on executing while Trainz is playing the sound.
*If you want to wait for the sound to complete playing before moving on, wrap the PlaySound() call up in a Sleep() call.
*Remember that Sleep() can't always be used.
*The sound volume will be at a maximum for a camera position at or less than the value of the ''near'' parameter and will reduce with distance until the hearing position reaches ''far'', when the sound will be inaudible.
 

==RemoveDriverCharacter==
{{MethodHeader|public native void RemoveDriverCharacter(DriverCharacter driver)}}
;Parameters
*'''driver''' = DriverCharacter to remove.
;Returned Value
*None
;Syntax
World.RemoveDriverCharacter(dave);
;Notes
 

==RemoveDriverCommand==
{{MethodHeader|public native void RemoveDriverCommand(DriverCommand command)}}
;Parameters
*'''command''' = DriverCommand to remove.
;Returned Value
*None
;Syntax
World.RemoveDriverCommand(driverCommand);
;Notes
 

==SetBadWeatherFog==
{{MethodHeader|public native void SetBadWeatherFog(float distance)}}
;Parameters
*'''distance''' = Bad weather fog distance to set.
;Returned Value
*None
;Syntax
World.SetBadWeatherFog(0.5);
;Notes
 

==SetCamera==
{{MethodHeader|public native bool SetCamera(MapObject focus) public native void SetCamera(Junction focus) public native void SetCamera(Vehicle focus, int cameraMode) public native void SetCamera(Train focus, int cameraMode)}}
;Parameters
*'''focus''' = Object on which the camera is to be focused.
*''cameraMode''' = One of the [[#Camera_View_Modes|Camera View Mode]] constants defining the view which should be assigned to the camera.
;Returned Value
*The first variant returns a boolean to indicate success or failure.
*Remaining variants do not return a value
'Syntax
World.SetCamera(train.GetVehicles[0],World.CAMERA_TRACKING); // sets the camera to track the first vehicle in the train.
 

==SetCameraAngle==
{{MethodHeader|public void SetCameraAngle(int yaw, int pitch, float radius)}}
;Parameters
*'''yaw''' = Camera rotation in degrees, 90 is a direct front view.
*'''pitch''' = Camera angle relative to the horizon, 0 is horizontal, 90 points vertically upwards.
*'''radius''' = Distance in metres to the object in focus.
;Returned Value
*None
;Syntax
World.SetCameraAngle(90,0,25); // Sets the camera to a direct frontal view at 25 metres from the currently focused object.
;Notes
*''Radius'' is measured from the object origin point (0,0,0).
 

==SetCameraFlags==
{{MethodHeader|public native void SetCameraFlags(int flags)}}
;Parameter
*'''flags''' integer value defining what the user is permitted to do with the game camera.
;Returned Value
*None
;Syntax
// User is permitted to select External or Tracking views only.
World.SetCameraFlags(World.CAMERA_EXTERNAL | World.CAMERA_TRACKING);
;Notes
*Use any combination of [[#Camera_Flags|Camera Flags]] and [[#Camera_View_Modes|Camera View Modes]] to set the parameter.
 

==SetCameraMode==
{{MethodHeader|public void SetCameraMode(int mode)}}
;Parameter
*'''mode''' = Camera mode to select.
;Returned Value
*None
;Syntax
World.SetCameraMode(World.CAMERA_TRACKING);
;Notes
*Use one of the [[#Camera_View_Modes|Camera View Modes]] to set the parameter.
 

==SetGameTime==
{{MethodHeader|public void SetGameTime(float time)}}
;Parameters
*'''time''' = new gane time to set.
;Returned Value
*None
;Syntax
World.SetGameTime(0.5); // sets time to midnight
;Notes
*Game time is normalised to a value between 0.0 and 1.0
*0.0 = midday.
*0.5 = midnight
*Use the [[#Time_Values|Time Value]] constants to convert human readable times to normalised values.
 

==SetGameTimeRate==
{{MethodHeader|public native void SetGameTimeRate(float rate)}}
;Parameters
*'''rate''' = New time rate to set.
;Returned Value
*None
;Syntax
World.SetGameTimeRate(World.TIME_RATE_8X); // sets game time to advance by 8 minutes per minute of real world time.
;Notes
*Use one of the [[#Time_Rate_Constants|Time Rate Constants]] to define the parameter.
 

==SetGoodWeatherFog==
{{MethodHeader|public native void SetGoodWeatherFog(float distance)}}
;Parameters
*'''distance''' = Good weather fog distance to set.
;Returned Value
*None
;Syntax
World.SetGoodWeatherFog(0.5);
;Notes
 

==SetGroundDrawDistance==
{{MethodHeader|public native void SetGroundDrawDistance(float distance)}}
;Parameters
*'''distance''' = Ground draw distance in metres.
;Returned Value
*None
;Syntax
World.SetGroundDrawDistance(1000.0);
;Notes
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.
 

==SetSceneryDrawDistance==
{{MethodHeader|public native void SetSceneryDrawDistance(float distance)}}
;Parameters
*'''distance''' = Scenery draw distance in metres.
;Returned Value
*None
;Syntax
World.SetSceneryDrawDistance(1000.0);
;Notes
*Compatibility warning: Use of this function is not recommended, it may become non-functional in future Trainz versions.
 

==SetTargetObserver==
{{MethodHeader|public void SetTargetObserver(GameObject observer)}}
;Parameters
*'''observer''' = ?
;Returned Value
*None
;Syntax
?
;Notes
*One of the great unsolved mysteries of Trainz
 

==SetWeather==
{{MethodHeader|public native void SetWeather(int type, int changeability)}}
;Parameters
*'''type''' = Weather conditions as defined by one of the [[#Weather_Type_Constants|Weather Type Constants]].
*'''change''' = Weather variation as defined by one of the [[#Weather_Changeability_Constants|Weather Changeability Constants]].
;Returned Value
*None
;Syntax
World.SetWeather(World.WEATHER_TYPE_HEAVY_SNOW,World.WEATHER_CHANGEABILITY_EXTREME); // April in Paris.
;Notes
 

==UserSetCamera==
{{MethodHeader|public native bool UserSetCamera(GameObject target)}}
;Parameters
*'''target''' = GameObject to set focus to.
;Returned Value
*True if successful, false otherwise.
;Syntax
World.UserSetCamera(Router,GetGameObject("Junction 5"));
;Notes
 

==UserSetCameraMode==
{{MethodHeader|public native void UserSetCameraMode(int mode)}}
;Parameters
*'''mode''' = One of the [[#Camera_View_Modes|Camera View Modes]]
;Returned Value
*None
;Syntax
World.UserSetCameraMode(World.CAMERA_ROAMING); // switches to roaming view if permitted.
;Notes
*This method respects the current [[#Camera_Flags|Camera Flag]] settings, disallowing any change which the flags do not permit.
 

==Categories==
[[Category:Script Class]]

"Smoke" container

2010-11-23T04:17:01Z

Pencil42: /* Supported Tags */ Changed inheritVelocity to inherit-Velocity as per NarrowGauge's post at http://forums.auran.com/trainz/showpost.php?p=696047&postcount=21

A smoke container is effectively a PFX (particle effects) emitter that defines smoke and similar effects produced by assets. Smoke tags take the form smokeX where X is a number. There is no maximum number of smoke tags but they must be numbered sequentially (i.e. smoke0,smoke1,smoke2,etc). Smoke blocks have two sections: main and sequence properties. Main properties describe the attributes that stay the same for the life of the emitter. Sequence properties describe a set of one or more phases/periods in the smoke emission sequence.

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

texture KUID<-1:6329>
file ""
attachment ""
mode "time"
accel 0,0,0
conesize 0.2,0.2,1
direction 0,0,1
enable-steam-physics 0
enabled 1
faces "camera"
inherit-Velocity 0
loop -1
loopdelay 0
loop-amount 0
minrate 0
maxrate 20
maxspeedkph 0
start 0
period -1
color 255,255,255,255
endcolor 255,255,255,255
rate 4
velocity 1
lifetime 3
minsize 0
maxsize 3
mass 1
mass-scale .5
drag .36
spring .17
dampening .02
physics-delay 0

====Main Properties====
====texture====
:Type: KUID
:Desc: Sets the kuid of the texture to use for the particles, defaults to KUID<-1:6329> (Steam).
====file====
:Type: String (filename)
:Desc: Specifies that the particle emitter settings should be read in from a file generated by the Twinkles PFX tool.
====attachment====
:Type: String
:Desc: The name of the attachment point at which to generate the PFX. Attachment points are specified in the mesh file during creation.
====mode====
:Type: String
:Desc: The PFX emitter mode. Smoke effects can contain a number of cycled 'phases', the mode defines how the 'start' and 'period' tags are interpreted to control the progression between each smoke phase. Mode must be one of the following values (defaults to "time" if not specified).
:*'''time''' - 'start' is a list of time values (in seconds) after the creation of the parent object when the next phase of the effect will start, 'period' is the duration of time the phase will remain active.
:*'''timeofday''' - 'start' is the time of day to start the next phase. The time of day is specified as a decimal from 0 to 1, where 0 is 0:00.00 AM and 1 is 12:59.59 PM.
:*'''anim''' - 'start' specifies a time in the assets animation cycle to start the next phase. 'period' is the time over which the phase is active. The time in the anim cycle is specified as a decimal between 0 and 1. 'start' + 'period' must not exceed 1.
:*'''anim2''' - Same as 'anim' with some additional tags (interpolate, loop, loopdelay)
:*'''speed''' - 'start' is a speed, in meters per second, to start the next phase. 'period' is not used.
:Only the 'time' and 'timeofday' modes are valid for scenery objects, other modes are intended for use with assets such as locomotives.
====accel====
:Type: Decimal List
:Desc: Sets the acceleration conditions for the smoke particles. First value is gravity, second is (optional) wind effect. Default is 0,0. A third (deprecated) form exists with three parameters - this uses the first two values to calculate the wind effect and the third as gravity.

====conesize====
:Type: Decimal List
:Desc: Specifies the cone in which the particles are emitted. When a particle is created it will be given an initial velocity vector with its direction being a random vector in this cone and its speed being taken from the 'velocity' tag. The cone tag is a decimal list of 1, 2 or 3 values (in meters). The first two values specify the width and depth (x and y) of the cone, and the third value specifies it's height. If the height isn't provided a value of 1 will be used, if only one value is provided it will be used for both the width and height. The default value if the tag isn't provided at all is (0.2,0.2,1.0).
====direction====
:Type: 3D Vector (x,y,z)
:Desc: Sets the direction the particle emitter is facing. The direction will default to (0,0,1) if not supplied (straight up).
====enable-steam-physics====
:Type: Boolean
:Desc: Enables some of the more advanced smoke/steam related particle physics (drag, spring & dampening).
====enabled====
:Type: Boolean
:Desc: Sets whether the particle emitter is enabled.
====faces====
:Type: String
:Desc: Sets the direction the particle faces. Can be one of the following values:
:*'''camera''' - The particles are drawn so that they always face the camera (Default)
:*'''motion''' - The particles are drawn so that they face the direction they are travelling.
:*'''down''' - The particles are drawn facing down.
====inherit-Velocity====
:Type: Boolean
:Desc: Causes particles to inherit the velocity of the emitter, default is off.
====loop====
:Type: Decimal
:Desc: Sets the time, in seconds, after which to loop the smoke sequence. Valid only for modes 'time' and 'anim2'. Can be set to -1 to imply that it loops after the length of the sequence, this is the default behaviour.
====loopdelay====
:Type: Decimal
:Desc: Specifies the delay, in seconds, until the sequence loops again.
====loop-amount====
:Type: Integer
:Desc: Sets the number of times the sequence should loop.
====minrate====
:Type: Integer
:Desc: Sets the minimum particle emission rate for the entire sequence. Defaults to 0.
====maxrate====
:Type: Integer
:Desc: Sets the maximum particle emission rate for the entire sequence. Defaults to 20.
====maxspeedkph====
:Type: Decimal
:Desc: For cone emitters, this will set the maximum speed of the particles, in kph.

====Sequence Properties====
Per-phase tags are specified as value lists. If a list is added it should specify a value for each phase.
====start====
:Type: Decimal List
:Desc: Specifies when to start this phase, 'start' behaves differently depending on 'mode' (see mode for details). Start will default to 0.
====period====
:Type: Decimal List
:Desc: Specifies the duration of this phase, 'period' behaves differently depending on 'mode' and is not always used (see mode for details). Period can be set to -1 to imply that the phase is active until the next phase begins, this is the default behaviour.
====color====
:Type: Color List (RGBA, 0 to 255)
:Desc: Specifies the initial color of the PFX texture for each phase. Color will default to white (255,255,255,255).
====endcolor====
:Type: Color List (RGBA, 0 to 255)
:Desc: Specifies the ending color of the PFX texture for each phase. Color will default to white (255,255,255,255).
====rate====
:Type: Integer List
:Desc: Specifies the rate of particle emission in each phase. For most modes this is set to the number of particles to emit per second, for 'anim' and 'anim2' however this is the number of particles to emit over the animation period. The default rate is 4. See also 'minrate' and 'maxrate'.
====velocity====
:Type: Decimal List
:Desc: Specifies the initial speed of the emitted particles for this phase. Speed is specified in meters per second, the default value is 1m/s.
====lifetime====
:Type: Decimal List
:Desc: Specifies the time, in seconds, that the particles exist for in this phase (defaults to 3).
====minsize====
:Type: Decimal List
:Desc: Specifies the starting size of the particles created in this phase (scaling value where 1 is 100%, default is 0).
====maxsize====
:Type: Decimal List
:Desc: Specifies the ending size of the particles created in this phase (scaling value where 1 is 100%, default is 3).
====mass====
:Type: Decimal List
:Desc: The initial mass, in kilograms, of the particles created in this phase. Defaults to 1.
====mass-scale====
:Type: Decimal List
:Desc: The percentage of mass lost over the particles life time for this phase. This allows particles to become lighter as they disipate into the air. The value is specified as a percentage where 1 is 100% and will default to 0.5 (50%).
====drag====
:Type: Decimal List
:Desc: The drag constant for the particle created in this phase. This specifes the resistance against the particles ability to move freely through the air. If not specified the drag constant will default to 0.36, increasing the value will cause particles to be more strongly affected by wind. Requires the 'enable-steam-physics' tag.
====spring====
:Type: Decimal List
:Desc: The spring constant for particles created in this phase. The spring constant specifies how the strong the link is between individual particles. By default the spring constant is 0.17 if not specified, increasing the value will cause the particles to be more rigidly linked to each others movement. Requires the 'enable-steam-physics' tag.
====dampening====
:Type: Decimal List
:Desc: The spring damping constant for particles created in this phase. The spring damping constant affects the 'stability' of the link between individual particles (see 'spring'). Requires the 'enable-steam-physics' tag. Defaults to 0.02.
====physics-delay====
:Type: Decimal List
:Desc: Delay, in seconds, before particles are affected by world physics. 0 by default.

==Example Config.txt==
Sample [[config.txt file]] for a scenery asset that produces smoke:

region Britain
kind scenery
type Industrial
light 1
smoke0
{
attachment a.smoke
mode timeofday
color 150,150,150,250
accel 1,0.3,0
start 0.25, 0.5
period 0.25, 0.125
rate 8
velocity 3
lifetime 5
minsize 0.5
maxsize 2
}

Sample [[config.txt file]] for a steam train with four smoke emitters.
*Dark smoke from the main chimney stack that is dependent on the trains velocity (a.smoke, Y axis pointing up),
*A constant steam trail from a small safety pipe on top (a.steam.safety, Y axis pointing up),
*2 steam trails on each side of the train that alternately expel steam keyed to the animation of the trains wheels (a.steam.l, a.steam.r, Y axis pointing outwards).

kind traincar
bogey 0
engine 1
name Steam Train
mass 100000
enginespec <KUID:0:0>
enginesound <KUID:0:0>
hornsound <KUID:0:0>
interior <KUID:0:0>

smoke0
{
attachment a.steam.l
mode anim
color 255,255,255,150
start 0
period 0.4
rate 2
velocity 1
lifetime 2
minsize 0.05
maxsize 1
}
smoke1
{
attachment a.steam.r
mode anim
color 255,255,255,150
start 0.5
period 0.4
rate 2
velocity 1
lifetime 2
minsize 0.05
maxsize 1
}
smoke2
{
attachment a.steam.safety
mode time
color 255,255,255,150
rate 2
velocity 1
lifetime 2
minsize 0.05
maxsize 1
}
smoke3
{
attachment a.smoke0
mode speed
color 100,100,100,200
start 0,10,20,30
rate 3,5,7,9
velocity 3,4,5,5
lifetime 4,3,2.5,2
minsize 0.3
maxsize 2
}

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

User:Pencil42

2010-10-17T13:51:50Z

Pencil42: New page: Proprietor of Carson Car Shops[http://carsoncarshops.com]; specializing in creating Old West content in general, and content for the Virginia & Truckee Railroad in specific.

Proprietor of Carson Car Shops[http://carsoncarshops.com]; specializing in creating Old West content in general, and content for the Virginia & Truckee Railroad in specific.

Index of Tags & Containers

2010-09-24T15:58:37Z

Pencil42:

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

Build Numbers

2010-09-10T18:09:22Z

Pencil42: /* TS2010 */

==TS2009==

The following builds exist for [[TS2009]]. Where patches are available, these are noted beside the build number.

{| 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
|}

==TS2010==

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

== Content Builds ==

Auran's patch technology has the capability of updating the base Trainz version and installed addon content independently. The following is a list of released content build versions for addon content.

{| 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
|}

"Steam" container

2010-08-31T23:16:36Z

Pencil42: Updated with additional information from http://forums.auran.com/trainz/showthread.php?p=308677

The steam container is a top-level [[config.txt file]] entry used by [[KIND Steam-engine|Steam Enginespec]] assets.

==Supported Tags==

The Steam container supports the following tags. Each tag is show here with its default value.

steam
{
boiler-volume 10.0
burn-rate 0.5
burn-rate-idle 0.01
firebox-heating-surface-area 20
firebox-efficiency 0.75
firebox-thermal-conductivity 10
firebox-plate-thickness 0.016
fuel-energy 27912000
fuel-specific-heat-capacity 1260
initial-boiler-temperature 373
max-coal-mass 1000
ideal-coal-mass 500
min-fire-temperature 500
max-fire-temperature 1300
minimum-volume 8.0
maximum-volume 9.0
fusible-plug-volume 7.5
boiler-heat-loss 2.0
piston-angular-offsets 0.0174,1.5254,3.0333,4.5413
piston-volume-min 0.0272
piston-volume-max 0.1505
piston-area 0.1734
safety-valve-low-pressure 1653
safety-valve-low-flow 0.05
safety-valve-high-pressure 1684
safety-valve-high-flow 0.1
shovel-coal-mass 5.0
water-injector-rate 3.0
water-injector-rate2 3.0
boiler-efficency-idle 0.75
boiler-efficency 0.4
boiler-efficency-min 0.25
speed 15.0
cutoff 0.4
blower-effect 0.5
blower-max-flow 2.5
starting-coal 500
starting-water 7500.0
starting-boiler-steam 10.0
steam-chest-volume 0.1233
steam-chest-max-flow 25.0
valve-lap-percent 0.05
hand-brake-max-force 1000
super-heating-constant 100
tractive-effort-constant 0.8
number-cylinders 2
number-power-strokes 2
legacy-piston-count 4
}

====boiler-volume====
:Type: Decimal
:Desc: Volume in Metres cubed. This is the total capacity of the boiler.

====burn-rate====
:Type: Decimal
:Desc: How much coal (kg) is consumed per second when the loco is operating at the test parameters?

====burn-rate-idle====
:Type: Decimal
:Desc: How much coal (kg) is consumed per second when the loco is idle, purely to keep the fire burning?

====firebox-heating-surface-area====
:Type: Decimal
:Desc: Surface area of the firebox used for heating water. In practice, most of the water heating is done through the firebox, not through the tubes. For this reason, the surface area quoted should be that of all used sides of the firebox - normally front, back, top, left, right. Larger areas result in more firebox to boiler heat transfer - both cooling the fire and heating the water.

====firebox-efficiency====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). How efficient is the firebox - how much of the fire output is captured and used, and how much is lost? Higher numbers here mean the fire heats up faster, and stays hotter longer when you are trying to cool it down after a run. Lower numbers result in a more lethargic fire which takes longer to heat up, and will cool more quickly.

====firebox-thermal-conductivity====
:Type: Decimal
:Desc: Technically watts per metre kelvin, but real numbers are no good here - many factors mean a steam loco is far from an ideal heat conductor that the equations are based around. 10 seems to be a good number, found by experimentation. A higher number here will mean more heat transfer from the fire to the boiler - resulting in higher pressure but also less fire temperature. Lower numbers will result in more fire temperature, but less heating.

====firebox-plate-thickness====
:Type: Decimal
:Desc: Thickness of firebox plate in metres. 0.016 == 5/8" plate.

====fuel-energy====
:Type: Decimal
:Desc: Joules per kilogram. Amount of energy (joules) that can be released by burning 1 kg of the fuel.

====fuel-specific-heat-capacity====
:Type: Decimal
:Desc: Joules per kilogram kelvin. Amount of energy (joules) needed to raise the temperature of 1 kg of the fuel substance by one degree kelvin.

====initial-boiler-temperature====
:Type: Decimal
:Desc: Degrees kelvin. This value will determine whether the engine is 'ready to go' or needs 'warming up' prior to a run when first placed.

====max-coal-mass====
:Type: Decimal
:Desc: Maximum amount (kg) of fuel it's possible to cram in the firebox, before it starts falling out.

====ideal-coal-mass====
:Type: Decimal
:Desc: Ideal amount (kg) of fuel to have in the firebox for optimal burning. This value will appear as "100%" on the interface, and will burn the best.

====min-fire-temperature====
:Type: Decimal
:Desc: Degrees K. A higher value here makes the loco 'wake up' quicker, but too high a value will make it build pressure even when left idle.

====max-fire-temperature====
:Type: Decimal
:Desc: Degrees K. Lowering top end fire temperature will have the effect of limiting both top end boiler pressure and maximum water heating ability when working hard.

====minimum-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the bottom of the sight glass - 0% on the interface. Defaults to 80% boiler-volume.

====maximum-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the top of the sight glass - 100% on the interface. It should be above the 'minimum volume'. Defaults to 90% boiler-volume.

====fusible-plug-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler at which point the fusible plugs will kick in. It should be below the 'minimum volume'. Defaults to 75% boiler-volume.

====boiler-heat-loss====
:Type: Decimal
:Desc: factor used to cool boiler water over time. Bigger number == more cooling. Magic number (unknown units). Sample: 2.2

====piston-angular-offsets====
:Type: Decimal Array
:Desc: Values are specified in radians. Amount of wheel rotation required to rotate each piston to maximum travel from starting position. Will depend on how the valve gear has been animated in max. One value per piston.

====piston-volume-min====
:Type: Decimal
:Desc: clearance volume of a piston - i.e. the volume at minimum travel. This value greatly affects the level of front-end power available to a specific loco.

====piston-volume-max====
:Type: Decimal
:Desc: Total volume of a piston at maximum travel - i.e. the swept volume (stroke*area) plus the clearance volume.

====piston-area====
:Type: Decimal
:Desc: Surface area of the piston (metres squared).

====safety-valve-low-pressure====
:Type: Decimal
:Desc: Pressure (absolute, and in kPa) at which the low pressure safety valve will blow.

====safety-valve-low-flow====
:Type: Decimal
:Desc: Kilograms per second of steam that escape through the low pressure safety valve. Note: Too high a value will result in a 'sawtooth' boiler pressure, and repeated short hisses from the safety valve.

====safety-valve-high-pressure====
:Type: Decimal
:Desc: Pressure (absolute, and in kPa) at which the high pressure safety valve will blow.

====safety-valve-high-flow====
:Type: Decimal
:Desc: Kilograms per second of steam that escape through the high pressure safety valve. Remember that both valves will be open at this point.

====shovel-coal-mass====
:Type: Decimal
:Desc: How many kg of fuel does the fireman move each time he shovels?

====water-injector-rate====
:Type: Decimal
:Desc: litres of water moved into the boiler per second through the first injector when fully on.

====water-injector-rate2====
:Type: Decimal
:Desc: litres of water moved into the boiler per second through the second injector when fully on.

====boiler-efficency-idle====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Maximum efficiency of boiler - e.g. when loco idle.

====boiler-efficency====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Efficiency of boiler when working at test parameters.

====boiler-efficency-min====
:Type: Decimal
:Desc: Minimum boiler efficiency. Calculated efficiency will not fall below this value.

====speed====
:Type: Decimal
:Desc: Speed of test run on which test parameters are based.

====cutoff====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Position of cutoff control for test run.

====blower-effect====
:Type: Decimal
:Desc: Multiplier. Sets the effectiveness of the blower. Value is the draft effect of working the loco at the test parameters compared with running the blower at maximum boiler pressure but the loco otherwise idle.

====blower-max-flow====
:Type: Decimal
:Desc: Kilograms per second of steam used by blower at max boiler pressure and max setting.

====starting-coal====
:Type: Decimal
:Desc: Kilograms of coal to start with in the firebox. Ideal-coal-mass value will be used if this is not present.

====starting-water====
:Type: Decimal
:Desc: Volume of water (in Litres) to start with in the boiler. Will default to 85% boiler-volume (equivalent to halfway between 'max' and 'min' on the sight glass.)

====starting-boiler-steam====
:Type: Decimal
:Desc: Amount of steam to start with in the boiler. If this is too high, a false 'high pressure' will be reported at initial startup (but working the loco will reduce it). If it is too low, the boiler will boil water to build pressure, so using a low value (maybe even zero?) is suggested.

====steam-chest-volume====
:Type: Decimal
:Desc: Volume (metres cubed) of the steam chest. A good estimate if unknown is piston-volume-max * number of cylinders (source 5AT website).

====steam-chest-max-flow====
:Type: Decimal
:Desc: Max flow (kilograms per second) of steam from boiler to steam chest with regulator fully open.

====valve-lap-percent====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0)

====hand-brake-max-force====
:Type: Decimal
:Desc: Maximum force exerted by handbrake.

====super-heating-constant====
:Type: Decimal
:Desc: Degrees (kelvin) to increase temperature of steam between boiler and steam chest. High superheat results in more power at the front end.

====tractive-effort-constant====
:Type: Decimal
:Desc: Used to calculate theoretical performance along with cylinder dimensions for the AI to use. Defaults to 0.4 * number_of_cylinders.

====number-cylinders====
:Type: Integer
:Desc: Number of cylinders.

====number-power-strokes====
:Type: Integer
:Desc: Number of power strokes per revolution. Two is by far the most common number, but this can be other numbers in extreme cases.

====legacy-piston-count====
:Type: Decimal
:Desc: Used for loading old (TRS2006) saved sessions. An omission in the TRS2006 save format causes a loco with a different number of pistons not to load properly. The number of pistons often needs to be changed when updating old enginespecs, as previously engines had to have twice as many single acting pistons, rather than the correct number of double acting pistons as they do now. This value is to record the old number of pistons so that old sessions can still be loaded.

==Example steam container==

''TBD''

[[Category:Config Container]]

KIND Groundtexture

2009-08-21T17:30:44Z

Pencil42: added scale information

[[KIND Groundtexture]] is an extension of [[KIND Texture]]. A ground texture is tiled in Surveyor to color and cover the base grid.

==Texture==
The ground uses a material with three texture inputs. The first two are supplied by the Ground Texture asset, the third is supplied by Trainz at runtime.

===Scale===
When choosing your image, make sure it is the proper scale so details don't look too large or too small in game. The smallest scale setting in surveyor corresponds to an image 10 meters across, while the largest scale setting corresponds to 24 meters across.

===Diffuse Texture===
The diffuse texture provides a [[diffuse map]], containing color information for the material.

The alpha channel is not used for transparency, but instead controls the strength of the Reflective Texture on a per-pixel basis. White alpha shows diffuse only. Black alpha shows reflection only. Grays are a blend between the diffuse and the reflection. In most cases, a white or light gray value is appropriate.

Sample:
texture "demo-diffuse.tga"

[[image:demo-diffuse.jpg]]

===Normal Texture===
The normal texture provides a [[normal map]].

The alpha channel provides per-pixel control of the [[specular highlight]]. White gives a strong specular, suitable for metals and water. Black gives no specular, more suitable for dark earth. Grays are a mid-strength specular.

When creating the .texture.txt file for the normal map, remember to include the following line, otherwise you will end up with odd effects such as shadowing when you rotate the texture.

'''NormalMapHint=normalmap'''

Sample:
normal-texture "demo-normal.tga"

[[image:demo-normal.jpg]]

===Reflective Texture===
The reflective texture is a cubemap supplied by Trainz which provides an approximate reflection of the surrounding environment. The ground texture has no direct control over this texture, however the use of this texture can be switched on or off per ground texture and the strength of the reflection is controlled per pixel via the diffuse texture's alpha channel.

==Configuration==
Sample [[config.txt file]] for a ground texture, with the Standard Tags excluded for brevity:

[[TagName_Kind|kind]] "groundtexture"
[[TagName_Texture|texture]] "demo-diffuse.texture"
[[TagName_Normal-texture|normal-texture]] "demo-normal.texture"

The "texture" and "normal" tags specify [[Texture file]]s located within the asset folder.

==Ground Clutter==
A ground texture can optionally reference a low polygon mesh (a "clutter mesh") and insert the mesh automatically as the ground is painted.

Sample [[config.txt file]] for a ground texture with a clutter mesh, with the Standard Tags excluded for brevity:

[[TagName_Kind|kind]] "groundtexture"
[[TagName_Texture|texture]] "demo-diffuse.texture"
[[TagName_Normal-texture|normal-texture]] "demo-normal.texture"
[[TagName_Clutter-Mesh|clutter-mesh]] <kuid:-3:10128>
[[TagName_Description|description]] "A very ugly Ground Texture with a whole bunch of Alaistair’s running around as the clutter mesh."

==Downloads==

''Attach sample files here?''

==Categories==
[[Category:Asset KIND]]

"Trainz-build" tag

2009-07-21T03:40:19Z

Pencil42:

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

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

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

The approved Trainz-Build version numbers are;

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

[[Category:Config Tag]]

Runtime Performance Statistics

2009-07-15T14:56:48Z

Pencil42: /* Test Results */

TS2009sp2 provides a simple tool for monitoring asset performance in Surveyor. Poor-performing assets can negatively affect both the frame rate and the available draw distance. In extreme cases, TS2009 will reduce the draw distance below the user's setting to reduce the risk of crashing due to excess resource consumption.

=Displaying Performance Statistics=
As of [[TS2009 SP2]], any user may activate a performance statistics display in Surveyor. This display is accurate on a per-frame basis. While the display is active, the user may notice a small overall decrease in frame rate.

To active or deactivate the display, follow these steps:
* Go to the Trainz game menu button in the top left of the screen;
* Select the "Options" menu;
* Change to the "Surveyor Settings" screen;
* Toggle the "Display performance stats" setting as appropriate.

=Statistics=
In the current version of the tool, the following information is displayed:

== Stitched Mesh Statistics==
These statistics represent the inputs and outputs of the [[mesh stitching]] system, which prepares efficient geometry for submission to the GPU. These numbers relate to the mesh stitching resources only, and do not account for similar types of resource usage in other systems. Larger numbers typically indicate increased system load.

* ''total buffers'' - The number of hardware buffers currently in use for the stitched mesh system. There will always be a minimum of one hardware buffer allocated per material. If a material is assigned to a large number of triangles, additional hardware buffers may be allocated to share the load. In "compatibility mode", some asset types may require one buffer per request, rather than stitching multiple requests into a single buffer.
* ''unprocessed buffers'' - The number of buffers which require CPU stitching. This number should be zero when idle, and increases while objects are being loaded, unloaded, or are changing LOD.
* ''vertices'' - The total number of hardware vertices present in the stitched mesh system.
* ''indices'' - The total number of hardware indices present in the stitched mesh system. This number correlates with the number of triangles being rendered (typically three indices per triangle.)
* ''materials'' - The number of distinct materials present in the stitched mesh system.
* ''total requests'' - The total number of input requests to the stitched mesh system. This is a general indicator of route density.
* ''unprocessed requests'' - The total number of input requests which require CPU stitching. This number should be zero when idle, and increases while objects are being loaded, unloaded, or are changing LOD.
* ''worst buffer count'' - The KUID and total buffer count of the single asset which is consuming the largest number of hardware buffers. This does not necessarily indicate a poor performer - it may be that the asset is simply used far more heavily than other assets in the current scene. This is, however, a great place to start looking if performance is suffering.
* ''worst index count'' - The KUID and total index count of the single asset which is consuming the largest number of hardware indices. This does not necessarily indicate a poor performer - it may be that the asset is simply used far more heavily than other assets in the current scene. This is, however, a great place to start looking if performance is suffering.

=Performance Fixing for End-Users=
End Users can do little to resolve the types of performance issue discussed here. Running in "Native Mode" instead of using "Compatibility Mode" can provide a very significant performance boost at the expense of some visual compatibility with older content. Keeping up-to-date with the latest Trainz and content updates can also help make sure that you have the latest performance optimisations.

=Performance Fixing for Route Builders=
There are hard caps to the 'total buffers', 'vertices' and 'indices' figures above to prevent the system from exhausting all resource space which leads to a game crash. These caps are typically quite generous, however it is possible for specific assets to be constructed in such a way that they rapidly exhaust available resources.

When the usage starts to approach the hard caps, Trainz will attempt to reduce the draw distance in an effort to prevent hitting a hard cap. Hitting the hard cap is considered bad because any further items will not be rendered - this can include large items near the viewer. It is better to reduce the draw distance such that nearby items can be seen and distant items will be culled.

If overall performance is poor, or the if the draw distance is being visibly reduced, the route builder should pay close attention to the 'worst buffer count' and 'worst index count' statistics. In the majority of cases, one of these statistics will directly indicate the cause of the problem. It is worth noting that several assets can contribute to poor performance in a given scene - after identifying and removing the worst performer, the next-worst performer will be revealed. Route builders should remove or reduce the usage of the worst performers from the route, or substitute them for alternative better-performing assets.

Note that the performance statistics relate to the objects currently in view. Moving to another location on the route, changing the viewing angle, or adjusting the draw distance may affect the results provided by this tool.

=Performance Fixing for Asset Builders=
When creating content, the Surveyor performance statistics display can be useful for testing the efficiency of your model.

==Test Methodology==
Simply load up a blank baseboard, place a large number of copies of one item of your content scattered around the baseboard, and watch the performance numbers. The Surveyor "Replace Assets" command can be useful to perform like-for-like comparisons of your content against similar existing items.

When testing performance, you should generally not place a large number of objects at a single location, as this is an unrealistic test and skews the results. Distribute your objects around the scene.

It is best to test your object in relatively large numbers, with no other changes to the blank baseboard - no terrain editing; no terrain painting; no other scenery or splines.

A blank baseboard has some performance costs for terrain rendering. Be sure to note those numbers as a baseline before you start adding your own test objects.

==Test Results==
If your test object does not show up in the statistics, it is not being handled by the [[mesh stitching]] system. For high-detail or animated object, this is expected behavior. For medium-to-low detail static objects, this suggests a performance problem that should be resolved. It is worth noting that the low LOD of an object may be stitched while the higher-detailed LODs are not stitched. This will be accurately reflected in the statistics.

The material count for your object (whether singularly, or in large quantities) should be low, preferably 1-2 total. If the material count is overly large, consider revising your material setup in your modeling tool.

For efficient low-polygon objects, all numbers should stay relatively low even when large amounts of the content are placed on the baseboard.

For efficient high-polygon objects with LOD, you should see a relatively low material and buffer count, and higher vertex and index counts. As you approach your content, the vertex and index counts will rise rapidly - moving away from your content, the vertex and index counts should drop substantially. A single object at highest LOD may have the same impact on the numbers as hundreds or thousands of objects at the lowest LOD.

It is worth noting that the hardware vertex count may be significantly higher than what you might expect from looking at the vertex count inside of your modeling tool. This is due to the modeling tools representing any single point in 3D space as a single vertex, whereas the hardware may need to separate different smoothing groups and materials into separate vertices.

In all cases, the number of hardware buffers should stay low - roughly one buffer per ten thousand vertices. It is best to measure this after you have placed a medium-to-large number of your test object onto the route. If you are seeing significantly higher buffer numbers than this, your object is likely to cause performance problems when used in quantity.

Help:WebBrowser Address

2009-07-05T21:07:25Z

Pencil42: New page: This field shows the current page to which the user has navigated. An address can also be typed here, although only addresses in the Trainz domain can be reached through the ingame browse...

This field shows the current page to which the user has navigated. An address can also be typed here, although only addresses in the Trainz domain can be reached through the ingame browser.

Help:WebBrowser Forward

2009-07-05T21:05:12Z

Pencil42: New page: When browsing through your history of web pages by using the back button, this button will move you one page 'forward'.

When browsing through your history of web pages by using the back button, this button will move you one page 'forward'.

Help:WebBrowser Stop

2009-07-05T21:03:36Z

Pencil42: New page: This button will stop the current page from loading any more of itself in the web browser.

This button will stop the current page from loading any more of itself in the web browser.

Help:WebBrowser Back

2009-07-05T21:01:43Z

Pencil42: New page: This button will take the user to the previous page visited.

This button will take the user to the previous page visited.

Help:WebBrowser Refresh

2009-07-05T21:00:31Z

Pencil42: New page: This button will refresh, or reload, the current page in the web browser.

This button will refresh, or reload, the current page in the web browser.

Help:WebBrowser Home

2009-07-05T20:58:09Z

Pencil42: New page: This button on the ingame web browser will take the user to the TS 2009 home page, where the latest news is displayed. The home page also has links to the user's profile, a gallery of Tra...

This button on the ingame web browser will take the user to the TS 2009 home page, where the latest news is displayed. The home page also has links to the user's profile, a gallery of Trainz pictures, a community page, and a page describing the Download Station.

Help:WebBrowser Go

2009-07-05T20:54:52Z

Pencil42: New page: This button on the web interface sends the user to the address that was entered in the address bar to the left. Only pages within the Trainz domain can be visited using this in-game brows...

This button on the web interface sends the user to the address that was entered in the address bar to the left. Only pages within the Trainz domain can be visited using this in-game browser.

Help:Menu Driver

2009-07-05T20:51:42Z

Pencil42:

Allows you to select a route to drive.

The driver module provides more than just a train driving simulation. Trainz provides you with a number of different ways of controlling the trains on your railroad.

Firstly you can hop into the cab and explore the tracks from behind the throttle. You can choose either the simple DCC speed control system or the realistic Cab controlls using each of the levers and switches in the cab. You can watch the trains from trackside as they come thundering past, or from a birds-eye view tracking along with the train.

You can even switch to a Map View and control the junctions, monitor signals, and control traffic flows from a 2D perspective.

While running miltiple consists, you can choose to control each train yourself, or let the computer AI system control the trains as you control the switches.

Finally, you can even issue specific orders to Drivers that you allocate to each train.

In addition to the various systems of control, there is also a fully interactive industry model that automatically generates waybills for goods that need to be delivered to the various industrial sites. Your task under this mode is to maintain the operation of these industries by controlling movement of goods and resources along your railroad. You can watch as your train or the trains under the control of your drivers are each loaded and unloaded at the various industries.

Help:ITrainz Chat

2009-07-05T20:47:23Z

Pencil42:

iTrainz Chat is a module that allows you to exchange instant messages with other online Trainz users. You can also manage your contacts and see when your contacts are online.

Help:Main Menu Button

2009-05-29T15:36:08Z

Pencil42:

Will display a list of Options, Credits, Exit Game or Help

In the Trainz Main Menu, there are 3 game modules to choose from: Surveyor, Driver, and Railyard, as well as the Quit option.

There are also links to the latest news, My Trainz, a Gallery, the Trainz Community, and the Download Station.

Help:Menu Driver

2009-05-29T15:30:31Z

Pencil42: added text from Trainz Railwayz manual

Allows you to select a route to drive.

The driver module provides more than just a train driving simulation. Trainz provides you with a number of different ways of controlling the trains on your railroad.

Firstly you can hop into the cab and explore the tracks from behind the throttle. You can choose either the simple DCC speed control system or the realistic Cab controlls using each of the levers and switches in the cab. You can watch the trains from trackside as they come thundering past, or from a birds-eye view tracking along with the train.

You can even switch to a Map View and control the junctions, monitor signals, and control traffic flows from a 2D perspective.

While running miltiple consists, you can choose to control each train yourself, or let the computer AI system control the trains as you control the switches.

Finally, you can even issue specific orders to Drivers that you allocate to each train.

In addition to the various systems of controll, tyhere is also a fully interactive industry model that automatically generates waybills for goods that need to be delivered to the various industrial sites. Your task under this mode is to maintain the operation of these industries by controlling movement of goods and resources along your railroad. You can watch as your train or the trains under the control of your drivers are each loaded and unloaded at the various industries.

Help:Menu Quit

2009-05-28T01:29:21Z

Pencil42: New page: This button will exit TS 2009

This button will exit TS 2009

"Steam" container

2009-03-23T01:28:19Z

Pencil42: /* starting-water */

The steam container is a top-level [[config.txt file]] entry used by [[KIND Steam-engine|Steam Enginespec]] assets.

==Supported Tags==

The Steam container supports the following tags. Each tag is show here with its default value.

steam
{
boiler-volume 10.0
burn-rate 0.5
burn-rate-idle 0.01
firebox-heating-surface-area 20
firebox-efficiency 0.75
firebox-thermal-conductivity 10
firebox-plate-thickness 0.016
fuel-energy 27912000
fuel-specific-heat-capacity 1260
initial-boiler-temperature 373
max-coal-mass 1000
ideal-coal-mass 500
min-fire-temperature 500
max-fire-temperature 1300
minimum-volume 8.0
maximum-volume 9.0
fusible-plug-volume 7.5
boiler-heat-loss 2.0
piston-angular-offsets 0.0174,1.5254,3.0333,4.5413
piston-volume-min 0.0272
piston-volume-max 0.1505
piston-area 0.1734
safety-valve-low-pressure 1653
safety-valve-low-flow 0.05
safety-valve-high-pressure 1684
safety-valve-high-flow 0.1
shovel-coal-mass 5.0
water-injector-rate 3.0
water-injector-rate2 3.0
boiler-efficency-idle 0.75
boiler-efficency 0.4
boiler-efficency-min 0.25
speed 15.0
cutoff 0.4
blower-effect 0.5
blower-max-flow 2.5
starting-coal 500
starting-water 7500.0
starting-boiler-steam 10.0
steam-chest-volume 0.1233
steam-chest-max-flow 25.0
valve-lap-percent 0.05
hand-brake-max-force 1000
super-heating-constant 100
tractive-effort-constant 0.8
number-cylinders 2
number-power-strokes 2
legacy-piston-count 4
}

====boiler-volume====
:Type: Decimal
:Desc: Volume in Metres cubed. This is the total capacity of the boiler.

====burn-rate====
:Type: Decimal
:Desc: How much coal (kg) is consumed per second when the loco is operating at the test parameters?

====burn-rate-idle====
:Type: Decimal
:Desc: How much coal (kg) is consumed per second when the loco is idle, purely to keep the fire burning?

====firebox-heating-surface-area====
:Type: Decimal
:Desc: Surface area of the firebox used for heating water. In practice, most of the water heating is done through the firebox, not through the tubes. For this reason, the surface area quoted should be that of all used sides of the firebox - normally front, back, top, left, right. Larger areas result in more firebox to boiler heat transfer - both cooling the fire and heating the water.

====firebox-efficiency====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). How efficient is the firebox - how much of the fire output is captured and used, and how much is lost? Higher numbers here mean the fire heats up faster, and stays hotter longer when you are trying to cool it down after a run. Lower numbers result in a more lethargic fire which takes longer to heat up, and will cool more quickly.

====firebox-thermal-conductivity====
:Type: Decimal
:Desc: Technically watts per metre kelvin, but real numbers are no good here - many factors mean a steam loco is far from an ideal heat conductor that the equations are based around. 10 seems to be a good number, found by experimentation. A higher number here will mean more heat transfer from the fire to the boiler - resulting in higher pressure but also less fire temperature. Lower numbers will result in more fire temperature, but less heating.

====firebox-plate-thickness====
:Type: Decimal
:Desc: Thickness of firebox plate in metres.

====fuel-energy====
:Type: Decimal
:Desc: Joules per kilogram. Amount of energy (joules) that can be released by burning 1 kg of the fuel.

====fuel-specific-heat-capacity====
:Type: Decimal
:Desc: Joules per kilogram kelvin. Amount of energy (joules) needed to raise the temperature of 1 kg of the fuel substance by one degree kelvin.

====initial-boiler-temperature====
:Type: Decimal
:Desc: Degrees kelvin. This value will determine whether the engine is 'ready to go' or needs 'warming up' prior to a run when first placed.

====max-coal-mass====
:Type: Decimal
:Desc: Maximum amount (kg) of coal it's possible to cram in the firebox, before it starts falling out.

====ideal-coal-mass====
:Type: Decimal
:Desc: Ideal amount (kg) of coal to have in the firebox for optimal burning. This value will appear as "100%" on the interface, and will burn the best.

====min-fire-temperature====
:Type: Decimal
:Desc: Degrees K. A higher value here makes the loco 'wake up' quicker, but too high a value will make it build pressure even when left idle.

====max-fire-temperature====
:Type: Decimal
:Desc: Degrees K. Lowering top end fire temperature will have the effect of limiting both top end boiler pressure and maximum water heating ability when working hard.

====minimum-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the bottom of the sight glass - 0% on the interface.

====maximum-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler that corresponds to the top of the sight glass - 100% on the interface. It should be above the 'minimum volume'.

====fusible-plug-volume====
:Type: Decimal
:Desc: Volume in Litres. This is the amount of water in the boiler at which point the fusible plugs will kick in. It should be below the 'minimum volume'.

====boiler-heat-loss====
:Type: Decimal
:Desc: TBD

====piston-angular-offsets====
:Type: Decimal Array
:Desc: Values are specified in radians. Amount of wheel rotation required to rotate each piston to maximum travel from starting position. Will depend on how the valve gear has been animated in max. One value per piston.

====piston-volume-min====
:Type: Decimal
:Desc: clearance volume of a piston - i.e. the volume at minimum travel. This value greatly affects the level of front-end power available to a specific loco.

====piston-volume-max====
:Type: Decimal
:Desc: Total volume of a piston at maximum travel - i.e. the swept volume (stroke*area) plus the clearance volume.

====piston-area====
:Type: Decimal
:Desc: Surface area of the piston (metres squared).

====safety-valve-low-pressure====
:Type: Decimal
:Desc: Pressure (absolute, and in kPa) at which the low pressure safety valve will blow.

====safety-valve-low-flow====
:Type: Decimal
:Desc: Kilograms per second of steam that escape through the low pressure safety valve. Note: Too high a value will result in a 'sawtooth' boiler pressure, and repeated short hisses from the safety valve.

====safety-valve-high-pressure====
:Type: Decimal
:Desc: Pressure (absolute, and in kPa) at which the high pressure safety valve will blow.

====safety-valve-high-flow====
:Type: Decimal
:Desc: Kilograms per second of steam that escape through the high pressure safety valve. Remember that both valves will be open at this point.

====shovel-coal-mass====
:Type: Decimal
:Desc: How much coal does the fireman move each time he shovels?

====water-injector-rate====
:Type: Decimal
:Desc: litres of water moved into the boiler per second through the first injector when fully on.

====water-injector-rate2====
:Type: Decimal
:Desc: litres of water moved into the boiler per second through the second injector when fully on.

====boiler-efficency-idle====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Maximum efficiency of boiler - e.g. when loco idle.

====boiler-efficency====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Efficiency of boiler when working at test parameters.

====boiler-efficency-min====
:Type: Decimal
:Desc: Minimum boiler efficiency. Calculated efficiency will not fall below this value.

====speed====
:Type: Decimal
:Desc: Speed of test run on which test parameters are based.

====cutoff====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0). Position of cutoff control for test run.

====blower-effect====
:Type: Decimal
:Desc: Multiplier. Sets the effectiveness of the blower. Value is the draft effect of working the loco at the test parameters compared with running the blower at maximum boiler pressure but the loco otherwise idle.

====blower-max-flow====
:Type: Decimal
:Desc: Kilograms per second of steam used by blower at max boiler pressure and max setting.

====starting-coal====
:Type: Decimal
:Desc: Kilograms of coal to start with in the firebox. Ideal value will be used if this is not present.

====starting-water====
:Type: Decimal
:Desc: Volume of water (in Litres) to start with in the boiler. 50% level (halfway between 'max' and 'min' on the sight glass) will be used if this is not present.

====starting-boiler-steam====
:Type: Decimal
:Desc: Amount of steam to start with in the boiler. If this is too high, a false 'high pressure' will be reported at initial startup (but working the loco will reduce it). If it is too low, the boiler will boil water to build pressure, so using a low value (maybe even zero?) is suggested.

====steam-chest-volume====
:Type: Decimal
:Desc: Volume (metres cubed) of the steam chest.

====steam-chest-max-flow====
:Type: Decimal
:Desc: Max flow (kilograms per second) of steam from boiler to steam chest with regulator fully open.

====valve-lap-percent====
:Type: Decimal
:Desc: Ratio (0.0 -> 1.0)

====hand-brake-max-force====
:Type: Decimal
:Desc: Maximum force exerted by handbrake.

====super-heating-constant====
:Type: Decimal
:Desc: Degrees (kelvin) to increase temperature of steam between boiler and steam chest. High superheat results in more power at the front end.

====tractive-effort-constant====
:Type: Decimal
:Desc: ''TBD''

====number-cylinders====
:Type: Integer
:Desc: Number of cylinders.

====number-power-strokes====
:Type: Integer
:Desc: Number of power strokes per revolution. Two is by far the most common number, but this can be other numbers in extreme cases.

====legacy-piston-count====
:Type: Decimal
:Desc: Used for loading old (TRS2006) saved sessions. An omission in the TRS2006 save format causes a loco with a different number of pistons not to load properly. The number of pistons often needs to be changed when updating old enginespecs, as previously engines had to have twice as many single acting pistons, rather than the correct number of double acting pistons as they do now. This value is to record the old number of pistons so that old sessions can still be loaded.

==Example steam container==

''TBD''

[[Category:Config Container]]

Surveyor Tools Feature Requests

2009-02-23T16:18:55Z

Pencil42: /* Requests */ request removed - already configurable in config.txt by using rollstep parameter.

This page is where the route-creation community gets to post all their surveyor tool feature requests. Request any surveyor tool additions or options that you think will enhance the game.

==Requests==

Requests are placed in this section by the community, for discussion and possible inclusion. Requests here may or may not make it into TS2009.

* Could an API dll be created to interface with the assets database? Like something that can be used in writing a C# application to interface with Trainz? - Roman
: Maybe [[TrainzNativeInterface]] is what you needed? -Mike

* It would be nice to have a DEM creation tool included with TRS2009, integrated into the game. Like TransDEM, but simpler to use, but with all the editing features of TransDEM (or at least some!)vector line creation, map textures, separate map-tile-objects for fine detail work etc. - Wayne

* Direct vertex manipulation - the ability to adjust the height of one terrain vertex without affecting the adjoining vertices. Would be very useful for fine-tuning terrain after getting the rough shape with the existing tools. - Curtis

* Ability to lock the x-y movement of an item (but leave z able to move) - would help for basemap templates - it's easy to move them out of the way accidentally if they are hidden underground and you miss clicking on something else and click on them instead (they then snap to the cursor and move, but since they are hidden underground, the user doesn't realize they have moved until sometime later). - Curtis
: Add snapgrid 720 and snapmode 1 to the template config. You will then only be able to move it by a whole base board ~Andi
:: Nice tip - thanks, Andi! -Curtis

* Ability to load a scaled, possibly georeferenced map template (.jpg, perhaps) to help guide track, terrain, and object placement. - Curtis

* A window that shows all textures loaded on a route, with the ability to click on the texture and be taken to when each texture is used. Would be nice if textures could be removed from the map here, as well as being selected to be painted on the map. Bonus for being able to replace a given texture with something else. - Curtis

* In the texture picker window, always show the name of the texture to better help when searching for a particular one. - Curtis

* A window that shows all items used in a map (maybe broken out by surveyor categories?) that allows deletion and replacement with other objects. Would be especially useful for replacing track. Bonus for being able to click on the item and be cycled through all the positions on the map that the object has been placed. - Curtis

* Auto terrain generation, based on several user parameter inputs (desert <-> jungle); (flat <-> mountainous); (water level) etc. - Curtis

* Or just a nice gui frontend to "Make Me a Map Aiden" - Curtis

* Complete overhaul of session creation tools including a much larger editing window, copy/paste commands, smaller rule icons (so you can see more) and the ability to edit a session outside surveyor (i.e. text editor). - Natvander

* Layers! Doesn't need to be too sophisticated to start with, just the facility to turn off the track or to turn off ground texturing would be a big gain. ~Andi

* Allow the builder to designate what streets have traffic and which don't, or what type of traffic. An example being one road might have heavy traffic, the other would have light. All done in surveyor. As opposed to using three or four types of the same road. - Chad

* Ability to rotate assets on all 3 axis (x,y,z) - as an example, to be able to rotate a parked vehicle so it conforms to a slope. - Natvander

* A keyboard shortcut to change texture direction in the Paint menu by 180 degrees. - Wreeder

* A keyboard shortcut to cycle through the textures added to the Advance panel of the Paint menu. This would allow the user to add a group of textures with a common look to the Advance panel and quickly choose from that group while painting an area to create a large area without repeating patterns. For example, Dave Drake has created several sets of textures that blend together very well. But to use them together requires moving the mouse from the baseboard to the Paint panel over and over again. -Wreeder

* Could the copy feature be made to recognize splines also? Currently all it seems to pick up is ground textures and objects. It'd be helpful, especially when making huge fields of rice (in my case) to just copy and paste the spline. - Chad

* Might take too much work to do it, but I'd love to see an "era" selector on the stations. This selection would define what years the passengers come from and change their clothing accordingly. There's a number of third party stations that do this, though I think most require editing the config file. Maybe an extension of the "chameleon" texture trick you see on rolling stock. - Chad

* Full spline handle control. While track and other splines seem to be based on cubic splines, a user does not have full control via handles, like it is possible in most vector programs (e.g. Adobe Illustrator, Corel Draw!, Inkscape). Instead, the control points are "auto-magically" calculated from the successor or predecessor nodes. Trainz should support such handles, with both smooth and symmetric modes for the nodes (same tangent and same tangent/length, resp.) for tracks. The current automatic way could be retained as a third, default mode. For other splines, a corner mode should be available as well. Handles should be three-dimensional, i.e. may have a different height than the related node. While this extension would not allow the user to create mathematical exact fixed-radius arcs and clothoids, these could be approximated much better than today. ~KlausM

* superelevation. Each node would receive an angle that represents the superelevation. Beween two nodes, the angle is interpolated in the same way as coordinates are (i.e. via cubic spline interpolation) ~KlausM

* Track Connection Toggle. Currently, in order to prevent track from linking to another existing section, the user must hold down the shift key and then click in the area they wish. Problem is, that doesn't always seem to work. Nine times out of ten it does, but there's always that one time when the thing connects and while that doesn't damage the route, it is a bit annoying. Could we have a setting in the options where we could toggle whether or not the track will automatically connect to form a spline junction? This could be a setting for splines themselves also. - Chad

* A ''user defined functions'' button which allows CC to write functions which enables track laying, spline laying, object placing etc. via coordinate input instead of using the imprecise mouse. Like in any 2D-CAD program. I already propose some ideas about this in the forum in the thread ''coordinate input''. ~Michael Vogt

* Add to the function already in TRS2004 & TRS2006 where one can use the move button in the Scenery Tab to actually move the cameras (both the tracking and the fixed one) around. As in, let the user be able to also raise and lower the camera with the height adjustment tool. Before TS2009 I could do it indirectly by moving the camera by the move button (in the Scenery tab) on top of a grid point, go into Landscape Tab, read out the height on that point, add to it about 2m and then move camera slightly and then lower the ground point back to the height it was before I raised it. This makes it possible to set great camera views from the ground in very tight places, even underground - while the camera move button refuses to put the camera down into the ground as soon as the ground is very uneven. It is often lot of work, but worth it. By having the move function in TS2009 back, and even add to it by letting the height button tool work with the camera would save lot of work. As of all SP1 TS2009, I no longer can use the move scenery button to tweak the camera location, making it impossible for me to any longer set the ground cameras other places then high up in air when ground is very uneven. - Linda

* To be able to ajust the length of day, ie Long summer days getting dark around 9pm getting daylight around 5am, shorter winter days get dark around 5pm. Lots_Trains

* Fine adjustment of building placement. Could it be added that by holding "shift" or something, that the position of a building could be tweaked a bit finer than the current degree turning or movement? It would aid in placing structures that are very close to or touching each other. -chad

* Lockable orientation. Ability to define what orientation buildings will have when placed on the map. Allow people to choose N-S, E-W, and then "random." That way, if you have a street running E-W, you could select that orientation and place buildings without having to monkey with turning them around to face like they need to. -Chad
: I'd like to see this option, too. However, I would like to select the angle manually. This would be useful, if we have a street running 60 degrees and we want to add some street lights. Rotating every single object is very annoying. -Zyxist

* Duplicating object properties. We choose an existing object, for example a house, and we can use its height and angle to place new houses. -Zyxist

* Multiple water levels: Allow water to be placed on several different levels, but don't force it to "link" when moved. Maybe a shift command like tracks to prevent the linking. - Chad

* Make Catenary snap to the track. I think it did this at one time, but now it's a matter of trying to line everything up and hoping it works. Letting it snap to the track would make route building much easier. - Chad

* Allow infinite elevation to be set in world origin. At the moment world origin can only be set to 100m above sea level, but I am building a route which has all features between 500m and 800m above sea level. - Bill69

* Duplicate 'straighten track' button onto the Scenery/Splines panel (assuming that it will still work there of course) ~Andi

* Catenary: An option for the height of the wire above the rails with ramping between different heights. Height settings force pantographs following the wire height level. - fatuli

==Short List==
Requests are placed into this section by Auran if they are somewhat likely to make it into the TS2009 product. Requests from this list will be serviced by Auran as time permits.

* Ability to see an item's description field in surveyor - often, the description has hints on how to use the object. - Curtis

* Can we have a little more control over height increments (we already have rotstep, we just need heightstep to go with it) ~Andi

* Can we organize things so that the Track/DefaultDirection button will work on suitably scripted fixed track junctions. We can use object properties to do this but it would be a lot more intuitive to have the same tool for fixed track and for spline junctions. ~Andi

* Allow the camera to be panned out further. For routes with lots of mountains, it would help to be able to pull further away from the route to see what work you've done. - Chad

* Altering the "Ordered List" and/or "Reset list" so the repeated child rules can be stopped by an event (e.g. trigger). I'm not sure if this belongs in surveyor (as it's a session issue) or scripting. - Natvander

==TS2009 Complete==

* Let me pinpoint paint in small areas like an air brush. -BG
: ''Surveyor includes a new [[Ground Types|5m ground grid]] which improves the ability to paint small areas.

* Filters! CMP filtering is generally quite good but can we be just a little more comprehensive, allowing a search by asset kind and adding a 'Not' button for every field for instance. Now having achieved that can we move exactly the same search and filtering facilities into Surveyor rather than having that funny little icon hidden away at the top. ~Andi
: [[TS2009]] includes comprehensive surveyor filters.

* Kuid (asset) replacement tool - for all assets including textures. This may prove essential when we are required to bring our pre 09 routes up to 09 standard. - Natvander
: ''We won't have a way to replace anything with anything - but hopefully the common types can be replaced in a simple fashion.'' ~chris

* Let me paint shade shadows on tracks or buildings or under trees. -BG
: ''Use TS2009 decals for this.'' ~chris

==Rejected==
If there's a request that we're clearly not going to entertain at the current time, we'll move it to here. This includes both flat rejections and also requests which sound good but won't be done for the next version of Trainz.

* Track should not dip down below the surface when a climbing grade is added to it. -BG
: ''You can either let the track follow the ground, or you can specify a grade. If you do the first, then Trainz is responisble for ensuring that it stays above the ground. If you do the second, then you are. ~chris''

* Possibility to create a real vertical rock terrain or better some over hanging rock terrain. - Sister
: ''I hear you! I'm also a big fan of this concept. Unfortunately, this won't be possible in the TS2009 timeframe. ~chris''

* More a feature than a tool - change LOD from % of screen to distance from. This will fix LOD issues with assets that have varied profiles (e.g. long but narrow stations), and will make creating the LOD file alot easier and more consistent than what is currently is. - Natvander
: ''I think you'll find that the example you gave doesn't actually change LODs as you spin it, as the bounding sphere is used for the screen-space calculation. But you're right, this request doesn't belong here. ~chris''

* Have 20m 40m and 80m Square boards for use at greater viewing distances allowing Trainz to have a greater viewing distance for minimal resource use. perhaps even have these boards have no objects and simpler textures added to them. Surley you have the tech developed for joining the 5m to 10m boards surley its a simple jump of the same tech to allow greater board sizes. - Lots Trains
: ''View distance has nothing to do with resource usage. Also, please do not put requests directly into the shortlist. ~chris''

* This time around when you change the interface skin colours from Maroon to purple polka dots can you have somebody check that both black and white text are actually legible in the default browsers? ~Andi
: ''We can't guarantee you any particular default color, so if you're going to use a defined RGB value, you should always provide a defined background color as well. We will be making sure that the default text color is legible, and also that color schemes used by built-in rules are legible. ~chris''
: -''Historically authors have used black or white without setting a background since the background in TRS was always a mid grey. The problem in TC is that ''legacy'' content with black text built on this assumption and which is never going to get updated is illegible, that's the issue I'm raising. Assuming you stay with almost black, how easy would it be to check for this and change their text colour to something else?''
:: ''We can't really do much for the existing non-Auran assets, however the TS2009 color scheme is unlikely to conflict.'' ~chris

* Could you make it so when an object is missing and the system asks if we wish to delete it, it lists the KUID of the item? Maybe records it somewhere like an error log so we could track them down if we need to? - Chad
: ''Why is this necessary? Doesn't CMP give you all this info already? ~chris''
:: Not exactly. I mean something in place of the "delete missing assets" pop up. Something that would tell what type of asset it is, Eg: Structure, Road, Spline, Etc. As well as the country of origin of it.
:: ''We don't necessarily have that information if the asset is missing. If you want the full details of any (known) missing assets, CMP provides all the functionality you should need.'' ~chris

* When a section of track has been "straightened", it should not flex when a curve or turnout is added to it. -BG
: ''Track needs to smoothly transition - you can't connect two straight tracks at an angle. That said, I'm not really sure what situation you're referring to here. Could you provide an example?'' ~chris
: ''Rejected due to lack of updates.'' ~chris

* More diversive traffic. Currently street traffic only contains simple cars and vans. Why not extend that to have higher detail trucks, busses, motorcycles, and tractor-trailers. (The latter could, and would probably need to be, two part to allow it to track properly around curves.) - Chad
: ''This isn't a tool requirement. You can simply download/create more road traffic and add them to the map/region's traffic list. My route has plenty of era/location specific cars and trucks (the articulation of semis would be a nice feature). - Natvander''

* Could road traffic turn not only to the left? I think will be good to make it proportional to roads' carrates -Mike
: ''This isn't a surveyor tools request.'' ~chris

* I really don't expect this to happen. It has been a problem since the first issue of Trainz. I would like to see the rain and the snow stop falling when a train enters a tunnel. Having it rain or snow inside a tunnel, is, at best, silly.
Hoping -sjacks
: ''This isn't a surveyor tools request.'' ~chris

* Not sure if this is scripting or not, but could automobiles (traffic) be made to obey stop signals at intersections? Maybe include this in the object so a car stops, waits, and then drives on. Possibly include them turning off onto side streets, etc. (I know the latter has been done to some degree by third party users.) - Chad
: ''This isn't a surveyor tools request.'' ~chris

* Make Junction Controllers work again. Back in 2004 (and UTC I think) someone came out with this neat little tool that when placed in surveyor, would allow one switch to control another. Usually used in a crossover, it meant that when you opened one switch, it would open the opposing one, and when you closed one, they both closed. The object was obsoleted by a junction control rule. Problem is not all users know how to, or are willing to do those. This little object did it for them though. The Kuid was kuid2_31293_23003_1. - Chad
: ''This isn't a surveyor tools request. A content creator would need to take this task on, and liaise with Auran if they find any game bugs or problem.'' ~chris

* Pedestrian traffic. Similar to roads, perhaps include a series of sidewalk splines and genraters that produce pedestrians at regular intervals. Major help for those urban streetcar lines. - Chad
: ''This isn't a surveyor tools request.'' ~chris

[[Category:Feature Request]]

Class Vehicle

2008-12-30T00:05:16Z

Pencil42: /* SetRunningNumber */ fixed typo

*[[TrainzScript Langage Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class TrainzGameObject|TrainzGameObject]]
****[[Class PropertyObject|PropertyObject]] *
*****[[Class MeshObject|MeshObject]]
******[[Class MapObject|MapObject]]
*******[[Class Trackside|Trackside]]
********Vehicle
 

*A vehicle is a single piece of rolling stock including locomotives and tenders.
*A vehicle is always part of a train, if a vehicle is decoupled and left alone TRS will create a new consist to include it.
 

==Related Messages==
*Messages sent to and from Vehicle objects are listed below:
 
{{TableHeader|width=75%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''||bgcolor="#EEEEEE" |
|-
|[[Vehicle Messages|Vehicle]]||Derailed||Vehicle||Broadcast||Vehicle has derailed and can no longer be used.
|-
|[[Vehicle Messages|Vehicle]]||Coupled||Vehicle||Broadcast||Vehicle has coupled up with another vehicle.
|-
|[[Vehicle Messages|Vehicle]]||Decoupled||Vehicle||Broadcast||Vehicle has decoupled from another vehicle.
|-
|[[Vehicle Messages|Vehicle]]||Bad Couple||Vehicle||Broadcast||Vehicle has coupled with another vehicle at too high a velocity.
|-
|[[Vehicle Messages|Vehicle]]||Collided||Vehicle||Broadcast||Vehicle has collided with another vehicle.
|}
 

==Constants==
 
===Coupler Flags===
 
{{TableHeader|width=95%|margin=15px}}
|width=425|public define int COUPLE_NONE = 0||Neither coupler.
|-
|public define int COUPLE_FRONT = 1||Front coupler.
|-
|public define int COUPLE_BACK = 2||Back coupler.
|-
|public define int COUPLE_BOTH = COUPLE_FRONT ¦ COUPLE_BACK||Both couplers.
|}
 

===Direction Relationships===
 
{{TableHeader|width=95%|margin=15px}}
|width=425|public define int DIRECTION_NONE = 0||No known relationship.
|-
|public define int DIRECTION_FORWARD = 1||Forward, facing in the same direction.
|-
|public define int DIRECTION_BACKWARD = -1||Backward, facing in opposite directions.
|}
 

===Engine Types===
 
{{TableHeader|width=95%|margin=15px}}
|width=425|public define int ENGINE_NONE = 0||Not a powered vehicle.
|-
|public define int ENGINE_STANDARD = 1||Diesel, Diesel-Electric, Electric.
|-
|public define int ENGINE_STEAM = 2||Steam powered.
|}
 

===Vehicle Type Flags===
 
{{TableHeader|width=95%|margin=15px}}
|width=425|public define int TYPE_LOCOMOTIVE = 1||Vehicle is a powered locomotive.
|-
|public define int TYPE_TENDER = 2||Vehicle carries fuel for a locomotive.
|-
|public define int TYPE_HAS_INTERIOR = 4||Vehicle has an interior. This does not necessarily mean that it is a lcomotive.
|}
 

==Members==
 
{{TableHeader|width=95%|margin=15px}}
|width=425|public IndustryProductInfoCollection vehicleProductInfoCollection||A data object that allows tracking of products and associated assets & queues.
|}
 

==Methods==
 

===BeginLoad===
{{MethodHeader|float BeginLoad(LoadingReport report)}}
;Parameters
*'''report''' = Report on the current state of the loading operation.
;Returned Value
*The time required, in seconds, for the activity to complete.
;Syntax
float BeginLoad(LoadingReport report) {
DoStuff(report);
return 10.0;
}
;Notes
*This is a callback method which should be overridden by the script writer to perform customised activities before loading at an industry.
*These include such operations as particle effects and animations.
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship.
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.
 

===BeginUnload===
{{MethodHeader|float BeginUnload(LoadingReport report)}}
;Parameters
*'''report''' = Report on the current state of the loading operation.
;Returned Value
*The time required, in seconds, for the activity to complete.
;Syntax
float BeginLoad(LoadingReport report) {
DoStuff(report);
return 10.0;
}
;Notes
*This is a callback method which should be overridden by the script writer to perform customised activities before loading at an industry.
*These include such operations as particle effects and animations.
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship.
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.
 

===CanLoadProductFromQueue===
{{MethodHeader|public bool CanLoadProductFromQueue(ProductQueue queue)}}
;Parameters
*'''queue''' = The queue to be queried.
;Returned Value
*True if the vehicle and queue are compatible and the queue can be used to load the vehicle, false otherwise.
*None
;Syntax
if (CanLoadProductFromQueue(industryOutQueue)) {
DoTheProcess();
}
;Notes
 

===CanUnloadProductToQueue===
{{MethodHeader|public bool CanUnloadProductToQueue(ProductQueue queue)}}
;Parameters
*'''queue''' = The queue to be queried.
;Returned Value
*True if the vehicle and queue are compatible and the queue can be used to unload the vehicle, false otherwise.
;Syntax
if (CanUnloadProductToQueue(industryOutQueue)) {
DoTheProcess();
}
;Notes
 

===Couple===
{{MethodHeader|public native bool Couple(Vehicle other)}}
;Parameters
*''other''' = Adjacent vehicle to couple to.
;Returned Value
*True if the operation was successfully completed, fale otherwise.
;Syntax
if (Couple(vehicle2)) Interface.Print("Success!");
;Notes
*Couples this vehicle to the given vehicle which must already be adjacent.
*When a vehicle is decoupled from another, the couplers are left in an unlocked state, even though the vehicles are flush against each other.
*This state will remain until the vehicles move a small distance apart.
*Sometimes you may wish to cause them to couple again and that is the intended use of this method.
*If the two vehicles involved are not adjacent then this method will have no effect.
 

===EndLoad===
{{MethodHeader|float EndLoad(LoadingReport report)}}
;Parameters
*'''report''' = Report on the current state of the loading operation.
;Returned Value
*The time required, in seconds, for the activity to complete.
;Syntax
float EndLoad(LoadingReport report) {
DoStuff(report);
return 10.0;
}
;Notes
*This is a callback method which should be overridden by the script writer to perform customised activities after loading at an industry.
*These include such operations as particle effects and animations.
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship.
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.
 

===EndUnload===
{{MethodHeader|float EndUnload(LoadingReport report)}}
;Parameters
*'''report''' = Report on the current state of the loading operation.
;Returned Value
*The time required, in seconds, for the activity to complete.
;Syntax
float EndUnload(LoadingReport report) {
DoStuff(report);
return 10.0;
}
;Notes
*This is a callback method which should be overridden by the script writer to perform customised activities after unloading at an industry.
*These include such operations as particle effects and animations.
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship.
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.
 

===GetAuxReservoirPressure===
{{MethodHeader|public native float GetAuxReservoirPressure(void)}}
;Parameters
*None
;Returned Value
*The current auxiliary reservoir pressure of this vehicle.
;Syntax
float ARP = GetAuxReservoirPressure();
;Notes
 

===GetBogeyList===
{{MethodHeader|public native Bogey[ ] GetBogeyList(void)}}
;Parameters
*None
;Returned Value
*An array containing references to all the Bogey objects attached to this vehicle.
;Syntax
Bogey[] bogies = GetBogeyList();
;Notes
*Bogies are indexed in the same numerical order as they are listed in ''config.txt''.
*Invisible bogies etc. are included.
 

===GetBrakeCylinderPressure===
{{MethodHeader|public native float GetBrakeCylinderPressure(void)}}
;Parameters
*None
;Returned Value
*The current brake cylinder pressure of this vehicle.
;Syntax
float BCP = GetBrakeCylinderPressure();
;Notes
 

===GetBrakePipePressure===
{{MethodHeader|public native float GetBrakePipePressure(void)}}
;Parameters
*None
;Returned Value
*The current brake pipe pressure of this vehicle.
;Syntax
float BPP = GetBrakePipePressure();
;Notes
 

===GetCabinSwayAmount===
{{MethodHeader|public native float GetCabinSwayAmount(void)}}
;Parameters
*None
;Returned Value
*The cabin sway amount for this vehicle.
;Syntax
float CSA = GetCabinSwayAmount();
;Notes
*Higher positive values indicate higher levels of cabin sway while a 0.0 indicates no cabin sway.
*See also [[#SetCabinSwayAmount|SetCabinSwayAmount()]].
 

===GetCouplerBreakageEnabled===
{{MethodHeader|public native bool GetCouplerBreakageEnabled(void)}}
;Parameters
*None
;Returned Value
*True if coupler breakages are enabled on this vehicle, false otherwise.
;Syntax
if (GetCouplerBreakageEnabled()) Interface.Print("Drive carefully to avoid breaking the couplers");
;Notes
 

===GetCouplingDirection===
{{MethodHeader|public native int GetCouplingDirection(Vehicle other)}}
;Parameters
*''other''' = Adjacent vehicle to couple to.
;Returned Value
*One of the [[#Direction Relationships|Direction Relationship]] constants indicating the direction of a neighbouring vehicle, relative to the direction of the caller.
;Syntax
bool direction = GetCouplingDirection(vehicle2);
;Notes
*If the result is DIRECTION_FORWARD then both vehicles have the same orientation.
*If the result is DIRECTION_BACKWARD then the two vehicles face in opposite directions.
*The fact that this method returns a value does not mean that it is possible for the two vehicles to couple.
 

===GetCouplingStress===
{{MethodHeader|public native float GetCouplingStress(Vehicle other)}}
;Parameters
*''other''' = Other vehicle in the same consist to query.
;Returned Value
*The calculated coupling stress between the two vehicles in kilonewtons (kN);
;Syntax
float kn = GetCouplingStress(vehicle2);
;Notes
*<float color=red>Must the two vehicles be adjacent?
 

===GetDefaultCabinSwayAmount===
{{MethodHeader|public native float GetDefaultCabinSwayAmount(void)}}
;Parameters
*None
;Returned Value
*The default cabin sway amount for this vehicle as defined in ''config.txt''.
;Syntax
float CSA = GetCabinSwayAmount();
;Notes
*Higher positive values indicate higher levels of cabin sway while a 0.0 indicates no cabin sway.
*See also [[#SetCabinSwayAmount|SetCabinSwayAmount()]].
 

===GetDefaultMaximumCouplerCompressionStress===
{{MethodHeader|publc native float GetDefaultMaximumCouplerCompressionStress(void)}}
;Parameters
*None
;Returned Value
*The default maximum coupler expansion stress value for this vehicle in kilonewtons (kN), as defined in ''config.txt''.
;Syntax
float DMCS = GetDefaultMaximumCouplerCompressionStress();
;Notes
*See [[#SetMaximumCouplerCompressionStress|SetMaximumCouplerCompressionStress()]].
 

===GetDefaultMaximumCouplerExpansionStress===
{{MethodHeader|public native float GetDefaultMaximumCouplerExpansionStress(void)}}
;Parameters
*None
;Returned Value
*The default maximum coupler expansion stress value for this vehicle in kilonewtons (kN), as defined in ''config.txt''.
;Syntax
float DMCE = GetDefaultMaximumCouplerExpansionStress();
;Notes
*See [[#SetMaximumCouplerExpansionStress|SetMaximumCouplerExpansionStress()]].
 

===GetDefaultMaximumCoupleVelocity===
{{MethodHeader|public native float GetDefaultMaximumCoupleVelocity(void)}}
;Parameters
*None
;Returned Value
*The default maximum speed at which this vehicle can be coupled to without breaking the coupler, as defined in ''config.txt''.
;Syntax
float DMCV = GetDefaultMaximumCoupleVelocity();
;Notes
*See [[#SetMaximumCoupleVelocity|SetMaximumCoupleVelocity()]].
 

===GetDefaultMaximumTractiveEffort===
{{MethodHeader|GetDefaultMaximumTractiveEffort()}}
;Parameters
*None
;Returned Value
*The default maximum tractive effort of this vehicle from its configuration in kilonewtons (kN), as defined in ''config.txt''.
;Syntax
float DMTE = GetDefaultMaximumTractiveEffort();
;Notes
*See [[#SetMaximumTractiveEffort|SetMaximumTractiveEffort()]].
 

===GetDirectionRelativeToTrain===
{{MethodHeader|public native bool GetDirectionRelativeToTrain(void)}}
;Parameters
*None
;Returned Value
*True if this vehicle faces in the same direction as the train's current heading, false otherwise.
;Syntax
bool vehicleToTrain = GetDirectionRelativeToTrain();
;Notes
 

===GetEngineParam===
{{MethodHeader|public native float GetEngineParam(string param)}}
;Parameters
*'''param''' = One of the engine parameter strings listed below.
;Returned Value
*The current value of the given engine parameter.
;Syntax
float pressure = GetEngineParam("steam-boiler-pressure");
;Notes
*Engine parameter strings you can use with this method are:
**"brake-cylinder-pressure"
**"brake-pipe-pressure"
**"coal-mass"
**"current-drawn"
**"equaliser-pressure"
**"fire-temperature"
**"flow"
**"horn"
**"main-reservoir-pressure"
**"max-coal-mass"
**"max-fire-temperature"
**"no3-pipe-pressure"
**"steam-boiler-liquid-percent"
**"steam-boiler-pressure"
**"steam-piston-cycle"
**"wheelslip"
**"engine-force"
**"applied-force"
**"max-te"
*The format and meaning of each of these parameters is detailed in the Content Creation Guide.
*Some of the values refer only to steam engines.
 

===GetEngineType===
{{MethodHeader|public native int GetEngineType(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Engine Types|Engine Type]] constants describing the engine type of this vehicle.
;Syntax
int eType = GetEngineType();
;Notes
 

===GetLength===
{{MethodHeader|public native float GetLength(void)}}
;Parameters
*None
;Returned Value
*The length of this vehicle in metres.
;Syntax
float length = GetLength();
;Notes
 

===GetLoadTime===
{{MethodHeader|float GetLoadTime(LoadingReport report)}}
;Parameters
*'''report''' = Report on the current state of the loading operation.
;Returned Value
*The time required, in seconds, for the activity to complete.
;Syntax
float GetLoadTime(LoadingReport report) {
DoStuff(report);
return 10.0;
}
;Notes
*This is a callback method which informs the game engine of the time needed to load this vehicle.
*The method may be use to perform customised activities during the loading operation.
*These include such operations as particle effects and animations.
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship.
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.
 

===GetMass===
{{MethodHeader|public native float GetMass(void)}}
;Parameters
*None
;Returned Value
*The mass of the vehicle in kilograms.
;Syntax
float mass = GetMass();
;Notes
 

===GetMaximumCouplerCompressionStress===
{{MethodHeader|publc native float GetMaximumCouplerCompressionStress(void)}}
;Parameters
*None
;Returned Value
*The maximum coupler expansion stress value for this vehicle in kilonewtons (kN).
;Syntax
float MCS = GetMaximumCouplerCompressionStress();
;Notes
*See [[#SetMaximumCouplerCompressionStress|SetMaximumCouplerCompressionStress()]].
 

===GetMaximumCouplerExpansionStress===
{{MethodHeader|public native float GetMaximumCouplerExpansionStress(void)}}
;Parameters
*None
;Returned Value
*The maximum coupler expansion stress value for this vehicle in kilonewtons (kN).
;Syntax
float DMCE = GetMaximumCouplerExpansionStress();
;Notes
*See [[#SetMaximumCouplerExpansionStress|SetMaximumCouplerExpansionStress()]].
 

===GetMaximumCoupleVelocity===
{{MethodHeader|public native float GetMaximumCoupleVelocity(void)}}
;Parameters
*None
;Returned Value
*The maximum speed at which this vehicle can be coupled to without breaking the coupler.
;Syntax
float MCV = GetMaximumCoupleVelocity();
;Notes
*See [[#SetMaximumCoupleVelocity|SetMaximumCoupleVelocity()]].
 

===GetMaximumTractiveEffort===
{{MethodHeader|GetMaximumTractiveEffort()}}
;Parameters
*None
;Returned Value
*The maximum tractive effort of this vehicle from its configuration in kilonewtons (kN).
;Syntax
float MTE = GetMaximumTractiveEffort();
;Notes
*See [[#SetMaximumTractiveEffort|SetMaximumTractiveEffort()]].
 

===GetMyTrain===
{{MethodHeader|public native Train GetMyTrain(void)}}
;Parameters
*None
;Returned Value
*A reference to the train of which this vehicle is part.
;Syntax
Train train = GetMyTrain();
;Notes
*All vehicles belong to a Train consist, even if a vehicle is not coupled to any other vehicle.
 

===GetProductRestriction===
{{MethodHeader|public ProductFilter GetProductRestriction(void)}}
;Parameters
*None
;Returned Value
*The current product restriction filter if any, null otherwise.
;Syntax
ProductFilter filter = GetProductRestriction();
;Notes
 

===GetRelationToTrack===
{{MethodHeader|public native int GetRelationToTrack(Buildable obj, string trackName)}}
;Parameters
*'''obj''' = Reference to a Buildable object.
*'''trackName''' = String representing the name of a track as defined in the Buildable's ''config.txt''.
;Returned Value
*One of the [[#Direction Relationships|Direction Relationship]] constants indicating the direction of the vehicle, relative to the Buildable's attached track.
;Syntax
*This method will return either DIRECTION_FORWARD or DIRECTION_BACKWARD if the vehicle is on the track as specified by the arguments or on a directly neighboring track, otherwise DIRECTION_NONE will be returned.
;Notes
 

===GetRunningNumber===
{{MethodHeader|public native string GetRunningNumber(void)}}
;Parameters
*None
;Returned Value
*The running (fleet identification) number of the vehicle.
;Syntax
string fleetId = GetRunningNumber();
;Notes
*This value is set using [[#SetRunningNumber|SetRunningNumber()]] and should be restricted to alphanumeric characters and paces.
 

===GetSandingTractionMultiplier===
{{MethodHeader|public native float GetSandingTractionMultiplier(void)}}
;Parameters
*None
;Returned Value
*A wheelslip traction multiplier to apply when sand is in use.
;Syntax
float slipFactor = GetSandingTractionMultiplier();
;Notes
*The returned value will be greater than or equal to 1.0.
*See [[#SetSandingTractionMultiplier|SetSandingTractionMultiplier()]];
 

===GetTrackGradient===
{{MethodHeader|public native float GetTrackGradient(void)}}
;Parameters
*None
;Returned Value
*The current track gradient as a percentage.
;Syntax
float gradient = GetTrackGradient();
;Notes
*The sign of the gradient is determined by the direction of this vehicle relative to the gradient.
*A negative sign indicates that the vehicle is facing down a gradient while a positive sign indicates the vehicle is facing up a gradient.
*The vehicle's direction may not match that of the train so the value returned here may not be what you expect.
*Use [[#GetDirectionRelativeToTrain|GetDirectionRelativeToTrain()]] to check this.
 

===GetUnloadTime===
{{MethodHeader|float GetUnloadTime(LoadingReport report)}}
;Parameters
*'''report''' = Report on the current state of the loading operation.
;Returned Value
*The time required, in seconds, for the activity to complete.
;Syntax
float GetUnloadTime(LoadingReport report) {
DoStuff(report);
return 10.0;
}
;Notes
*This is a callback method which informs the game engine of the time needed to unload this vehicle.
*The method may be use to perform customised activities during the unloading operation.
*These include such operations as particle effects and animations.
*The report parameter provides details of the industries and vehicles involved and of their spatial relationship.
*It is the responsibility of the script writer to determine the time required for these activities and to return this in the method result.
 

===GetVehicleTypeFlags===
{{MethodHeader|public native int GetVehicleTypeFlags(void)}}
;Parameters
*None
;Returned Value
*One of the [[#Vehicle Type Flags|Vehicle Type Flags]] representing what kind of vehicle the current object is.
;Syntax
int flags = GetVehicleTypeFlags();
;Notes
 

===GetVelocity===
{{MethodHeader|public native float GetVelocity(void)}}
;Parameters
*None
;Returned Value
*The current instantaneous velocity of the train in metres per second.
;Syntax
float speed = GetVelocity();
;Notes
*Use the [[Class Train#Measurement Conversion Multipliers|Measurement Conversion Multiplier]] constants for conversion to other units.
*For human consumption [[Class Train#GetSmoothedVelocity|Train.GetSmoothedVelocity()]] may be preferable.
 

===GetWheelslipTractionMultiplier===
{{MethodHeader|public native float GetWheelslipTractionMultiplier(void)}}
;Parameters
*None
;Returned Value
*The current wheelslip traction multiplier value.
;Syntax
float slip = GetWheelslipTractionMultiplier();
;Notes
*The returned value will be greater than or equal to 1.0.
*See [[#SetWheelslipTractionMultiplier|SetWheelslipTractionMultiplier()]];
 

===IsInTunnel===
{{MethodHeader|public native bool IsInTunnel(void)}}
;Parameters
*None
;Returned Value
*True if this vehicle is in a tunnel, false otherwise.
;Syntax
bool underground = IsInTunnel();
;Notes
 

===IsOnBridge===
{{MethodHeader|public native void IsOnBridge(void)}}
;Parameters
*None
;Returned Value
*True if this vehicle is on a bridge, false otherwise.
;Syntax
bool onBridge = IsOnBridge();
;Notes
 

===LoadProduct===
{{MethodHeader|public bool LoadProduct(LoadingReport report)}}
;Parameters
*'''report''' = Report on the current state of the loading operation.
;Returned Value
*True if the loading operation was successful, false otherwise.
;Syntax
LoadProduct(report);
;Notes
*Loads products into this vehicle as defined by the given report.
*This method works by attempting to transfer products to this vehicle's queues if possible from the industry queue specified in report.
*The sequence of events for a loading operation as performed by this method is:
**Verify that an loading operation is possible with this vehicle by calling [[#CanLoadProductFromQueue|CanLoadProductFromQueue()]].
**[[#BeginLoad|BeginLoad()]] on this vehicle and [[Class Industry#BeginLoad|Industry.BeginLoad()]] on the industry specified in the report are called to perform any pre-loading events like animation or particle effects on the vehicle and industry respectively.
**Both of these methods return the amount of time required for a load operation and the LoadProduct() method sleeps for which ever of these times is the longer.
**The actual product transfer from the industry to the vehicle is performed by calling ProductQueue.TransferProductFrom() on this vehicle's queue(s).
**[[#GetLoadTime|GetLoadTime()]] on this vehicle and [[Class Industry#GetLoadTime|Industry.GetLoadTime()]] are called. Again, LoadProduct() sleeps for which ever is the longer of the times returned.
**[[#EndLoad|EndLoad()]] and [[Class Industry#EndLoad|Industry.EndLoad()]] are called to perform any post-loading events. As before LoadProduct() sleeps for the longer time.
 

===Reposition===
{{MethodHeader|public native bool Reposition(Train train, int myCoupleDir, int otherCoupleDir) public native bool Reposition(Vehicle vehicle, int myCoupleDir, int otherCoupleDir) public native bool Reposition(TrackMark mark, bool direction)}}
;Parameters
*'''train''' = Train to attach the vehicle to.
*'''vehicle''' = Vehicle to attach the vehicle to.
*'''myCoupleDir''' = The end of the current vehicle that will be coupled, use either COUPLE_FRONT or COUPLE_BACK.
*'''otherCoupleDir''' = The end of the target vehicle that will be coupled to, use either COUPLE_FRONT or COUPLE_BACK.
*'''mark''' = Trackmark to move this vehicle to.
*'''direction''' = Direction for the vehicle, relative to the TrackMark.
*None
;Returned Value
*True if the operation was successfully completed, false otherwise.
;Syntax
Reposition(Train3,COUPLE_FRONT,COUPLE_BACK);
Reposition(Vehicle5,COUPLE_FRONT,COUPLE_BACK);
Reposition(Mark9,true);
;Notes
*Variant 1 moves the current vehicle and couples it to the specified train using the specified vehicle ends.
*Variant 2 moves the current vehicle and couples it to the specified vehicle using the specified vehicle ends.
*Variant 3 moves the current vehicle from its train to the specified trackmark, normally creating a new consist.
 

===Reverse===
{{MethodHeader|public native bool Reverse(void)}}
;Parameters
*None
;Returned Value
*True if the operation was successfully completed, false otherwise.
;Syntax
if (Reverse()) Interface.Print("Direction of " + GetName() + " reversed");
;Notes
*This method reverses the direction of the current vehicle in relation to its consist.
 

===SetBrakePipeEfficiency===
{{MethodHeader|public native void SetBrakePipeEfficiency(float efficiency)}}
;Parameters
*'''efficiency''' = A Normalised value in the range 0.0 .. 1.0 representing the efficiency of the brake pipe.
;Returned Value
*None
;Syntax
SetBrakePipeEfficiency(0.5);
;Notes
 

===SetBrokenBrakes===
{{MethodHeader|public native void SetBrokenBrakes(bool broken)}}
;Parameters
*'''broken''' = True to render the brakes non operational, false to repair them.
;Returned Value
*None
;Syntax
SetBrokenBrakes(true);
;Notes
 

===SetCabinSwayAmount===
{{MethodHeader|public native void SetCabinSwayAmount(float amount)}}
;Parameters
*'''amount''' = Cabin sway value greater than or equal to zero.
;Returned Value
*None
;Syntax
SetCabinSwayAmount(2.5);
;Notes
*A value of zero removes all sway.
*Higher positive values increase the effect.
*The method is only of relevance to vehicles with interior views.
 

===SetCouplerBreakageEnabled===
{{MethodHeader|public native void SetCouplerBreakageEnabled(bool enabled)}}
;Parameters
*'''enabled''' = True enables simulation of coupler breakage.
*None
;Returned Value
*None
;Syntax
SetCouplerBreakageEnabled(true);
;Notes
 

===SetCouplingMask===
{{MethodHeader|public native void SetCouplingMask(int mask)}}
;Parameters
*'''mask''' = A mask specifying which of the vehilce's couplers are allowed to couple.
;Returned Value
*None
;Syntax
SetCouplingMask(COUPLE_NONE); // prevents this vehicle from coupling to another in Driver mode.
;Notes
*The mask can be built using the [[#Coupler Flags|Coupler Flag]] constants.
*This method will not prevent vehicles from coupling in Surveyor, but takes effect in Driver mode.
 

===SetDecouplingMask===
{{MethodHeader|public native void SetDecouplingMask(int mask)}}
;Parameters
*'''mask''' = A mask specifying which of the vehilce's couplers are allowed to couple.
;Returned Value
*None
;Syntax
SetDecouplingMask(COUPLE_NONE); // prevents this vehicle from uncoupling in Driver mode.
;Notes
*The mask can be built using the [[#Coupler Flags|Coupler Flag]] constants.
*This method will not prevent vehicles from uncoupling in Surveyor, but takes effect in Driver mode.
 

===SetHandbrake===
{{MethodHeader|public native void SetHandBrake(bool applied)}}
;Parameters
*'''applied''' = If true the handbrake is applied, if false the handbrake is released.
;Returned Value
*None
;Syntax
SetHandBrake(true);
;Notes
 

===SetHeadlightColor===
{{MethodHeader|SetHeadlightColor(float red, float blue, float green)}}
;Parameters
*'''red, blue, green''' = RGB components of selected colour, expressed as normalised values.
;Returned Value
*None
;Syntax
SetHeadlightColour(0.5,1.0,0.5); // sets colour to RGB:128,255,128
;Notes
*This method controls the color of the illumination produced by the headlights.
*It does not affect the color of the headlight coronas.
*This should method not be used to "turn off" the headlights, as even a black light will consume CPU time with lighting calculations.
 

===SetMaximumCouplerCompressionStress===
{{MethodHeader|public native void SetMaximumCouplerCompressionStress(float stress)}}
;Parameters
*'''stress''' = Maximum compressive stress in kilonewtons (kN), Use 0.0 to turn off this simulation.
;Returned Value
*None
;Syntax
SetMaximumCouplerCompressionStress(1500.0);
;Notes
*Sets the maximum coupler compressive stress value for this vehicle.
*This value refers to the maximum compressive stress which this vehicle's couplers need to experience before they break.
*This is effectively the stress that a coupler can withstand before it breaks.
*As a point of reference, a typical modern knuckle-type coupler can handle approximately 2500 kN of force before breaking.
*This is roughly equivalent to the weight of 2.5 million apples.
 

===SetMaximumCouplerExpansionStress===
{{MethodHeader|public native void SetMaximumCouplerExpansionStress(float stress)}}
;Parameters
*'''stress''' = Maximum tensile stress in kilonewtons (kN), Use 0.0 to turn off this simulation.
;Returned Value
*None
;Syntax
SetMaximumCouplerExpansionStress(1000.0);
;Notes
*Sets the maximum coupler tensile stress value for this vehicle.
*This value refers to the maximum tesnile stress which this vehicle's couplers need to experience before they break.
*This is effectively the stress that a coupler can withstand before it breaks.
*As a point of reference, a typical modern knuckle-type coupler can handle approximately 2500 kN of force before breaking.
*This is roughly equivalent to the weight of 2.5 million apples.
 

===SetMaximumCoupleVelocity===
{{MethodHeader|public native void SetMaximumCoupleVelocity(float velocity)}}
;Parameters
*'''velocity''' = The maximum speed in metres per second at which this vehicle can be coupled to without breaking a coupler.
;Returned Value
*None
;Syntax
SetMaximumCoupleVelocity(10);
;Notes
*"Vehicle","BadCouple" are broadcast if this speed is exceeded.
*If a value of zero is used "Vehicle","BadCouple" messages will not be issued.
 

===SetMaximumTractiveEffort===
{{MethodHeader|public native void SetMaximumTractiveEffort(float maxTE)}}
;Parameters
*'''maxTE''' = The maximum tractive effort of this vehicle in kilonewtons (kN).
;Returned Value
*None
;Syntax
SetMaximumTractiveEffort(1850.0);
;Notes
*The maximum tractive effort of a vehicle refers to its maximum traction or pulling power measured in kilonewtons.
*This value is initially defined in the configuration of a vehicle asset but can be altered with this method.
*Generally, only locomotives will have tractive effort.
 

===SetPitchBasedOnSpeed===
{{MethodHeader|public native void SetPitchBasedOnSpeed(float factor)}}
;Parameters
*'''factor''' = An arbitrary value used to vary the pitch of the train with its velocity.
;Returned Value
*None
;Syntax
SetPitchBasedOnSpeed(2.5);
;Notes
*Pitch is rotation about an axis at right angles to the track direction.
 

===SetPitchBasedOnTrack===
{{MethodHeader|public native void SetPitchBasedOnTrack(bool pitch)}}
;Parameters
*'''pitch''' = True to enable the effect, false to disable.
;Returned Value
*None
;Syntax
SetPitchBasedOnTrack(true);
;Notes
*Pitch is rotation about an axis at right angles to the track direction.
 

===SetProductDisabled===
{{MethodHeader|public native void SetProductDisabled(void)}}
;Parameters
*None
;Returned Value
*None
;Syntax
SetProductDisabled();
;Notes
*Disables the loading or unloading of any product, overriding any previous calls to SetProductRestriction().
 

===SetProductRestriction===
{{MethodHeader|public native bool SetProductRestriction(Asset product)}}
;Parameters
*'''product''' = Asset to to which this vehicle's load is to be restricted.
;Returned Value
*True if successful, false otherwise.
;Syntax
SetProductRestriction(coal);
;Notes
*Restricts this vehicle to only allow the given product.
*When a product restriction is in effect, only that product may be either loaded or unloaded.
*This method overrides any previous call to SetProductDisabled().
*If the product parameter is null, any product compatible with this vehicle can be loaded/unloaded.
*If it is a product that is not compatible with this vehicle, no restriction is set and false will be returned.
 

===SetQueueInitialCount===
{{MethodHeader|public void SetQueueInitialCount(ProductQueue queue, Asset product, int amount)}}
;Parameters
*'''queue''' = Queue to use, any existing products in this queue will be destroyed.
*'''product''' = Asset of product to use.
*'''amount''' = Amount of product to use.
;Returned Value
*None
;Syntax
SetQueueInitialCount(passengerQueue,passengers,20);
;Notes
*Fills the given queue with the specified quantity of product.
*This method sets the amount of products in the given queue.
*It is a utility method that works on the given queue which need not be a queue from this vehicle.
*The product filter provided with queue will be used to check if the queue can take products of type asset.
*If it can't, the filter will be modified to suit as this method is forceful in that regard.
 

===SetRollBasedOnTrack===
{{MethodHeader|public native void SetRollBasedOnTrack(float factor)}}
;Parameters
*'''factor''' = Arbitrary value used to control the amount of roll.
;Returned Value
*None
;Syntax
SetRollBasedOnTrack(2.0);
;Notes
*Roll is a rotation about an axis parallel to the track direction.
*Use a positive value to lean 'into' the curve, a negative value to lean out.
 

===SetRunningNumber===
{{MethodHeader|public native void SetRunningNumber(string number)}}
;Parameters
*'''number''' = The running (fleet identification) number of the vehicle.
;Returned Value
*None
;Syntax
SetRunningNumber("21C1");
SetRunningNumber("4472");
;Notes
*This value is retrieved using [[#GetRunningNumber|GetRunningNumber()]] and should be restricted to alphanumeric characters and spaces.
 

===SetSandingTractionMultiplier===
{{MethodHeader|public native void SetSandingTractionMultiplier(float factor)}}
;Parameters
*'''factor''' = A multiplier value of 1.0 or more defining the increase in this vehicle's tractive effort when sand is in use.
;Returned Value
*None
;Syntax
SetSandingTractionMultiplier(1.5); // allow sanding to increase tractive effort by 50%
;Notes
 

===SetWheelslipTractionMultiplier===
{{MethodHeader|public native void SetWheelslipTractionMultiplier(float factor)}}
;Parameters
*'''factor''' = A multiplier value of 1.0 or less to apply to decrease this vehicle's traction when wheelslip occurs.
;Returned Value
*None
;Syntax
SetWheelslipTractionMultiplier(0.25); // wheelslip reduces tractive effort to 25% of normal.
;Notes
 

===Uncouple===
{{MethodHeader|public native void Uncouple(int end) public native void Uncouple(Vehicle other)}}
;Parameters
*'''end''' = One of the [[#Direction Relationships|Direction Relationship]] constants indicating at which end of the current vehicle the uncoupling is to occur.
*'''other''' = A reference to the other vehicle form which the caller is to be uncoupled.
;Returned Value
*None
;Syntax
Uncouple(DIRECTION_FORWARD); // uncouple at the current vehicle's front end
Uncouple(vehicle1); // uncouple from the specified vehicle
;Notes
*This method will always cause another Train object to be created.
*The current Train reference will remain on the section of the previous train with the most drivers declared.
 

===UnloadProduct===
{{MethodHeader|public bool UnloadProduct(LoadingReport report)}}
;Parameters
*'''report''' = Report on the current state of the loading operation.
;Returned Value
*True if the unloading operation was successful, false otherwise.
;Syntax
UnloadProduct(report);
;Notes
*Unloads products into this vehicle as defined by the given report.
*This method works by attempting to transfer products from this vehicle's queues to the industry queue specified in report.
*The sequence of events for an unloading operation as performed by this method is:
**Verify that an unloading operation is possible with this vehicle by calling [[#CanUnloadProductToQueue|CanUnloadProductToQueue()]].
**[[#BeginUnload|BeginUnload()]] on this vehicle and [[Class Industry#BeginUnload|Industry.BeginUnload()]] on the industry specified in the report are called to perform any pre-unloading events like animation or particle effects on the vehicle and industry respectively.
**Both of these methods return the amount of time required for an unloading operation and the UnloadProduct() method sleeps for which ever of these times is the longer.
**The actual product transfer to the industry from the vehicle is performed by calling ProductQueue.TransferProductFrom() on the industry queue(s).
**[[#GetUnloadTime|GetUnloadTime()]] on this vehicle and [[Class Industry#GetUnloadTime|Industry.GetUnloadTime()]] are called. Again, UnloadProduct() sleeps for which ever is the longer of the times returned.
**[[#EndUnload|EndUnload()]] and [[Class Industry#EndUnload|Industry.EndUnload()]] are called to perform any post-loading events. As before UnloadProduct() sleeps for the longer time.
 

===UpdateViewDetails===
{{MethodHeader|void UpdateViewDetails(Message msg)}}
;Parameters
*'''msg''' = Message object which triggers this handler.
;Returned Value
*None
;Notes
*Update the view details window for this vehicle (from the train).
*This method is setup by Init() as a handler method for a message of type "Vehicle","LoadComplete".
*Such a message indicates that the load or queue of the vehicle have changed and the view details window of the train will need to be updated.
 

===ViewDetails===
{{MethodHeader|void ViewDetails(Message msg)}}
;Parameters
*'''msg''' = Message object which triggers this handler.
;Returned Value
*None
;Notes
*View details window for this vehicle using the Train's output.
*This method is setup by Init() as a handler method for a message of type "MapObject","ViewDetails".object.
*Such a message indicates that the user has opened the right-click menu of the vehicle and selected the "View Details" menu item.
*This method will call the ViewDetails() method of this vehicle's train so that a Browser window describing the entire train can be displayed to the user.
 

===ViewSchedule===
{{MethodHeader|void ViewSchedule(Message msg)}}
;Parameters
*'''msg''' = Message object which triggers this handler.
;Returned Value
*None
;Notes
*View the schedule window for this vehicle from the train.
*This method is setup by Init() as a handler method for a message of type "MapObject","View-Schedule".
*Such a message indicates that the schedule of the vehicle or train is to be displayed for the user.
*This method calls through to Train.UpdateScheduleWindow().
 

==Code Examples==
 

==Related Methods==
[[Class Train#GetVehicles|Train.GetVehicles()]] 
[[Class World#GetVehicleList|World.GetVehicleList()]] 
 

==Categories==
[[Category:Script Class]]

Clutter-mesh

2008-08-07T20:15:10Z

Pencil42: Clutter-mesh moved to TagName Clutter-Mesh

#redirect [[TagName Clutter-Mesh]]

"Texture" tag

2008-08-07T19:54:47Z

Pencil42:

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

[[Category:Config Tag]]

"Description" tag

2008-08-07T19:42:24Z

Pencil42:

The human-readable multi-line English description of this asset. It displays on the Download Station with your model, so please make it useful and informative so others may understand your model, for instance, entering what the model is called and under which name and category it may be found in Surveyor. It is very useful in finding an installed model.

To compliment the English description, a variety of additional tags allow for equivalent descriptions to be supported across other languages. These are as follows:
* description-cn - Chinese
* description-cz - Czech
* description-de - German
* description-es - Spanish
* description-fr - French
* description-it - Italian
* description-pl - Polish
* description-ru - Russian

[[Category:Config Tag]]

"Username" tag

2008-08-07T19:41:16Z

Pencil42:

The human-readable English name of this asset. This is the name that will be visible in CMP, the DLS, or in Surveyor. The username tag is mandatory.
For ground textures, this will be the name that appears as a mouseover hint in the surveyor menu. Textures are also sorted alphabetically by username.

To compliment the English username, a variety of additional optional tags allow for equivalent usernames to be supported across other languages. These are as follows:
* username-cn - Chinese
* username-cz - Czech
* username-de - German
* username-es - Spanish
* username-fr - French
* username-it - Italian
* username-nl - Dutch
* username-pl - Polish
* username-ru - Russian

[[Category:Config Tag]]

Texture

2008-07-25T20:07:16Z

Pencil42: Texture moved to TagName Texture

#redirect [[TagName Texture]]

Trackside

2008-07-25T20:01:48Z

Pencil42: Trackside moved to TagName Trackside

#redirect [[TagName Trackside]]

Thumbnails

2008-07-25T19:53:12Z

Pencil42: Thumbnails moved to Thumbnails container

#redirect [[Thumbnails container]]

Kuid-table

2008-07-25T19:50:12Z

Pencil42: Kuid-table moved to Kuid-table container

#redirect [[Kuid-table container]]

Attached-track

2008-07-25T19:40:57Z

Pencil42: Attached-track moved to Attached-track container

#redirect [[Attached-track container]]

Description

2008-07-25T19:35:08Z

Pencil42: Description moved to TagName Description

#redirect [[TagName Description]]

Username

2008-07-25T19:27:57Z

Pencil42: Username moved to TagName Username

#redirect [[TagName Username]]

Trainz-build

2008-07-25T15:31:33Z

Pencil42: Trainz-build moved to TagName Trainz-build: renaming to match convention

#redirect [[TagName Trainz-build]]

KIND MoCrossing

2008-07-11T04:29:14Z

Pencil42: KIND MoCrossing moved to KIND MOCrossing

#redirect [[KIND MOCrossing]]

Mesh-table

2008-07-09T15:04:25Z

Pencil42:

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

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

Important Note:

Any asset that uses a mesh-table will not be compatible with pre-TRS versions of Trainz (i.e. Ultimate Trainz Collection or UTC). TRS will of course still read UTC assets.

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

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

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

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

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

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

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

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

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

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

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

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

TRS2004

2008-07-08T20:27:26Z

Pencil42:

==Description==
Trainz Railroad Simulator 2004 is the most complete railroad experience ever created.

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

TC3

2008-07-08T18:58:03Z

Pencil42:

==Description==
The Trainz Classics 3 centrepiece is based on arguably some of the most famous track in the UK. One of the three major Anglo-Scottish routes the S&C's importance steadily downgraded after it was grouped into the London Midland & Scottish Railway (LMS) in 1923.

The stunningly researched and expansive layout is modelled on the railway between Skipton and Carlisle. A wide range of purpose built structures and lineside details accurately depict the route at the time of transition from steam during the 1950's and 60's.

The route can be travelled in it's splendid full length; and it is also supplied divided into smaller sections, for those occasions where the entire route is not required.

==Packaged Versions==
TBD

==Bug fixes==
*'''Attachment to attachment bug:''' There were some problems experienced with having attached meshes which were attached to objects which were themsleves attachments. This has now been resolved.
*'''Cull attachment bug:''' The issues found with culling attachments when using multiple LOD levels in Classics 1&2 has been resolved and this now functions correctly again.
*'''Trackside objects:''' Trackside objects can now be on gradients
*'''World location / Show KUID issue:''' These two tools couldn’t be on at the same time before (same area of window) this is now fixed.
*'''Turntable bug:''' The ‘disappearing track’ issue when using turntables has been resolved.
*'''Bogie vertical curve:''' Bogies that are attached 180 degrees rotated now pitch the correct direction on vertical curves
*'''Sky animation:''' The problem with the sky moving too fast in Classics 1&2 has been resolved.
*'''Alpha issues:''' Some of the problems related to the use of alpha channel textures have been worked on and this results in better implementation of alphas within TC.
*'''dighole bug:''' The 'dighole' function no longer results in occasional land deformation.
*'''camera position bug:''' The camera positions will no longer be altered when routes are merged that contain cameras.

==New features from TC 1&2==
===Updated Passenger Objects===
It will now be possible to have alternate passenger sets which can be specified at stations. This means that you can have appropriate passengers for your route other than the current defaults.
===key for Cylinder Drain cocks===
A key has been added to the keyboard mapping to open and close the cylinder drain cocks on steam locomotives.
===Spline mesh table support===
Adds support for spline objects to be trainz-build 2.5
===Derailed consist removal===
A rule has been included which can be set to automatically remove derailed consists. This can be modified to specify the time delay before removal occurs.
===Bogie movement===
Bogies can now be configured to have horizontal movement .
===Second Injector===
Interior assets will now support a second injector control.
===Sanding control===
Interior assets will now support a sander control.
===Automatic Fireman===
The ability to have an automatic fireman has been added to assist driving.
===Coupler Repair===
It will now be possible to repair a broken coupler.
===Speeding check===
A rule has been added which enables scenario creators to check for the speed limit being exceeded.
===Station Visited check===
A rule has been added which enables scenario creators to check if a specific station has been visited.

==Enhancements in TC3==
===Scripting update===
Scripting hooks added to Passenger carriage door.
===Improvements to CCP===
Some changes have been made to CCP to make it more user-friendly and to enhance the usefulness of this tool.
===New PFX for steam and Scripting access to PFX===
Particle effects and their implementation have been improved to give the content creator much greater control of how the particle effect works through the use of scripting. We have also made it easier for a content creator to make steam smoke effects out of the smoke chimney/stack with the smoke mode "anim2". This, when used on a steam locomotive, generates '"chuffs" of steam syncronised with the cylinder strokes of the locomotive. Along with new smoke textures this provides a much superior smoke effect.
===Improved Steam Sound===
Steam sound will now be based on the RPM of a locomotive. Instead of before a train having to have a custom sound made, a base sound can be made for a variety of steam locomotives. Steam sounds are also synchronised to the locomotive's cylinders. With the new sound system steam locomotives are sounding better than ever before in a Trainz simulator.
===New Signalling System===
TC3 brings with it an entirely new signalling system. Trainz will now understand the concept of home and distant signals. It will also now be possible to implement block working on your routes with prototypical behaviour of both semaphore and colour-light signalling systems. A new set of signals will be included in TC3 but the added flexibility of the system can be used to create alternate sets of signals for other regions and eras.
===Improved Physics simulation of Steam locomotives===
The entire physics system for steam locomotives has been given an update. An increased number of parameters within the engine spec configuration file and a greater degree of flexibility in their implementation has improved the characteristics of all steam locomotives leading to a more realistic and flexible system..
===Better Animated Wheel slip===
The animation of wheelslip has been improved and the subsequent effects of allowing wheelslip to continue on the fire state and steaming ability of steam locomotives has been implemented.
===Improved Mini-map===
Enhancements have been made to the look of the mini-map and some improvements made to the features available within it.
===Spline/Track improvements===
unit_mesh can now specify a distance to change detail level
===Fixed/Improved tunnels===
Single track splines without portals can be a tunnel, so that kitbuilt tunnels can have all standard tunnel behaviours
===More realistic AI Control===
The AI drivers will now use the loco/train brakes. Along with other enhancements this results in a more realistic driving manner of AI consists.
===Greater control over traction through scripting===
The scripting possibilities have been improved to give a greater degree of control over the traction characteristics of a locomotive.
===Changes to water===
Water is now see through. This means that it is now possible to see bridge supports and submerged objects.
===Headlights control===
Due to the popularity of the low beam headlight setting from Trainz Classics 1&2, we have added the ability to set the high beam values of the headlights too. This gives the content creators a much greater flexibility about creating lights on the front of train cars.
===AWS system===
AWS equipment will be present and fully functional in each locomotive represented in Classics 3 that was fitted with the system while in service with British Railways. When driving in 'full simulation' mode, it will be capable of stopping the train if you do not interact with it in the proper manner.

TC2

2008-07-08T18:39:43Z

Pencil42:

==Description==
Take a tropical break without leaving home in a breathtaking Trainz experience. Amazing lighting art and cleverly planned routines make Modula City is a noteworthy composition by anyone's standards.

Trainzland has proven a popular and impressive creator of Trainz add-ons and has joined forces with Auran in a partnership that enables us to present Modula City in it's updated entirity with our second Trainz Classics edition.

Operate modern trams around a thriving coastal city. Convey holiday makers over the causeway to a beautiful resort island.

==Packaged Versions==
TC2 was packaged along with TC1 and TRS2006 in the United States by Merscom as "Trainz Railways"

==New features from TRS2006==
Same as [[TC1]]

TC1

2008-07-08T18:33:19Z

Pencil42:

==Description==
Experience New York's Harlem Line, realistically represented in a 3D virtual world. Rule the rails with a fast express train or stop at stations and help to convey commuters along the route.

Accurately representing 40 miles of the former NYC empire; the Trainz Classics Harlem Line project is a carefully researched and convincing railroad simulation experience.

The Harlem Line edition takes advantage features newly added to the ever evolving Trainz platform to realistically model Metro North's operations over the busy line.

==Packaged Versions==
TC1 was packaged along with TC2 and TRS2006 in the United States by Merscom as "Trainz Railways"

==New features from TRS2006==
A number of new functions have been introduced in TC relevant to content creators. The following list summarises the new features:
===Removal of legacy content===
Much of the legacy content from TRS2006 was removed in an effort to streamline the program.
===New Freeways feature supporting and including one way and multi-lane roads===
There are two kinds that support the creation of freeway model, Kind Track and Bridge. The Kind track is used to specify a road freeway asset. For example, a two lane road mesh is used for the lanes of the freeway and tags in the config.txt file specify lane configuration.

The example below is for a freeway with 2 lanes; both travelling in the same direction. This would also be used for a one-way road.

[[username]] “Road_Freeway_01”
[[grounded]] 0.4
[[region]] “Britain”
[[length]] 5
[[width]] 7.9
[[bendy]] 1
[[kind track]]
[[type]] "Roads"
[[uncached_alphas]] 1
[[carrate]] 25
[[asset-filename]] “road”
[[kuid]] <kuid:523:100082>
[[istrack]] 0
[[isroad]] 1
[[isfreeway]] 1
[[numlanes]] 2

For a freeway with multiple lanes flowing in both directions, a [[Kind bridge]] has to be used. This asset calls up a freeway road model by kuid to be used on the bridge.

The following example uses a [[Kind bridge]] to generate a four lane road (two lanes in each direction), calling up the two lane freeway asset in the previous example.

[[username]] “Road_Freeway_02”
[[grounded]] 0.4
[[region]] “Britain”
[[length]] 5
[[width]] 7.9
[[bendy]] 1
[[kind track]]
[[type]] "Roads"
[[uncached_alphas]] 1
[[carrate]] 25
[[asset-filename]] “road”
[[kuid]] <kuid:-22:1003>
[[trackoffsets]] -3.5,3.5
[[trackdirections]] 0,1
[[height]] 0
[[rgb]] 255,200,0
[[istrack]] 0
[[isroad]] 1
[[isfreeway]] 1
[[numlanes]] 4
[[bridgetrack]] <kuid:523:100082>

===Flashing ditch-lights===
Operating ditch lights now function for locomotives. The usual attachment point conventions apply for a point placed in the mesh in 3dsmax or gmax.

a.ditch0, a.ditch1 etc

The odd numbered light points flash together, alternating with the even numbered light points.

The flashing rate can be changed in the traincar config.txt file by adding the [[flash-scale]] tag.

Ditch lights are toggled in Driver using the ; key

===Headlight dimmer system===
Locomotives can run with normal or dimmed lights (normal or low beam), use the Shift + L key in Driver.

The intensity of the light may be varied by adding the [[low-beam-value]] tag to the traincar config.txt file.

===Remodelled roadway traffic featuring working head lights===
Cars driving on roads can have operating head and tail lights. Use the nightmode tag in the config.txt file for a car and in the mesh table, include the default-night tag and night mesh file that you create for the vehicle.

The following tags show the entries in the config.txt file.

[[nightmode]] "none"
[[mesh-table]]
{
default
{
auto-create 1
mesh “hilux_blue.im”
}
default-night
{
mesh “night/gondwana_night.im”
night-mesh-base “default”
}
}

Specifically, the [[nightmode]] tag has been updated to support lights that are on for vehicles used as traffic, but off when not moving.

===New sound functions for better representation of electric traction===

New functions to better represent electric locomotive sounds have been implemented. The options are set in the config.txt file for the enginesound Kind.

For an electric locomotive, the sound may be considered a speeding up of one wave form, different from diesel or steam locomotives where different sound files are used in “steps”.

The sound used is a single .wav file called engine_loop.wav and must be placed in the directory with the config.txt file. TC automatically loads the file of this name.

In non-electric engines, the .wav file used is the base sound (the sound used at zero km per hour). With electric engines there should be no sound at zero speed, and the use of the isfading tag scales the volume, reducing the sound as the speed reduces to zero.

Example:
[[kind enginesound]]
[[asset-filename]] "MN M7 enginesound"
[[kuid]] <kuid:523:100052>
[[username]] "MN M7 enginesound"
[[isspeed]] 4
[[isfading]] 1
[[isramping]] 0

===New interior features===
===Fonts===
TC has added the ability to define the fonts to be used for the text, alternative to the default font. See [[kuid name]] for more details.
===Surveyor - Height Control===
Holding down the LMB while moving the mouse forward will now raise objects that are height adjustable in increments of 1.0 units. Conversely, moving the mouse backwards will lower the object in the same way. Holding the Ctrl key in conjuction with this move will adjust the objects height in increments of 0.1 units and holding the Shift key will change the height by units of 0.05.
===Train controlled sounds, lights and boom gates at build-in road crossings===
Add a level crossing road/rail junction from the Scenery Objects Tab in Surveyor, e.g. XING 1 US

Use the Edit Properties dialogue in the Scenery panel to uniquely name the crossing, e.g. Hobotown

Add the crossing lights to both sides of the crossing and name those in accordance with the name given to the crossing,e.g. Hobotownsig1 and Hobotownsig2.
===Flexible Cab Signalling system===
Add the object “MN Trackside Cabsignal” from the Track Panel / Trackside Objects. This signal controls the states that will be shown by the in cab signalling and is only visible in Surveyor.
===Computerised in-cab displays===
The computerised M7 cab digitally displays various technical and safeworking data. It can also display the next station name. Add a trigger at the point along the track where you would like the next station name to light up in the cab. The naming convention is simple. If the next station is “Hobotown” then name the trigger as:

xxHobotown

The name will be displayed until the train passes another station-name trigger.

To blank the display add another trigger named xx_

===Automatic Train Protection options===
Add the “speed_rule” to a session using Surveyor’s “edit session” dialogue. This limits your train’s speed to within the limit as imposed by both the trackside speedboards and the cab signalling system.

===Driver - Odometer Trip Meter Display===
Add the “Display Custom HUD” rule to a session using Surveyor’s “edit session” dialogue. A new “Trip Meter” field will be added to the Custom Heads Up Display (HUD) which can be reset at anytime by pressing the T key on the keyboard.

===New scripting commands===
This document does not cover scripting functions and coding in detail, but may refer to necessary scripts for correct functionality. Some of the new scripting functions that have been included in TC include:

'''setgoodfog, setbadfog'''

To set the density of fog to be used - can use values larger than 1.

'''setdrawdistance'''

Sets the drawdistance for the ground and scenery items.

'''worldplaysound'''

This is a looping waveform to play a sound in a map.

'''World Day, World Night'''

Specifies a function may play during daytime or at night.

'''playvideo'''

This is a rule to play a video clip.

'''locomotive and cabin scripts'''

These have been developed for each individual locomotive and associated cab, for the in-built models. Each individual script may not use all the available new tags for cab displays.

Users would need to modify these scripts for other uses. Refer to included scripts for the M7, FL9 and P32 locomotives for information. Useful examples are:
*signalinterior.gs
*acmu.gs
*fl9.gs
*p32.gs
*m7.gs

'''Station.gs'''
There is a new station script used in TC to load and unload passengers. The file is Station.gs, found in a number of the MN station assets in TC. This script operates two platforms. A second script, Station3track.gs will operate three platforms on one station. By comparing the script differences, modified scripts may be created to operate more than three platforms.

The script makes the stopping points of trains more predictable and accurate, provided the following is used to set trigger points on the station tracks in 3dsmax or gmax.

Trigger points in 3dsmax/gmax

A track trigger point should be placed at each end of the platform, and another on the track near the centre of the platform length, for example a.trig1a, a.trig1d and a.trigmain.

Trigger radii are defined in the config.txt file for the station, and 10 metres is suggested for these three trigger points.

Additional trigger points need to be placed in between these three, so the trigger diameters touch along the full length of the track. Place the a.trig1b and a.trig1c points equidistant between the already placed points. Calculate a radius X or Y to suit and enter in the config.txt file for the station.

A maximum value for X or Y should be 75 metres for consistent operation. If larger, place additional intermediate trigger points with reduced radii.

While track attachment points called up in the config.txt file can be used as triggers, it is often more convienient to specify separate trigger points in the 3dsmax/gmax mesh in order to have the trigger diameters touch - track attachment points, particularly for curved stations, are not always in the best locations required for trigger points.

===CMP functions===
New functions of interest to Creators are included in the Miscellaneous screen of CMP.

'''Suppress Asset Warning in Trainz'''

This allows you to disable the “Missing Asset Screen” displayed when launching a route.
'''Suppress Asset Database Update at Startup'''

This allows you to disable the DLS update process every time you start CMP or return to it from Trainz. For creators this should speed up the process of creating content when you do not wish to keep checking with the Download Station updates.
Note this does not suppress the update of the local assets.tdx file when CMP is loaded.
'''Built in Objects - Colour Display in Driver'''

Adding the line -showkuids to the [[Trainzclassicoptions.txt]] file will show the kuid number of any object selected in Surveyor, in the bottom right of the Surveyor screen. A built-in object will show the kuid in yellow and a custom objects will be shown in red.

'''Automatic Committal'''

Modified and imported assets will be committed automatically when launching TC from within CMP.

Kind name

2008-07-08T18:09:57Z

Pencil42: /* font */

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

Typical Kind Name mesh table set-up:

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

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

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

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

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

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

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

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

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

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

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

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

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

Kind corona

2008-07-07T05:33:39Z

Pencil42:

A corona is a ‘glow’ light effect. It is a simple texture that is inserted at an attachment point within the mesh. Coronas can be added to any asset that uses a mesh-table.

Examples of coronas used in-game can be seen on the Airport and Airport basic assets. The Jumbo Jet, the Cessna and the Airport tower all use flashing coronas.

Example mesh table with coronas:

[[mesh-table]]
{
default
{
mesh asset.lm
auto-create 1
effects
{
0
{
kind corona
att a.corona0
texture-kuid <KUID:-3:10110>
frequency 2
directional 0
object-size 0.20
}
1
{
kind corona
att a.corona1
}
}
}
}

==Breakdown of KIND CORONA:==
===kind corona (required)===
The effect kind
===att (required)===
The corona insertion point in the main mesh.
===texture-kuid (optional)===
Add this tag only when you want to specify your own texture for the corona. It specifies the KUID of a [[kind texture]] asset.

If the texture-kuid tag is not present the corona will use the default yellow/orange texture in TRS.

TRS released corona textures:
* Yellow/orange corona Default (if no texture-kuid)
* Green corona <KUID:-3:10110>
* Red corona <KUID:-3:10112>
* White corona <KUID:-3:10111>

===frequency 2 (optional)===
This variable specifies the frequency in Hz (or ‘flashes’ per second). e.g. 1 for once per second, 0.5 for once every 2 seconds, 2 for twice per second.
===directional 0 (optional)===
The default for coronas is to be aligned to the attachment point to face the NEGATIVE Z direction. This is especially useful for Traincars.

Adding this tag over-rides this behavior, to make the corona always face the screen – useful for scenery objects.
===object-size 0.15 (optional)===
Size of the corona on the object when viewed up close, defaults to 0.15 (i.e. 0.15m)

"Obsolete-table" container

2008-07-07T05:02:50Z

Pencil42:

The obsolete-table describes the asset’s revision history.

This field was used extensively for pre-TRS assets, as each version required a unique Content ID. However in order to make the content creator’s life a little easier, Trainz now uses the KUID2 format which adds another number as a version number.

TRS and the Trainz Download Station automatically detects the most recent version of an asset whether it be through the KUID2 Version ID or through the obsolete-table.

If there are no obsoletes, leave the obsolete tags out.