|
The information in this Wiki Page applies to Trainz Plus, TRS22 and TRS22 Platinum. This page is intended to provide you with an overview of the properties and features of Routes and Sessions when creating layouts for Trainz. More detailed descriptions of these various features plus instructions on getting you started with creating Routes and Sessions can be found in the Trainz Wiki How To Guides - ;s are provided at the end of this document. |
|
|
Workflow Diagrams
 |
The virtual worlds that Trainz creates can be classified as:-
 |
 |
Routes |
Routes are created in Surveyor and contain most (if not all) of what you will see in your virtual Trainz world. You can have many different routes, limited only by your storage space. They can be built to represent different geographical regions (real or imagined) and different periods of time (past, present, future). They also control the environment settings in your virtual world, such as your geographic location and altitude, the season of the year, lighting conditions and the weather. Each route can have multiple sessions.
|
Sessions |
Sessions are also created in Surveyor but are designed to be run in Driver. They contain the instructions that will control your trains when they are operating in automatic or "AI" mode in your route. They also control the goods your trains will carry, load and unload at industries along the way. You can create different sessions for different aspects of your railway - freight, passenger, shunting or a mixture - or for different seasons of the year or times of the day. Sessions are where you can program the behaviour of objects in your virtual Trainz world. A session can also contain scenery items that are specific to a particular railway operation, season or time of day. Sessions also control the environment settings in your virtual world, such as lighting conditions and the weather. Each session can have multiple saved driver games.
|
Driver Games (or Driver Sessions or Saved Games) |
Driver Games (also known as Driver Sessions and Saved Games) are created in Driver and save the "state of play" in a running session so you can restart it at the same point at a later time. They are optionally stamped with the date and time they were saved and the play duration. |
A route (also known as a "Layout") consists of most of what you will see on the screen when using Surveyor and Driver. Things such as the landform or terrain, most (if not all) of the scenery items, the ground textures, the effect layers (such as TurfFX and Clutter), plus some "environmental" features.
A route consists of two parts:- |
 |
Route Data and |
 |
Route Layers |
|
| When you save a Route, all items in the Route Data and Route Layers will be saved |
|
|
Route Data:
 |
The Route Data stores all those features that are painted into a layout using a brush tool and all the Environmental Data including the World Origin (latitude, longitude, altitude) |
The Route Data includes the Terrain, Textures, Effect Layers, Legacy Water and the Environmental features.
| Route Data contains:- |
 |
Landforms (Terrain) - baseboards and ground height |
|
Water height and spread for Legacy Water found in Surveyor Classic |
|
Ground Textures including the grid pattern which is a texture |
|
TurfFX, Clutter, Water, Color - found in the Effects Layers (the Color Effect Layer is only available in Trainz Plus) |
|
Environmental Settings - World Origin (latitude, longitude, altitude), Water Surface (rough/calm/etc), Snow Altitude, Lighting (sun, ambient and water colours), Sky (clouds), Road Traffic (on/off), Date (day, month), Wind strength, Fog level, Weather (rain/fine/snow), Brightness level. You must edit and save the route for these settings to become part of the Route Data - see the Trainz Wiki page  How to Use the Environment Tools for more details. |
|
Route Layers:
|
Route Layers are used to hold the scenery assets that you want to appear in all sessions created for the route |
All scenery assets are held in layers. Route Layers (you can have many layers) give you a way of organising or grouping the assets displayed in your route.
| Route Layers contain:- |
|
Track and Track Objects (such as signals, switches, bridges, tunnels, speed signs, etc) |
|
Most (or all) scenery items (e.g. buildings, trees, rocks, active industries/stations) and scenery splines (e.g. roads, fences, etc) |
|
Rolling Stock (including locos) - Note: It is strongly recommended that all rolling stock be placed into a Session Layer |
|
Lineside and Fixed Cameras |
|
Trackmarks, Triggers, Direction and Priority Marks |
|
 |
Scenery objects can also be stored in a session. This can cause confusion if you load a route without loading a session and find that some scenery items are "missing". See  Loading an Existing Route below for how to deal with this situation. |
|
 |
A detailed description of Layers can be found on the Trainz Wiki Page:-
- How to Use Layers
|
Loading (and Creating) a Route
|
 |
|
 |
 |
 |
 |
|
A Left Click on the MAIN MENU button (bottom left) will take you back to the starting or main screen. |
|
A Left Click on the Sort By A-Z button (top near right) will give you a drop down menu of sorting options for the thumbnail list. |
|
A Left Click on the Expand View  button (top right) will expand the thumbnail list to fill the screen - Left Click it again to return the thumbnails to the strip at the bottom of the screen. |
|
The thumbnail images are colour coded.
| Payware on DLC |
Must be purchased and downloaded, but some may be free - depending on your membership options. If you click a thumbnail with this colour a DOWNLOAD button will appear on the bottom right of the screen. If a price is included in the button then that is the purchase price (in $US) |
| Payware installed |
Already installed from the DLC. DLC items cannot be deleted. To remove them use the Uninstall option in the Content Store from the Launcher. You can reinstall them later without any additional cost |
| Installed |
Downloaded from the Download Station (DLS) or created by you. This includes any cloned DLC Routes and Sessions (see Cloning a Route/Session below) |
| Multiplayer |
For simultaneous development by multiple players. Special conditions apply |
Creating a New Route
|
|
 |
|
|
|
|
In both Surveyor Classic (also known as S1.0) and in Surveyor 2.0 (also known as S2.0) Left Click CREATE ROUTE . This will start Trainz Surveyor and open the New Route Dialogue Window.
 |
 |
You can also easily edit the route settings at any time after the route has been created.
| Steps: To edit the route details at any time:- |
 |
Open the  Edit menu from the top menu in Surveyor |
| |
 |
Select the Edit Route... option or press Ctrl + E |
|
 |
|
|
|
|
|
It is recommended that you enter some details before you click the  icon to create the new route. A bare minimum is listed on the right that will save you some time and effort later, and you can always change them at any time. |
|
| Route name: |
Enter a name for your new Route (keep it simple but descriptive)
|
| Geographical region: |
Select a region from the drop down list |
|
|
|
In Trainz Plus the default resolution setting for a new route is HD (High Definition). |
|
A Left Click on the icon at the bottom right of the New Route window will create a new route with a single flat baseboard using the data settings you have entered.
A Left Click on the  icon on the top right of the New Route window will cancel the data entry and create a new route with a single flat baseboard using the default data settings (usually the settings entered for the last route you created). |
|
Notes:
|
|
Enter a name for the route - keep it simple but as descriptive as possible (without writing an essay). This will be the first thing that users will see when looking for a route to download from the DLS. |
|
Enter a description for the route. At the starting stage this is basically a "memory jogger" for you so a basic description would be sufficient but when you release the finished route (e.g. to the DLS) it should contain some critical information usch as "HD Terrain", "High Detail Assets" and the source(s) of any non-DLS dependencies |
 |
Setting a Geographical region sets some basic features of the route - such as its latitude (used to determine the season of the year), the altitude (in metres) of the first baseboard, the number and types of moving road vehicles (if any) and the side of the road they drive on, to name a few. If none of the installed regions are suitable you can download others from the DLS or create a region of your own - see How to Create a Region Asset |
 |
Create a Thumbnail image. At the starting stage this is less important but at some point, before the route is released, select a suitable camera view point and Left Click on the thumbnail button. The thumbnail is an advertisement for the route and many potential users will judge the quality of your work by the thumbnail when deciding whether to download or not |
 |
The Working scale provides measurements that are comparable to model railroading dimensions, but the actual (physical) sizes of the layout and its assets are not altered or scaled down. It is only the Surveyor Ruler tool that will be affected. The choices are between Real scale (which is the default), G scale (100m real scale = 4.4m G scale), HO scale (100m real scale = 1.1m HO scale) and many other options. |
 |
The Working units provides a choice between Metric (metres, kilometres) and Imperial (yards, miles) which only affects measurements used by rulers and track distances, and for train speeds (km/h or mph).
Note that track speed signs are always locked at either metric (km/h) or imperial (mph) - there are separate speed signs available for each. The signs will not be altered by this selection but their values will be converted. So a track speed sign that is set at 40 mph, for example, will still be displayed as 40 but it will be read as 64.3 km/h in Driver if the Working Units have been set to metric. So it will be less confusing if you use speed signs that are in the same working units as your route, for example use one set for 65 km/h instead of 40 mph.
Altitudes are always measured and displayed using metric units (metres). |
 |
The Route edit detail in Trainz Plus only. This sets the minimum terrain resolution when working with HD Terrain. It can be changed at anytime when editing. See SD/HD Options below for more details |
 |
The Draw distance cap sets how far away from the camera that scenery objects will be drawn. A high setting, particularly the Disabled option (which means no draw distance cap), could affect the game performance, including the fps rate (frames per second), on some systems |
|
|
The Surveyor World View
|
|
|
|
|
|
|
| |
The Key Topology Tools, as shown in the diagram above, are:- |
|
Add New Baseboard - Left Click (it will stay active until another button is clicked) and then Left Click in a blank area outside the baseboard to add a new baseboard in that position. Each click will add a new baseboard at the same altitude as the first |
|
Delete Baseboard - Left Click (it will stay active until another button is clicked) and then Left Click anywhere on a baseboard to delete that baseboard. You will get a warning dialogue window - you CANNOT undo this operation to restore a deleted baseboard |
|
Grid Size - a pop-out menu will give you a choice of 10m (the default) or 5m. The option for the HD Grid is only available in Surveyor 2.0 in Trainz Plus. This sets the resolution of the baseboard. It does not alter the size of the grid squares which is actually a painted texture and will always stay at 10m x 10m.
|
With a 10m grid the smallest area (resolution) in which you can set a height is 10m x 10m |
|
With a 5m grid that resolution becomes 5m x 5m, so 4 different height values can be set in each 10m grid. This allows you to create more accurate topology features such as railway cuttings and embankments but it has a penalty, significantly larger route map files |
|
With a HD grid (Trainz Plus only) the smallest area (resolution) in which you can set a height is 0.125m x 0.125m |
|
Each new baseboard you add will have its grid size set to the selected value. You can have different baseboards set to each resolution - for example: baseboards used by the track at 5m and those further out at 10m
This control is also used to change an existing baseboard from one resolution to the other. |
|
|
Advanced - this will open another window in the Topology Tab that will allow you to select a grey scale bit map image to set the height of each grid |
In Surveyor 2.0 (S20)
In Surveyor 2.0 there is no separate Topology Tools fly-out. A single Tools Palette replaces all the separate tools "fly-outs" found in the original Surveyor Classic.
 |
| Steps: To add new baseboards:- |
| |
select the Marquee Tool from the Tools Palette (or press the F key). |
| Note that in S20 you can add and delete multiple baseboards in a single step, not just one-at-a-time. |
| |
Left Click and Drag (using the Left mouse button) to draw out an area where the new baseboards will be added. This area can include the current baseboard. |
|
| The Marquee area, shown with a green border in the image below right, shows the positions where 3 new baseboards will be created to add to the existing baseboard. The Marquee area has a Context Menu icon as shown in the image. |
| |
Left Click on the Context Menu icon or press the T key to open up the Marquee Context Menu.
|
| The Key Marquee Baseboard Operations, as shown in the Marquee Context Menu above, are:- |
| Set Marquee to Brush Height |
to create new baseboards in the selected area. The Brush Height is the value stored in the Height setting in the Tool Options palette. This value will be used to set the height of the new baseboards. Any part of the initial baseboard that is covered by the marquee will also have its height set to the brush height |
 |
| Convert Baseboards to |
a pop-out menu will give the options, 10m Grid, or 5m Grid or (for Trainz Plus only) HD Grid. Selecting one of the options will create the new baseboards in the selected resolution. This tool is also used to convert existing baseboards from one resolution to the other.
|
It is NOT RECOMMENDED that you mix HD Grid baseboards with 5m Grid or 10m Grid baseboards in the same route. It should be ALL HD or none.
See S20 Tools - Upgrading a Route to HD for more details. |
|
|
| Delete Baseboards in Marquee |
to delete the selected baseboards. The Undo command Ctrl + Z will restore the deleted baseboards |
|
|
Default Baseboard Ground Texture
|
|
|
|
|
|
|
| When a new route is created or a new baseboard is added in both Surveyor Classic and Surveyor 2.0 it will be covered with the ground texture for the selected Region or the default texture/grid if no region has been set. This can be changed to a different texture (including to the standard TRS19/TRS22 grid pattern). |
 |
| Steps: To disable the current default ground texture (easiest method):- |
|
open the  Surveyor Display Menu |
|
select the Ground option |
|
select the Grid sub-option. This will use the current grid texture. |
|
|
| A more complex solution is to edit an existing Region or create one of your own to add your preferred ground texture (such as the standard TRS22 grid pattern) to each new route you create and every new baseboard that you add. |
|
Notes:
The Baseboard Ground Texture, chosen from the Surveyor Display Menu or by specifying a Region, will become the default for every new route you create and every new baseboard you add, until you change it to something else.
|
|
Loading an Existing Route
|
|
|
|
|
|
|
You must first find and select the route to load from those already installed. At the top of the Driver/Surveyor screen the route search options are shown as a set of buttons.
| Type: |
ROUTES is the default selection. No need to change this. |
| Source: |
PURCHASED is the default selection, Click and change to MY CONTENT for a route you have created (or already modified) or to INSTALLED for one you have downloaded from the DLS. |
| Region: |
ALL is the default selection. You can select a particular geographic region if required and IF the route had a geographic region set when it was created. |
| Search: |
You can narrow down the list of routes by typing the first few letters of its name (e.g. SA) as shown in the image above. |
This will produce a display of thumbnails at the bottom of the screen.
Left Click on the thumbnail for the route you want to load, then Left Click on the EDIT ROUTE button to load the route into Surveyor.
|
Notes: Routes and Sessions - An Endless Source of Confusion
|
Scenery objects that have been placed in a session will NOT APPEAR if the route has been loaded into Surveyor without also loading the session |
|
If scenery objects have mysteriously vanished when you reload a route into Surveyor it is highly likely that those objects have been saved in a session. You must load the session into Surveyor to make them visible again |
|
You can easily move most scenery objects from a session into a route if needed - see the Trainz Wiki Page How to Use the Bulk Asset Update/Replace Tool for more details |
|
|
Loading a Route Into Surveyor From Content Manager
|
|
|
|
|
|
|
Trainz provides a shortcut that allows you to load an existing route directly into Surveyor for editing from Content Manager.
 |
Steps: To load a route from Content Manager:-
|
in Content Manager select the filter Routes & Sessions |
|
select the route to be edited |
|
Right Click to open the Command Menu |
|
select Open..., then select Edit Asset in Surveyor
|
|
|
|
Loading After an Unexpected Shutdown
|
|
|
|
|
|
|
The options you will see are:-
| Use changes |
Use the edited/changed versions that are in the open database assets. Note: there is a possibility that these assets may have been damaged during the shutdown and may be corrupted |
| Revert changes |
Ignore the edited/changed versions and load the previous versions instead |
| Cancel |
Cancel the Load and return to the Surveyor/Driver menu screen |
| You could also use the Content Manager program (select Manage Content from the Trainz Launcher) to Submit the open route or route and session assets. This has the risk of replacing the last good copy of that asset or assets with a possibly faulty copy. |
|
Editing a Route
|
|
|
|
|
|
|
|
When a Route is loaded or a new Route is created all the assets you add will be automatically placed into a Route Layer |
When you create a new route, or load an existing route without a session, and start adding scenery assets they will automatically be placed into a Route Layer. See How to Use Layers for more details.
Any ground textures, water, effect layers (turfFX and clutter) you add, or terrain changes (including new baseboards) you make, will be added to the Route Data. |
 |
WARNING: Do not edit track in a Route that is occupied by consists in any of the Sessions based on the Route
Moving or deleting a section of track in a Route that is occupied by a consist in a Session can cause the consist to become a "missing asset". This can happen if you load the Route only and not the Session. If a consist becomes a "missing asset" then the only immediate solution is to use the Delete missing assets command from the Tools menu in Surveyor.
Prevention:
if you have the consists placed in a Session then always load the Session, not just the Route, and move or delete any consists BEFORE editing the track they are occupying.
|
|
|
You can edit the Route Characteristics at any time by selecting the Edit Route... option from the Edit Menu or simply pressing Ctrl + E .
This will bring up the Edit Route dialogue window (shown below). |
|
|
|
Route Characteristics:-
|
Name and Description |
|
assigned Geographic Region, which sets a number of different features |
|
Thumbnail image |
|
Working Scale and Working Units |
|
Draw Distance |
|
|
|
 |
|
Route name . Editing this will change the route username in the config.txt file but it will not alter the route <kuid> value |
|
Region . Changing the region (the Geographic region) selected could affect other features such as the moving road traffic, season of the year (through the latitude tag) and altitude |
|
Route description . Edit to include additional information or describe changes that have been made |
|
Route thumbnail . Left Click on the Set Thumbnail button to take a snapshot using the current camera view which will be used as the new thumbnail. The image shown in the example on the left has been edited. |
|
Working scale . Changing this will only affect the measurement shown in the Surveyor Ruler tool |
|
Working units . Switching between Metric and Imperial will change how train speeds are calculated and displayed in Driver (in km/h or mph) and the units used by track speed signs |
|
Route edit detail in Trainz Plus only. This sets the minimum terrain resolution when working with HD Terrain. It can be changed at anytime when editing. See SD/HD Options below for more details |
|
|
Draw distance cap will affect how far away from the camera that scenery objects will be drawn. A high setting, particularly the Disabled option (which means no draw distance cap), could affect the game performance, including the fps rate (frames per second), on some systems |
 |
Left Click on the icon to save the entered values and exit back to Surveyor. Left Click on the icon to cancel any entered values and exit back to Surveyor |
|
Editing the Environment of a Route
|
|
|
|
|
|
|
|
Notes:
It is possible (and sometimes even expected) that a Route and its Sessions will have different environmental settings - for example the Route may have been created for the summer season but one Session may be set in winter and will require an overcast sky, snow, fog and generally lower light levels. See the Trainz Wiki Page at The Environment Tools for more details.
|
|
Edit Effect Layers
|
|
|
|
|
|
|
|
The Edit Effect Layers menu option allows you to add, remove and edit the special effect layers |
| Effect Layers contain:- |
|
TurfFX - 3D animated grasses including crops (e.g. wheat) |
|
Clutter - rocks, stones, small clumps of plants (grasses, flowers, etc) |
|
Water - a layer of water that covers the entire route but its height can be set to different values to be hidden or revealed throughout the route. It is possible to set a slope on the water (perfect for a water skiing scene 😀) |
|
Color - a transparent "skin" that covers the ground texture throughout the entire route. Different parts of this layer can be given different colors or "tints" to alter the appearance of the texture below. This is only available for Trainz Plus subscribers |
| You can have multiple effect layers of each type (except the color layer) in a route. |
|
|
|
Notes:
|
|
Currently, there are differences in the Effect Layers between Windows and MacOS versions of Trainz. Some of these differences are hardware (GPU) dependant. This means that some of the effect layers or features will not work on the MacOS platform. |
|
TurfFX is hardware dependent and requires an Nvidia graphics card. TurfFX is an Nvidia software product and is not from N3V. |
|
The latest versions of Trainz are starting to eliminate these differences and, for performance improvements, are moving the implementation of some effect layers from the CPU to the GPU. |
|
|
Merging Routes
|
Two (or more) separate routes can be joined together (merged) to create a new route |
There are some important restrictions on the merging of two routes:-
|
Payware (DLC) routes cannot be merged with Freeware (DLS) or other Payware routes |
|
The Session Data and Session Layers in the first route can be saved in the merger (if required) but those in the other route cannot |
|
There may be a significant height difference between the two routes and this may not be easy to overcome |
|
The orientation of the two routes (East-West or North-South) cannot be changed (it is possible but will usually require a lot of time, effort and patience) |
|
A detailed description of the process of Merging Routes can be found on the Trainz Wiki Page:-
- How to Merge Routes
|
|
A Session is always a part of an existing Route - you cannot have a Session that does not belong to a Route |
|
If you create a Route without a Session then ALL the active industries and rolling stock, time, environmental conditions, etc, will revert to their original (default) values. There will be no AI drivers and drivers will have a very limited set of available commands for manual driving |
In general, while a route provides the physical structures (or "hardware"), a session provides the services (or "software"). While you can easily have a route without a session, it could be a very limited (or even a boring) experience.
A single route can have multiple sessions, or none, but a session must always belong to a route. To put it into Trainz terminology, a session has a route as a dependency.
A session consists of two parts:-
|
|
Session Data and |
|
Session Layers |
|
| When you save a Session, all items in the Session Data and Session Layers will be saved |
|
|
Session Data:
| Session Data are often the "invisibles" that control the operation of a session. Session rules, driver orders and loco assignments, commodities (loaded, unloaded and carried) and most of the Environmental Settings are examples of Session Data. |
| Session Data contains:- |
|
Drivers (names, AI commands and assigned locos) |
|
Driver Commands - those available for AI and manual driving |
|
Session Rules |
|
Industry Settings (commodities consumed and produced) |
|
Consist Settings (commodities carried) |
|
Consist Locations - this is stored in the session even if the consists are placed in the route |
|
Switch Settings (left/right) - but the default switch direction is stored in the route |
|
Environmental Settings - Water Surface (rough/calm/etc), Snow Altitude, Lighting (sun, ambient and water colours), Sky (clouds), Road Traffic (on/off), Date (day, month), Wind strength, Fog level, Weather (rain/fine/snow), Brightness level. You must edit and save the session for these settings to become part of the Session Data - see How to Use Environment Tools for more details. If both a route and a session have saved Environmental Settings, which do not have to be the same, then those in the session will be used. If the session does not have any saved Environmental Settings then those in the route will be used
|
|
Session Layers:
|
Session Layers are used to hold the scenery assets that you want to only appear in that particular Session and not in all Sessions. The Session Layers can be left empty and the Route Layers can contain all the scenery assets |
Session Layers give you a way of organising or grouping the assets displayed in your session.
| Session Layers can contain any assets that will be unique to that Session:- |
|
Scenery |
|
Rolling Stock (including locos) - Note: It is strongly recommended that all rolling stock be placed into a Session Layer |
|
Trackmarks, Triggers, Direction and Priority Markers |
|
|
|
|
While it is possible to add track and track objects (bridges, tunnels, turntables, signals, switches, etc) to Session Layers it is NOT RECOMMENDED. These assets should always be placed into Route Layers and, preferably, into the route-layer itself. |
|
|
|
A detailed description of Layers can be found on the Trainz Wiki Page:-
- How to Use Layers
|
Loading (and Creating) a Session
|
|
|
|
|
|
|
Creating a New Session
|
To create a new Session you must first create a new Route or load an existing Route |
|
A route can have many individual sessions so a new session can be added to a route that already has sessions |
|
| Steps: To add a new session to an existing route:- |
|
Locate (but do not load) the route as described in the section Loading an Existing Route above |
|
Once you have selected the route from its thumbnail, Left Click on the VIEW SESSIONS button
 |
|
Then Left Click on the CREATE SESSION button. If no other session exists for this route then this will be the only choice available to you
 |
|
Loading an Existing Session
|
|
|
|
|
|
|
There are two different ways to load existing sessions into Surveyor.
|
Select the Route First |
|
|
|
If the EDIT SESSION option is not present then the selected session is a saved Driver Game (a "game" saved when in Driver) and cannot be edited. See the section Saving and Loading Sessions in Driver below.
|
|
|
|
| Both and will load the route and session into Surveyor. |
Loading a Session Into Surveyor From Content Manager
|
|
|
|
|
|
|
Trainz provides a shortcut that allows you to load an existing session directly into Surveyor for editing from Content Manager.
 |
Steps: To load a session into Surveyor:-
|
in Content Manager select the filter Routes & Sessions |
|
select the session to be loaded and edited in Surveyor |
|
Right Click to open the Command Menu |
|
select Open... , then select Edit Asset in Surveyor |
Both the route and the session will be loaded into Surveyor for editing. |
|
|
Loading a Session into Driver From Surveyor
|
|
|
|
|
|
|
To start Driver simply select a session as described above in Loading an Existing Session and Left Click on the DRIVE SESSION button.
This will load both the session and the route into Driver.
You can save your "game play" in Driver at anytime. See Saving and Loading Sessions in Driver below.
Loading a Session into Driver From Content Manager
|
|
|
|
|
|
|
Trainz provides a shortcut that allows you to load an existing session directly into Driver from Content Manager.
Editing a Session
|
|
|
|
|
|
|
|
WARNING:
When a Session is loaded into Surveyor or a new Session is created all the assets you add will be AUTOMATICALLY placed into a Session Layer. To place them in a different layer, for example a Route Layer, change the Active Layer to the required layer before adding them to the route. See the Trainz Wiki Page How to Use Layers for more details. |
|
Any changes made to the Session Rules (including drivers and their commands), the Environment Tools, Industry or Rolling Stock settings, will be added to the Session Data.
There are other changes that will also be added to the Session Data. |
 |
|
|
You can edit the Name of the Session. This will change the session username in the config.txt file but it will not alter the session <kuid> value |
|
You can edit the Session Description |
|
You can add, delete and edit the Session Rules |
|
Editing the Environment of a Session
|
|
|
|
|
|
|
|
Notes:
It is possible (and sometimes even expected) that a Route and its Sessions will have different environmental settings - for example the Route may have been created for the summer season but one Session may be set in winter and will require an overcast sky, snow, fog and generally lower light levels. See the Trainz Wiki Page at The Environment Tools for more details.
|
|
Saving a Route and a Session
|
|
|
|
|
|
|
Routes and Sessions are saved from the System Menu on the Surveyor screen.
 |
|
Selecting Save or pressing Ctrl + S will save the route, or the route and the session, with the previously entered name(s) when they were loaded or created. You will be asked to confirm both the names (and can change them if you wish) and the Save command.
|
|
Selecting Save As... will save the route, or the route and the session, with the previously entered name(s) when they were loaded or created. You will be asked to confirm both the names (and can change them if you wish) and the Save As command.
|
|
Notes:
|
|
|
|
|
Notes on Saving DLS/DLC Routes and Sessions:
|
| |
| DLS Routes and Sessions can be modified and saved as new routes and sessions |
 |
Modifying and Creating:-
|
if you have modified a DLS route then you can delete the original route if you no longer need it and your modified version will not be affected |
|
if you have modified a DLS session then you can delete the original session if you no longer need it and your modified version will not be affected. However, if you delete the original DLS route then your modified session will not work |
|
you can create a completely new and original session for a DLS route but it will not work if the original DLS route is deleted |
|
the original DLS routes and sessions will not be altered or replaced by your modified versions |
|
 |
Saving:-
|
when saved, modified DLS routes and sessions will become Your Content and can be found using the MY CONTENT search option in Surveyor/Driver |
|
 |
Uploading:-
|
you can only upload your modified DLS route and session to the DLS if you have the permission of the original creator |
|
if you have created a completely original session based on a DLS route then you can upload the session as it is your creation |
|
|
| |
| DLC Routes and Sessions can also be modified and saved as new routes and sessions ONLY if the creators of the original DLC content have allowed it - see Cloning a Route/Session below for more details |
|
Modifying and Creating:-
|
some DLC routes and sessions are encrypted and cannot be modified - that is a decision made by the content creator |
|
your modified DLC route or session will become an alias of the original and will need the original route and session to be present on your system to work |
|
if you delete or disable the original DLC route or session then your modified versions will not work |
|
you can create a completely new and original session for a DLC route but it will not work if the original DLC route is deleted or disabled |
|
the original DLC routes and sessions will not be altered or replaced by your modified versions |
|
|
Saving:-
|
when saved, a modified DLC route or session will become Your Content and can be found using the MY CONTENT search option in Surveyor/Driver |
|
the original DLC route and session will not be altered or replaced by your modified versions |
|
|
Uploading:-
|
you can upload your modified DLC route or session to the DLS but it can only be used by those who also have the same original (unmodified) DLC version installed |
|
|
Saving a New Route and Session
|
|
|
|
|
|
|
If you have created a new route and select Save or Save As..., then you will be presented with the following Save Route Dialogue Windows.
 |
 |
| In both cases the name of the route that was entered when it was created will be shown and you can change the name, even in the Save option. However, there is no option in either case to change the name of the created session because the other options have been greyed out and cannot be selected. |
Saving an Existing Route
|
|
|
|
|
|
|
If you have loaded the route only and not the session and HAVE NOT edited any Session Data or Session Layers, then selecting Save will produce the following Save Route Dialogue Window.
If you have loaded the route only and not the session and HAVE edited Session Data or Session Layers, then selecting Save will produce the following Save Route Dialogue Window.
|
Notes:
|
|
If you have edited any session Data or Layers but have selected the option Do not save session then later, before you exit the program, you will be prompted to save the edited session by the appearance of the Save Session dialogue box (see below). |
|
If you decide to create a new session and leave its name as Default then a new Default Session will be created to add to any others also named Default that may already be present in a route and this will cause confusion. This is why it is not a good idea to use Default as a session name. |
|
Saving an Existing Route and Session
|
|
|
|
|
|
|
| If you have loaded a route and a session and have edited the route or the route and the session then selecting Save will produce the following Save Route Dialogue Window. |
|
Notes:
|
|
If you have edited any session Data or Layers but have selected the option Do not save session then later, before you exit the program, you will be prompted to save the edited session by the appearance of the Save Session dialogue box (see below). |
|
If you decide to create a new session and leave its name as Default then a new Default Session will be created to add to any others also named Default that may already be present in a route and this will cause confusion. This is why it is not a good idea to use Default as a session name. |
|
| If you have loaded a route and a session and have edited the session (Data or Layers) only and not the route, or have already saved the route but not the session, then selecting Save will produce the following Save Session Dialogue Window. |
Saving a Route and Session Using the UDS
|
|
|
|
|
|
|
|
The UDS feature is available in TRS19 Platinum Edition, Trainz Plus, TRS22 and TRS22 Platinum |
| The UDS (Unified Driver Surveyor) Interface allows you to quickly switch from Driver to Surveyor and back to Driver again without having to restart the session from the beginning. You can edit a route and session while in Surveyor and then switch back to Driver to continue the session where you left it. |
|
WARNING:
This powerful ability does come with a warning. If you save the edited session before switching back into Driver then all the moving consists will be saved in their new positions. Other changes, such as the status of Session Rules, will also be saved in their new states. See the Trainz Wiki Page How to Use the UDS Interface for more details.
|
|
| Most of the problems users seem to be experiencing with the UDS, judging from the posts in the Trainz Forums, is when saving their edited Driver session after switching to Surveyor mode. |
|
Notes:
|
|
Using Driver Mode involves driving consists (either manually or through the AI) and activating rules. These will change the session parameters |
|
Overwriting the Session will save the consist in their new positions and the Session Rules in their new (completed/not completed) conditions |
|
When you are in Driver Mode at least one of the consists will probably be moving. Some of the Session rules may have already been completed while others may still be running or waiting for events (e.g. triggers to be activated) |
|
If, after switching to Surveyor Mode, you then choose to save using the Overwrite existing session option then you will be replacing your original starting Session with a new one with the consists saved in their new positions and the Session rules saved in their new states. So when you later load and restart the Session things will not be the same as they were in the original or starting Session. |
|
Unless you have a particular reason for overwriting the original Session then the recommended save options are:-
|
If you have NOT edited anything while in Surveyor and select Save then you will be shown the Save Driver Session dialogue window to save the session in its current state as a Driver Game (also called a Game or Driver Game). This is exactly the same as pressing Ctrl + S while in Driver.
The Driver Game will appear in the Select Session menu for the route. Loading it will resume Driver at the point where it was saved. |
|
If you exit Surveyor after editing without saving then you will be prompted to Save. |
 |
Steps:
|
Open the Main Menu |
|
select the Exit Surveyor option |
| Another option is to exit Trainz completely |
|
select the Exit Game option |
| Regardless of which option you take, if you have unsaved work you will be prompted to save before you exit |
|
|
|
| Unsaved Route |
Unsaved Session |
 |
 |
| Options: |
|
Don't Save will exit Surveyor to either the Main Menu Screen or to your OS Desktop without saving. Any changes you have made will be lost. |
|
Save will exit Surveyor to either the Main Menu Screen or to your OS Desktop after saving. You will be prompted to select what to save as described in the section Saving a Route and a Session above |
 |
Cancel will cancel the Exit command and return you to Surveyor. |
|
|
If you exit Driver after running a session you will be prompted to Save a Driver Game. |
 |
Steps:
|
Open the Main Menu |
|
select the Exit Driver option |
| Another option is to exit Trainz completely |
|
select the Exit Game option |
| Regardless of which option you take, if your Session Data has changed then you will be prompted to save before you exit |
|
|
|
| Options: |
|
Don't Save will exit Driver to either the Main Menu Screen or to your OS Desktop without saving. The current state of the session (positions and movements of the consists, commodity levels, time of day, etc) will be lost. |
|
Save will exit Driver to either the Main Menu Screen or to your OS Desktop sfter saving. You will be prompted to enter a name for your saved Driver Game. See the section Saving Driver Games below for more details. |
|
Cancel will cancel the Exit command and return you to Driver. |
|
|
A Clone is an exact or duplicate copy of an asset. Some Payware routes and sessions cannot be cloned |
|
Cloned routes and sessions can be edited and saved as Your Content |
Cloning a Route or a Session allows you to work on a duplicate copy of the original. All changes that you make will be saved in the cloned copy leaving the original copy unchanged.
|
Cloned assets are subject to copyright laws and they remain the property of the original creator
|
|
|
Notes:
|
|
Freeware routes, that have been downloaded and installed from the DLS, can be cloned and saved as new routes.
|
They are saved with a new <kuid> that will include your personal identity code, so they will become Your Content and can be found using the MY CONTENT search option |
|
The original route from the DLS will not be altered or replaced by your new version |
|
You can delete the original DLS route if you wish and your cloned version will NOT be affected |
|
|
Payware Routes, that have been downloaded and installed from the DLC, can also be cloned as new routes if the creators of the routes allow it.
|
Some Payware routes are encrypted and cannot be cloned |
|
When an approved DLC route is cloned it will be given a new <kuid> that will include your personal identity code, so it will become Your Content and can be found using the MY CONTENT search option |
|
The original Payware route will not be altered or replaced by your new version |
|
If you delete or disable the original DLC route then your cloned route will NOT work |
|
You can upload, depending on permissions, your edited clone of a Payware route to the DLS but it can only be used by other users who also have the same original (unedited) DLC Payware route installed |
|
|
Sessions that have been downloaded and installed from the DLS (freeware) or DLC (payware) follow the same rules as described for DLS and DLC routes above
|
Some Payware sessions are encrypted and cannot be cloned |
|
When an approved DLC session is cloned it will be given a new <kuid> that will include your personal identity code, so it will become Your Content and can be found using the MY CONTENT search option |
|
The original DLC or DLS session will not be altered or replaced by your new version |
|
You can, if you decide, safely delete the original DLS session but not the original DLS route |
|
If you delete or disable the original DLC session or the original DLC route then your cloned session will NOT work |
|
You can upload, depending on permissions, your edited clone of a Payware session to the DLS but it can only be used by other users who also have the same original (unedited) DLC Payware installed. |
|
|
Cloning Using Surveyor
|
|
|
|
|
|
|
Routes and Sessions that have been loaded into Surveyor can be cloned using the Save As... command from the Surveyor System Menu
Enter a new name or edit the original name (as shown above) for your cloned route or session.
| Options: |
|
If the first option ( Save new route and session) is selected then the Route will be cloned using your new or edited name. The Session will be also cloned using its original name but it will use the newly cloned Route as a dependency instead of the original Route.
|
If the original route is Freeware (e.g. from the DLS) and you do not want to keep it then it can be safely deleted, which will also delete the original session but the new cloned route and session will remain active on your system |
|
If the original route is Payware (e.g. from the DLC) then deleting or disabling it will disable your cloned route and session. When Payware is cloned it must remain active on your system for the clone to work.
|
|
|
If the second option ( Save new session) is selected then only the Session will be cloned using your new or edited name (make sure that you change the "Default" to something else) but it will still use the original (uncloned) Route as a dependency - so it is vital that you DO NOT DELETE the original route.
|
If the original session is Freeware then it can be safely deleted if you no longer need it |
|
If the original session is Payware then deleting or disabling it will also disable your cloned session |
|
|
Cloning Using Content Manager
|
|
|
|
|
|
|
Select the Route or Session to Clone
A Task Window will open to display the result.
In the image above the original Route has been cloned and given a new <kuid> value.
The newly cloned Route will be shown in Content Manager as a New Asset that is Open for Editing.
Steps:
|
close the Task Window |
|
select the Open for Editing filter. |
|
|
Rename the Clone (an Optional Step)
You can give the cloned Route or Session a new name and a new description. Note that these changes will not appear until after the New Asset has been submitted.
Submit the Clone (a Necessary Step)
|
When submitted a cloned DLC Route or Session will be described as Payware, Modified while a cloned DLS Route or Session will be described as Modified |
Steps:
|
Right Click on the New Asset |
|
select the option Submit Edits |
The New Asset entry will vanish from the Open for Editing display. Open the Content Manager filter Today to check that it has been correctly submitted. If you have renamed the clone then it should appear using its new name.
|
|
|
Notes:
You can rename a cloned Route or a cloned Session in Surveyor but the clone would still have to be submitted in Content Manager first using its original name and then loaded into Surveyor. You would then have two Routes or Sessions with the same name to select from - one would be the original and the other the clone, and telling them apart may not be simple. You can use the Driver/Surveyor main screen MY CONTENT source filter to locate and load the correct cloned Route or Session because the clone will have your <kuid> code and not its original code.
|
|
Saving and Loading Driver Games in Driver
|
|
|
|
|
|
|
|
Driver Games (sometimes called "Saved Games" or "Driver Sessions") are "Game States" saved while in Driver Mode |
|
Notes:
| Driver Games:- |
|
like routes and sessions, are saved as entries in the Trainz Database, not as files on your hard drive. Loading a driver game will retrieve it from the database. |
|
can be loaded directly into Driver from Content Manager in exactly the same way that Sessions can be loaded directly into Driver from Content Manager |
|
can be exported as files (in the Trainz .cdp file format) from Content Manager for backup or transfer. |
|
|
Saving Driver Games
|
|
|
|
|
|
|
|
Driver Games save the "state of play" in Driver - the position of consists, the commodities and levels in rolling stock and industries, the state of the Driver Command queues, Session Rules, clock time, etc. Once saved, the Driver Game can be loaded back into Driver to continue the play at the point where it was saved.
When you are in Driver select Save from the System Menu or press Ctrl + S .
This will display the Save Driver Session dialogue window showing the name of the current session with a date and time stamp (shown left below). If you Left Click pn the Tick then this will be the name used for the saved game. Alternatively, you could enter your own unique name (shown right below).
The space below the entered name will display any other saved driver games for that session.
|
 |
Loading Driver Games
|
|
|
|
|
|
|
|
Notes:
|
|
Where a route has multiple sessions and driver games they will all be shown by their thumbnails with no way of telling which driver games belong to which session. |
|
It can also be difficult to tell which thumbnail is a session and which is a Driver Game, especially if you have removed the date/time stamp Trainz automatically adds to the name of a Driver Game. A simple way to tell is to Left Click on a thumbnail to see if the EDIT SESSION button is still visible. If it is not, because driver games cannot be edited, then the thumbnail is for a Driver Game.
|
|
Where there is only one session in a route, the session will be the first thumbnail shown in the list followed by the driver games. Note that the session is selected by default.
Select (hightlight) the Driver Game you want to load and then Left Click on the DRIVE SESSION button.
This will load the Driver Game, the session and the route into Driver.
|
If you load a Driver Game after you have edited the original route or session that was used to create it, then you will receive a message warning you that changes have been made to the original assets. The changes could affect the operation of the Driver Game.
|
| |
 |
Options:-
|
Cancel - the Driver Game will NOT be loaded, OR |
|
Ok - load the Driver Game wirh the changes |
If the changes to the route or session have been:-
|
minor and non-operational, such as scenery assets (trees, buildings, etc) then the Driver Game can be safely loaded. |
|
more significant operational changes, such as triggers, trackmarks, active industries, consists, tracks, etc, then it may NOT be wise to load and run the Driver Game. |
Only you can be the judge but I would err on the side of caution
|
|
|
Editing Driver Games
|
|
|
|
|
|
|
| It is possible to load and edit a saved Driver Game in versions of Trainz that have the UDS (Unified Driver Surveyor) interface - these versions are TRS19 Platinum, Trainz Plus, TRS22 and TRS22 Platinum. However, when you save your edit, it will NOT be saved as an update to the loaded Driver Game. Instead it will be saved as a Session. You can select to create a new session or to overwrite the original session. |
The Session will be saved with all the:-
|
consists in their positions and states (stationary or moving) at the time of the save |
|
industries and rolling stock in their conditions (e.g. product levels) at the time of the save |
|
switches in their state at the time of the save, and |
|
session rules in their state (completed or not completed) at the time of the save |
Deleting Routes and Sessions
|
|
|
|
|
|
|
|
Deleting a Session will delete that Session and its Driver Games (if any), not the Route it was created from or any other Sessions |
|
Deleting a Driver Game will only delete that Driver Game, not the Route or Session it was created from or any other Driver Games |
All the Surveyor and Driver screens for loading routes and sessions have a DELETE ... button as an option.
| |
WARNING: |
|
If you delete a Route you will also delete all the Sessions and Driver Games created using that Route
|
|
If you delete a Session you will also delete all the Driver Games created using that Session
|
|
If you need a more selective way of deleting routes, sessions and driver games, then use Content Manager from the Trainz Launch Screen. Select the Filter Routes & Sessions.
The Type column will identify each entry as a route, session or Misc. Misc in this case means a saved Driver Game.
You can delete routes and/or sessions individually but if you delete a route by itself then its dependant sessions and driver games will be shown as faulty with Missing dependencies. Likewise, if you delete a session by itself then its dependant driver games will be shown as faulty with Missing dependencies. |
Trainz Wiki
 |
Route and Session Building Guides
|
| |
More Tutorials and Guides to Using Trainz
|
|
|
Related Links
|
|
This page was created by Trainz user pware in September 2021 and was last updated as shown below.
the route will be saved (overwritten using its current name) but no session will be saved.
Create new session.
to Accept or 
to Cancel
Create a New Route and a New Session
