Route and Session Basics: Difference between revisions

From TrainzOnline
Jump to navigationJump to search
Pware (talk | contribs)
Pware (talk | contribs)
mNo edit summary
 
(348 intermediate revisions by the same user not shown)
Line 1: Line 1:
The information in this Wiki Page applies to '''TRS19''', '''Trainz Plus''' and '''TRS22'''. 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''' - links are provided at the end of this document.
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
__TOC__
<table> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepHierarchy"></span>&nbsp;</td>
<td width=629>&#160;</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=50>&#160;</td>
<td width=75>&nbsp;</td>
<td width=50>&#160;</td>
<td width=75>[[image:NextDown.png|link=#stepWhatRoute|alt=Next Down|Next Down]]</td>
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>[[image:NextDown.png|link=#stepHierarchy|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->
='''Trainz Worlds'''=
 
The virtual worlds that Trainz creates can be classified as:-<br>
<table width=1000 bgcolor=#000000 cellpadding=2>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteSessionGamesMap.png|link=|alt= Route-Sessions-Games|480px]]</td>
<td>
<td>
<table cellpadding=4>
<table width=996 bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<tr valign="middle">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=35>[[image:Information.png|35px|link=]]</td>
<td><span style="font-weight: 700; font-size: 17px;">Routes</span></td>
<td><span style="font-size: 15px;">The information in this Wiki Page applies to '''Trainz Plus''', '''TRS22''' and '''TRS19'''. It explains the basic concepts and processes involved in creating and editing '''Routes''' and '''Sessions'''.</span></td>
</tr>
</tr>
</table>
</table>
'''Routes''' are created in '''Surveyor''' and contain most (if not all) of what you will see in your virtual Trainz world. You can have multiple '''Routes''', limited only by your storage space. '''Routes''' can be built to represent different geographical regions (real or imagined) and different periods of time (past, present, future). Each '''Route''' can have one or more:-<br><br>
</td>
<table cellpadding=4>
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 17px;">Sessions</span></td>
</tr>
</tr>
</table>
</table>
'''Sessions''' are also created in '''Surveyor''' but are designed to be run in '''Driver'''. '''Sessions''' 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''' also control some of the environment settings in your virtual world, such as lighting and the weather. A '''Session''' can have many:-<br><br>
<br>
<table cellpadding=4>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>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'''. Links are provided at the end of this document.</td>
<td><span style="font-weight: 700; font-size: 17px;">Driver Games (or Driver Sessions or Saved Games)</span></td>
</tr>
</tr>
</table>
</table>
'''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.</td>
<br>
<table>
<tr valign="top">
<td>
__TOC__
</td>
<td align="center"><span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&#160;Workflow Diagrams&#160;</span><br>
[[image:RouteWorkflow.png|link=|alt=Route Workflow diagram]]<br>
[[image:SessionWorkflow.png|link=|alt=Session Workflow diagram]]</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepWhatRoute"></span>&nbsp;</td>
<td width=629><span id="stepHierarchy"></span>
='''Trainz Worlds'''=
</td>
<td width=50>&#160;</td>
<td width=50>&#160;</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[image:NextUp.png|link=#stepHierarchy|alt=Next Up|Next Up]]</td>
<td width=75>&#160;</td>
<td width=75>[[image:NextDown.png|link=#stepLoadRoute|alt=Next Down|Next Down]]</td>
<td width=75>[[image:NextDown.png|link=#stepWhatRoute|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->


='''What is a Route?'''=
<table width=1000>
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, TurfFX and Clutter Effects, plus some "environmental" features.<br>
 
A '''Route''' consists of two parts:-
#'''Route Data''' and
#'''Route Layers'''.
<br>
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>The virtual worlds that Trainz creates can be classified as:-</td>
<td>'''When you save a Route, all the items in the Route Data and Route Layers will be saved</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
<span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&nbsp;Route Data:&nbsp;</span>
<table width=1000>
<br>
<tr valign="top">
<table cellpadding=4 bgcolor=#c1e7e7>
<td>[[image:RouteSessionGamesMap.png|link=|alt=Route-Sessions-Games|480px]]</td>
<td>
<table cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|link=]]</td>
<td>The '''Route Data''' stores all those features that are '''painted''' into a layout using a '''brush tool'''</td>
<td><span style="font-weight: 700; font-size: 17px;">Routes</span></td>
</tr>
</tr>
</table>
</table>
 
'''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 saved '''Sessions'''.<br><br>
This covers all those visual elements that are "painted" in '''Surveyor''' with a brush tool and all the '''Environmental''' features.
<table cellpadding=2>
 
[[image:Woolshed_Route_Data.png|link=|alt=Route Data]]
 
'''Route Data''' consists of:-
*'''Landforms''' (Terrain) - baseboards and ground height
*'''Water''' height and spread
*'''Ground Textures''' including the grid pattern which is a texture
*'''TurfFX and Clutter''' - found in the '''Effects Layers'''
*'''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 (TRS19/Trainz Plus/TRS22). You must edit and save the '''Route''' for these settings to become part of the '''Route Data''' - see '''[[image:WikiLink.PNG|link=]]&nbsp;[[How_to_Use_Environment_Tools|How to Use Environment Tools]]''' for more details. If the '''Route''' does not have any saved <br>
<span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&nbsp;Route Layers:&nbsp;</span>
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|link=]]</td>
<td>'''Route Layers''' are used to hold the scenery assets that you want to appear in all '''Sessions''' created for the '''Route'''</td>
<td><span style="font-weight: 700; font-size: 17px;">Sessions</span></td>
</tr>
</tr>
</table>
</table>
<br>
'''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 '''Games'''.<br><br>
 
<table cellpadding=2>
All scenery assets are held in layers. '''Route Layers''' give you a way of organising or grouping the assets displayed in your '''Route'''.
 
[[image:Woolshed_Route_Layers.png|link=|alt=Route Layers]]
 
'''Route Layers''' have those scenery items that you want to always appear.<br>
 
'''Route Layers''' can 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) - <span style="background-color: yellow; font-weight: 700;">&nbsp;Note:&nbsp;</span> It is '''strongly recommended''' that all rolling stock be placed into a '''Session Layer'''
*Lineside and Fixed Cameras
*Trackmarks, Triggers, Direction and Priority Marks
 
<table cellpadding=4 bgcolor="Aquamarine">
<tr valign="top">
<tr valign="top">
<td>[[image:LinkWiki.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|link=]]</td>
<td>
<td><span style="font-weight: 700; font-size: 17px;">Games (also called Driver Games, Driver Sessions, Saved Games)</span></td>
A detailed description of '''Layers''' can be found on the '''Trainz Wiki Page [[How_to_Use_Layers|How to Use Layers]]'''<br>
</tr>
</td>
</table>
'''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.</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepLoadRoute"></span>&nbsp;</td>
<td width=629><span id="stepWhatRoute"></span>
='''What is a Route?'''=
</td>
<td width=50>&#160;</td>
<td width=50>&#160;</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[image:NextUp.png|link=#stepWhatRoute|alt=Next Up|Next Up]]</td>
<td width=75>[[image:NextUp.png|link=#stepHierarchy|alt=Next Up|Next Up]]</td>
<td width=75>[[image:NextDown.png|link=#stepWhatSession|alt=Next Down|Next Down]]</td>
<td width=75>[[image:NextDown.png|link=#stepLoadRoute|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->


='''Loading (and Creating) a Route'''=
<table width=1000>
The Main Menu screen is shown below. The first option (shown highlighted in the image) opens '''Driver/Surveyor''' with all its options including loading and creating a '''Route'''.<br>
<tr valign="top">
<td colspan=2>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.<br><br>


[[image:TRS19MainScreen.png|link=|alt=TRS19 Main Screen options]]
A route consists of two parts:-</td>
 
</tr>
In '''Driver/Surveyor''' a strip of thumbnails for all the installed Routes will be shown at the base of the screen. The strip will scroll horizontally if there are too many to display. Just move the mouse pointer onto any thumbnail to reveal the scroll bar device.
</table>
 
[[image:TRS19SelectRoute.png|link=|alt=TRS19 Main Screen Route Selection]]
 
The <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;MAIN MENU&nbsp;</span> button will take you back to the starting or main screen.<br>
The <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Sort By A-Z&nbsp;</span> will give you a drop down menu of sorting options for the thumbnail list.<br>
The [[image:MainScreenDownArrow.png|link=]] button will expand the thumbnail list to fill the screen - click it again to return the thumbnails to the strip at the bottom of the screen.<br>
 
The thumbnail images are colour coded.<br>


<table>
<table width=700>
<tr valign="top">
<tr valign="top">
<td bgcolor=#ffae00 width=50>&nbsp;</td>
<td>
<td>'''Payware'''</td>
<table width=300>
<td>'''DLC''' - must be purchased. '''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</td>
</tr>
<tr valign="top">
<tr valign="top">
<td bgcolor=#dbdbdb width=50>&nbsp;</td>
<td width=25>[[image:Ablue.png|link=]]</td>
<td>'''Installed'''</td>
<td>'''Route Data''' and</td>
<td>Downloaded from the Download Station ('''DLS''') or created by you. This includes any cloned '''DLC''' Routes and Sessions (see [[image:PageLink.PNG|link=]] '''[[#Cloning a Route/Session|Cloning a Route/Session]]''' below)</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td bgcolor=#848dff width=50>&nbsp;</td>
<td>[[image:Bblue.png|link=]]</td>
<td>'''Not Installed'''</td>
<td>'''Route Layers'''</td>
<td>Needs to be downloaded and installed before you can use this route</td>
</tr>
</tr>
</table>
</table>
<br>
</td>
=='''Creating a New Route'''==
On the '''Driver/Surveyor''' screen the '''Route''' options are shown as a set of buttons at the bottom of the screen.
 
[[image:RouteButtonsCreate.png|link=|alt=Create a New Route]]
 
Click <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;CREATE ROUTE&nbsp;</span>. This will start Trainz '''Surveyor''' and open the '''New Route Dialogue Window'''.
 
<table width=1000>
<tr valign="top">
<td width=400>[[image:RouteNewWindow.png|link=|alt=New Route dialogue window]]</td>
<td>
<td>
<table width=600 bgcolor=#000000>
<table width=400 bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#ffffe0 width=596>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:PencilTips.PNG|link=]]</td>
<td width=35>[[image:Information.png|35px|link=]]</td>
<td>All these settings plus others can be easily changed at any time after the '''Route''' has been created.
<td>'''When you save a Route, all items in the Route Data and Route Layers will be saved'''</td>
<table>
<tr>
<td>[[image:RouteEdit.png|link=|alt=Route edit]]</td>
<td>From the '''Edit''' menu select '''Edit Route''' or press <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;E&nbsp;</span><br><br>
For more details see '''[[file:PageLink.PNG|link=]]&nbsp;[[#Editing a Route|Editing a Route]]''' below.</td>
</tr>
</tr>
</table>
</table>
Line 189: Line 141:
</tr>
</tr>
</table>
</table>
</td>
<br>
<table width=1000>
<tr valign="top">
<td>[[image:Ablue.png|link=]] <span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&#160;Route Data:&#160;</span></td>
</tr>
</tr>
</table>
</table>
 
<br>
It is strongly advised that you enter some details before clicking the tick icon to create the new route. This will save you time and hassle later.
<table width=1000 bgcolor="lightcyan" cellpadding=2>
<table>
<tr valign="top">
<tr valign="top">
<td width=150><span style="color: white; background-color: black; font-weight: 700;">&nbsp;Route name:&nbsp;</span></td>
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
<td>Enter a name for your new Route (keep it simple)<br></td>
<td>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)</td>
</tr>
</tr>
</table>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td><span style="color: white; background-color: black; font-weight: 700;">&nbsp;Session name:&nbsp;</span></td>
<td>The '''Route Data''' includes the '''Terrain''', '''Textures''', '''Effect Layers''', '''Legacy Water''' and the '''Environmental''' features.</td>
<td>Enter a name for your Session (again keep it simple) - see '''Notes:''' below<br></td>
</tr>
<tr valign="top">
<td><span style="color: white; background-color: black; font-weight: 700;">&nbsp;Geographical region:&nbsp;</span></td>
<td>Select a region from the drop down list
</tr>
</tr>
</table>
</table>


<table width=1000>
[[image:Woolshed_Route_Data.png|link=|alt=Route Data]]
<tr>
 
<td width=400>[[image:RouteSARWindowDots.png|link=|alt=Route Details]]</td>
<table width=1000 bgcolor=#000000 cellpadding=2>
<td width=600>
<table width=600 bgcolor=#000000>
<tr valign="top">
<tr valign="top">
<td>
<td>
<table cellpadding=4 bgcolor=#ffffb0 width=596>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td colspan=2>'''Route Data''' contains:-</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span>
----
</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint1.JPG|link=]]</td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>You do not have to add the name of a '''Session''' but when you save a new '''Route''' without a named '''Session''' a default '''Session''' will be automatically saved with the name '''Default'''. This can later cause confusion if a multitude of different '''Default Sessions''' appear so it is '''recommended''' that a unique '''Session name''' be entered at this point.</td>
<td>'''Landforms''' (Terrain) - baseboards and ground height</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>&nbsp;</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>A '''Session''' can always be deleted later if you have no interest in creating one for your '''Route''' - see '''[[file:PageLink.PNG|link=]]&nbsp;[[#Deleting Routes and Sessions|Deleting Routes and Sessions]]''' below. However a '''Route''' with a '''Session''' does have some important advantages - see '''[[file:PageLink.PNG|link=]]&nbsp;[[#What is a Session?|What is a Session?]]''' below.</td>
<td>'''Water''' height and spread for '''Legacy Water''' found in '''Surveyor Classic''' </td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint2.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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), 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 '''[[image:WikiLink.PNG|link=]]&nbsp;[[How to Create a Region Asset|How to Create a Region Asset]]'''</td>
<td>'''Ground Textures''' including the grid pattern which is a texture</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint3.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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.</td>
<td>'''Effect Layers''' - '''TurfFX, Clutter, Water, Color''' (the '''Color Effect Layer''' is <span style="background-color: yellow;">only available in '''Trainz Plus''' when using '''High Definition (HD)'''</span>)</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint4.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>The '''Working units''' choice between '''Metric''' (metres, kilometres) and '''Imperial''' (yards, miles) only affects the measurement and display of horizontal distances used for 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) and will not be altered by this selection. Altitudes are always measured and displayed using '''Metric''' units (metres).</td>
<td>'''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 '''[[image:WikiLink.PNG|link=]]&#160;[[How_to_Use_Environment_Tools|How to Use the Environment Tools]]''' for more details.</td>
</tr>
</tr>
</table>
</table>
</td>
</tr>
</tr>
</table>
</table>
</td>
<br>
<table width=1000>
<tr valign="top">
<td>[[image:Bblue.png|link=]] <span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&#160;Route Layers:&#160;</span></td>
</tr>
</tr>
</table>
</table>


=='''Loading an Existing Route'''==
<table width=1000 bgcolor="lightcyan" cellpadding=2>
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.
 
[[image:RouteSearchButtons.png|link=|alt=Route Search]]
 
<table>
<tr valign="top">
<tr valign="top">
<td>'''Type:'''</td>
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
<td><span style="background-color: black; color: white; font-weight: 700;">&nbsp;ROUTES&nbsp;</span> is the default selection. No need to change this.</td>
<td>'''Route Layers''' are used to hold the scenery assets that you want to appear in all sessions created for the route</td>
</tr>
</tr>
</table>
<br>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>'''Source:'''</td>
<td>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.</td>
<td><span style="background-color: black; color: white; font-weight: 700;">&nbsp;PURCHASED&nbsp;</span> is the default selection, Click and change to <span style="background-color: black; color: white; font-weight: 700;">&nbsp;MY CONTENT&nbsp;</span> for a '''Route''' you have created (or already modified) or to <span style="background-color: black; color: white; font-weight: 700;">&nbsp;INSTALLED&nbsp;</span> for one you have downloaded from the '''DLS'''.</td>
</tr>
</tr>
</table>
[[image:Woolshed_Route_Layers.png|link=|alt=Route Layers]]
<table bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>'''Region:'''</td>
<td>
<td><span style="background-color: black; color: white; font-weight: 700;">&nbsp;ALL&nbsp;</span> 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.</td>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<td colspan=2>'''Route Layers''' contain:-</td>
</tr>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Track''' and '''Track Objects''' (such as signals, switches, bridges, tunnels, speed signs, etc)</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>'''Search:'''</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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.</td>
<td>Most (or all) '''scenery''' items (e.g. buildings, trees, rocks, active industries/stations) and scenery '''splines''' (e.g. roads, fences, etc)</td>
</tr>
</tr>
</table>
This will produce a display of thumbnails at the bottom of the screen.<br>
[[image:RouteSelectExisting.png|link=|alt=Existing Routes]]
Click on the thumbnail for the '''Route''' you want to load, then click on the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;EDIT ROUTE&nbsp;</span> button to load the '''Route''' into '''Surveyor'''.
[[image:RouteButtonsEdit.png|link=|alt=Edit Route]]
=='''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'''.<br>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:CMOpenRouteSurveyor.png|link=|Load a route from CM]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>
<td>'''Rolling Stock''' (including locos) - <span style="background-color: yellow; font-weight: 700;">&#160;Note:&#160;</span> It is '''strongly recommended''' that all rolling stock be placed into a '''Session Layer'''</td>
<table cellpadding=4 bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Steps.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br>
<td>Lineside and Fixed '''Cameras'''</td>
#in '''Content Manager''' select the filter '''Routes & Sessions'''
#select the '''Route''' to be edited
#use the '''right-mouse-button''' to open the '''Command Menu'''
#select '''Open...''', then
#select '''Edit Asset in Surveyor'''
</td>
</tr>
</tr>
<tr>
<tr valign="top">
<td colspan="2">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
----</td>
<td>'''Trackmarks, Triggers, Direction''' and '''Priority Marks''' - these are often placed into a '''Session Layer''' so that they can be specific to a particular session</td>
</tr>
</tr>
</table>
</table>
Line 311: Line 247:
</tr>
</tr>
</table>
</table>
 
<br>
=='''Loading After an Unexpected Shutdown'''==
<table bgcolor=#000000 width=1000 cellpadding=2>
If you select a '''Route''' for loading after an unexpected shutdown of '''Trainz''' then any '''Route''' (or '''Route''' and '''Session''') that was open and running in '''Trainz Surveyor''' or '''Driver''' will be left marked as '''Open for Edit'''. When you attempt to load this '''Route''' into '''Surveyor''' or '''Driver''' you will see a message listing the '''Route''' and '''Session''' (if any) that were affected.<br>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteLoadAfterCTD.png|link=|alt=Load after CTD]]</td>
<td>
<td>
<table bgcolor=#000000 width=520>
<table bgcolor=#ffffb0 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>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 [[image:PageLink.PNG|link=]] '''[[#Loading an Existing Route|Loading an Existing Route]]''' below for how to deal with this situation.</td>
</tr>
</table>
</td>
</tr>
</table>
<br>
<table cellpadding=2 bgcolor="Aquamarine">
<tr valign="top">
<td width=50>[[image:LinkWiki.PNG|link=]]</td>
<td>
<td>
<table cellpadding=4 bgcolor=#ffffb0 width=516>
A detailed description of '''Layers''' can be found on the '''Trainz Wiki Page''':-
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Note:'''</span>
<td>'''[[How_to_Use_Layers|How to Use Layers]]'''<br>
----
</td>
A similar message will appear when you load a '''Driver Game''' (see '''[[file:PageLink.PNG|link=]]&nbsp;[[#Saving and Loading Sessions in Driver|Saving and Loading Sessions in Driver]]''' below) after editing the original '''Route''' or '''Session''' that was used to create the '''Driver Session'''.<br>
 
It is possible that the changes you have made may affect the operation of the '''Driver Session'''.</td>
</tr>
</tr>
</table>
</table>
Line 334: Line 276:
</tr>
</tr>
</table>
</table>
<br>
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=629><span id="stepLoadRoute"></span>
='''Loading (and Creating) a Route'''=
</td>
</td>
<td width=50>[[image:SkipDown.png|link=#skipNewRoute|Skip Down]]</td>
<td width=50>&#160;</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td width=75>[[image:NextUp.png|link=#stepWhatRoute|alt=Next Up|Next Up]]</td>
<td width=75>[[image:NextDown.png|link=#stepWhatSession|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</tr>
</table>
</table> <!-- END Nav Buttons Table -->


The message is saying that the assets in the list '''may have been''' changed since the last time you loaded them and exited '''Trainz''' normally. For example if you had been editing the '''Route''' and/or '''Session''' and had experienced a crash to the desktop or had used Windows '''Task Manager''' to terminate the program.<br>
<table width=1000>
 
The options you will see are:-<br>
<table>
<tr valign="top">
<tr valign="top">
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Use changes&nbsp;</span>
<td colspan=2>The '''Main Menu''' screen is shown below. The first option (shown highlighted in the image) opens '''Driver/Surveyor''' with all its options including loading and creating a route.</td>
<td>&nbsp;</td>
<td>Use the edited/changed versions that are in the open database assets - there is a possibility that they may have been damaged during the shutdown and may be corrupted</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Revert changes&nbsp;</span>
<td width=480>[[image:TRS19MainScreen.png|link=|alt=TRS19 Main Screen options]]</td>
<td>&nbsp;</td>
<td>
<td>Ignore the edited/changed versions and load the previous versions instead</td>
<br>
</tr>
<table bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Cancel&nbsp;</span>
<td>
<td>&nbsp;</td>
<table bgcolor=#ffffb0 cellpadding=2>
<td>Cancel the Load and return to the '''Surveyor/Driver''' menu screen</td>
<tr valign="top">
</tr>
<td width=25>[[image:NotePad.PNG|link=]]</td>
</table>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
You could also use the '''Content Manager''' program (select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Manage Content&nbsp;</span> 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.
----
<br>
<table>
 
<tr valign="top">
=='''Editing a Route'''==
<td colspan=2>'''Routes''':-</td>
<table cellpadding=4 bgcolor=#c1e7e7>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''When a Route is loaded or a new Route is created all the assets you add will be automatically placed into a Route Layer'''</td>
<td>are saved as entries in the '''Trainz Database''', not as files on your hard drive. Loading a route will retrieve it from the database.</td>
</tr>
</tr>
</table>
When you create a new '''Route''' (with or without a named '''Session'''), or load an existing '''Route''' without a '''Session''', and start adding scenery assets they will automatically be placed into a '''Route Layer'''. See '''[[image:WikiLink.PNG|link=]]&nbsp;[[How_to_Use_Layers|How to Use Layers]]''' for more details.<br>
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'''.<br>
<table bgcolor=#ff0000 width=900>
<tr valign="top">
<tr valign="top">
<td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<table bgcolor=#fcbcbc>
<td>can be loaded directly into '''Surveyor''' from '''Content Manager'''. See [[image:PageLink.PNG|link=]] '''[[#Loading a Route Into Surveyor From Content Manager|Loading a Route Into Surveyor From Content Manager]]''' below</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[file:Stop.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>
<td>can be '''exported''' as files (in the '''Trainz .cdp''' file format) from '''Content Manager''' for backup or transfer.</td>
<span style="font-size: 15px; font-weight: 700;">WARNING:</span><br>
</tr>
 
</table>
Moving or deleting a section of track that is occupied by a train will cause problems particularly if the train is in a '''Session''' and you have only loaded the '''Route''' for editing. The train will most likely become a "missing asset".<br><br>
 
'''Move or delete any affected trains first before editing the track''' by loading and editing the '''Session''', not just the '''Route'''. See '''[[image:PageLink.PNG|link=]]&nbsp;[[#Loading an Existing Session|Loading an Existing Session]]''' and '''[[image:PageLink.PNG|link=]]&nbsp;[[#Editing a Session|Editing a Session]]''' below.
</td>
</td>
</tr>
</tr>
Line 392: Line 331:
</table>
</table>
<br>
<br>
<table width=1000>
<table bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td width=350>
----
You can edit the '''Route Characteristics''' at any time by selecting the '''Edit Route''' command from the '''Edit''' menu or simply pressing <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;E&nbsp;</span>.<br>
This will bring up the '''Edit Route''' dialogue window (shown below).</td>
<td width=170>[[image:RouteEdit.png|link=|alt=Route edit]]</td>
<td>
<td>
<table bgcolor=#000000 width=480>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps: To Load or Create a Route:-</span></td>
<table cellpadding=4 bgcolor=#ffffb0 width=476>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Route Characteristics:-'''</span><br>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the large <span style="font-weight: 700; font-size: 15px;">Driver / Surveyor</span> graphic shown highlighted in white in the image on the left</td>
----
</tr>
*'''Name''' and '''Description'''
</table>
*assigned '''Geographic Region''', which sets a number of different features
*'''Thumbnail''' image
*'''Working Scale''' and '''Working Units'''
*'''Draw Distance'''
</td>
</td>
</tr>
</tr>
Line 418: Line 348:
</td>
</td>
</tr>
</tr>
</table>
<tr valign="top">
</td>
<td colspan=2><br><br>
In the '''Driver/Surveyor''' screen a strip of thumbnails of all the Routes, installed and as well as available as '''DLC''', will be shown at the base of the screen.<br>
[[image:TRS19SelectRoute.png|link=|alt=TRS19 Main Screen Route Selection]]<br><br></td>
</tr>
</tr>
</table>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td width=650>[[image:RouteEditDialogue.png|link=|alt=Edit Route dialogue window]]</td>
<td colspan=2>If there are too many to fit in the available space, then either:-
<td>
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint1.JPG|link=]]</td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>You can edit the '''Name''' of the Route. This will change the route '''username''' in the '''config.txt''' file but it will not alter the route '''&lt;kuid&gt;''' value</td>
<td>move the mouse pointer onto the base of any thumbnail image to reveal the scroll bar device, as shown above, then <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click and Drag</span> the scroll bar left or right to reveal the additional routes <span style="font-weight: 700; font-size: 15px;">OR</span></td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint2.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>You can select a new '''Region'''. Depending on the region selected this could affect other features such as the moving road traffic, season of the year (through the latitude tag) and altitude</td>
<td>move the mouse pointer onto any thumbnail image and roll the mouse scroll wheel forwards or backwards to reveal the additional routes <span style="font-weight: 700; font-size: 15px;">OR</span></td></tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint3.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>You can edit the Route '''Description'''</td>
<td>use the '''Expand View''' [[image:MainScreenDownArrow.png|link=]] button described below. This will fill the screen with thumbnail images. If there are still too many to fit then use either of the two methods listed above to scroll the full screen view left and right</td>
</tr>
</tr>
<tr valign="top">
</table>
<td>[[image:DotPoint4.JPG|link=]]</td>
</td>
<td>You can change the Route '''Thumbnail'''. Clicking the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Set Thumbnail&nbsp;</span>
button will take a snapshot using the current camera view which will be used as the new thumbnail</td>
</tr>
</tr>
</table>
<br>
<table width=1000 bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint5.JPG|link=]]</td>
<td>
<td>You can change the Route '''Working Scale''' which will only affect the measurement shown in the Surveyor Ruler tool</td>
<table bgcolor=#ffffff cellpadding=2>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint6.JPG|link=]]</td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>You can change the Route '''Working Units''' to <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Metric&nbsp;</span> or <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Imperial&nbsp;</span> which will change the display of measurements using the Surveyor '''Ruler''' (to metres or yards) and how train speeds are calculated and displayed in Driver (in km/h or mph)</td>
<td>A <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;MAIN MENU&#160;</span> button (bottom left) will take you back to the starting or main screen.</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint7.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>You can set or disable the '''Draw Distance Cap''' which will affect how far away from the camera that scenery objects will be drawn. This will affect the ''game performance'' and the ''fps'' (frames per second)</td>
<td>A <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Sort By A-Z&#160;</span> button (top near right) will give you a drop down menu of sorting options for the thumbnail list.</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint8.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>Clicking the '''Tick''' icon will save the entered values and exit back to Surveyor. Clicking the '''Cross''' icon will cancel any entered values and exit back to Surveyor</td>
<td>A <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the '''Expand View''' [[image:MainScreenDownArrow.png|link=]] button (top right) will expand the thumbnail list to fill the screen. <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the '''Expand View''' [[image:MainScreenDownArrow.png|link=]] button again to return the thumbnails to the strip at the bottom of the screen.</td>
</tr>
</tr>
</table>
</table>
Line 465: Line 393:
</table>
</table>
<br>
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000>
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepWhatSession"></span>&nbsp;</td>
<td>The thumbnail images are colour coded.</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
<td width=75>[[image:NextUp.png|link=#stepLoadRoute|alt=Next Up|Next Up]]</td>
</table>
<td width=75>[[image:NextDown.png|link=#stepLoadSession|alt=Next Down|Next Down]]</td>
<br>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
<table width=1000>
<tr valign="top">
<td width=200><span style="background-color: #ffae00;">&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;</span> <span style="font-weight: 700; font-size: 15px;">Payware on DLC</span></td>
<td>Must be purchased and downloaded, but some may be free - depending on your membership options. If you click a thumbnail with this colour a <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;DOWNLOAD&#160;</span> 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)</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
='''What is a Session?'''=
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=200><span style="background-color: #10c810;">&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;</span> <span style="font-weight: 700; font-size: 15px;">Payware installed</span></td>
<td>'''A Session is always a part of an existing Route - you cannot have a Session that does not belong to a Route'''</td>
<td>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</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=200><span style="background-color: #dbdbdb;">&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;</span> <span style="font-weight: 700; font-size: 15px;">Installed</span></td>
<td>'''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'''</td>
<td>Downloaded from the Download Station ('''DLS''') or created by you. This includes any cloned '''DLC''' Routes and Sessions (see [[image:PageLink.PNG|link=]] '''[[#Cloning a Route/Session|Cloning a Route/Session]]''' below)</td>
</tr>
</tr>
</table>
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.<br>
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'''''.<br>
A '''Session''' consists of two parts:-
#'''Session Data''' and
#'''Session Layers'''.
<br>
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=200><span style="background-color: #848dff;">&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;</span> <span style="font-weight: 700; font-size: 15px;">Multiplayer</span></td>
<td>'''When you save a Session, all the items in the Session Data and Session Layers will be saved</td>
<td>For simultaneous development by multiple players. Special conditions apply</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
 
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&nbsp;Session Data:&nbsp;</span>
 
'''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'''.
 
[[image:Woolshed_Session_Data.png|link=|alt=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''' ('''TRS19PE/Trainz Plus/TRS22''') - 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 (TRS19/Trainz Plus/TRS22). You must edit and save the '''Session''' for these settings to become part of the '''Session Data''' - see '''[[image:WikiLink.PNG|link=]]&nbsp;[[How_to_Use_Environment_Tools|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
<br>
<span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&nbsp;Session Layers:&nbsp;</span>
 
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=629><span id="skipNewRoute"></span>
<td>'''Session Layers''' are used to hold the scenery assets that you want to only appear in that particular Session and not in all Sessions</td>
=='''Creating a New Route'''==
</td>
<td width=50>[[image:SkipDown.png|link=#skipWorldView|Skip Down]]</td>
<td width=50>[[image:SkipUp.png|link=#stepLoadRoute|Skip Up]]</td>
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
<table width=1000 bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>
<td>'''Session Layers can be left empty''' and the '''Route Layers''' can contain all the scenery assets</td>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<td width=35>[[image:Information.png|35px|link=]]</td>
<td>When you create a new '''Route''' a new default '''Session''' will also be created for it. Sessions contain specific data that are not found in routes. See [[image:PageLink.PNG|link=]]&#160;'''[[#What is a Session?|What is a Session?]]''' below.<br>
When you save the new route you will be given the opportunity to save the session as well. If you have not added anything to the session then saving it is optional.
<table bgcolor=#fcbcbc cellpadding=2>
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td><span style="font-size: 15px; font-weight: 700;">WARNING:</span><br>
If you have added anything to the '''session-layer''' or edited any session data (e.g. the products carried by a wagon) and do not save the '''Session''' as well as the '''Route''' then that data will be lost. See [[image:PageLink.PNG|link=]]&#160;'''[[#Saving_a_Route_and_a_Session|Saving a Route and Session]]''' below for more information.</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
</tr>
</tr>
</table>
</table>


[[image:Woolshed_Session_Layers.png|link=|alt=Session layers]]
[[image:RouteButtonsCreate.png|link=|alt=Create a New Route]]


'''Session Layers''' give you a way of organising or grouping the assets displayed in your '''Session'''.<br>
<table width=1000>
 
<tr valign="top">
<table width=800>
<td colspan=2>In both '''Surveyor Classic''' (also known as '''S1.0''' or '''S10''') and in '''Surveyor 2.0''' (also known as '''S2.0''' or '''S20''') <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;CREATE ROUTE&#160;</span>. This will start Trainz '''Surveyor''' and create a new blank route with a single baseboard using the '''Default''' settings which are usually those that were used when you last created and saved a route. The default settings may include a ground texture other than the grid pattern, for example - thick grass.</td>
</tr>
<tr valign="top">
<tr valign="top">
<td width=400>
<td width=490 align="center">[[image:S20_SurveyorScreen.png|490px|link=]]<br>
'''Session Layers''' can contain:-
'''Surveyor 2.0 screen shown'''</td>
*Scenery
<td>
*Rolling Stock (including locos) - <span style="background-color: yellow; font-weight: 700;">&nbsp;Note:&nbsp;</span> It is '''strongly recommended''' that all rolling stock be placed into a '''Session Layer'''
<table bgcolor=#000000 cellpadding=2>
*Trackmarks, Triggers, Direction and Priority Markers
</td>
<td width=400>
<table bgcolor=#000000 width=400>
<tr valign="top">
<tr valign="top">
<td>
<td>
 
<table bgcolor=#ffffb0 cellpadding=2>
<table bgcolor=#ffffb0 width=396>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td width=25>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
<td><span style="font-size: 17px;">'''Notes: for Trainz Plus'''</span><br>
----
----
While it is possible to add '''track''' and '''track objects''' (bridges, tunnels, turntables, signals, switches, etc) to '''Session Layers''' it is '''not recommended'''. These fixed assets should be placed into '''Route Layers'''.
</td>
</td>
</tr>
</tr>
</table>
<tr valign="top">
</td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>the '''default''' grid resolution for a new route is '''HD (High Definition) Grid'''</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>to convert your new '''HD resolution''' route to '''5m resolution''' or to '''10m resolution''', at any time, see [[image:WikiLink.PNG|link=]]&#160;'''[[How to Use S20 Tools#The Marquee Tool|The Marquee Tool]]''' for the details</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>if you want to convert an existing '''5m resolution''' or '''10m resolution''' route entirely to '''HD resolution''' then see [[image:WikiLink.PNG|link=]]&#160;'''[[How to Use S20 Tools#stepUpgrading|Upgrading a Route to HD]]''' for the details</td>
</tr>
</tr>
</table>
</table>
Line 565: Line 491:
</table>
</table>
<br>
<br>
<table cellpadding=4 bgcolor="Aquamarine">
<table bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:LinkWiki.PNG|link=]]</td>
<td>
<td>
A detailed description of '''Layers''' can be found on the '''Trainz Wiki Page [[How_to_Use_Layers|How to Use Layers]]'''<br>
<table bgcolor=#ffffb0 cellpadding=2>
<tr valign="top">
<td width=25>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Notes: for TRS19 and TRS22'''</span><br>
----
</td>
</td>
</tr>
</tr>
</table>
<br>
<table bgcolor=#000000 width=1000>
<tr valign="top">
<tr valign="top">
<td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<table bgcolor=#ffffb0>
<td>the '''default''' grid resolution for a new route is '''10m'''</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>using '''Surveyor 2.0''' (<span style="font-weight: 700; background-color: yellow;">in TRS22PE</span>) to convert your new '''10m resolution''' route to '''5m resolution''', at any time, see [[image:WikiLink.PNG|link=]]&#160;'''[[How to Use S20 Tools#The Marquee Tool|The Marquee Tool]]''' for the details</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
<td>in '''Surveyor Classic''' to convert your new '''10m resolution''' route to '''5m resolution''', at any time, you will need to individually convert each baseboard</td>
----
</tr>
'''Scenery''', '''Rolling Stock''', '''Triggers''' and '''Markers''' (Track, Direction, Priority) can be used in both '''Route Layers''' and '''Session Layers'''. Assets placed in a '''Route Layer''' will appear in all '''Sessions''' that are based on the '''Route'''. The vast majority of (if not all) scenery items will be placed in '''Route Layers'''. Assets placed in a '''Session Layer''' will only appear in the currently loaded '''Session'''.
</table>
 
Examples of assets that would be placed in a '''Session Layer''' instead of a '''Route Layer''' would include:-
 
*products waiting at a factory for pickup in an industrial '''Session''' that would not be present in a weekend or holiday passenger '''Session'''
*signallers holding lanterns in a night '''Session''' only or standing alongside manual track switch levers in a daylight shunting '''Session'''
*trackmarks and triggers that are only required in one '''Session''' but not in all '''Sessions'''
*crowds of onlookers alongside the track in a '''Session''' recreating an historic steam train run, together with
*historic rolling stock in a special vintage train '''Session''' running on a modern '''Route'''
</td>
</td>
</tr>
</tr>
Line 598: Line 521:
</table>
</table>
<br>
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000>
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepLoadSession"></span>&nbsp;</td>
<td width=500>[[image:RouteEditWindow_S20.png|link=]]</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td>
<td width=75>[[image:NextUp.png|link=#stepWhatSession|alt=Next Up|Next Up]]</td>
<table width=500 cellpadding=2 bgcolor=#000000>
<td width=75>[[image:NextDown.png|link=#stepSaving|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table> <!-- END Nav Buttons Table -->
 
='''Loading (and Creating) a Session'''=
 
=='''Creating a New Session'''==
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>
<td>'''To create a new Session you must first create a new Route or identify an existing Route'''</td>
<table cellpadding=2 bgcolor=#ffffff>
</tr>
</table>
A new '''Session''' can be created in two ways:-<br>
 
<table width=900>
<tr valign="top">
<tr valign="top">
<td colspan=2 bgcolor=#000000><span style="font-size: 17px; font-weight:700; color: white;">&nbsp;Method&nbsp;[[image:DotPoint1.JPG|link=]]&nbsp;Automatically When a New Route is Created&nbsp;</span></td>
<td>You can easily edit the route settings at any time after the route has been created.
</tr>
<table>
<tr valign="top">
<tr valign="top">
<td width=450>[[image:RouteSARWindow.png|link=|alt=Route Details]]</td>
<td>
<td>Follow the steps shown in the section '''[[file:PageLink.PNG|link=]]&nbsp;[[#Creating a New Route|Creating a New Route]]''' above by entering:-
<table bgcolor=#ffffff cellpadding=2>
*a '''Route name''' for the new '''Route'''
*a '''Session name''' for the new '''Session'''
*a '''Geographical region'''
*'''Working scale''' and '''Working units'''</td>
</tr>
</table>
 
<table width=900>
<tr valign="top">
<tr valign="top">
<td bgcolor=#000000><span style="font-size: 17px; font-weight:700; color: white;">&nbsp;Method&nbsp;[[image:DotPoint2.JPG|link=]]&nbsp;Adding a Session to an Existing Route&nbsp;</span></td>
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps: To Edit the Route Details at Any Time:-</span></td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>
<td>
<br>
<table>
<table bgcolor=#000000 width=900>
<tr valign="top">
<tr valign="top">
<td>
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
<table bgcolor=#ffffb0 width=896>
<td>Open the [[image:EditMenu_S20.png|link=]] '''Edit''' menu from the top menu in Surveyor and select the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Edit&#160;Route...&#160;</span> option<br>
<tr valign="top">
The keyboard shortcut is <span style="font-weight: 700; font-size: 15px;"><span style="color: white; background-color: black;">&#160;Ctrl&#160;</span>&#160;+&#160;<span style="color: white; background-color: black;">&#160;E&#160;</span></span></td>
<td>[[image:NotePad.PNG|link=]]</td>
</tr>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
</table>
----
A '''Route''' can have many individual '''Sessions''' so a new '''Session''' can be added to an existing '''Route''' that already has '''Sessions''' installed.
</td>
</td>
<td>[[image:EditMenuOptions_S20.png|link=]]</td>
</tr>
</tr>
</table>
</table>
Line 655: Line 554:
</tr>
</tr>
</table>
</table>
The first step is to locate (but not load) the '''Route''' as described in the section '''[[file:PageLink.PNG|link=]]&nbsp;[[#Loading an Existing Route|Loading an Existing Route]]''' above.
Once you have selected the '''Route''' from its thumbnail, click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;VIEW SESSIONS&nbsp;</span> button.
[[image:RouteButtonsView.png|link=|alt=View Sessions]]
Then click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;CREATE SESSION&nbsp;</span> button. If no other '''Session''' exists for this '''Route''' then this will be the only choice available to you.
[[image:SessionButtonsCreate.png|link=|alt=Create Session]]
</td>
</td>
</tr>
</tr>
<tr valign="top">
</table>
<td bgcolor=#000000>&nbsp;</td>
</td>
</tr>
</tr>
</table>
</table>
 
</td>
Both methods will load the '''Route''' into '''Surveyor''' and create a new '''Session''' with all its values/parameters set at '''default''' levels.
 
=='''Loading an Existing Session'''==
There are two different ways to load existing '''Sessions''' into '''Surveyor'''.<br>
<table width=900>
<tr valign="top">
<td colspan=2 bgcolor=#000000><span style="font-size: 17px; font-weight:700; color: white;">&nbsp;Method&nbsp;[[image:DotPoint1.JPG|link=]]&nbsp;Search For the Session&nbsp;</span></td>
</tr>
</tr>
</table>
<br>
<table>
<tr valign="top">
<tr valign="top">
<td>The easiest way to load an existing '''Session''' is to use the search tools at the top of the '''Driver/Surveyor''' screen.
<td width=495>It is '''recommended''' that you enter some details before you click the [[image:Tick.PNG|link=|alt=Tick]] 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.</td>
 
<td width=10>&#160;</td>
[[image:SessionSearchButtons.png|link=|alt=Session Search]]
<td>
 
<table width=500 bgcolor=#000000 cellpadding=2>
<table>
<tr valign="top">
<tr valign="top">
<td>'''Type:'''</td>
<td>
<td><span style="background-color: black; color: white; font-weight: 700;">&nbsp;ROUTES&nbsp;</span> is the default selection. Change this to <span style="background-color: black; color: white; font-weight: 700;">&nbsp;SESSIONS&nbsp;</span>.</td>
<table width=496 bgcolor=#ffffff cellpadding=2>
</tr>
<tr valign="top">
<td>'''Source:'''</td>
<td><span style="background-color: black; color: white; font-weight: 700;">&nbsp;PURCHASED&nbsp;</span> is the default selection, Click and change to <span style="background-color: black; color: white; font-weight: 700;">&nbsp;MY CONTENT&nbsp;</span> for a '''Session''' you have created (or already modified) or to <span style="background-color: black; color: white; font-weight: 700;">&nbsp;INSTALLED&nbsp;</span> for one you have downloaded from the '''DLS'''.</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>'''Gameplay:'''</td>
<td width=175><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Route name:&#160;</span></td>
<td><span style="background-color: black; color: white; font-weight: 700;">&nbsp;ALL&nbsp;</span> is the default selection. There is no need to change this</td>
<td>Enter a name for your new Route (keep it simple but descriptive)<br></td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>'''Search:'''</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Geographical region:&#160;</span></td>
<td>If required you can narrow down the list of '''Sessions''' by typing the first few letters of its name.</td>
<td>Select a region from the drop down list</td>
</tr>
</tr>
</table>
</table>
Line 706: Line 585:
</tr>
</tr>
</table>
</table>
 
</td>
This will produce a list of '''Session''' thumbnails at the bottom of the screen. As with the '''Route''' thumbnails, the list can be scrolled horizontally.<br>
 
[[image:SessionSelectExisting.png|link=|alt=Existing Sessions]]
 
The same colour coding system used in the '''Route''' thumbnails also applies to '''Session''' thumbnails.<br>
 
<table width=900>
<tr valign="top">
<td bgcolor=#ffae00 width=50>&nbsp;</td>
<td>'''Payware'''</td>
<td>'''DLC''' - must be purchased. '''DLC''' items cannot be deleted. To remove them use the '''Uninstall''' option in the '''Trainz Store''' from the '''Launcher'''. You can reinstall them later without any additional cost</td>
</tr>
<tr valign="top">
<td bgcolor=#dbdbdb width=50>&nbsp;</td>
<td>'''Installed'''</td>
<td>Downloaded from the Download Station ('''DLS''') or created by you. This includes any cloned '''DLC''' Routes and Sessions (see [[image:PageLink.PNG|link=]] '''[[#Cloning a Route/Session|Cloning a Route/Session]]''' below)</td>
</tr>
<tr valign="top">
<td bgcolor=#848dff width=50>&nbsp;</td>
<td>'''Not Installed'''</td>
<td>Needs to be downloaded and installed</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
Click on the thumbnail for the '''Session''' you want to load and then click on the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;EDIT SESSION&nbsp;</span> button. This will load '''BOTH''' the '''Route''' and the '''Session''' into '''Surveyor'''.
<table width=1000>
 
<tr valign="top">
[[image:SessionButtonsEdit2.png|link=|alt=Edit Session]]
<td width=500>[[image:RouteEditWindowExample_S20.png|link=]]<br><br>
 
A <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the [[image:Tick.PNG|link=|alt=Tick]] icon at the bottom right of the window will apply the new data settings to the single flat baseboard that you have just created.<br>
<table bgcolor=#000000 width=900>
A <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the [[image:Cross.PNG|link=|alt=Cross]] icon at the bottom right of the window will cancel the data entry and continue to use the '''default''' data settings (usually the settings entered for the last route you created) in the single flat baseboard currently on the screen.</td>
<td>
<table width=500 bgcolor=#000000>
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#ffffb0 width=896>
<table cellpadding=2 bgcolor=#ffffb0 width=596>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>[[image:NotePad.PNG|link=]]</td>
<td>
<td><span style="font-size: 17px; font-weight: 700;">Notes: Route Options'''</span>
If the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;EDIT SESSION&nbsp;</span> 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 '''[[file:PageLink.PNG|link=]]&nbsp;[[#Saving and Loading Sessions in Driver|Saving and Loading Sessions in Driver]]''' below.
----
</td>
</td>
</tr>
</tr>
</table>
<tr valign="top">
</td>
<td width=20>[[image:DotPoint1.JPG|link=]]</td>
<td>Enter a <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Route name&#160;</span> 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.</td>
</tr>
</tr>
</table>
<br>
<table width=900>
<tr valign="top">
<tr valign="top">
<td colspan=2 bgcolor=#000000><span style="font-size: 17px; font-weight:700; color: white;">&nbsp;Method&nbsp;[[image:DotPoint2.JPG|link=]]&nbsp;Select the Route First&nbsp;</span></td>
<td>[[image:DotPoint2.JPG|link=]]</td>
<td>Enter a <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Route description&#160;</span> for the route. At the starting stage this is basically a "memory jogger" for you so a basic description would be sufficient but before you release the finished route (e.g. to the '''DLS''') it should contain some critical information such as '''Trainz Plus only''', "high detail assets used" and the source(s) of any non-DLS dependencies</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>Select the '''Route''' as described in the section '''[[file:PageLink.PNG|link=]]&nbsp;[[#Loading an Existing Route|Loading an Existing Route]]''' above. Then click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;VIEW SESSIONS&nbsp;</span> button.
<td>[[image:DotPoint3.JPG|link=]]</td>
 
<td>Setting a <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Region&#160;</span> 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 the '''Trainz Wiki Page&#160;[[image:WikiLink.PNG|link=]]&#160;[[How to Create a Region Asset|How to Create a Region Asset]]'''</td>
[[image:RouteButtonsView.png|link=|alt=View Sessions]]
</tr>
 
<tr valign="top">
This will display a list of thumbnails for all the '''Sessions''' in that '''Route'''. Select the '''Session''' thumbnail you need and then click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;EDIT SESSION&nbsp;</span> button.
<td>[[image:DotPoint4.JPG|link=]]</td>
 
<td>Create a <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Route thumbnail&#160;</span> 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 <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Set Thumbnail&#160;</span> 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</td>
[[image:SessionButtonsEdit2.png|link=|alt=Edit Session]]
</tr>
 
<tr valign="top">
Again, both the selected '''Route''' and its '''Session''' will be loaded into '''Surveyor'''.<br>
<td>[[image:DotPoint5.JPG|link=]]</td>
 
<td>The <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Working scale&#160;</span> 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''' and its measurements 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.</td>
<table bgcolor=#000000 width=900>
</tr>
<tr valign="top">
<td>[[image:DotPoint6.JPG|link=]]</td>
<td>The <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Working units&#160;</span> provides a choice between '''Metric''' (metres, kilometres) and '''Imperial''' (feet, yards, miles) which only affects measurements used by rulers (in '''Surveyor 2.0''' separate metric and imperial rulers are available) and train speeds ('''km/h''' or '''mph'''). See Notes below.</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>
<td>[[image:DotPoint7.JPG|link=]]</td>
<table bgcolor=#ffffb0 width=896>
<td>The <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Route Edit Detail&#160;</span> <span style="background-color: yellow;">in '''Trainz Plus''' only</span>. This sets the minimum ground brush size when working with '''HD resolution'''. It can be swapped between the two settings at anytime when editing. See <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;SD/HD Options&#160;</span> below for more details</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>[[image:DotPoint8.JPG|link=]]</td>
<td>
<td>The <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Draw distance cap&#160;</span> sets how far away from the camera that scenery objects will be drawn. A high setting, particularly the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Disabled&#160;</span> option (which means no draw distance cap), could affect the game performance, including the '''fps''' rate (frames per second), on some systems</td>
If the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;EDIT SESSION&nbsp;</span> 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 '''[[file:PageLink.PNG|link=]]&nbsp;[[#Saving and Loading Sessions in Driver|Saving and Loading Sessions in Driver]]''' below.
</td>
</tr>
</tr>
</table>
</table>
Line 780: Line 642:
</table>
</table>
</td>
</td>
</tr>
<tr valign="top">
<td bgcolor=#000000>&nbsp;</td>
</tr>
</tr>
</table>
</table>
 
<br>
=='''Loading a Session Into Surveyor From Content Manager'''==
<table width=1000 bgcolor=#000000 cellpadding=2>
'''Trainz''' provides a shortcut that allows you to load an existing '''Session''' directly into '''Surveyor''' for editing from '''Content Manager'''.<br>
 
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:CMOpenSessionSurveyor.png|link=|Load a session from CM]]</td>
<td>
<td>
<table cellpadding=4 bgcolor=#ffffff>
<table width=996 bgcolor=#ffffb0 cellpadding=2>
<tr>
<tr valign="top">
<td colspan="2">
<td width=25 rowspan=3>[[image:NotePad.PNG|link=]]</td>
----</td>
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Notes: Height, Position and Speed Measurements</span></td>
</tr>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>All '''Height''' and '''Position''' data in the '''Surveyor Tools''' are always entered and displayed in <span style="background-color: yellow; font-weight: 700;">metres</span> even if you are using '''Imperial''' units (feet) for your rulers and distance measurements.</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Track speed signs''' are always locked at either '''Metric''' (km/h) or '''Imperial''' (mph) - there are separate speed signs available for each. The number shown by a speed sign will not be changed if you switch between the two systems. However, their speed values will be converted. So a track speed sign that is set at '''40 mph''' will still be displayed as '''40''' but it will be read as '''64 km/h''' in '''Driver''' if the '''Working Units''' have been set to '''metric'''.</td>
</tr>
<tr valign="top">
<td width=25 rowspan=3>[[image:NotePad.PNG|link=]]</td>
<td colspan=2><span style="font-size: 17px; font-weight: 700;">Notes: Ground Texture and Regions'''</span></td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Steps.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br>
<td>When a new route is created all the baseboards added will be covered with the '''Default Ground Texture''' which is usually the last one that you set. Selecting a '''Region''' ('''Point''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: red;">&#160;3&#160;</span> in the '''Notes: Route Options''' above) will set the ground texture to be used in every baseboard added to the new route. Some regions have a standard grid pattern as their default ground texture - look on the '''DLS''' for region assets with '''TRS19 Grid''' or similar in their titles. You can change the selected '''Region''' and its ground texture as often as you like but this can also change other properties of the route as described above.</td>
#in '''Content Manager''' select the filter '''Routes & Sessions'''
#select the '''Session''' to be loaded and edited in '''Surveyor'''
#use the '''right-mouse-button''' to open the '''Command Menu'''
#select '''Open...''', then
#select '''Edit Asset in Surveyor'''
</td>
</tr>
</tr>
<tr>
<tr valign="top">
<td colspan="2">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
----</td>
<td>You can create your own '''Region''' with your preferred ground texture and other features - see the '''Trainz Wiki Page&#160;[[image:WikiLink.PNG|link=]]&#160;[[How to Create a Region Asset|How to Create a Region Asset]]''' for the details</td>
</tr>
</tr>
</table>
</table>
Both the '''Route''' and the '''Session''' will be loaded into '''Surveyor''' for editing.
</td>
</td>
</tr>
</tr>
</table>
</table>
<br>
<table width=1000>
<tr valign="top">
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;SD/HD Options&#160;</span></td>
</tr>
<tr valign="top">
<td>[[image:RouteEditDetailHD_S20.png‎|link=]]<br>


=='''Loading a Session into Driver From Surveyor'''==
This option, <span style="background-color: yellow;">available in '''Trainz Plus''' only</span>, allows you to set the route detail when working in '''HD resolution''' to the default '''HD''' (High Definition) or to a lower '''SD''' (Standard Definition) which is easier to work with over larger areas.<br>
To start '''Driver''' simply select a '''Session''' as described above in '''Loading an Existing Session''' and click the <span style="font-weight: 700; background-color: black; color: white; font-size: 15px;">&nbsp;DRIVE SESSION&nbsp;</span> button.<br>
 
[[image:DriverButtons.png|link=|alt=Driver Game]]<br>
 
This will load both the '''Session''' and the '''Route''' into '''Driver'''.<br>
 
You can save your "game play" in '''Driver''' at anytime. See '''[[file:PageLink.PNG|link=]]&nbsp;[[#Saving and Loading Sessions in Driver|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'''.<br>


<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:CMOpenSessionDriver.png|link=|Load a session from CM]]</td>
<td>
<td>
<table cellpadding=4 bgcolor=#ffffff>
<table width=500 bgcolor=#000000 cellpadding=2>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Steps.PNG|link=]]</td>
<td>
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br>
<table bgcolor=#ffffff cellpadding=2>
#in '''Content Manager''' select the filter '''Routes & Sessions'''
<tr valign="top">
#select the '''Session''' to drive
<td colspan=2>The distinction between these two options is:-</td>
#use the '''right-mouse-button''' to open the '''Command Menu'''
</tr>
#select '''Open...''', then
<tr valign="top">
#select '''Open Asset in Driver'''
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;HD&#160;</span></td>
</td>
<td>This is the full '''HD Mode''' where the minimum brush size is '''0.12m''' (12cm) - <span style="font-weight: 700; background-color:  yellow;">HD Mode is only available in Trainz Plus</span></td>
</tr>
<tr valign="top">
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;SD&#160;</span></td>
<td>This is a reduced '''HD Mode''' where the minimum brush size is '''2m'''</td>
</tr>
</tr>
<tr>
<tr valign="top">
<td colspan="2">
<td colspan=2>Both options are using '''HD''' resolution and have all the '''HD''' controls and features. Both <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;SD&#160;</span> and <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;HD&#160;</span> can be used in the same baseboard</td>
----</td>
</tr>
</tr>
</table>
</table>
The '''Session''' and its parent '''Route''' will be loaded into '''Driver''' and the simulation will be started.
</td>
</td>
</tr>
</tr>
</table>
</table>
 
<table width=500>
=='''Editing a Session'''==
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td colspan=2>The setting can be switched during editing without affecting or altering the existing terrain. For example:-</td>
<td>'''When a Session is loaded into Surveyor or a new Session is created for an existing Route, all the assets you add will be automatically placed into a Session Layer'''</td>
</tr>
</tr>
</table>
When you create a new '''Session''', or load an existing '''Session''', and start adding scenery assets in '''Surveyor''' they will automatically be placed into a '''Session Layer'''. See the '''Trainz Wiki Page [[image:WikiLink.PNG|link=]]&nbsp;[[How_to_Use_Layers|How to Use Layers]]''' for more details.<br>
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'''.<br>
There are also other changes that will be added to the '''Session Data'''.
<table width=1000>
<tr valign="top">
<tr valign="top">
<td width=350>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
----
<td>you can start editing the terrain using the '''HD Mode''' to give you the highest level of precision in one area of a baseboard</td>
You can edit the '''Session Characteristics''' at any time by selecting the '''Edit Session''' command from the '''Edit Menu''' or by simply pressing <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;R&nbsp;</span>.<br>
</tr>
This will bring up the '''Edit Session''' dialogue window which is more commonly called the '''Session Editor''' (shown below).<br>
For more details on editing a Session see the '''Trainz Wiki Page''' at '''[[image:WikiLink.PNG|link=]]&nbsp;[[How_to_Use_Session_Editor|The Session Editor]]'''.</td>
<td width=170>[[image:SessionEdit.png|link=|alt=Session edit]]</td>
<td>
<table bgcolor=#000000 width=480>
<tr valign="top">
<tr valign="top">
<td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<table cellpadding=4 bgcolor=#ffffb0 width=476>
<td>then switch to '''SD Mode''' to work in another area of the same (or a different) baseboard at a lower level of precision - which would be faster than using the '''HD Mode'''</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Session Characteristics:-'''</span><br>
<td>then switch back to '''HD Mode''' to continue working in the same, or another, high precision area</td>
----
*'''Name''' and '''Description'''
*'''Session Rules''' which control/set:-
**drivers and their consists
**driver commands
**time of day/night
**events
**and much, much more
</td>
</tr>
</table>
</td>
</tr>
</tr>
</table>
</table>
</td>
</td>
<td>
<table width=500 bgcolor=#000000>
<tr valign="top">
<td>
<table bgcolor=#ffffff>
<tr valign="top">
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps: To Switch Between HD and SD Modes at Any Time:-</span></td>
</tr>
</tr>
</table>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td width=650>[[image:EditSessionDialogue.png|link=|alt=Edit Session dialogue window]]</td>
<td>
<td>
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint1.JPG|link=]]</td>
<td>
<td>
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 '''&lt;kuid&gt;''' value</td>
<table>
<tr valign="top">
<td width=20>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the '''Main Menu''' [[image:EditMenu_S20.png|link=]]&#160;'''Edit Menu''' and select the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Edit&#160;Route...&#160;</span> option.<br><br>
The keyboard shortcut is <span style="font-weight: 700; font-size: 15px;"><span style="color: white; background-color: black;">&#160;Ctrl&#160;</span>&#160;+&#160;<span style="color: white; background-color: black;">&#160;E&#160;</span></span></td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint2.JPG|link=]]</td>
<td>[[image:DotPoint2.JPG|link=]]</td>
<td>You can edit the Session '''Description'''</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on either the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;SD&#160;</span> or the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;HD&#160;</span> button</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint3.JPG|link=]]</td>
<td>[[image:DotPoint3.JPG|link=]]</td>
<td>You can add, delete and edit the Session '''Rules'''</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the [[image:Tick.PNG|link=|alt=Tick]] icon to make the switch</td>
</tr>
</table>
</td>
</tr>
</tr>
</table>
</table>
</td>
</td>
<td>[[image:EditMenuOptions_S20.png|link=]]</td>
</tr>
</tr>
</table>
</table>
<table width=1000>
<tr valign="top">
<td width=350>
----
You can edit the '''Environment Controls''' of a Session by selecting the '''Edit Environment''' command from the '''Edit Menu'''.<br>
This will bring up the '''Edit Environment''' dialogue window, more commonly called the '''Environment Tools'''.<br>
For more details on editing the '''Environment''' see the '''Trainz Wiki Page''' at '''[[image:WikiLink.PNG|link=]]&nbsp;[[How_to_Use_Environment_Tools|The Environment Tools]]'''</td>
<td width=170>[[image:EnvironmentEditLaunch.png|link=|alt=Environment edit]]</td>
<td>
<table bgcolor=#000000 width=480>
<tr valign="top">
<td>
<table cellpadding=4 bgcolor=#ffffb0 width=476>
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Environment Controls:-</span><br>
----
*lighting conditions
*weather and cloud cover
*water color and water surface
*wind speed (for '''SpeedTree''' assets only)
*fog and snow
*season (by the date and latitude)
*world origin
*road traffic (on or off only)
</td>
</td>
</tr>
</tr>
Line 964: Line 775:
</table>
</table>
<br>
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepSaving"></span>&nbsp;</td>
<td width=629><span id="skipWorldView"></span>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
=='''The Surveyor World View'''==
<td width=75>[[image:NextUp.png|link=#stepLoadSession|alt=Next Up|Next Up]]</td>
</td>
<td width=75>[[image:NextDown.png|link=#stepExit|alt=Next Down|Next Down]]</td>
<td width=50>[[image:SkipDown.png|link=#skipDefaultGroundTexture|Skip Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
<td width=50>[[image:SkipUp.png|link=#skipNewRoute|Skip Up]]</td>
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->


='''Saving a Route and a Session'''=
<table width=1000 bgcolor=#000000 cellpadding=2>
 
'''Routes''' and '''Sessions''' are saved from the '''System Menu''' on the '''Surveyor''' screen.
 
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteSaveMenu.png|link=|alt=Save]]</td>
<td>
<td>
<table width=996 bgcolor=#ffffb0 cellpadding=2>
<tr valign="top">
<td width=25>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
----
The terms '''Grid Size''' and '''Grid Resolution''' when used in this document refer to the following:-
</td>
</tr>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px;">Grid Size:</span> - the size of the yellow grid squares shown in an untextured baseboard. The grid squares are always '''10m&#160;x&#160;10m''' in size regardless of the '''Working Scale''' (Real Scale, G Scale, HO Scale, etc) or the '''Working Units''' (metric or imperial). When a ruler object is used to measure the squares it will show their size using the selected '''Working Scale''' and '''Working Units'''</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px;">Grid Resolution:</span> - a measure of the '''level of detail''' that can be shown when using the '''Ground Height''' and '''Ground Texture''' brush tools.
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=10>[[image:RedDot10x10.png|link=]]</td>
<td>Selecting <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Save&nbsp;</span> or pressing <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;S&nbsp;</span> 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) and the '''Save''' command.<br><br></td>
<td>A '''10m Grid Resolution''' will allow the use of a brush of radius 10m without restrictions anywhere in the baseboard. Smaller brushes can be used but with restrictions that will increase as the brush size is reduced.</td>
</tr>
<tr valign="top">
<td width=10>[[image:RedDot10x10.png|link=]]</td>
<td>A '''5m Grid Resolution''' will allow the use of a brush of radius 5m without restrictions anywhere in the baseboard. Smaller brushes can be used but with restrictions that will increase as the brush size is reduced.</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=10>[[image:RedDot10x10.png|link=]]</td>
<td>Selecting <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Save As...&nbsp;</span> 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) and the '''Save As''' command.<br><br></td>
<td>A '''HD Grid Resolution''' will allow the use of a brush of radius as small as 0.12m (12cm) without any restrictions anywhere in the baseboard - <span style="font-weight: 700; background-color: yellow;">HD Grid Resolution is only available in Trainz Plus</span>.</td>
</tr>
</table>
</td>
</tr>
</tr>
</table>
</table>
Line 996: Line 828:
</table>
</table>
<br>
<br>
<table cellpadding=4 bgcolor=#ffffb0 width=1000> <!-- BEGIN Notes Table -->
<table width=1000>
<tr valign="top">
<td colspan=2>Depending on the '''Route Editor''' settings and the version of Trainz you are using, you may see or be affected by the following factors:-<br><br>
<span style="font-weight: 700; font-size: 15px;">Baseboards and Grid Squares:</span></td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td width=550>
<td><span style="font-size: 17px; font-weight: 700;">Notes on Saving:'''</span><br>
<table>
----
<table bgcolor=#ffffb0>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Routes''' that have been downloaded and installed from the '''DLS''' (freeware) or '''DLC''' (payware) can be edited and saved as new '''Routes'''. When they are saved they will be given a new '''<kuid>''' that will include your personal identity code, so they will become '''Your Content''' and can be found using the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;MY CONTENT&nbsp;</span> search option. The original '''Route''' will not be altered or replaced by your new version. You are allowed to copy (edit and save) purchased '''DLC Routes''' for your personal use only but they '''cannot be uploaded''' to the '''DLS'''.</td>
<td>Each '''Baseboard''' is always '''720m x 720m''' (2362.2ft x 2362.2ft) regardless of the '''Working scale''' and '''Working units''' you have selected</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Sessions''' that have been downloaded and installed from the '''DLS''' (freeware) or '''DLC''' (payware) can be edited and saved as new '''Sessions''' and will also become '''Your Content'''. The originals will not be replaced by your new version. You are allowed to copy (edit and save) purchased '''DLC Sessions''' for your personal use only but they '''cannot be uploaded''' to the '''DLS'''.<br>
<td>Baseboards without any applied ground texture will be covered with grid squares. Each yellow '''Grid Square''' is always '''10m x 10m''' (32.8ft x 32.8ft) regardless of the '''Working scale''' and '''Working units''' you have selected</td>
<span style="background-color: yellow; font-weight: 700; font-size: 15px;">&nbsp;Note:&nbsp;</span> If your copied '''Session''' was created using a '''DLS''' or '''DLC Route''' then it will still need the original '''DLS/DLC Route'''. If you delete the original '''Route''' then your '''Session''' will no longer work. This restriction does not apply for any new '''Session''' you create for a copied '''DLS/DLC Route'''. The new '''Session''' will be based on the copied '''Route''' and not the original.</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>&nbsp;</td>
<td colspan=2>But in both cases the distance measurement shown by a ruler object will depend on the '''Working scale''' and '''Working units''' selected</td>
<td>
</tr>
<table bgcolor=#ff0000>
<tr valign="top">
<tr valign="top">
<td>
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Grid Resolution:</span> See '''Notes:''' above</td>
<table bgcolor=#fcbcbc>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Cloned assets are subject to copyright laws and they remain the property of the original creator. You are allowed to clone DLC Routes and Sessions for your personal use only.</td>
<td>'''10m resolution''' - the default setting for new baseboards created using '''TRS19''' and '''TRS22''' <span style="font-weight: 700; font-size: 15px;">OR</span></td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''5m resolution''' - at '''4x''' the resolution of '''10m'''. You can have a mixture of '''10m''' and '''5m''' resolution baseboards in the same route <span style="font-weight: 700; font-size: 15px;">OR</span></td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Under no circumstances are you to upload cloned assets to the DLS or any 3rd party web site without the permission of the original creator
<td>'''HD (High Definition) resolution''' - at '''6400x''' the resolution of '''10m''' and '''1600x''' the resoltion of '''5m''' this resolution is <span style="background-color: yellow;">only available in '''Trainz Plus'''</span>. It is the default setting for new baseboards created using '''Trainz Plus''' and it is '''NOT''' recommended that '''HD''' baseboards be mixed with '''10m/5m''' baseboards in the same route</td>
</td>
</tr>
</tr>
</table>
<tr valign="top">
</td>
<td colspan=2>Baseboards can be converted between these resolution settings at any time</td>
</tr>
</tr>
</table>
<tr valign="top">
</td>
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Baseboard Altitude:</span></td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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''' - this is possible because they will all have different '''<kuid>''' values. This is why it is not a good idea to use '''Default''' as a '''Session''' name.</td>
<td>The altitude (in metres) of the first baseboard will depend on the '''Geographic region''' you have selected but the default value is '''0m'''</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Baseboard Texture:</span></td>
<td>Many scenery assets actually have their properties stored in the '''Session Data''' even when the assets themselves are in '''Route Layers'''. Editing the properties of these assets is considered to be a change to the '''Session''' and will result in a '''Save''' command requesting that the '''Session''' be saved as well as the '''Route'''. You can decide whether or not to save the '''Session'''.<br>
These assets include:-
*junction switches - the left/right switch direction is stored in the '''Session''' (but the switch '''default''' direction is stored in the '''Route''')
*industries - the commodities and quantities loaded/unloaded are stored in the '''Session'''
*industry enabled wagons - the commodities and quantities carried are stored in the '''Session'''
*consist locations - this is stored in the '''Session''' even if the consists are placed in the '''Route'''. See the '''Trainz Wiki Page [[image:WikiLink.PNG|link=]]&nbsp;[[How_to_Use_the_UDS_Interface|How to Use the UDS Interface]]''' for more details.
*named route objects - while the name is stored in the '''Route''', adding or changing the name is treated as a change to the '''Session'''</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>It is possible for '''Trainz''' to request that the '''Route''' and/or '''Session''' be saved when no obvious changes have occurred. This can happen when a '''Route/Session''' with an earlier asset build number has been loaded into '''Surveyor'''. For example - loading a '''Route''' with an asset build number of '''3.7''' (from '''TRS12 SP1''') into '''TRS19 SP3''' which uses asset build number '''4.8''' for all its '''Routes''' and '''Sessions'''.</td>
<td>The baseboard will be covered with a texture, such as grass or a grid pattern. This is set by the '''Geographic region''' and the selection made in the '''Ground''' option from the [[image:SurveyorDisplayIcon.png|link=]] '''Surveyor Display Menu''' - see '''[[image:PageLink.PNG|link=]]&#160;[[#skipDefaultGroundTexture|Default Baseboard Ground Texture]]''' below</td>
</tr>
</tr>
</table>
</table>
</td>
</td>
</tr>
</tr>
</table> <!-- END Notes Table -->
</table>
<br>
===<span style="color: white; background-color: green;">&#160;In Surveyor Classic (S10)&#160;</span>===


=='''Saving a New Route and Session'''==
<table width=1000>
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'''.
<table width=900>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteSARSaveNew.png|link=|alt=First Save]]</td>
<td>'''Surveyor Classic''' or '''S10''' is the version of Surveyor found in '''TRS19''', '''TRS19PE''' and '''TRS22'''. It is one of two versions of Surveyor available in '''TRS22PE''' and '''Trainz Plus'''.<br>
<td>[[image:RouteSARSaveAsNew.png|link=|alt=First Save As]]</td>
 
</tr>
In '''Surveyor Classic''' the baseboards are controlled using the '''Topology Tools'''. To open the tools fly-out either <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> the '''Topology Tool Tab''' or press the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;F1&#160;</span> key.<br>
<tr valign="top">
[[image:Route Baseboard Tools.png|link=|alt=Topology Tools]]
<td colspan=2>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.</td>
</td>
<td width=450>[[image:Route_Baseboard.png|link=|alt=First baseboard|450px]]</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
 
<table width=1000>
=='''Saving an Existing Route'''==
<tr valign="top">
<td>&#160;</td>
<td>The '''Key Topology Tools''', as shown in the diagram above, are:-</td>
</tr>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px;">Add New Baseboard</span> - <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> (it will stay active until another button is clicked) and then <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> 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</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px;">Delete Baseboard</span> - <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> (it will stay active until another button is clicked) and then <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> anywhere on a baseboard to delete that baseboard. You will get a warning dialogue window - <span style="font-weight: 700; background-color: yellow;">&#160;you CANNOT undo this operation to restore a deleted baseboard&#160;</span></td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px;">Grid Resolution</span> - a pop-out menu will give you a choice of '''10m''' (the default) or '''5m'''. The option for the '''HD resolution''' is <span style="background-color: yellow;">only available in '''Trainz Plus'''</span>. 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.
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>If you have loaded the '''Route''' only and not the '''Session''' and '''<u>HAVE NOT</u>''' edited any '''Session Data''' or '''Session Layers''', then selecting '''Save''' will produce the following '''Save Route Dialogue Window'''.</td>
<td>With a 10m resolution the smallest area in which you can set a height is 10m x 10m</td>
</tr>
</tr>
</table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteSARSaveExistingNoSession.png|link=|alt=Save Route with no Session]]<td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>
<td>With a 5m resolution that 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, <span style="font-weight: 700; background-color: yellow;">&#160;significantly larger route map files&#160;</span></td>
<table bgcolor=#eeeeee width=800>
<tr>
<td colspan="2">
----</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Gears.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br>
<td>With HD resolution (<span style="background-color: yellow;">in '''Trainz Plus''' only</span>) the smallest area ('''resolution''') in which you can set a height is 0.125m x 0.125m. This allows you to create even more accurate topology features but it has a penalty, <span style="font-weight: 700; background-color: yellow;">&#160;enormously larger route sizes&#160;</span> - on average '''5x''' or more larger than 10m resolution maps</td>
[[image:DotPoint1.JPG|link=]]&nbsp;Overwrite '''Route''' only. The '''default''' selection.<br>
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing route and:'''
::[[image:White_Select_Dot.png|link=]]&nbsp;'''Do not save session'''
::*the '''Route''' will be saved ('''overwritten''' using its current name) but no '''Session''' will be saved.
[[image:DotPoint2.JPG|link=]]&nbsp;Overwrite '''Route''' and create a new '''Session'''..
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing route and:'''
::[[image:White_Select_Dot.png|link=]]&nbsp;'''Create new session:'''
::*enter a name for the '''Session''' (the suggested name '''Default''' is '''NOT''' recommended).
::*the '''Route''' will be saved ('''overwritten''' using its current name).  
::*a new  '''Session''' will be created using the name you enter and it will be added to the '''Route'''.
::*because you did not originally load a '''Session''', the new '''Session''' will be saved with '''default''' values for all settings.
[[image:DotPoint3.JPG|link=]]&nbsp;Create new '''Route''' and a '''default Session'''.
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Save new route and session:'''
::*enter a new name for the '''Route'''. The '''Route''' will be saved with its new name.
::*the original '''Route''' will not be changed.
::*a new '''Session''' will be created using the name '''Default''' and it will be added to the new '''Route'''.
::*because you did not originally load a '''Session''', the new '''Session''' will be saved with the '''default''' values for all settings.
</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td colspan="2">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
----</td>
<td>Each new baseboard you add will have its resolution set to the selected value. You can have different baseboards set to each resolution - for example: baseboards used by the track set at '''5m''' and those further out at '''10m'''
This control is also used to change an existing baseboard from one resolution to the other.</td>
</tr>
</tr>
</table>
</table>
</td>
</td>
</tr>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px;">Advanced</span> - 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</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
<table>
<span id="BaseboardS20"></span>
===<span style="color: white; background-color: blue;">&#160;In Surveyor 2.0 (S20)&#160;</span>===
 
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>'''Surveyor 2.0''' or '''S20''' is an alternative version of Surveyor found in '''TRS22PE''' and '''Trainz Plus'''. '''Surveyor Classic''' is also available as an option in both '''TRS22PE''' and '''Trainz Plus'''.<br>
<td>If you have loaded the '''Route''' only and not the '''Session''' and '''<u>HAVE</u>''' edited '''Session Data''' or '''Session Layers''', then selecting '''Save''' will produce the following '''Save Route Dialogue Window'''.</td>
 
In '''Surveyor 2.0''' there is no separate '''Topology Tools''' fly-out. A single <span style="font-weight: 700; font-size: 15px; color: white; background-color: #797979;">&#160;Tools&#160;Palette&#160;</span> replaces all the separate tools "fly-outs" found in the original '''Surveyor Classic'''.</td>
</tr>
</tr>
</table>
</table>
<table>
<br>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteSARSaveExistingNewSession.png|link=|alt=Save Route with Session]]<td>
<td>[[image:S20_MarqueeTool.png|link=|alt=Marquee Tool]]</td>
<td>
<td>
<table bgcolor=#eeeeee width=800>
<table>
<tr>
<tr valign="top">
<td colspan="2">
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps: To Add New Baseboards:-</span></td>
----</td>
</tr>
<tr valign="top">
<td width=20>[[image:DotPoint1.JPG|link=]] </td>
<td>select the [[image:S20_MarqueeToolIcon.png|link=|20px]]&#160;'''Marquee Tool''' from the <span style="font-weight: 700; font-size: 15px; color: white; background-color: #797979;">&#160;Tools&#160;Palette&#160;</span> (or press the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;F&#160;</span> key).</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Gears.PNG|link=]]</td>
<td colspan=2>Note that in '''S20''' you can add and delete multiple baseboards in a single step, not just one-at-a-time.</td>
<td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br>
[[image:DotPoint1.JPG|link=]]&nbsp;Overwrite '''Route''' and create a new '''Session'''. The '''default''' selection.
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing route and:'''
::[[image:White_Select_Dot.png|link=]]&nbsp;'''Create new session:'''
::*enter a name for the '''Session''' (the suggested name '''Default''' is '''NOT''' recommended).
::*the '''Route''' will be saved ('''overwritten''' using its current name).
::*a new  '''Session''' will be created using the name you enter and it will be added to the '''Route'''. The new '''Session''' will have the settings and changes you have made.
[[image:DotPoint2.JPG|link=]]&nbsp;Overwrite '''Route''' only.<br>
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing route and:'''
::[[image:White_Select_Dot.png|link=]]&nbsp;'''Do not save session'''
::*the '''Route''' will be saved ('''overwritten''' using its current name) but no '''Session''' will be saved.
::*the changes you have made to the '''Session''' will be lost.
[[image:DotPoint3.JPG|link=]]&nbsp;Create new '''Route''' and a '''default Session'''.
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Save new route and session:'''
::*enter a new name for the '''Route'''. The '''Route''' will be saved with its new name.
::*the original '''Route''' will not be changed.
::*a new '''Session''' will be created using the name '''Default''' and it will be added to the new '''Route'''. The new '''Session''' will have the settings and changes you have made.
</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td colspan="2">
<td>[[image:DotPoint2.JPG|link=]] </td>
----</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click and Drag</span> (using the Left mouse button) to draw out an area where the new baseboards will be added. This area can include the current baseboard.</td>
</tr>
</tr>
</table>
</table>
Line 1,160: Line 974:
</tr>
</tr>
</table>
</table>
<br>


=='''Saving an Existing Route and Session'''==
<table width=1000>
<tr valign="top">
<td colspan=2>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.</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint3.JPG|link=]] </td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the '''Context Menu''' icon or press the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;T&#160;</span> key to open up the '''Marquee Context Menu'''.<br>
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:S20_MarqueeContextTool.png|link=]]</td>
<td>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'''.</td>
<td>[[image:S20_MarqueeDrawnArea.png|link=|alt=Marquee drawn area]]</td>
</tr>
</table>
</td>
</tr>
</tr>
</table>
</table>
<table>
 
<table width=1000 bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteSessionSARSaveExisting.png|link=|alt=Save Route and Session]]<td>
<td>
<td>
<table bgcolor=#eeeeee width=800>
<table width=996 bgcolor=#ffffff cellpadding=2>
<tr>
<tr valign="top">
<td colspan="2">
<td colspan=2>The main '''Marquee Baseboard Operations''', as shown in the '''Marquee Context Menu''' above, are:-</td>
----</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Gears.PNG|link=]]</td>
<td>
<td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br>
<table>
[[image:DotPoint1.JPG|link=]]&nbsp;Overwrite '''Route''' and '''Session'''. The '''default''' selection.
<tr valign="top">
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing route and:'''
<td width=250><span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Set Marquee to Brush Height&#160;</span></td>
::[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing session:'''
<td width=546>to create new baseboards in the selected area. The '''Brush Height''' is the value stored in the <span style="font-weight: 700; font-size: 15px; color: gold; background-color: black;">&#160;Height&#160;</span> setting in the <span style="font-weight: 700; font-size: 15px; color: white; background-color: #797979;">&#160;Tool&#160;Options&#160;Palette&#160;</span>. 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</td>
::*both the '''Route''' and the '''Session''' will be saved ('''overwritten''' using their current names).
<td width=200 rowspan=3>[[image:S20_ToolHeight.png|link=|alt=Tool Height]]</td>
[[image:DotPoint2.JPG|link=]]&nbsp;Overwrite existing '''Route''' and create a new '''Session'''.
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing route and:'''
::[[image:White_Select_Dot.png|link=]]&nbsp;'''Create new session:'''
::*enter a new name for the '''Session'''.
::*the '''Route''' will be saved ('''overwritten''' using its current name).
::*a new '''Session''' will be created using the name you enter and it will be added to the existing '''Route'''.
::*the original '''Session''' will not be changed.
[[image:DotPoint3.JPG|link=]]&nbsp;Overwrite '''Route''' only.<br>
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing route and:'''
::[[image:White_Select_Dot.png|link=]]&nbsp;'''Do not save session'''
::*the '''Route''' will be saved ('''overwritten''' using its current name) but no '''Session''' will be saved.
::*the changes you have made to the '''Session''' will be lost.
[[image:DotPoint4.JPG|link=]]&nbsp;Create a new '''Route''' and a new '''Session'''.
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Save new route and session:'''
::*enter a new name for the '''Route'''.
::*the '''Route''' will be saved with its new name.
::*a new '''Session''' will be created using the same name as the original '''Session''' and it will be added to the new '''Route'''.
::*the original '''Session''' and '''Route''' will not be changed.
</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td colspan="2">
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Convert Baseboards to&#160;</span></td>
----</td>
<td>a pop-out menu will give the options, '''10m''', or '''5m''' or (for <span style="background-color: yellow;">'''Trainz Plus''' only</span>) '''HD resolution'''. 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.
<table>
<tr valign="top">
<td>
<table bgcolor=#fcbcbc cellpadding=2>
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td><span style="font-size: 15px; font-weight: 700;">WARNING:</span><br>
It is '''NOT RECOMMENDED''' that you mix '''HD resolution''' baseboards with '''5m''' or '''10m''' baseboards in the same route. It should be '''ALL HD''' or none.<br>
See [[image:WikiLink.PNG|link=]]&#160;'''[[How to Use S20 Tools#Upgrading a Route to HD|S20 Tools - Upgrading a Route to HD]]''' for more details.</td>
</tr>
</tr>
</table>
</table>
Line 1,213: Line 1,024:
</tr>
</tr>
</table>
</table>
<table>
</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Delete Baseboards in Marquee&#160;</span></td>
<td>If you have loaded a '''Route''' and a '''Session''' and have edited the '''Session''' ('''Data''' or '''Layers''') only and not the '''Route''' then selecting '''Save''' will produce the following '''Save Session Dialogue Window'''.</td>
<td>to delete the selected baseboards. The '''Undo''' command <span style="font-weight: 700; font-size: 15px;"><span style="color: white; background-color: black;">&#160;Ctrl&#160;</span>&#160;+&#160;<span style="color: white; background-color: black;">&#160;Z&#160;</span></span> will restore the deleted baseboards</td>
</tr>
</tr>
</table>
</table>
<table>
<tr valign="top">
<td>[[image:SessionSARSaveExistingNoRoute.png|link=|alt=Save Session]]<td>
<td>
<table bgcolor=#eeeeee width=800>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[image:Gears.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br>
[[image:DotPoint1.JPG|link=]]&nbsp;Overwrite the '''Session''' only. The '''default''' selection.
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Overwrite existing session'''
:*the '''Session''' will be saved ('''overwritten''' using its current name).
:*the original '''Route''' will not be changed.
[[image:DotPoint2.JPG|link=]]&nbsp;Create a new '''Session'''.
:[[image:White_Select_Dot.png|link=]]&nbsp;'''Create new session:'''
:*you can enter a new name for the '''Session''' or use the suggested name which will include the date, time and '''Session''' runtime.
:*a new '''Session''' will be created using the name you enter and it will be added to the existing '''Route'''.
:*the original '''Route''' and '''Session''' will not be changed.
</td>
</td>
</tr>
<tr valign="top">
<td colspan="2">
----</td>
</tr>
</tr>
</table>
</table>
Line 1,251: Line 1,038:
</table>
</table>
<br>
<br>
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=629><span id="skipDefaultGroundTexture"></span>
=='''Default Baseboard Ground Texture'''==
</td>
<td width=50>[[image:SkipDown.png|link=#skipLoadOldRoute|Skip Down]]</td>
<td width=50>[[image:SkipUp.png|link=#skipWorldView|Skip Up]]</td>
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
</tr>
</table> <!-- END Nav Buttons Table -->


=='''Saving a Route and Session Using the UDS'''==
<table width=1000>
'''TRS19 Platinium Edition''', '''Trainz Plus''' and '''TRS22''' have an additional feature, the '''UDS''' ('''U'''nified '''D'''river '''S'''urveyor) Interface, that allows you to quickly switch from '''Driver''' to '''Surveyor''' and back to '''Driver''' again without having to restart the '''Session''' from the start. You can edit a '''Route''' and '''Session''' while in '''Surveyor''' and then switch back to '''Driver''' to continue the '''Session''' where you left it.<br>
<tr>
 
<td colspan=2>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).</td>
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 new states. See the '''Trainz Wiki Page [[image:WikiLink.PNG|link=]]&nbsp;[[How_to_Use_the_UDS_Interface|How to Use the UDS Interface]]''' for more details. <br>
 
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 '''Session''' before switching back into '''Driver''' mode. <br>
 
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
<td>Using '''Driver Mode''' involves driving consists (either manually or through the AI) and activating rules. '''These will change the Session Data'''</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
<td width=360>[[image:MainMenuSetGroundTexture.png|link=]]</td>
<td>'''Overwriting the Session will save changes to the consist locations and the Session Rules'''</td>
<td>
</tr>
<table bgcolor=#000000 cellpadding=2>
</table>
<br>
<table bgcolor=#000000 width=900>
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#ffffb0>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<td colspan=2><span style="font-weight: 700; font-size: 15px;;">Steps: To Disable the Current Default Ground Texture (Easiest Method):-</span></td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
<td width=20>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Note:'''</span><br>
<td>open the [[image:SurveyorDisplayIcon.png|link=]] '''Surveyor Display Menu'''</td>
----
An important change that has been introduced by the '''UDS''' is that train vehicle '''placement''' is now saved as part of the '''Session''', even if those vehicles have been placed in '''Route Layers'''.
</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td colspan=2>
<td>[[image:DotPoint2.JPG|link=]]</td>
<table bgcolor=#ffffe0>
<td>select the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Ground&#160;</span> option</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[file:PencilTips.PNG|link=]]</td>
<td>[[image:DotPoint3.JPG|link=]]</td>
<td>For this reason, it is '''<u>strongly recommended</u>''' that all consists be placed into a '''Session Layer''' and become part of a '''Session''' instead of the '''Route'''
<td>select the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Grid&#160;</span> sub-option. This will use the current grid texture.</td>
</td>
</tr>
</tr>
</table>
</table>
Line 1,294: Line 1,083:
</table>
</table>
</td>
</td>
</tr>
<tr>
<td colspan=2>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.</td>
</tr>
</tr>
</table>
</table>
<br>
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'''.<br>


<span style="font-size: 17px;"><span style="background-color: yellow; font-weight: 700">&nbsp;Unless you have a particular reason for overwriting the original Session </span>&nbsp;then the '''recommended''' save options are:-</span><br>
<table bgcolor=#000000 width=1000 cellpadding=2>
<table width=900>
<tr valign="top">
<tr valign="top">
<td colspan=2>[[Image:line740.png|link=]]</td>
<td>
</tr>
<table bgcolor=#ffffb0 width=996 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Option&nbsp;</span>[[image:DotPoint1.JPG|link=]]&nbsp;<span style="font-weight: 700; font-size: 17px;">Do not save session</span></td>
<td width=25>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:</span><br>
----
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.
</td>
</tr>
</tr>
<tr valign="top">
</table>
<td width=20>&nbsp;</td>
<td>[[image:UDS-DoNotSaveSession.png|link=]]<br>
This will only save the '''Route''' using its existing name. This will save any edits that you have made to the '''Route''' but not to the '''Session'''.<br>
</td>
</td>
</tr>
</tr>
</table>
<br>
<table cellpadding=2 bgcolor="Aquamarine">
<tr valign="top">
<tr valign="top">
<td colspan=2>[[Image:line740.png|link=]]</td>
<td width=50>[[image:LinkWiki.PNG|link=]]</td>
</tr>
<td>
Information on creating and editing '''Region''' assets can be found on the '''Trainz Wiki''' at:-
<table>
<tr valign="top">
<tr valign="top">
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Option&nbsp;</span>[[image:DotPoint2.JPG|link=]]&nbsp;<span style="font-weight: 700; font-size: 17px;">Create new session</span></td>
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
<td>'''[[How_to_Create_a_Region_Asset|How to Create a Region Asset]]'''
</td>
</tr>
</tr>
<tr valign="top">
</table>
<td width=20>&nbsp;</td>
<td>[[image:UDS-CreateNewSession.png|link=]]<br>
This will save the '''Route''' using its existing name. It will also save the '''Session''' using a new name you enter in the text box below the option ('''Stage 3''' in the example shown). The original '''Session''' will not be altered. This is useful when you want to test out changes to consists, industry settings, Rules, driver commands, etc but do not want to destroy the original '''Session'''.<br>
</td>
</td>
</tr>
<tr valign="top">
<td colspan=2>[[Image:line740.png|link=]]</td>
</tr>
</tr>
</table>
</table>
If you have have '''NOT''' edited anything while in '''Surveyor''' and select <span style="font-weight: 700; color: white; background-color: black; font-size: 15px;">&nbsp;Save&nbsp;</span> 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 <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;S&nbsp;</span> while in '''Driver'''.<br>
[[image:RouteSARSaveDriverSession.png|link=|alte=Save Driver Session]]<br>
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.
<br>
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepExit"></span>&nbsp;</td>
<td width=629><span id="skipLoadOldRoute"></span>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
=='''Loading an Existing Route'''==
<td width=75>[[image:NextUp.png|link=#stepSaving|alt=Next Up|Next Up]]</td>
</td>
<td width=75>[[image:NextDown.png|link=#stepCloning|alt=Next Down|Next Down]]</td>
<td width=50>[[image:SkipDown.png|link=#skipLoadRouteCM|Skip Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
<td width=50>[[image:SkipUp.png|link=#skipDefaultGroundTexture|Skip Up]]</td>
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->


='''Exiting Surveyor'''=
<table width=1000 bgcolor=#000000 cellpadding=2>
If you exit '''Surveyor''' after editing without saving then you will be prompted to '''Save'''.<br>
<tr valign="top">
<table>
<td>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<tr valign="top">
<td align="center"><span style="font-weight: 700;">Unsaved <span style="color: white; background-color: black;">&nbsp;Route&nbsp;</span></span></td>
<td width=35>[[image:Information.png|35px|link=]]</td>
<td align="center"><span style="font-weight: 700;">Unsaved <span style="color: white; background-color: black;">&nbsp;Session&nbsp;</span></span></td>
<td>When you load an existing '''Route''' without also loading a '''Session''', a new default '''Session''' will be created for it. Sessions contain specific data that are not found in routes. See [[image:PageLink.PNG|link=]]&#160;'''[[#What is a Session?|What is a Session?]]''' below.<br>
</tr>
When you save the route you will be given the opportunity to save the new default session as well. If you have not added anything to the session then saving it is optional.
<table bgcolor=#fcbcbc cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteSessionExitRouteSave.png|link=|alt=Exit Route Save]]</td>
<td>[[image:Stop.PNG|link=]]</td>
<td>[[image:RouteSessionExitSessionSave.png|link=|alt=Exit Session Save]]</td>
<td><span style="font-size: 15px; font-weight: 700;">WARNING:</span><br>
If you have added anything to the '''session-layer''' or edited any session data (e.g. the products carried by a wagon) and do not save the '''Session''' as well as the '''Route''' then that data will be lost. See [[image:PageLink.PNG|link=]]&#160;'''[[#Saving_a_Route_and_a_Session|Saving a Route and Session]]''' below for more information.</td>
</tr>
</tr>
</table>
</table>
<table>
</td>
<tr valign="top">
</tr>
<td>[[image:DotPoint.JPG|link=]]</td>
</table>
<td>Selecting <span style="font-weight: 700; color: white; background-color: black; font-size: 15px;">&nbsp;Don't Save&nbsp;</span> will exit '''Surveyor''' without saving. Any changes you have made will be lost.</td>
</td>
</tr>
</tr>
</table>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>You must first find and select the route to load from those already installed. At the top of the '''Driver/Surveyor''' screen the search options are shown as a set of buttons, the first 3 are drop down lists and the last is a text entry box.</td>
<td>Selecting <span style="font-weight: 700; color: white; background-color: black; font-size: 15px;">&nbsp;Save&nbsp;</span> will exit '''Surveyor''' after saving. You will be prompted to select what to save as described in the section '''[[file:PageLink.PNG|link=]]&nbsp;[[#Saving a Route and a Session|Saving a Route and a Session]]''' above</td>
</tr>
</tr>
</table>
[[image:RouteSearchButtons.png|link=|alt=Route Search]]
<table width=720>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=260>[[image:SelectRouteMenu.png|link=|alt=Route List]]</td>
<td>Selecting <span style="font-weight: 700; color: white; background-color: black; font-size: 15px;">&nbsp;Cancel&nbsp;</span> will cancel the save command and return you to '''Surveyor'''.</td>
<td width=240>[[image:SelectSourceMenu.png|link=|alt=Source List]]</td>
<td width=210>[[image:SelectRegionMenu.png|link=|alt=Region List]]</td>
</tr>
</tr>
</table>
</table>
<br>
 
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000>
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepCloning"></span>&nbsp;</td>
<td>'''Type:'''</td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;ROUTES&#160;</span> is the default selection. No need to change this.</td>
<td width=75>[[image:NextUp.png|link=#stepExit|alt=Next Up|Next Up]]</td>
<td width=75>[[image:NextDown.png|link=#stepGames|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</tr>
</table> <!-- END Nav Buttons Table -->
='''Cloning a Route/Session'''=
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>'''Source:'''</td>
<td>A '''Clone''' is an exact or duplicate copy of an asset. '''Routes''' and '''Sessions''' can be cloned</td>
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;PURCHASED&#160;</span> is the default selection, Click and change to <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;MY CONTENT&#160;</span> for a route you have created (or already modified) or to <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;INSTALLED&#160;</span> for one you have downloaded from the '''DLS'''.</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>'''Region:'''</td>
<td>Cloned '''Routes''' and '''Sessions''' can be edited and saved as '''Your Content'''</td>
<td><span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;ALL&#160;</span> 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.</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>'''Search:'''</td>
<td>Cloned '''DLC Routes''' and '''Sessions''' <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;CANNOT&nbsp;</span> be uploaded to the '''DLS'''</td>
<td>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.</td>
</tr>
</tr>
</table>
</table>
<br>
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.<br>


<table bgcolor=#ff0000 width=900>
<table width=1000>
<tr valign="top">
<td>
<table bgcolor=#fcbcbc>
<tr valign="top">
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>This will produce a display of thumbnails at the bottom of the screen.</td>
<td>'''Cloned assets are subject to copyright laws and they remain the property of the original creator. You are allowed to clone DLC Routes and Sessions for your personal use only.</td>
</tr>
</tr>
</table>
<br>
[[image:RouteSelectExisting.png|link=|alt=Existing Routes]]
<table width=1000>
<tr valign="top">
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the thumbnail for the route you want to load, then <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&#160;EDIT ROUTE&#160;</span> button to load the route into '''Surveyor'''.</td>
<td>'''Under no circumstances are you to upload cloned assets to the DLS or any 3rd party web site without the permission of the original creator
</td>
</tr>
</tr>
</table>
</table>
</td>
 
</tr>
[[image:RouteButtonsEdit.png|link=|alt=Edit Route]]
</table>
<br><br>
<br>
<table bgcolor=#000000 cellpadding=2 width=1000>
<table bgcolor=#000000 width=900> <!-- BEGIN Notes Table -->
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#ffffb0>
<table bgcolor=#ffffb0 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes on Cloning:'''</span><br>
<td><span style="font-size: 17px; font-weight: 700;">Notes: Routes and Sessions - An Endless Source of Confusion</span>
----
----
<table bgcolor=#ffffb0>
<table>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Routes''' that have been downloaded and installed from the '''DLS''' (freeware) or '''DLC''' (payware) can be saved (cloned) as new '''Routes'''. When they are cloned they will be given a new '''<kuid>''' that will include your personal identity code, so they will become '''Your Content''' and can be found using the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;MY CONTENT&nbsp;</span> search option. The original '''Routes''' will not be altered or replaced by your clones. You are allowed to clone purchased '''DLC Routes''' for your personal use only but they '''cannot be uploaded''' to the '''DLS'''.</td>
<td>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</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Sessions''' that have been downloaded and installed from the '''DLS''' (freeware) or '''DLC''' (payware) can be cloned as new '''Sessions''' and will also become '''Your Content'''. The original '''Sessions''' will not be altered or replaced by your clones. You are allowed to clone purchased '''DLC Sessions''' for your personal use only but they '''cannot be uploaded''' to the '''DLS'''.<br>
<td>You can easily move most scenery objects from a session into a route if needed - see the Trainz Wiki Page '''[[image:WikiLink.PNG|link=]]&#160;[[How_to_Use_Bulk_Asset_Update/Replace_Tool|How to Use the Bulk Asset Update/Replace Tool]]''' for more details</td>
<span style="background-color: yellow; font-weight: 700; font-size: 15px;">&nbsp;Note:&nbsp;</span> If your cloned '''Session''' was created using a '''DLS''' or '''DLC Route''' then it will still need the original '''Route'''. If you delete the original '''Route''' then your cloned '''Session''' will no longer work. This restriction does not apply to any new '''Session''' you create for a cloned '''DLS/DLC Route'''. The new '''Session''' will be based on the cloned '''Route''' and not the original. Both will be classified as '''Your Content'''.
</td>
</tr>
</tr>
</table>
</table>
Line 1,442: Line 1,237:
</tr>
</tr>
</table>
</table>
 
<br>
=='''Using Surveyor'''==
<table width=1000> <!-- BEGIN Nav Buttons Table -->
'''Routes''' and '''Sessions''' that have been loaded into '''Surveyor''' can be cloned using the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Save As...&nbsp;</span> command from the '''Surveyor''' <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;System Menu&nbsp;</span><br>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteSaveAsMenu.png|link=]]</td>
<td width=629><span id="skipLoadRouteCM"></span>
<td>[[image:CloneSaveAs.png|link=]]</td>
=='''Loading a Route Into Surveyor From Content Manager'''==
</td>
<td width=50>[[image:SkipDown.png|link=#skipLoadShutdown|Skip Down]]</td>
<td width=50>[[image:SkipUp.png|link=#skipLoadOldRoute|Skip Up]]</td>
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
</tr>
</table> <!-- END Nav Buttons Table -->
 
<table width=1000>
<tr valign="top">
<td>'''Trainz''' provides a shortcut that allows you to load an existing route directly into '''Surveyor''' for editing from '''Content Manager'''.</td>
</tr>
</tr>
</table>
</table>
Enter a new name or edit the original name (as shown above) for your cloned '''Route''' or '''Session'''.<br>
<br>
 
<table width=1000>
<table bgcolor=#000000 width=900>
<tr valign="top">
<td>[[image:CMOpenRouteSurveyor.png|link=|Load a route from CM]]</td>
<td>
<table bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#ffffb0>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px;">Steps: To Load a Route from Content Manager:-</span>
<td><span style="font-size: 17px; font-weight: 700;">Notes:</span><br>
----
<table>
<table>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=20>[[image:DotPoint1.JPG|link=]]</td>
<td>If the first option ([[image:White_Select_Dot.png|link=]]&nbsp;'''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 you do not want to keep the original '''Route''' then it can be safely deleted, which will also delete the original '''Session''' but the new cloned '''Route''' and '''Session''' will remain.
<td>in '''Content Manager''' select the filter '''Routes & Sessions'''</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint2.JPG|link=]]</td>
<td>identify the route to be edited</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint3.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Right Click</span> on the route to open its '''Command Menu'''</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint4.JPG|link=]]</td>
<td>select '''Open...''', then select '''Edit Asset in Surveyor'''
</td>
</td>
</tr>
</tr>
<tr valign="top">
</table>
<td>[[image:DotPoint.JPG|link=]]</td>
<td>If the second option ([[image:White_Select_Dot.png|link=]]&nbsp;'''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'''. But it is safe to delete the original '''Session''' if you no longer need it.
</td>
</td>
</tr>
</tr>
Line 1,479: Line 1,296:
</tr>
</tr>
</table>
</table>
=='''Using Content Manager'''==
<span style="color: white; background-color: black; font-weight: 700; font-size: 17px;">&nbsp;1. Select the Route or Session to Clone&nbsp;</span>
<br>
<br>
<table>
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<td width=629><span id="skipLoadShutdown"></span>
=='''Loading After an Unexpected Shutdown'''==
</td>
<td width=50>[[image:SkipDown.png|link=#skipEditRoute|Skip Down]]</td>
<td width=50>[[image:SkipUp.png|link=#skipLoadRouteCM|Skip Up]]</td>
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
</tr>
</table> <!-- END Nav Buttons Table -->
 
<table width=1000>
<tr valign="top">
<td colspan=2>If you select a route for loading after an unexpected shutdown of '''Trainz''' then any route (or route and session) that was open and running in '''Trainz Surveyor''' or '''Driver''' will be left marked as '''Open for Edit'''. When you attempt to load this route into '''Surveyor''' or '''Driver''' you will see a message listing the route and session (if any) that were affected.</td>
</tr>
<tr valign="top">
<td>[[image:RouteLoadAfterCTD.png|link=|alt=Load after CTD]]</td>
<td>The message is saying that the assets in the list '''may have been''' changed since the last time you loaded them and exited '''Trainz''' normally. For example if you had been editing the route and/or session and had experienced a crash to the desktop or had used Windows '''Task Manager''' to terminate the program.<br><br>
<table bgcolor=#000000 width=620>
<tr valign="top">
<tr valign="top">
<td>[[image:RouteClone.png|link=|alt=Cloning a route]]</td>
<td>
<td>
<table cellpadding=4 bgcolor=#ffffff>
<table cellpadding=2 bgcolor=#ffffb0 width=616>
<tr>
<tr valign="top">
<td colspan="2">
<td>[[image:NotePad.PNG|link=]]</td>
----</td>
<td><span style="font-size: 17px; font-weight: 700;">Note:'''</span>
----
A similar message will appear when you load a '''Game''' (see '''[[image:PageLink.PNG|link=]]&#160;[[#skipLoadDriverGames|Loading Games]]''' below) after editing the original route or session that was used to create the '''Game'''.<br>
 
It is possible that the changes you have made may affect the operation of the saved game.</td>
</tr>
</tr>
<tr valign="top">
</table>
<td>[[image:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br>
#In '''Content Manager''' select the filter '''Routes & Sessions'''
#select the '''Route''' or '''Session''' to be cloned
#either
#*from the '''Content Menu''' select '''Clone''' OR
#*press <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;D&nbsp;</span>
</td>
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</tr>
</table>
</table>
Line 1,511: Line 1,338:
</table>
</table>
<br>
<br>
A '''Task Window''' will open to display the result.<br>
<table width=1000>
[[image:RouteCloneTask.png|link=|alt=Clone task completed]]<br>
<tr valign="top">
 
<td>The options you will see are:-</td>
In the image above the original Route has been cloned and given a new '''<kuid>''' value.<br>
</tr>
</table>
<br>
<br>
The newly cloned Route will be shown in '''Content Manager''' as a '''New Asset''' that is '''Open for Editing'''.<br>
<table bgcolor=#000000 width=1000 cellpadding=2>
 
<tr valign="top">
<table cellpadding=4 bgcolor=#ffffff>
<td>
<tr>
<table bgcolor=#ffffff width=996 cellpadding=2>
<td colspan="2">
<tr valign="top">
----</td>
<td width=125><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Use changes&#160;</span></td>
<td>Use the edited/changed versions that are in the open database assets. <span style="font-weight: 700; font-size: 15px; background-color: yellow;">&#160;Note:&#160;</span> there is a possibility that these assets may have been damaged during the shutdown and may be corrupted</td>
</tr>
<tr valign="top">
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Revert changes&#160;</span></td>
<td>Ignore the edited/changed versions and load the previous versions instead</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Steps.PNG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Cancel&#160;</span></td>
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br>
<td>Cancel the Load and return to the '''Surveyor/Driver''' menu screen</td>
#close the '''Task Window'''<br>
#select the '''Open for Editing''' filter.
</td>
</tr>
</tr>
<tr>
<tr>
<td colspan="2">
<td colspan=2>You could also use the '''Content Manager''' program (select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Manage Content&#160;</span> 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.</td>
----</td>
</tr>
</table>
</td>
</tr>
</tr>
</table>
</table>
[[image:RouteCloneNewAsset.png|link=|alt=New Asset]]
<br><br>
<span style="color: white; background-color: black; font-weight: 700; font-size: 17px;">&nbsp;2. Rename the Clone (an Optional Step)&nbsp;</span>
<br>
<br>
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.<br>
<table width=1000> <!-- BEGIN Nav Buttons Table -->
<table cellpadding=4 bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:Steps.PNG|link=]]</td>
<td width=629><span id="skipEditRoute"></span>
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br>
=='''Editing a Route'''==
#right mouse click the '''New Asset'''.
#select '''Open...'''
#select '''Edit Config File Text'''.
The config.txt file will open in your default text editor. You can then edit both the '''Title''' (username) and the '''Description''' of the Route or Session.
#locate the line that starts with '''username'''.
#edit the text on that line between the '''Quote''' (") marks (but do not delete the quote marks) to change it to the new name of this Route/Session.
#locate the line that starts with '''description'''.
#edit the text on that line between the '''Quote''' (") marks (but do not delete the quote marks) to edit the description of this Route/Session.
#save (usually <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;S&nbsp;</span>)
#exit the text editor.
</td>
</td>
<td width=50>[[image:SkipDown.png|link=#skipSetRouteTerrain|Skip Down]]</td>
<td width=50>[[image:SkipUp.png|link=#skipLoadShutdown|Skip Up]]</td>
<td width=46>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
<td width=75>&#160;</td>
</tr>
</tr>
<tr>
</table> <!-- END Nav Buttons Table -->
<td colspan="2">
 
----</td>
<table width=1000 bgcolor="lightcyan" cellpadding=2>
<tr valign="top">
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
<td>'''When a Route is loaded or a new Route is created all the assets you add will be automatically placed into a Route Layer'''</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
<span style="color: white; background-color: black; font-weight: 700; font-size: 17px;">&nbsp;3. Submit the Clone (a Necessary Step)&nbsp;</span>
<table width=1000>
<br>
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>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 '''[[image:WikiLink.PNG|link=]]&#160;[[How_to_Use_Layers|How to Use Layers]]''' for more details.<br><br>
<td>When submitted a cloned '''DLC''' Route or Session will be described as '''Payware, Modified'''</td>
 
</tr>
Any ground textures, effect layers (e.g. TurfFX, Water, Clutter) you add, or terrain changes (including new baseboards) you make, will be added to the '''Route Data'''.</td>
</table>
<table cellpadding=4 bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[image:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br>
#right mouse click the '''New Asset'''.
#select '''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 than it should appear using its new name.
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</tr>
</table>
</table>
<br>
<br>
<table bgcolor=#000000 width=900>
<table bgcolor=#ff0000 width=1000>
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#ffffb0>
<table bgcolor=#fcbcbc>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>[[image:Stop.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
----
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 <span style="background-color: black; color: white; font-weight: 700;">&nbsp;MY CONTENT&nbsp;</span> '''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.
<table>
<tr valign="top">
<td>[[image:RouteEdit.png|link=|alt=Route edit]]</td>
<td>
<td>
Load the cloned Route or Session into '''Surveyor''', then
<span style="font-weight: 700; font-size: 15px;">WARNING: Do not edit track in a Route that is occupied by consists in any of the Sessions based on the Route</span><br>
*to rename a '''Route''' open the '''Edit''' menu and select '''Edit Route''', or press <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;E&nbsp;</span> - see [[image:PageLink.PNG|link=]]&nbsp;'''[[#Editing a Route|Editing a Route]]''' above
 
*to rename a '''Session''' open the '''Edit''' menu and select '''Edit Session''', or press <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;R&nbsp;</span> - see [[image:PageLink.PNG|link=]]&nbsp;'''[[#Editing a Session|Editing a Session]]''' above
'''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'''.<br>
Both will also allow you to edit the '''Name''' and '''Description''' of the cloned '''Route/Session'''.
 
</td>
<span style="font-size: 15px; font-weight: 700;">Prevention:</span><br>
</tr>
 
</table>
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.
</td>
</td>
</tr>
</tr>
Line 1,621: Line 1,418:
</table>
</table>
<br>
<br>
<table> <!-- BEGIN Nav Buttons Table -->
<table width=1000>
<tr valign="top">
<td>
<table width=520 bgcolor=#000000 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td width=729><span id="stepGames"></span>&nbsp;</td>
<td>
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
<table bgcolor=#ffffb0 cellpadding=2>
<td width=75>[[image:NextUp.png|link=#stepCloning|alt=Next Up|Next Up]]</td>
<td width=75>[[image:NextDown.png|link=#stepDeleting|alt=Next Down|Next Down]]</td>
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
</tr>
</table> <!-- END Nav Buttons Table -->
 
='''Saving and Loading Driver Games in Driver'''=
=='''Saving Driver Games'''==
<table cellpadding=4 bgcolor=#c1e7e7>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td width=25>[[image:NotePad.PNG|link=]]</td>
<td>'''Driver Games (sometimes called "Saved Games" or "Driver Sessions") are "Game States" saved while in Driver Mode'''</td>
<td>You can edit the '''Route Characteristics''' at any time by selecting the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Edit&#160;Route...&#160;</span> option from the [[image:EditMenu_S20.png|link=]]&#160;'''Edit Menu''' <span style="font-weight: 700; font-size: 15px;">OR</span> simply by pressing the <span style="font-weight: 700; font-size: 15px;"><span style="color: white; background-color: black;">&#160;Ctrl&#160;</span>&#160;+&#160;<span style="color: white; background-color: black;">&#160;E&#160;</span></span> keys.<br>
This will bring up the '''Edit Route''' dialogue window (shown below).</td>
</tr>
</tr>
</table>
</table>
<table width=900>
<tr valign="top">
<td width=745>
'''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.<br>
When you are in '''Driver''' select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Save&nbsp;</span> from the '''System Menu''' or press <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ctrl&nbsp;</span>&nbsp;<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;S&nbsp;</span>.<br>
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 click the Tick then this will be the name used for the saved game. Alternatively, you could enter your own unique name (shown right below).<br>
The space below the entered name will display any other saved '''Driver Games''' for that '''Session'''.
</td>
</td>
<td width=155>[[image:DriverSaveMenu.png|link=|alt=Save Menu]]</td>
</tr>
</tr>
</table>
</table>
 
</td>
<table>
<td>
<tr valign="top">
<table width=480 bgcolor=#000000>
<td>[[image:DriverSARSave01.png|link=|alt=Save Driver Game]]</td>
<td>[[image:DriverSARSave02.png|link=|alt=Save Driver Game]]</td>
</tr>
</table>
=='''Loading Driver Games'''==
Saved '''Driver Games''' will be shown with their '''Sessions''' for a selected '''Route'''. The section '''[[file:PageLink.PNG|link=]]&nbsp;[[#Loading an Existing Session|Loading an Existing Session]]''' shows two different methods of displaying saved '''Sessions''' and their '''Driver Games'''. <br>
'''Method''' [[image:DotPoint1.JPG|link=]] will display '''ALL''' the saved '''Sessions''' and '''Driver Games''' which may be a very long list.<br>
'''Method''' [[image:DotPoint2.JPG|link=]] will display '''ALL''' the saved '''Sessions''' and '''Driver Games''' for a selected '''Route''', which should be a much shorter list.<br>
 
Using '''Method 2:''' select the '''Route''' first and then click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;">&nbsp;VIEW SESSIONS&nbsp;</span> button. This will display a list of thumbnails for all the '''Sessions''' and '''Driver Games''' in that '''Route'''.<br>
 
[[image:DriverLoadDriverSession.png|link=|alt=Load Driver Game]]<br>
 
<table bgcolor=#000000 width=900>
<tr valign="top">
<tr valign="top">
<td>
<td>
<table bgcolor=#ffffb0>
<table width=476 cellpadding=2 bgcolor=#ffffb0>
<tr valign="top">
<tr valign="top">
<td>[[image:NotePad.PNG|link=]]</td>
<td>[[image:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
<td><span style="font-size: 17px; font-weight: 700;">Route Characteristics:-'''</span><br>
----
----
</td>
<table>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Name''' and '''Description'''</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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'''.</td>
<td>assigned '''Geographic Region''', which sets a number of different features</td>
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>[[image:DotPoint.JPG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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 click on a thumbnail to see if the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;EDIT SESSION&nbsp;</span> button is still visible. If it is not, because '''Driver Games''' cannot be edited, then the thumbnail is for a '''Driver Game'''.
<td>'''Thumbnail''' image</td>
</td>
</tr>
</tr>
</table>
<tr valign="top">
</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>'''Working Scale''' and '''Working Units'''</td>
</tr>
</tr>
</table>
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.<br>
Select (hightlight) the '''Driver Game''' you want to load and click the <span style="font-weight: 700; background-color: black; color: white; font-size: 15px;">&nbsp;DRIVE SESSION&nbsp;</span> button.<br>
[[image:DriverButtonsNoEdit.png|link=|alt=Driver Game]]<br>
This will load  the '''Driver Game''', the '''Session''' and the '''Route''' into '''Driver'''.<br>
<table bgcolor=#ff0000 width=900>
<tr valign="top">
<td>
<table bgcolor=#fcbcbc>
<tr valign="top">
<tr valign="top">
<td>[[image:Stop.PNG|link=]]</td>
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>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'''.
<td>'''Draw Distance'''</td>
</td>
</tr>
</tr>
<tr valign="top">
</table>
<td>&nbsp;</td>
<td>
<table>
<tr valign="top">
<td width=480>[[image:DriverLoadWarning.png|link=|alt=Warning assets have changed|480px]]</td>
<td>You will have the options of:-<br>
<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Cancel&nbsp;</span> - the '''Driver Game''' will NOT be loaded, or<br>
<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&nbsp;Ok&nbsp;</span> - load the '''Driver Game''' wirh the changes<br>
<br>
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.<br>
*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'''.<br>
<br>
'''Only you can be the judge'''.
</td>
</td>
</tr>
</tr>
Line 1,734: Line 1,475:
</tr>
</tr>
</table>
</table>
<br>
<table width=1000>
<table> <!-- BEGIN Nav Buttons Table -->
<tr valign="top">
<tr valign="top">
<td width=500>[[image:RouteEditWindowExample2_S20.png|link=]]</td>
<td width=729><span id="stepDeleting"></span>&nbsp;</td>
<td>
<td width=46>
<table width=500>
<tr valign="top">
<td width=20>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Route name&#160;</span>. Editing this will change the route '''username''' in the '''config.txt''' file but it will not alter the route '''&lt;kuid&gt;''' value</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint2.JPG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Route description&#160;</span>. Edit to include additional information or describe changes that have been made</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint3.JPG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Region&#160;</span>. 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</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint4.JPG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Route thumbnail&#160;</span>. <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Set Thumbnail&#160;</span> 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.</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint5.JPG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Working scale&#160;</span>. Changing this will only affect the measurement shown in the '''Surveyor Ruler''' tool</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint6.JPG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Working units&#160;</span>. Switching between '''Metric''' and '''Imperial''' will change how train speeds are calculated and displayed in Driver (in km/h or mph), the speeds set by track speed signs and the units used by the ruler tools</td>
</tr>
</table>
</td>
</tr>
<tr valign="top">
<td colspan=2>
<table>
<tr valign="top">
<td>[[image:DotPoint7.JPG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Route Edit Detail&#160;</span> <span style="background-color: yellow;">in '''Trainz Plus''' only</span>. This sets the minimum ground brush size when working with '''HD resolution'''. It can be swapped between the two settings at anytime when editing. See <span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;SD/HD Options&#160;</span> below for more details</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint8.JPG|link=]]</td>
<td><span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Draw distance cap&#160;</span> will affect how far away from the camera that scenery objects will be drawn. A high setting, particularly the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;">&#160;Disabled&#160;</span> option (which means no draw distance cap), could affect the game performance, including the '''fps''' rate (frames per second), on some systems</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint9.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the [[image:Tick.PNG|link=|alt=Tick]] icon to save the entered values and exit back to Surveyor. <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Left Click</span> on the [[image:Cross.PNG|link=|alt=Tick]] icon to cancel any entered values and exit back to Surveyor</td>
</tr>
</table>
</td>
</tr>
</table>
<br>
<table width=1000>
<tr valign="top">
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: blue;">&#160;SD/HD Options&#160;</span></td>
</tr>
<tr valign="top">
<td>[[image:RouteEditDetailHD_S20.png‎|link=]]</td>
</tr>
</table>
<br>
<table width=1000>
<tr valign="top">
<td>The '''Surveyor Route Editor''' will allow you to switch between two minimum brush sizes when working with '''HD resolution''' routes.</td>
</tr>
<tr valign="top">
<td>This option, <span style="background-color: yellow;">available in '''Trainz Plus''' only</span>, allows you to set the brush detail to the default '''HD''' (High Definition) or to a lower '''SD''' (Standard Definition) which is easier to work with over larger areas.
<br>
<table>
<tr valign="top">
<td>
<table width=500 bgcolor=#000000 cellpadding=2>
<tr valign="top">
<td>
<table bgcolor=#ffffff cellpadding=2>
<tr valign="top">
<td colspan=2>The distinction between these two options is:-</td>
</tr>
<tr valign="top">
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;HD&#160;</span></td>
<td>This is the full '''HD Mode''' where the minimum brush size is '''0.12m''' (12cm). This is the default selection</td>
</tr>
<tr valign="top">
<td><span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;SD&#160;</span></td>
<td>This is a reduced '''HD Mode''' where the minimum brush size is '''2m'''</td>
</tr>
<tr valign="top">
<td colspan=2>Both modes:-
<table>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>have all the normal '''HD''' controls and features</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>will work anywhere within the grid squares of a '''HD resolution''' route and are not restricted to the grid lines or intersections</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>can be used in different areas of the same baseboard</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
</tr>
</table>
<table width=500>
<tr valign="top">
<td colspan=2>The setting can be switched during editing without affecting or altering the existing terrain. For example:-</td>
</tr>
<tr valign="top">
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
<td>you can start editing the terrain using the '''HD Mode''' to give you the highest level of precision in one area of a baseboard</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>then switch to '''SD Mode''' to work in another area of the same (or a different) baseboard at a lower level of precision - which would be faster than using the '''HD Mode'''</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint.JPG|10px|link=]]</td>
<td>then switch back to '''HD Mode''' to continue working in the same, or another, high precision area</td>
</tr>
</table>
</td>
<td>
<table width=500 bgcolor=#000000>
<tr valign="top">
<td>
<table bgcolor=#ffffff>
<tr valign="top">
<td colspan=2><span style="font-weight: 700; font-size: 15px;">Steps: To Switch Between HD and SD Modes at Any Time:-</span></td>
</tr>
<tr valign="top">
<td>
<table>
<tr valign="top">
<td>
<table>
<tr valign="top">
<td width=20>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the '''Main Menu''' [[image:EditMenu_S20.png|link=]]&#160;'''Edit Menu''' and select the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Edit&#160;Route...&#160;</span> option<br>
'''Shortcut:''' Press <span style="font-weight: 700; font-size: 15px;"><span style="color: white; background-color: black;">&#160;Ctrl&#160;</span>&#160;+&#160;<span style="color: white; background-color: black;">&#160;E&#160;</span></span></td>
</tr>
<tr valign="top">
<td colspan=2>This will open the '''Route Editor''' dialogue window which, <span style="background-color: yellow;">in '''Trainz Plus''' only</span>, has an additional control, the '''Route Edit Detail'''</td>
</tr>
<tr valign="top">
<td colspan=2>[[image:RouteEditDetailHD_S20.png‎|link=]]</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint2.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on either the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;SD&#160;</span> or the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;HD&#160;</span> button</td>
</tr>
<tr valign="top">
<td>[[image:DotPoint3.JPG|link=]]</td>
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the [[image:Tick.PNG|link=|alt=Tick]] icon at the bottom right of the dialogue window to make the switch</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
<td>[[image:EditMenuOptions_S20.png|link=]]</td>
</tr>
</table>
</td>
</tr>
</table>
<br>
<table bgcolor=#000000 cellpadding=2>
<tr valign="top">
<td>
<table bgcolor=#ffffb0 cellpadding=2>
<tr valign="top">
<td width=25>[[image:NotePad.PNG|link=]]</td>
<td>When using <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;SD&#160;</span> mode brush sizes less than '''2m''' will be ignored and a '''2m''' brush size will be used instead. Larger brush sizes can be set and used</td>
</tr>
</table>
</table> <!-- END Nav Buttons Table -->
</table> <!-- END Nav Buttons Table -->
----
----
----
----
='''Trainz Wiki'''=
='''Trainz Wiki'''=
<table cellpadding=4 bgcolor=#ffffff>
<table width=1000 cellpadding=2>
<tr valign="top">
<td>
<table width=500 cellpadding=2>
<tr valign="top">
<tr valign="top">
<td>[[image:TrainzWiki.png|link=]]</td>
<td>[[image:TrainzWiki.png|link=]]</td>
<td>
<td>
<span style="font-size: 17px;">'''Route and Session Building Guides'''</span><br>
<span style="font-size: 17px;">'''Route and Session Building Guides'''</span><br>
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
*'''<span class="plain;">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
*'''[[HowTo/Create_a_Route_in_10_Minutes|Create a Route in 10 Minutes]]'''
*'''[[HowTo/Create_a_Route_in_10_Minutes|Create a Route in 10 Minutes]]'''
*'''[[How_to_Make_Good_Scenery|How to Make Good Scenery]]'''
*'''[[How_to_Make_Good_Scenery|How to Make Good Scenery]]'''
Line 1,811: Line 5,105:
</tr>
</tr>
<tr valign="top">
<tr valign="top">
<td>&nbsp;</td>
<td>&#160;</td>
<td>
<td>
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
*'''<span class="plain;">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
*'''[[Driver Commands List]]'''
*'''[[Driver Commands List]]'''
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
</td>
</tr>
</table>
</td>
<td>
<table width=500 cellpadding=4 bgcolor="Aquamarine">
<tr valign="top">
<td width=50>[[image:LinkWiki.PNG|link=]]</td>
<td>
<span style="font-size: 17px;">'''Related Links'''</span><br>
*'''[[How_to_Create_a_Region_Asset|How to Create a Region Asset]]'''
*'''[[How_to_Merge_Routes|How to Merge Routes]]'''
*'''[[How_to_Use_Layers|How to Use Layers]]'''
*'''[[How_to_Use_S20_Palettes|How to Use Surveyor 2.0 Palettes]]'''
*'''[[How_to_Use_S20_Tools|How to Use Surveyor 2.0 Tools]]'''
</td>
</tr>
</table>
</td>
</td>
</tr>
</tr>
</table>
</table>
----
----
This page was created by Trainz user '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in September 2021 and was last updated as shown below.
This page was created by Trainz user '''<span class="plain;">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in September 2021 and was last updated as shown below.
----
----
[[Category:How-to guides]]
[[Category:How-to guides]]

Latest revision as of 10:52, 27 August 2026

          Next Down Bottom
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The information in this Wiki Page applies to Trainz Plus, TRS22 and TRS19. It explains the basic concepts and processes involved in creating and editing Routes and Sessions.


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. Links are provided at the end of this document.


 Workflow Diagrams 

Route Workflow diagram

Session Workflow diagram


Trainz Worlds

    Top   Next Down Bottom
The virtual worlds that Trainz creates can be classified as:-


Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127
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 saved 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 Games.

Games (also called Driver Games, Driver Sessions, Saved Games)
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.


What is a Route?

    Top Next Up Next Down Bottom
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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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

Route Data contains:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Landforms (Terrain) - baseboards and ground height
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Water height and spread for Legacy Water found in Surveyor Classic
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Ground Textures including the grid pattern which is a texture
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Effect Layers - TurfFX, Clutter, Water, Color (the Color Effect Layer is only available in Trainz Plus when using High Definition (HD))
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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

Route Layers contain:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Track and Track Objects (such as signals, switches, bridges, tunnels, speed signs, etc)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Most (or all) scenery items (e.g. buildings, trees, rocks, active industries/stations) and scenery splines (e.g. roads, fences, etc)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Rolling Stock (including locos) -  Note:  It is strongly recommended that all rolling stock be placed into a Session Layer
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Lineside and Fixed Cameras
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Trackmarks, Triggers, Direction and Priority Marks - these are often placed into a Session Layer so that they can be specific to a particular session


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

Skip Down   Top Next Up Next Down Bottom
The Main Menu screen is shown below. The first option (shown highlighted in the image) opens Driver/Surveyor with all its options including loading and creating a route.
TRS19 Main Screen options


Notes:

Routes:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 are saved as entries in the Trainz Database, not as files on your hard drive. Loading a route will retrieve it from the database.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 can be loaded directly into Surveyor from Content Manager. See Loading a Route Into Surveyor From Content Manager below
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 can be exported as files (in the Trainz .cdp file format) from Content Manager for backup or transfer.


Steps: To Load or Create a Route:-
 Left Click  on the large Driver / Surveyor graphic shown highlighted in white in the image on the left


In the Driver/Surveyor screen a strip of thumbnails of all the Routes, installed and as well as available as DLC, will be shown at the base of the screen.

TRS19 Main Screen Route Selection

If there are too many to fit in the available space, then either:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 move the mouse pointer onto the base of any thumbnail image to reveal the scroll bar device, as shown above, then Left Click and Drag the scroll bar left or right to reveal the additional routes OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 move the mouse pointer onto any thumbnail image and roll the mouse scroll wheel forwards or backwards to reveal the additional routes OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 use the Expand View button described below. This will fill the screen with thumbnail images. If there are still too many to fit then use either of the two methods listed above to scroll the full screen view left and right


Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 A Left Click on the  MAIN MENU  button (bottom left) will take you back to the starting or main screen.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 A Left Click on the Expand View button (top right) will expand the thumbnail list to fill the screen. Left Click the Expand View button 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

Skip Down Skip Up        
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 When you create a new Route a new default Session will also be created for it. Sessions contain specific data that are not found in routes. See  What is a Session? below.

When you save the new route you will be given the opportunity to save the session as well. If you have not added anything to the session then saving it is optional.

WARNING:
If you have added anything to the session-layer or edited any session data (e.g. the products carried by a wagon) and do not save the Session as well as the Route then that data will be lost. See  Saving a Route and Session below for more information.

Create a New Route

In both Surveyor Classic (also known as S1.0 or S10) and in Surveyor 2.0 (also known as S2.0 or S20) Left Click on  CREATE ROUTE . This will start Trainz Surveyor and create a new blank route with a single baseboard using the Default settings which are usually those that were used when you last created and saved a route. The default settings may include a ground texture other than the grid pattern, for example - thick grass.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127
Surveyor 2.0 screen shown
Notes: for Trainz Plus

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the default grid resolution for a new route is HD (High Definition) Grid
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to convert your new HD resolution route to 5m resolution or to 10m resolution, at any time, see  The Marquee Tool for the details
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 if you want to convert an existing 5m resolution or 10m resolution route entirely to HD resolution then see  Upgrading a Route to HD for the details


Notes: for TRS19 and TRS22

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the default grid resolution for a new route is 10m
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 using Surveyor 2.0 (in TRS22PE) to convert your new 10m resolution route to 5m resolution, at any time, see  The Marquee Tool for the details
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 in Surveyor Classic to convert your new 10m resolution route to 5m resolution, at any time, you will need to individually convert each baseboard


You can 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 and select the  Edit Route...  option
The keyboard shortcut is  Ctrl  +  E 


It is recommended that you enter some details before you click the Tick 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




A Left Click on the Tick icon at the bottom right of the window will apply the new data settings to the single flat baseboard that you have just created.

A Left Click on the Cross icon at the bottom right of the window will cancel the data entry and continue to use the default data settings (usually the settings entered for the last route you created) in the single flat baseboard currently on the screen.
Notes: Route Options
Enter a  Route 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  Route description  for the route. At the starting stage this is basically a "memory jogger" for you so a basic description would be sufficient but before you release the finished route (e.g. to the DLS) it should contain some critical information such as Trainz Plus only, "high detail assets used" and the source(s) of any non-DLS dependencies
Setting a  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 the Trainz Wiki Page  How to Create a Region Asset
Create a  Route 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  Set 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 and its measurements 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 (feet, yards, miles) which only affects measurements used by rulers (in Surveyor 2.0 separate metric and imperial rulers are available) and train speeds (km/h or mph). See Notes below.
The  Route Edit Detail  in Trainz Plus only. This sets the minimum ground brush size when working with HD resolution. It can be swapped between the two settings 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


Notes: Height, Position and Speed Measurements
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 All Height and Position data in the Surveyor Tools are always entered and displayed in metres even if you are using Imperial units (feet) for your rulers and distance measurements.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Track speed signs are always locked at either Metric (km/h) or Imperial (mph) - there are separate speed signs available for each. The number shown by a speed sign will not be changed if you switch between the two systems. However, their speed values will be converted. So a track speed sign that is set at 40 mph will still be displayed as 40 but it will be read as 64 km/h in Driver if the Working Units have been set to metric.
Notes: Ground Texture and Regions
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 When a new route is created all the baseboards added will be covered with the Default Ground Texture which is usually the last one that you set. Selecting a Region (Point  3  in the Notes: Route Options above) will set the ground texture to be used in every baseboard added to the new route. Some regions have a standard grid pattern as their default ground texture - look on the DLS for region assets with TRS19 Grid or similar in their titles. You can change the selected Region and its ground texture as often as you like but this can also change other properties of the route as described above.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 You can create your own Region with your preferred ground texture and other features - see the Trainz Wiki Page  How to Create a Region Asset for the details


 SD/HD Options 

This option, available in Trainz Plus only, allows you to set the route detail when working in HD resolution to the default HD (High Definition) or to a lower SD (Standard Definition) which is easier to work with over larger areas.

The distinction between these two options is:-
 HD  This is the full HD Mode where the minimum brush size is 0.12m (12cm) - HD Mode is only available in Trainz Plus
 SD  This is a reduced HD Mode where the minimum brush size is 2m
Both options are using HD resolution and have all the HD controls and features. Both  SD  and  HD  can be used in the same baseboard
The setting can be switched during editing without affecting or altering the existing terrain. For example:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 you can start editing the terrain using the HD Mode to give you the highest level of precision in one area of a baseboard
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 then switch to SD Mode to work in another area of the same (or a different) baseboard at a lower level of precision - which would be faster than using the HD Mode
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 then switch back to HD Mode to continue working in the same, or another, high precision area
Steps: To Switch Between HD and SD Modes at Any Time:-
 Left Click  on the Main Menu  Edit Menu and select the  Edit Route...  option.

The keyboard shortcut is  Ctrl  +  E 
 Left Click  on either the  SD  or the  HD  button
 Left Click  on the Tick icon to make the switch


The Surveyor World View

Skip Down Skip Up        
Notes:

The terms Grid Size and Grid Resolution when used in this document refer to the following:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Grid Size: - the size of the yellow grid squares shown in an untextured baseboard. The grid squares are always 10m x 10m in size regardless of the Working Scale (Real Scale, G Scale, HO Scale, etc) or the Working Units (metric or imperial). When a ruler object is used to measure the squares it will show their size using the selected Working Scale and Working Units
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Grid Resolution: - a measure of the level of detail that can be shown when using the Ground Height and Ground Texture brush tools.
A 10m Grid Resolution will allow the use of a brush of radius 10m without restrictions anywhere in the baseboard. Smaller brushes can be used but with restrictions that will increase as the brush size is reduced.
A 5m Grid Resolution will allow the use of a brush of radius 5m without restrictions anywhere in the baseboard. Smaller brushes can be used but with restrictions that will increase as the brush size is reduced.
A HD Grid Resolution will allow the use of a brush of radius as small as 0.12m (12cm) without any restrictions anywhere in the baseboard - HD Grid Resolution is only available in Trainz Plus.


Depending on the Route Editor settings and the version of Trainz you are using, you may see or be affected by the following factors:-

Baseboards and Grid Squares:
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Each Baseboard is always 720m x 720m (2362.2ft x 2362.2ft) regardless of the Working scale and Working units you have selected
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Baseboards without any applied ground texture will be covered with grid squares. Each yellow Grid Square is always 10m x 10m (32.8ft x 32.8ft) regardless of the Working scale and Working units you have selected
But in both cases the distance measurement shown by a ruler object will depend on the Working scale and Working units selected
Grid Resolution: See Notes: above
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 10m resolution - the default setting for new baseboards created using TRS19 and TRS22 OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 5m resolution - at 4x the resolution of 10m. You can have a mixture of 10m and 5m resolution baseboards in the same route OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 HD (High Definition) resolution - at 6400x the resolution of 10m and 1600x the resoltion of 5m this resolution is only available in Trainz Plus. It is the default setting for new baseboards created using Trainz Plus and it is NOT recommended that HD baseboards be mixed with 10m/5m baseboards in the same route
Baseboards can be converted between these resolution settings at any time
Baseboard Altitude:
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The altitude (in metres) of the first baseboard will depend on the Geographic region you have selected but the default value is 0m
Baseboard Texture:
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The baseboard will be covered with a texture, such as grass or a grid pattern. This is set by the Geographic region and the selection made in the Ground option from the Surveyor Display Menu - see  Default Baseboard Ground Texture below


 In Surveyor Classic (S10) 

Surveyor Classic or S10 is the version of Surveyor found in TRS19, TRS19PE and TRS22. It is one of two versions of Surveyor available in TRS22PE and Trainz Plus.

In Surveyor Classic the baseboards are controlled using the Topology Tools. To open the tools fly-out either Left Click the Topology Tool Tab or press the  F1  key.
Topology Tools

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127


  The Key Topology Tools, as shown in the diagram above, are:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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 
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Grid Resolution - a pop-out menu will give you a choice of 10m (the default) or 5m. The option for the HD resolution is only available 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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 With a 10m resolution the smallest area in which you can set a height is 10m x 10m
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 With a 5m resolution that 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 
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 With HD resolution (in Trainz Plus only) the smallest area (resolution) in which you can set a height is 0.125m x 0.125m. This allows you to create even more accurate topology features but it has a penalty,  enormously larger route sizes  - on average 5x or more larger than 10m resolution maps
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Each new baseboard you add will have its resolution set to the selected value. You can have different baseboards set to each resolution - for example: baseboards used by the track set at 5m and those further out at 10m This control is also used to change an existing baseboard from one resolution to the other.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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) 

Surveyor 2.0 or S20 is an alternative version of Surveyor found in TRS22PE and Trainz Plus. Surveyor Classic is also available as an option in both TRS22PE and Trainz Plus.
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.


Marquee Tool
Steps: To Add New Baseboards:-
select the Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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.
Marquee drawn area
The main 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 Tool Height
 Convert Baseboards to  a pop-out menu will give the options, 10m, or 5m or (for Trainz Plus only) HD resolution. 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.
WARNING:

It is NOT RECOMMENDED that you mix HD resolution baseboards with 5m or 10m 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

Skip Down Skip Up        
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.


Information on creating and editing Region assets can be found on the Trainz Wiki at:-

How to Create a Region Asset


Loading an Existing Route

Skip Down Skip Up        
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 When you load an existing Route without also loading a Session, a new default Session will be created for it. Sessions contain specific data that are not found in routes. See  What is a Session? below.

When you save the route you will be given the opportunity to save the new default session as well. If you have not added anything to the session then saving it is optional.

WARNING:
If you have added anything to the session-layer or edited any session data (e.g. the products carried by a wagon) and do not save the Session as well as the Route then that data will be lost. See  Saving a Route and Session below for more information.
You must first find and select the route to load from those already installed. At the top of the Driver/Surveyor screen the search options are shown as a set of buttons, the first 3 are drop down lists and the last is a text entry box.

Route Search

Route List Source List Region List
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.


Existing Routes

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.

Edit Route

Notes: Routes and Sessions - An Endless Source of Confusion
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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

Skip Down Skip Up        
Trainz provides a shortcut that allows you to load an existing route directly into Surveyor for editing from Content Manager.


Load a route from CM
Steps: To Load a Route from Content Manager:-
in Content Manager select the filter Routes & Sessions
identify the route to be edited
Right Click on the route to open its Command Menu
select Open..., then select Edit Asset in Surveyor


Loading After an Unexpected Shutdown

Skip Down Skip Up        
If you select a route for loading after an unexpected shutdown of Trainz then any route (or route and session) that was open and running in Trainz Surveyor or Driver will be left marked as Open for Edit. When you attempt to load this route into Surveyor or Driver you will see a message listing the route and session (if any) that were affected.
Load after CTD The message is saying that the assets in the list may have been changed since the last time you loaded them and exited Trainz normally. For example if you had been editing the route and/or session and had experienced a crash to the desktop or had used Windows Task Manager to terminate the program.

Note:

A similar message will appear when you load a Game (see  Loading Games below) after editing the original route or session that was used to create the Game.

It is possible that the changes you have made may affect the operation of the saved game.


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

Skip Down Skip Up        
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, effect layers (e.g. TurfFX, Water, 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 by pressing the  Ctrl  +  E  keys.
This will bring up the Edit Route dialogue window (shown below).
Route Characteristics:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Name and Description
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 assigned Geographic Region, which sets a number of different features
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Thumbnail image
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Working Scale and Working Units
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
 Route description . Edit to include additional information or describe changes that have been made
 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 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), the speeds set by track speed signs and the units used by the ruler tools
 Route Edit Detail  in Trainz Plus only. This sets the minimum ground brush size when working with HD resolution. It can be swapped between the two settings 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 Tick icon to save the entered values and exit back to Surveyor. Left Click on the Tick icon to cancel any entered values and exit back to Surveyor


 SD/HD Options 


The Surveyor Route Editor will allow you to switch between two minimum brush sizes when working with HD resolution routes.
This option, available in Trainz Plus only, allows you to set the brush detail to the default HD (High Definition) or to a lower SD (Standard Definition) which is easier to work with over larger areas.


The distinction between these two options is:-
 HD  This is the full HD Mode where the minimum brush size is 0.12m (12cm). This is the default selection
 SD  This is a reduced HD Mode where the minimum brush size is 2m
Both modes:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 have all the normal HD controls and features
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 will work anywhere within the grid squares of a HD resolution route and are not restricted to the grid lines or intersections
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 can be used in different areas of the same baseboard
The setting can be switched during editing without affecting or altering the existing terrain. For example:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 you can start editing the terrain using the HD Mode to give you the highest level of precision in one area of a baseboard
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 then switch to SD Mode to work in another area of the same (or a different) baseboard at a lower level of precision - which would be faster than using the HD Mode
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 then switch back to HD Mode to continue working in the same, or another, high precision area
Steps: To Switch Between HD and SD Modes at Any Time:-
 Left Click  on the Main Menu  Edit Menu and select the  Edit Route...  option
Shortcut: Press  Ctrl  +  E 
This will open the Route Editor dialogue window which, in Trainz Plus only, has an additional control, the Route Edit Detail
 Left Click  on either the  SD  or the  HD  button
 Left Click  on the Tick icon at the bottom right of the dialogue window to make the switch


When using  SD  mode brush sizes less than 2m will be ignored and a 2m brush size will be used instead. Larger brush sizes can be set and used


Adding Terrain Height, Textures, Effect Layers in a Route

Skip Down Skip Up        
Terrain, Textures, Effect Layers can only be added to a route not a session
The height of the terrain can be adjusted to represent hills, valleys, plains, slopes
The Terrain can be painted with textures to represent real ground surfaces
Effect Layers (grasses, rocks, water, etc) can be added to the terrain to enhance its appearence. The types of effect layers that are available will depend on your Trainz version, GPU and Operating System


Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The Ground Height and Ground Texture are kept in special layers that cannot be renamed, moved, deleted or merged with other layers
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The Effect Layers (TurfFX, Clutter, Water and Color) are found:-
in the Advanced Topology Tools (press the  F1  key and open the  Advanced  tab) in  Surveyor Classic 
as layers in the  Layers Palette  in  Surveyor 2.0 
They can be deleted and renamed but cannot be moved or merged with other layers


 In Surveyor Classic (S10) 

In Surveyor Classic (S10) the tools and objects are in tabbed icons on the right of the screen which can be opened by a  Left Click  on the icon or by pressing its Function Key
 F1  The Terrain Height, Legacy Water and Effect Layers are added and manipulated by tools in the Topology icon (the  F1  key). For the Effect Layers you will also need to open the  Advanced  tab
 F2  The Ground Texture is added and manipulated by tools in the Paint icon (the  F2  key)
Opening each tool will reveal a selection list of assets and/or a set of tools for applying and manipulating the selected feature


 In Surveyor 2.0 (S20) 

In Surveyor 2.0 (S20) there is a single set of common tools that can add and manipulate objects of any type. Select a tool by a  Left Click  on its icon in the  Tools Palette  or by pressing its key. You can also select multiple objects, that can be of different types, and manipulate them (move, rotate, delete) as if they were a single object.
 W  The Brush Tool in the  Tools Palette  sets the Terrain Height, paints the Ground Textures and adds/edits Effect Layers (including Water). The textures and effect layers are selected using the  Filter Palette  and the  Assets Palette 
There is a Wiki Page that covers in great detail the use of the Surveyor 2.0 tools at  How to Use S20 Tools with specific sections dealing with Ground Height, Ground Terrain and Effect Layers


Effect Layers
The Effect Layers are TurfFX (grasses, bushes, crops, etc), Clutter (small ground cover such as grasses and stones), Water and Color
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The TurfFX Effect Layer is only available if you have an NVidia Graphics Card (e.g. a GTX or RTX) and Windows OS (Windows 10 or 11)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The Color Effect Layer is only available in Trainz Plus when using the High Definition (HD) mode


Adding Assets to a Route

Skip Down Skip Up        
Assets include all visible objects (trees, buildings, roads, tracks, signals, rolling stock, etc) and invisible objects (track triggers, track marks, etc) that can be added to your route
Objects added to your route will be present in all sessions created using that route


 In Surveyor Classic (S10) 

In Surveyor Classic (S10) the tools and objects are in tabbed icons on the right of the screen which can be opened by a  Left Click  on the icon or by pressing its Function Key.
 F3  Scenery objects (e.g. buildings) and splines (e.g. roads) are added and manipulated by tools in the Objects icon (the  F3  key)
 F4  Railroad tracks and track objects (e.g. signals, switches, etc) are added and manipulated by tools in the Tracks icon (the  F4  key)
 F7  Rolling stock (locomotives, wagons) are added and manipulated by tools in the Trains icon (the  F7  key)
Opening each tool will reveal a selection list of assets and a set of tools for applying and manipulating the selected asset


 In Surveyor 2.0 (S20) 

In Surveyor 2.0 (S20) there is a single set of common tools that can add and manipulate objects of any type. Select a tool by a  Left Click  on its icon in the  Tools Palette  or by pressing its key. You can also select multiple objects, that can be of different types, and manipulate them (move, rotate, delete) as if they were a single object.
 E  The Placement Tool adds ALL objects (scenery, splines, track and track objects, rolling stock) selected using the  Filter Palette  and the  Assets Palette 
 S  The Free Move Tool moves ALL objects, either individually or as a group, to anywhere on the surface
 D  The Fine Adjustment Tool moves and rotates ALL objects, either individually or as a group, in small movements to anywhere on, below or above the surface
There is a Wiki Page that covers in great detail the use of the Surveyor 2.0 tools at  How to Use S20 Tools


Editing the Environment of a Route

Skip Down Skip Up        

You can edit the Environment Controls of a Route by selecting the  Edit Environment...  option from the  Edit Menu.
This will bring up the Edit Environment dialogue window, more commonly called the Environment Tools.

For more details on editing the Environment see the Trainz Wiki Page at  The Environment Tools
Environment edit
Environment Controls in a Route:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 lighting conditions
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 weather and cloud cover
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 water color and water surface (rough, calm, etc) for Legacy Water only
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 wind speed (for SpeedTree assets only)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 fog and snow
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 season (by the date and latitude)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 road traffic (on or off only)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 world origin (latitude, longitude, altitude)
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.

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 When a route is created all the Environmental Settings will be set to their default values and they will remain at those values when the route is saved unless they are changed.
  Most Environmental Settings are found in both the Route and the Session. An edited setting in the Session (e.g. Weather) will always take priority over the same setting, edited or default, in the Route. See  Edit the Environment of a Session for the details.


Edit Effect Layers

Skip Down Skip Up        
The Edit Effect Layers menu option allows you to add, remove and edit the special effect layers


Effect Layers contain:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 TurfFX - 3D animated grasses including crops (e.g. wheat)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Clutter - rocks, stones, small clumps of plants (grasses, flowers, etc)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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 😀)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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 when using HD terrain 
You can have multiple effect layers of each type (except the color layer) in a route.
Notes:

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 TurfFX is hardware dependent and requires an Nvidia graphics card. TurfFX is an Nvidia software product and is not from N3V.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Payware (DLC) routes cannot be merged with Freeware (DLS) or other Payware routes
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 There may be a significant height difference between the two routes and this may not be easy to overcome
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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


What is a Session?

  Skip Up Top Next Up Next Down Bottom
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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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

Session Data contains:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Drivers (names, AI commands and assigned locos)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Driver Commands - those available for AI and manual driving
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Session Rules
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Industry Settings (commodities consumed and produced)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Consist Settings (commodities carried)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Consist Locations - this is stored in the session even if the consists are placed in the route
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Switch Settings (left/right) - but the default switch direction is stored in the route. See  Setting Switch Directions in Routes and Sessions for more information on this
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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

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:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Scenery
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Rolling Stock (including locos) -  Note:  It is strongly recommended that all rolling stock be placed into a Session Layer
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Trackmarks, Triggers, Direction and Priority Markers
WARNING:
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 Group and, preferably, into the route-layer itself.


A detailed description of Layers can be found on the Trainz Wiki Page:-

How to Use Layers


Notes:

Scenery, Rolling Stock, Triggers and Markers (Track, Direction, Priority) can be used in both Route Layers and Session Layers. Assets placed in a Route Layer will appear in all sessions that are based on the route. The vast majority of (if not all) scenery items will be placed in Route Layers. Assets placed in a Session Layer will only appear in the currently loaded session.

Examples of assets that would be placed in a Session Layer instead of a Route Layer would include:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 products waiting at a factory for pickup in an industrial session that would not be present in a weekend or holiday passenger session
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 signallers holding lanterns in a night session only or standing alongside manual track switch levers in a daylight shunting session
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 trackmarks and triggers that are only required in one session but not in all sessions
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 crowds of onlookers alongside the track in a session recreating an historic steam train run, together with
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 historic rolling stock in a special vintage train session running on a modern route


Loading (and Creating) a Session

Skip Down   Top Next Up Next Down Bottom

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
View Sessions
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
Create Session


Loading an Existing Session

Skip Down Skip Up        

There are two different ways to load existing sessions into Surveyor.

 Search For the Session 
The easiest way to load an existing session is to use the search tools at the top of the Driver/Surveyor screen. Session Search
 Type:    ROUTES  is the default selection. Left Click on the button to change it to  SESSIONS .
 Source:    PURCHASED  is the default selection, Left Click on the button to change it to  MY CONTENT  for a session you have created (or already modified) or to  INSTALLED  for one you have downloaded from the DLS.
 Gameplay:    ALL  is the default selection. There is no need to change this
 Search:   If required you can narrow down the list of sessions by typing the first few letters of its name.
Notes:

Sessions:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 are saved as entries in the Trainz Database, not as files on your hard drive. Loading a session will retrieve it from the database.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 can be loaded directly into Surveyor from Content Manager. See Loading a Session Into Surveyor From Content Manager below.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 can be exported as files (in the Trainz .cdp file format) from Content Manager for backup or transfer.


A strip of thumbnails of all the Sessions, installed and as well as any that may be available from the DLC, for the selected route will be shown at the base of the screen.

Existing Sessions

If there are too many to fit in the available space, then either:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 move the mouse pointer onto the base of any thumbnail image to reveal the scroll bar device then Left Click and Drag the scroll bar left or right to reveal the additional sessions OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 move the mouse pointer onto any thumbnail image, as shown above, and roll the mouse scroll wheel forwards or backwards to reveal the additional sessions OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 use the Expand View button. This will fill the screen with thumbnail images. If there are still too many to fit then use either of the two methods listed above to scroll the full screen view left and right. Left Click the Expand View button again to return the thumbnails to the strip at the bottom of the screen.

The same colour coding system used in the route thumbnails also applies to session thumbnails.

             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


Left Click on the thumbnail for the session you want to load and then Left Click on the  EDIT SESSION  button. This will load BOTH the route and the session into Surveyor.

Edit Session

If the  EDIT SESSION  option is not present then the selected session is a saved Game (a "game" saved when in Driver) and cannot be edited. See the section  Loading Games below.


OR


 Select the Route First 
Steps: To Load a Route and Then a Session:-
Select the route as described in the section  Loading an Existing Route above. Then Left Click on the  VIEW SESSIONS  button.
A strip of thumbnails of all the Sessions, installed and as well as any that may be available from the DLC, for the selected route will be shown at the base of the screen.
Existing Sessions

If there are too many to fit in the available space, then either:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 move the mouse pointer onto the base of any thumbnail image to reveal the scroll bar device then Left Click and Drag the scroll bar left or right to reveal the additional sessions OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 move the mouse pointer onto any thumbnail image, as shown above, and roll the mouse scroll wheel forwards or backwards to reveal the additional sessions OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 use the Expand View button. This will fill the screen with thumbnail images. If there are still too many to fit then use either of the two methods listed above to scroll the full screen view left and right. Left Click the Expand View button again to return the thumbnails to the strip at the bottom of the screen.
Select the session thumbnail you need and then Left Click on the  EDIT SESSION  button.

Edit Session


If the  EDIT SESSION  option is not present then the selected session is a saved Game (a "game" saved when in Driver) and cannot be edited. See the section  Loading Games below.


Both and will load the route and session into Surveyor.


Loading a Session Into Surveyor From Content Manager

Skip Down Skip Up        

Trainz provides a shortcut that allows you to load an existing session directly into Surveyor for editing from Content Manager.

Load a session from CM
Steps: To Load a Session into Surveyor:-
in Content Manager select the filter Routes & Sessions
identify the session to be loaded and edited in Surveyor
Right Click on the session to open its 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

Skip Down Skip Up        

To start Driver simply select a session as described above in Loading an Existing Session and Left Click on the  DRIVE SESSION  button.

Driver Game

This will load both the session and the route into Driver.

You can save your "game play" in Driver at anytime. See  Loading Games below.

Loading a Session into Driver From Content Manager

Skip Down Skip Up        

Trainz provides a shortcut that allows you to load an existing session directly into Driver from Content Manager.

Load a session from CM
Steps To Load a Session into Driver from Content Manager:-:
in Content Manager select the filter Routes & Sessions
Identify the session to drive
Right Click on the session to open its Command Menu
select  Open... , then select  Open Asset in Driver 

Both the session and its parent route will be loaded into Driver and the simulation will be started.


Editing a Session

Skip Down Skip Up        
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 Session Characteristics at any time by selecting the  Edit Session...  option from the  Edit Menu or by simply pressing  Ctrl  +  R .
This will bring up the Edit Session dialogue window which is more commonly called the Session Editor (shown below).

For more details on editing a Session see the Trainz Wiki Page at  The Session Editor - screenshot shown below.
Session edit
Session Characteristics:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Name and Description
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Session Rules which set:-
drivers and their consists
driver commands
time of day/night
events
and much, much more
Edit Session dialogue window


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


Adding Assets to a Session

Skip Down Skip Up        
Assets include all visible objects (trees, buildings, roads, tracks, signals, rolling stock, etc) and invisible objects (track triggers, track marks, etc) that can be added to your session
Any objects added to a session will only be available in that session


 In Surveyor Classic (S10) 

In Surveyor Classic (S10) the tools and objects are in tabbed icons on the right of the screen which can be opened by a  Left Click  on the icon or by pressing its Function Key
 F3  Scenery objects (e.g. buildings) and splines (e.g. roads) are added and manipulated by tools in the Objects icon (the  F3  key)
 F4  Railroad tracks and track objects (e.g. signals, switches, etc) are added and manipulated by tools in the Tracks icon (the  F4  key)
 F7  Rolling stock (locomotives, wagons) are added and manipulated by tools in the Trains icon (the  F7  key)
Opening each tool will reveal a selection list of assets and a set of tools for applying and manipulating the selected asset


 In Surveyor 2.0 (S20) 

In Surveyor 2.0 (S20) there is a single set of common tools that can add and manipulate objects of any type. Select a tool by a  Left Click  on its icon in the  Tools Palette  or by pressing its key. You can also select multiple objects, that can be of different types, and manipulate them (move, rotate, delete) as if they were a single object.
 E  The Placement Tool adds ALL objects (scenery, splines, track and track objects, rolling stock) selected using the  Filter Palette  and the  Assets Palette 
 S  The Free Move Tool moves ALL objects, either individually or as a group, to anywhere on the surface
 D  The Fine Adjustment Tool moves and rotates ALL objects, either individually or as a group, in small movements to anywhere on, below or above the surface
There is a Wiki Page that covers in great detail the use of the Surveyor 2.0 tools at  How to Use S20 Tools


Setting Different Switch Directions in Routes and Sessions
Steps: To Save the Default Switch Direction in the Route:-
Set the switch to the desired direction for the route. If the switch is already in that direction then change something in the route (e.g. move a tree a few centimetres) to make sure that the route has been edited
Save ( Ctrl  +  S  or select  Save  from the System Menu)
In the Save Dialogue Window, make sure that the options
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Overwrite existing route and
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Do not save session
...are selected and then save


Steps: To Save a Different Switch Direction in a Session:-
Set the switch to the desired direction for the Session
Save ( Ctrl  +  S  or select  Save  from the System Menu)
The Save Dialogue Window SHOULD only contain the options
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Overwrite existing session
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Create new session
Select one of the options and then save


Editing the Environment of a Session

Skip Down Skip Up        
Environmental settings in a Session will have priotity over those in a Route


You can edit the Environment Controls of a Session by selecting the  Edit Environment...  option from the  Edit Menu.
This will bring up the Edit Environment dialogue window, more commonly called the Environment Tools.
For more details on editing the Environment see the Trainz Wiki Page at  The Environment Tools

The only difference between the Environment Controls in a Route and a Session is that the route has the World Origin control.
Environment edit
Environment Controls ina Session:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 lighting conditions
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 weather and cloud cover
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 water color and water surface (rough, calm, etc) for Legacy Water only
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 wind speed (for SpeedTree assets only)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 fog and snow
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 season (by the date and latitude)
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 road traffic (on or off only)
Notes: Environment Settings in Routes and Sessions

It is possible (and often 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.

There is an order of priority with the Environmental Settings in Routes and Sessions

If an Environmental Control (e.g. Weather or Date) is set in both the Route and the Session, then the Session setting will take priority over the setting in the Route
If an Environmental Control is set in the Route but NOT in the Session, then the Route setting will take priority
if an Environmental Control is NOT set in both the Route and the Session, then the default value for that setting will be used. The default value for the Date is today's date
The World Origin is only found in a Route. If the World Origin is not set in the Route then its default setting of 52.45°N 13.3°E (Berlin, Germany) will be used


Saving a Route and a Session

Skip Down Skip Up Top Next Up Next Down Bottom

Routes and Sessions are saved from the System Menu on the Surveyor screen.

Save
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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.

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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:

Routes and Sessions:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 are saved as entries in the Trainz Database, not as files on your hard drive. Loading a route or a session will retrieve it from the database.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 can be loaded directly into Surveyor from Content Manager. See Loading a Route Into Surveyor From Content Manager and Loading a Session Into Surveyor From Content Manager below.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 can be exported as files (in the Trainz .cdp file format) from Content Manager for backup or transfer.


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:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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 
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the original DLS routes and sessions will not be altered or replaced by your modified versions
Saving:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 you can only upload your modified DLS route and session to the DLS if you have the permission of the original creator
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 some DLC routes and sessions are encrypted and cannot be modified - that is a decision made by the content creator
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 if you delete or disable the original DLC route or session then your modified versions  will not work 
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the original DLC routes and sessions will not be altered or replaced by your modified versions
Saving:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the original DLC route and session will not be altered or replaced by your modified versions
Uploading:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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

Skip Down Skip Up        

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.

First Save First Save As
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

Skip Down Skip Up        
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.
Save Route with no Session

Settings:

 Option   Overwrite Route Only. This is the default selection so there is nothing to change.

 Overwrite existing route and:
 Do not save session
the route will be saved (overwritten using its current name) but no session will be saved.

 Option    Overwrite Route and Create a New Session. Tick the box  Create new session.

 Overwrite existing route and:
 Create new session:
enter a name for the session (the suggested name Default is NOT recommended).
the route will be saved (overwritten using its current name).
a new session will be created using the name you enter and it will be added to the route.
because you did not originally load a session, the new session will be saved with default values for all its settings.

 Option   Create a New Route and a "Default Session". Tick the box  Save new route and session.

 Save new route and session:
enter a new name for the route. The route will be saved with its new name.
the original route will not be changed.
a new session will be created using the name Default and it will be added to the new route.
because you did not originally load a session, the new session will be saved with the default values for all its settings.
After you have made your selections, Left Click on Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to Accept or Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to Cancel


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.
Save Route with Session

Settings:

 Option   Overwrite Route and Create a New Session. This is the default selection so there is nothing to change.

 Overwrite existing route and:
 Create new session:
enter a name for the session (the suggested name Default is NOT recommended).
the route will be saved (overwritten using its current name).
a new session will be created using the name you enter and it will be added to the route. The new session will have the settings and changes you have made.

 Option   Overwrite Route Only. Tick the box  Do not save session.

 Overwrite existing route and:
 Do not save session
the route will be saved (overwritten using its current name) but no session will be saved.
if you have edited the session and later exit the program without saving those edits (you will be prompted to save the session) then any changes you have made to the session will be lost.

 Option   Create a New Route and a "Default Session". Tick the box  Save new route and session.

 Save new route and session:
enter a new name for the route. The route will be saved with its new name.
the original route will not be changed.
a new session will be created using the name Default and it will be added to the new route. The new session will have the settings and changes you have made.
After you have made your selections, Left Click on Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to Accept or Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to Cancel


Notes:

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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).
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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

Skip Down Skip Up        
If you have loaded a route and a session and have edited the route OR both the route AND the session, then selecting Save will produce the following Save Route Dialogue Window.
Save Route and Session

Settings:

 Option   Overwrite Route and Session. This is the default selection so there is nothing to change.

 Overwrite existing route and:
 Overwrite existing session:
both the route and the session will be saved (overwritten using their current names).

 Option   Overwrite Existing Route and Create a New Session. Tick the box  Create new session.

 Overwrite existing route and:
 Create new session:
enter a new name for the session.
the route will be saved (overwritten using its current name).
a new session will be created using the name you enter and it will be added to the existing route.
the original session will not be changed.

 Option   Overwrite Route Only. Tick the box  Do not save session.

 Overwrite existing route and:
 Do not save session
the route will be saved (overwritten using its current name) but no session will be saved.
if you have edited the session and later exit the program without saving those edits (you will be prompted to save the session) then any changes you have made to the session will be lost.

 Option   Create a New Route and a New Session. Tick the box  Save new route and session.

 Save new route and session:
enter a new name for the route.
the route will be saved with its new name.
a new session will be created using the same name as the original session and it will be added to the new route.
the original session and route will not be changed.
After you have made your selections, Left Click on Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to Accept or Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to Cancel


Notes:

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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).
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 There is a BUG in Trainz Plus and TRS22 that will treat changing the name of a Track Object (e.g. a signal, track mark, switch, etc) as a change to the session and not to the route. If you have not edited anything else in the route then you will see the Session Save dialogue window (see  Saving an Edited Session Only below) to save the session and not the route. The workaround is to make a change to the route (e.g. move a tree a few centimetres) and select save again. NOTE: This bug has been fixed in the Release Candidate for the next update.


Saving an Edited Session Only

Skip Down Skip Up        
If you have only edited the session then you will be given the option to save the Session only


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.
Save Session

Settings:

 Option   Overwrite the Session Only. This is the default selection so there is nothing to change.

 Overwrite existing session
the session will be saved (overwritten using its current name).
the original route will not be changed.

 Option   Create a New Session. Tick the box  Create new session.

 Create new session:
you can enter a new name for the session or use the suggested name which will include the date, time and session runtime.
a new session will be created using the name you enter and it will be added to the existing route.
the original route and session will not be changed.
After you have made your selections, Left Click on Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to Accept or Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to Cancel


Saving a Route and Session Using the UDS

Skip Down Skip Up        
The UDS allows you to switch quickly between Driver and Surveyor (in both directions) so you can edit a running session
The UDS (Unified Driver Surveyor) Interface (see the Trainz Wiki Page  How to Use the UDS Interface for more details) 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 the route and session while in Surveyor and then switch back to Driver to continue the session where you left it.


This powerful ability does come with a warning. When you save your changes take particular care of what you are saving and how you are saving (overwrite or new save). See Notes: below.


Most of the problems users seem to be experiencing with the UDS, judging from the posts in the Trainz Forums, is when saving an edited Route or Session after switching from Surveyor to Driver. The Notes: and Options: below contain some tips and steps you can use to avoid these problems.


Notes:

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 After switching to Surveyor you can edit any Route or Session objects and scenery. Be aware that the properties of some route objects are actually stored in the Session and that editing/deleting some objects, such as tracks, signals and switches, could have a serious effect on saved Sessions and Games
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Using Driver Mode involves driving consists (either manually or through the AI) and starting or completing Session Rules. This will change the session parameters
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Switching from Driver to Surveyor and editing the session is almost the same as loading the session directly into Surveyor from the opening Trainz menu. But the big difference is that after using Driver:-
the consists may have moved to new positions some driver commands may have already been completed
some of the session rules may have started or completed commodity levels (industries and wagons) may have changed
switch levers may be in new positions signals may be in new states
the clock and possibly the weather would have changed
 
Saving the Session after editing will save all of these changes. If you choose to save using the Overwrite existing session option then you will be replacing your original starting Session with a new one with the possible changes listed above. 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:-

Option  Do Not Save the Session
 
Steps: To Save the Route Only:-
Left Click the checkbox  Do not save session 

This will save the Route only, using its existing name and it will overwrite the original route. This will save any edits that you have made to the Route but not to the Session.

Option  Create a New Session
 
Steps: To Save the Route and a NEW Session:-
Left Click the checkbox  Create new session 
Enter a name for the new session

This will save the Route using its existing name and it will overwrite the original route. It will also save the Session using the name you enter in the text box below the checkbox (Stage 3 in the example shown). The original Session will not be altered. This is useful when you want to test out changes to consists, industry settings, Rules, driver commands, etc but do not want to destroy the original Session.

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 Game (also called a Driver Game). This is exactly the same as pressing  Ctrl  +  S  while in Driver.

alte=Save Driver Session


Notes:

The area below the name text entry box will show any existing games that have already been saved for this session. You can select one of them and your current game will be saved with that name and it will replace (overwrite) that game.

Your saved Game will appear in the Select Session menu for the route. Loading it will resume Driver at the point where it was saved.


Exiting Surveyor

  Skip Up Top Next Up Next Down Bottom
If you exit Surveyor after editing without saving then you will be prompted to Save.
Steps: To Exit Surveyor:-
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 
Exit Route Save Exit Session Save
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.


Exiting Driver

    Top Next Up Next Down Bottom
If you exit Driver after running a session you will be prompted to Save the current Game
Steps: To Exit Driver:-
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 Game. See the section  Saving Games below for more details.
 Cancel  will cancel the Exit command and return you to Driver.


Cloning a Route/Session

Skip Down   Top Next Up Next Down Bottom
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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The original route from the DLS will not be altered or replaced by your new version
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Some Payware routes are encrypted and cannot be cloned
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The original Payware route will not be altered or replaced by your new version
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 If you delete or disable the original DLC route then your cloned route  will NOT work 
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Some Payware sessions are encrypted and cannot be cloned
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The original DLC or DLS session will not be altered or replaced by your new version
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 You can, if you decide, safely delete the original DLS session but not the original DLS route
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 If you delete or disable the original DLC session or the original DLC route then your cloned session  will NOT work 
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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

Skip Down Skip Up        
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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 If the original session is Freeware then it can be safely deleted if you no longer need it
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 If the original session is Payware then deleting or disabling it will also disable your cloned session


Cloning Using Content Manager

Skip Down Skip Up        
 Select the Route or Session to Clone 


Cloning a route
Steps: To Create a Clone:-
In Content Manager select the filter Routes & Sessions
select the route or session to be cloned
then either:-

Options:-

from the Content Menu select  Clone  OR
press  Ctrl  +  D 


A Task Window will open to display the result.

Clone task completed

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: To Find the Clone:-
close the Task Window
select the Open for Editing filter.
New Asset



 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.


Steps: To Rename a Clone:-
Right Click the New Asset
select  Open... 
select  Edit Config File Text 

The config.txt file will open in your default text editor. You can then edit both the Title (username) and the Description of the Route or Session

locate the line that starts with username
edit the text on that line between the Quote (") marks (but do not delete the quote marks) to change it to the new name of this Route/Session
locate the line that starts with description
edit the text on that line between the Quote (") marks (but do not delete the quote marks) to edit the description of this Route/Session
save (usually  Ctrl  +  S )
exit the text editor


 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: To Submit the Clone as a New Asset:-
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.

Route edit

Load the cloned Route or Session into Surveyor, then

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to rename a route open the  Edit menu and select the  Edit Route...  option, OR press  Ctrl  +  E  - see  Editing a Route above
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 to rename a session open the Edit menu and select Edit Session, or press  Ctrl  +  R  - see  Editing a Session above

Both will also allow you to edit the Name and Description of the cloned Route/Session.


Saving and Loading Games in Driver

Skip Down Skip Up Top Next Up Next Down Bottom
Games are the state of play when a route and session is saved while in Driver Mode
A Game can be loaded back into Trainz to continue running from the point where it was saved


Notes:

Games:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 can be exported as files (in the Trainz .cdp file format) from Content Manager for backup or transfer.


Saving Games

Skip Down Skip Up        
Games save the "state of play" in Driver. Once saved, the Game can be loaded back into Driver to continue the play at the point where it was saved.

The Game will be saved with:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 consists in their positions and states (stationary or moving, loads carried, driver commands) at the time of the save
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 industries and rolling stock in their conditions (product levels) at the time of the save
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 switches in their state at the time of the save
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 session rules in their state (completed or not completed) at the time of the save
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 the game clock showing the game time at the time of the save


Steps: To Save a Game in Driver:-
In Driver select  Save  from the System Menu or press  Ctrl  +  S . This will usually (see Notes below) display the Save Driver Session dialogue window showing the name of the current session with a date and time stamp (shown below left). The space below the entered name will display any other saved Games for that session
Left Click on the Tick icon to save the Game using the name shown. Alternatively, you can enter your own unique name (shown below right) and then Left Click on the Tick icon
Selecting an existing name will bring up a dialogue window asking you to confirm your choice.
Save Menu


Save Driver Game Save Driver Game


Notes: Saving Games After an Edit

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 You can use the  UDS to switch from Driver to Surveyor during gameplay to edit the Route and/or the Session (see  Editing Games below for the details). If you edit the game it is strongly recommended that you save your edits before switching back to Driver to continue the game
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 If you edit the Route only and switch back to Driver without saving your edits, then the first save you make in Driver will ask you to save the Route with the usual choices of overwriting the original route or creating a new one. The next and all following saves will save the Game. Note: Some route objects have properties that are stored in the session. Editing those properties will also be editing the session
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 If you edit the Session and switch back to Driver without saving your edits, then the first save you make in Driver will ask you to save the Session with the usual choices of overwriting the original session or creating a new one. The next and all following saves will save the Game.


Loading Games

Skip Down Skip Up        
Saved Games will be shown along with all the Sessions for a selected Route. The section  Loading an Existing Session shows two different methods of displaying saved sessions and their games.

Method will display ALL the saved sessions and games, which may be a very long list.
Method will display the saved sessions and games for a SELECTED route, which should be a much shorter list.

If using Method select the route first and then click the  VIEW SESSIONS  button. This will display a list of thumbnails for all the sessions and games for that route.

Load Driver Game

Notes:

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Where a route has multiple sessions and games they will all be shown by their thumbnails with no way of telling which games belong to which session.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 It can also be difficult to tell which thumbnail is a Session and which is a Game, especially if you have removed the date/time stamp Trainz automatically adds to the name of a 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 games cannot be edited, then the thumbnail is for a Game.


Where there is only one session in a route, the session will be the first thumbnail shown in the list followed by its games (if any). Note that the session is selected by default.


Steps: To Load a Game into Driver - Either:-
 Double Left Click  on the Game you want to load
  OR
 Left Click  on the Game you want to load
Left Click on the  DRIVE SESSION  button

Driver Game

This will load the saved Game, the session and the route into Driver


If you load a 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 Game.
If you have opened the Game in Driver directly from Content Manager then you will not be given this warning
 
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Options:-
 Cancel  - the Game will NOT be loaded, OR
 Ok  - load the Game wirh the changes


If the changes to the route or session have been:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 minor and non-operational, such as scenery assets (trees, buildings, etc) then the Game can be safely loaded.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 more significant operational changes, such as triggers, trackmarks, active industries, consists, tracks, etc, then it may NOT be wise to load and run the Game.


Only you can be the judge but I would err on the side of caution


Editing Games

Skip Down Skip Up        
You can edit a saved Game using the UDS (Unified Driver Surveyor) interface. However:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 if you edit the the Route then those edits will be saved as a Route, not a Game. You can select to create a new route or overwrite (update) the original route
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 if you edit the Session then those edits will be saved as a Session, not a Game. You can select to create a new session or to overwrite (update) the original session

In both cases the changes you make will appear in the Game when you use the UDS to return to Driver and will be part of the Game when you next save.


Steps: To Edit a Game:-
Use the UDS to switch from Driver to Surveyor. The game will be immediately paused so that nothing will be moving while you are in Surveyor (do not switch OFF the Pause function)
Edit the Route and/or Session as you normally would in Surveyor. Save if you want to make the changes permanent
Use the UDS to switch back to Driver. Press the  P  key to cancel the Pause and resume game play


Deleting Routes and Sessions

  Skip Up Top Next Up   Bottom
Deleting a Route will delete that Route, all its Sessions and all its saved Games (if any)
Deleting a Session will delete that Session and its saved Games (if any). It will NOT delete the Route it was created from. It will NOT delete other Sessions created for that Route. It will NOT delete any other Games created for those other Sessions
Deleting a Game will only delete that Game. It will NOT delete the Route or Session it was created from or any other Games from that Session


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 Games created using that Route
If you delete a Session you will also delete all the Games created using that Session


If you need a more selective way of deleting routes, sessions and games, then use Content Manager from the Trainz Launch Screen. Select the Filter Routes & Sessions.

CM list of routes and sessions

The Type column will identify each entry as a route, session or Misc. Misc in this case means a saved Game.

You can delete routes and/or sessions individually but if you delete a route by itself then its dependant sessions and games will be shown as faulty with Missing dependencies. Likewise, if you delete a session by itself then its dependant games will be shown as faulty with Missing dependencies.


 

    Top Next Up    


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.