Route and Session Basics
m (→What is a Route?) |
m |
||
(47 intermediate revisions by one user not shown) | |||
Line 23: | Line 23: | ||
</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''' 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> |
<table cellpadding=4> | <table cellpadding=4> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 30: | Line 30: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | '''Sessions''' are also created in '''Surveyor''' but are designed to be run in '''Driver'''. | + | '''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, regardless of whether you are driving them manually or using the AI. 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. A session can also contain scenery items that are specific to a particular railway operation, season of the year or time of day that will only appear in that specific session. 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> |
<table cellpadding=4> | <table cellpadding=4> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 37: | Line 37: | ||
</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 | + | '''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> |
</tr> | </tr> | ||
</table> | </table> | ||
Line 52: | Line 52: | ||
='''What is a Route?'''= | ='''What is a Route?'''= | ||
− | A | + | 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 (TurfFX and Clutter), plus some "environmental" features.<br> |
− | A | + | A route consists of two parts:- |
#'''Route Data''' and | #'''Route Data''' and | ||
#'''Route Layers'''. | #'''Route Layers'''. | ||
Line 71: | Line 71: | ||
<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>The '''Route Data''' stores all those features that are '''painted''' into a layout using a '''brush tool'''</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|link=]]</td> | ||
+ | <td>The '''Route Data''' stores all the '''Environmental Data''' including the '''World Origin''' (latitude, longitude, altitude)</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Line 83: | Line 87: | ||
*'''Ground Textures''' including the grid pattern which is a texture | *'''Ground Textures''' including the grid pattern which is a texture | ||
*'''TurfFX and Clutter''' - found in the '''Effects Layers''' | *'''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. You must edit and save the | + | *'''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=]] [[How_to_Use_Environment_Tools|How to Use the Environment Tools]]''' for more details.<br> |
<span style="font-weight: 700; font-size: 17px; color: white; background-color: black;"> Route Layers: </span> | <span style="font-weight: 700; font-size: 17px; color: white; background-color: black;"> Route Layers: </span> | ||
<table cellpadding=4 bgcolor=#c1e7e7> | <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 | + | <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> | </table> | ||
<br> | <br> | ||
− | All scenery assets are held in layers. '''Route Layers''' give you a way of organising or grouping the assets displayed in your | + | 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]] | [[image:Woolshed_Route_Layers.png|link=|alt=Route Layers]] | ||
Line 105: | Line 109: | ||
*Lineside and Fixed Cameras | *Lineside and Fixed Cameras | ||
*Trackmarks, Triggers, Direction and Priority Marks | *Trackmarks, Triggers, Direction and Priority Marks | ||
− | + | <br> | |
+ | <table bgcolor=#000000 width=900 cellpadding=2> | ||
+ | <tr valign="top"> | ||
+ | <td> | ||
+ | <table bgcolor=#ffffb0 cellpadding=2> | ||
+ | <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 issue.</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <br> | ||
<table cellpadding=4 bgcolor="Aquamarine"> | <table cellpadding=4 bgcolor="Aquamarine"> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 126: | Line 143: | ||
='''Loading (and Creating) a Route'''= | ='''Loading (and Creating) a Route'''= | ||
− | 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 | + | 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> |
[[image:TRS19MainScreen.png|link=|alt=TRS19 Main Screen options]] | [[image:TRS19MainScreen.png|link=|alt=TRS19 Main Screen options]] | ||
Line 135: | Line 152: | ||
The <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> MAIN MENU </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;"> MAIN MENU </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;"> Sort By A-Z </span> will give you a drop down menu of sorting options for the thumbnail list.<br> | + | The <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Sort By A-Z </span> (top right of the image above) 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 [[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> | The thumbnail images are colour coded.<br> | ||
− | <table> | + | <table width=900> |
<tr valign="top"> | <tr valign="top"> | ||
<td bgcolor=#ffae00 width=50> </td> | <td bgcolor=#ffae00 width=50> </td> | ||
− | <td>'''Payware'''</td> | + | <td width=150>'''Payware on DLC'''</td> |
− | <td>'''DLC''' | + | <td>Must be purchased and downloaded, but some may be free. There will be a <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> DOWNLOAD </span> button 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 valign="top"> | ||
+ | <td bgcolor=#10c810 width=50> </td> | ||
+ | <td>'''Payware installed'''</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"> | ||
Line 152: | Line 174: | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td bgcolor=#848dff width=50> </td> | + | <td bgcolor=#848dff width=50> <br> </td> |
− | <td>''' | + | <td>'''Multiplayer'''</td> |
− | <td> | + | <td>For simultaneous development by multiple players. Special conditions apply</td> |
</tr> | </tr> | ||
</table> | </table> | ||
<br> | <br> | ||
=='''Creating a New Route'''== | =='''Creating a New Route'''== | ||
− | On the '''Driver/Surveyor''' screen the | + | 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]] | [[image:RouteButtonsCreate.png|link=|alt=Create a New Route]] | ||
Line 175: | Line 197: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:PencilTips.PNG|link=]]</td> | <td>[[image:PencilTips.PNG|link=]]</td> | ||
− | <td>All these settings plus others can be easily changed at any time after the | + | <td>All these settings plus others can be easily changed at any time after the route has been created. |
<table> | <table> | ||
<tr> | <tr> | ||
Line 225: | Line 247: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint1.JPG|link=]]</td> | <td>[[image:DotPoint1.JPG|link=]]</td> | ||
− | <td>You do not have to add the name of a | + | <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> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td> </td> | <td> </td> | ||
− | <td>A | + | <td>A session can always be deleted later if you have no interest in creating one for your route - see '''[[file:PageLink.PNG|link=]] [[#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=]] [[#What is a Session?|What is a Session?]]''' below.</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint2.JPG|link=]]</td> | <td>[[image:DotPoint2.JPG|link=]]</td> | ||
− | <td>Setting a '''Geographical region''' sets some basic features of the | + | <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=]] [[How to Create a Region Asset|How to Create a Region Asset]]'''</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 251: | Line 273: | ||
=='''Loading an Existing Route'''== | =='''Loading an Existing Route'''== | ||
− | You must first find and select the | + | 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]] | [[image:RouteSearchButtons.png|link=|alt=Route Search]] | ||
Line 262: | Line 284: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>'''Source:'''</td> | <td>'''Source:'''</td> | ||
− | <td><span style="background-color: black; color: white; font-weight: 700;"> PURCHASED </span> is the default selection, Click and change to <span style="background-color: black; color: white; font-weight: 700;"> MY CONTENT </span> for a | + | <td><span style="background-color: black; color: white; font-weight: 700;"> PURCHASED </span> is the default selection, Click and change to <span style="background-color: black; color: white; font-weight: 700;"> MY CONTENT </span> for a route you have created (or already modified) or to <span style="background-color: black; color: white; font-weight: 700;"> INSTALLED </span> for one you have downloaded from the '''DLS'''.</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>'''Region:'''</td> | <td>'''Region:'''</td> | ||
− | <td><span style="background-color: black; color: white; font-weight: 700;"> ALL </span> is the default selection. You can select a particular geographic region if required and '''IF''' the | + | <td><span style="background-color: black; color: white; font-weight: 700;"> ALL </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>'''Search:'''</td> | <td>'''Search:'''</td> | ||
− | <td>You can narrow down the list of | + | <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> | ||
Line 277: | Line 299: | ||
[[image:RouteSelectExisting.png|link=|alt=Existing Routes]] | [[image:RouteSelectExisting.png|link=|alt=Existing Routes]] | ||
− | Click on the thumbnail for the | + | 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;"> EDIT ROUTE </span> button to load the route into '''Surveyor'''. |
[[image:RouteButtonsEdit.png|link=|alt=Edit Route]] | [[image:RouteButtonsEdit.png|link=|alt=Edit Route]] | ||
+ | <br><br> | ||
+ | <table bgcolor=#000000 cellpadding=2 width=900> | ||
+ | <tr valign="top"> | ||
+ | <td> | ||
+ | <table bgcolor=#ffffb0 cellpadding=2> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:NotePad.PNG|link=]]</td> | ||
+ | <td><span style="font-size: 17px; font-weight: 700;">Notes: Routes and Sessions - An Endless Source of Confusion</span> | ||
+ | ---- | ||
+ | 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.<br> | ||
+ | |||
+ | 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.<br> | ||
+ | |||
+ | You can easily move most scenery objects from a session into a route if needed - see the Trainz Wiki Page '''[[image:WikiLink.PNG|link=]] [[How_to_Use_Bulk_Asset_Update/Replace_Tool|How to Use the Bulk Asset Update/Replace Tool]]''' for more details. | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
=='''Loading a Route Into Surveyor From Content Manager'''== | =='''Loading a Route Into Surveyor From Content Manager'''== | ||
− | '''Trainz''' provides a shortcut that allows you to load an existing | + | '''Trainz''' provides a shortcut that allows you to load an existing route directly into '''Surveyor''' for editing from '''Content Manager'''.<br> |
<table> | <table> | ||
Line 297: | Line 339: | ||
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br> | ||
#in '''Content Manager''' select the filter '''Routes & Sessions''' | #in '''Content Manager''' select the filter '''Routes & Sessions''' | ||
− | #select the | + | #select the route to be edited |
#use the '''right-mouse-button''' to open the '''Command Menu''' | #use the '''right-mouse-button''' to open the '''Command Menu''' | ||
#select '''Open...''', then | #select '''Open...''', then | ||
Line 313: | Line 355: | ||
=='''Loading After an Unexpected Shutdown'''== | =='''Loading After an Unexpected Shutdown'''== | ||
− | If you select a | + | 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> | <table width=1000> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 326: | Line 368: | ||
<td><span style="font-size: 17px; font-weight: 700;">Note:'''</span> | <td><span style="font-size: 17px; font-weight: 700;">Note:'''</span> | ||
---- | ---- | ||
− | A similar message will appear when you load a '''Driver Game''' (see '''[[file:PageLink.PNG|link=]] [[#Saving and Loading Sessions in Driver|Saving and Loading Sessions in Driver]]''' below) after editing the original | + | A similar message will appear when you load a '''Driver Game''' (see '''[[file:PageLink.PNG|link=]] [[#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> | It is possible that the changes you have made may affect the operation of the '''Driver Session'''.</td> | ||
Line 338: | Line 380: | ||
</table> | </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 | + | 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> |
The options you will see are:-<br> | The options you will see are:-<br> | ||
Line 358: | Line 400: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | You could also use the '''Content Manager''' program (select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Manage Content </span> from the '''Trainz Launcher''') to Submit the open | + | You could also use the '''Content Manager''' program (select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Manage Content </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> | <br> | ||
Line 369: | Line 411: | ||
</table> | </table> | ||
− | When you create a new | + | 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=]] [[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> | 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> | ||
Line 380: | Line 422: | ||
<td>[[file:Stop.PNG|link=]]</td> | <td>[[file:Stop.PNG|link=]]</td> | ||
<td> | <td> | ||
− | <span style="font- | + | <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> |
− | Moving or deleting a section of track that is occupied by a | + | '''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> |
− | + | <span style="font-size: 15px; font-weight: 700;">Prevention:</span><br> | |
+ | |||
+ | 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 461: | Line 505: | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <br> | ||
+ | =='''Merging Routes'''== | ||
+ | <table cellpadding=4 bgcolor=#c1e7e7> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|link=]]</td> | ||
+ | <td>'''Two (or more) separate routes can be joined together (merged) to create a new route'''</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | |||
+ | There are some important restrictions on the merging of two routes:- | ||
+ | *'''Payware (DLC)''' routes cannot be merged with '''Freeware (DLS)''' or other '''Payware''' routes | ||
+ | *The '''Session Data''' and '''Session Layers''' in the first route can be saved in the merger, if required, but those in the other route are not | ||
+ | *There may be a significant height difference between the two routes and this may not be easy to overcome | ||
+ | *The orientation of the two routes (East-West or North-South) cannot be changed | ||
+ | <br> | ||
+ | <table cellpadding=4 bgcolor="Aquamarine"> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:LinkWiki.PNG|link=]]</td> | ||
+ | <td> | ||
+ | A detailed description of the process of '''Merging Routes''' can be found on the '''Trainz Wiki Page [[How_to_Merge_Routes|How to Merge Routes]]'''<br> | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 487: | Line 554: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | In general, while a | + | 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 | + | 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 | + | A session consists of two parts:- |
#'''Session Data''' and | #'''Session Data''' and | ||
#'''Session Layers'''. | #'''Session Layers'''. | ||
Line 505: | Line 572: | ||
<span style="font-weight: 700; font-size: 17px; color: white; background-color: black;"> Session Data: </span> | <span style="font-weight: 700; font-size: 17px; color: white; background-color: black;"> Session Data: </span> | ||
− | '''Session Data''' are often the "invisibles" that control the operation of a | + | '''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]] | [[image:Woolshed_Session_Data.png|link=|alt=Session Data]] | ||
Line 515: | Line 582: | ||
*'''Industry Settings''' (commodities consumed and produced) | *'''Industry Settings''' (commodities consumed and produced) | ||
*'''Consist Settings''' (commodities carried) | *'''Consist Settings''' (commodities carried) | ||
− | *'''Consist Locations''' - this is stored in the | + | *'''Consist Locations''' - this is stored in the session even if the consists are placed in the route |
− | *'''Switch Settings''' (left/right) - but the '''default''' switch direction is stored in the | + | *'''Switch Settings''' (left/right) - but the '''default''' switch direction is stored in the route |
− | *'''Environmental Settings''' - '''Water Surface''' (rough/calm/etc), '''Snow Altitude''', '''Lighting''' (sun, ambient and water colours), '''Sky''' (clouds), '''Road Traffic''' (on/off), '''Date''' (day, month), '''Wind''' strength, '''Fog''' level, '''Weather''' (rain/fine/snow), '''Brightness''' level. You must edit and save the | + | *'''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 '''[[image:WikiLink.PNG|link=]] [[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> | <br> | ||
<span style="font-weight: 700; font-size: 17px; color: white; background-color: black;"> Session Layers: </span> | <span style="font-weight: 700; font-size: 17px; color: white; background-color: black;"> Session Layers: </span> | ||
Line 534: | Line 601: | ||
[[image:Woolshed_Session_Layers.png|link=|alt=Session layers]] | [[image:Woolshed_Session_Layers.png|link=|alt=Session layers]] | ||
− | '''Session Layers''' give you a way of organising or grouping the assets displayed in your | + | '''Session Layers''' give you a way of organising or grouping the assets displayed in your session.<br> |
<table width=800> | <table width=800> | ||
Line 582: | Line 649: | ||
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br> | ||
---- | ---- | ||
− | '''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 | + | '''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:- | 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 | + | *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 | + | *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 | + | *trackmarks and triggers that are only required in one session but not in all sessions |
− | *crowds of onlookers alongside the track in a | + | *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 | + | *historic rolling stock in a special vintage train session running on a modern route |
</td> | </td> | ||
</tr> | </tr> | ||
Line 617: | Line 684: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | A new | + | A new session can be created in two ways:-<br> |
<table width=900> | <table width=900> | ||
Line 626: | Line 693: | ||
<td width=450>[[image:RouteSARWindow.png|link=|alt=Route Details]]</td> | <td width=450>[[image:RouteSARWindow.png|link=|alt=Route Details]]</td> | ||
<td>Follow the steps shown in the section '''[[file:PageLink.PNG|link=]] [[#Creating a New Route|Creating a New Route]]''' above by entering:- | <td>Follow the steps shown in the section '''[[file:PageLink.PNG|link=]] [[#Creating a New Route|Creating a New Route]]''' above by entering:- | ||
− | *a '''Route name''' for the new | + | *a '''Route name''' for the new route |
− | *a '''Session name''' for the new | + | *a '''Session name''' for the new session |
*a '''Geographical region''' | *a '''Geographical region''' | ||
*'''Working scale''' and '''Working units'''</td> | *'''Working scale''' and '''Working units'''</td> | ||
Line 648: | Line 715: | ||
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br> | ||
---- | ---- | ||
− | A | + | 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> | ||
</tr> | </tr> | ||
Line 656: | Line 723: | ||
</table> | </table> | ||
− | The first step is to locate (but not load) the | + | The first step is to locate (but not load) the route as described in the section '''[[file:PageLink.PNG|link=]] [[#Loading an Existing Route|Loading an Existing Route]]''' above. |
− | Once you have selected the | + | Once you have selected the route from its thumbnail, click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> VIEW SESSIONS </span> button. |
[[image:RouteButtonsView.png|link=|alt=View Sessions]] | [[image:RouteButtonsView.png|link=|alt=View Sessions]] | ||
− | Then click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> CREATE SESSION </span> button. If no other | + | Then click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> CREATE SESSION </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]] | [[image:SessionButtonsCreate.png|link=|alt=Create Session]] | ||
Line 672: | Line 739: | ||
</table> | </table> | ||
− | Both methods will load the | + | 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'''== | =='''Loading an Existing Session'''== | ||
− | There are two different ways to load existing | + | There are two different ways to load existing sessions into '''Surveyor'''.<br> |
<table width=900> | <table width=900> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 681: | Line 748: | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>The easiest way to load an existing | + | <td>The easiest way to load an existing session is to use the search tools at the top of the '''Driver/Surveyor''' screen. |
[[image:SessionSearchButtons.png|link=|alt=Session Search]] | [[image:SessionSearchButtons.png|link=|alt=Session Search]] | ||
Line 692: | Line 759: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>'''Source:'''</td> | <td>'''Source:'''</td> | ||
− | <td><span style="background-color: black; color: white; font-weight: 700;"> PURCHASED </span> is the default selection, Click and change to <span style="background-color: black; color: white; font-weight: 700;"> MY CONTENT </span> for a | + | <td><span style="background-color: black; color: white; font-weight: 700;"> PURCHASED </span> is the default selection, Click and change to <span style="background-color: black; color: white; font-weight: 700;"> MY CONTENT </span> for a session you have created (or already modified) or to <span style="background-color: black; color: white; font-weight: 700;"> INSTALLED </span> for one you have downloaded from the '''DLS'''.</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 700: | Line 767: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>'''Search:'''</td> | <td>'''Search:'''</td> | ||
− | <td>If required you can narrow down the list of | + | <td>If required you can narrow down the list of sessions by typing the first few letters of its name.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
Line 707: | Line 774: | ||
</table> | </table> | ||
− | This will produce a list of | + | 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]] | [[image:SessionSelectExisting.png|link=|alt=Existing Sessions]] | ||
− | The same colour coding system used in the | + | The same colour coding system used in the route thumbnails also applies to session thumbnails.<br> |
<table width=900> | <table width=900> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td bgcolor=#ffae00 width=50> </td> | <td bgcolor=#ffae00 width=50> </td> | ||
− | <td>'''Payware'''</td> | + | <td width=150>'''Payware on DLC'''</td> |
− | <td>'''DLC''' | + | <td>Must be purchased and downloaded, but some may be free. There will be a <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> DOWNLOAD </span> button 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 valign="top"> | ||
+ | <td bgcolor=#10c810 width=50> </td> | ||
+ | <td>'''Payware installed'''</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"> | ||
Line 725: | Line 797: | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td bgcolor=#848dff width=50> </td> | + | <td bgcolor=#848dff width=50> <br> </td> |
− | <td>''' | + | <td>'''Multiplayer'''</td> |
− | <td> | + | <td>For simultaneous development by multiple players. Special conditions apply</td> |
</tr> | </tr> | ||
</table> | </table> | ||
<br> | <br> | ||
− | Click on the thumbnail for the | + | 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;"> EDIT SESSION </span> button. This will load '''BOTH''' the route and the session into '''Surveyor'''. |
[[image:SessionButtonsEdit2.png|link=|alt=Edit Session]] | [[image:SessionButtonsEdit2.png|link=|alt=Edit Session]] | ||
Line 742: | Line 814: | ||
<td>[[image:NotePad.PNG|link=]]</td> | <td>[[image:NotePad.PNG|link=]]</td> | ||
<td> | <td> | ||
− | If the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> EDIT SESSION </span> option is not present then the selected | + | If the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> EDIT SESSION </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=]] [[#Saving and Loading Sessions in Driver|Saving and Loading Sessions in Driver]]''' below. |
</td> | </td> | ||
</tr> | </tr> | ||
Line 755: | Line 827: | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>Select the | + | <td>Select the route as described in the section '''[[file:PageLink.PNG|link=]] [[#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;"> VIEW SESSIONS </span> button. |
[[image:RouteButtonsView.png|link=|alt=View Sessions]] | [[image:RouteButtonsView.png|link=|alt=View Sessions]] | ||
− | This will display a list of thumbnails for all the | + | 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;"> EDIT SESSION </span> button. |
[[image:SessionButtonsEdit2.png|link=|alt=Edit Session]] | [[image:SessionButtonsEdit2.png|link=|alt=Edit Session]] | ||
− | Again, both the selected | + | Again, both the selected route and its session will be loaded into '''Surveyor'''.<br> |
<table bgcolor=#000000 width=900> | <table bgcolor=#000000 width=900> | ||
Line 772: | Line 844: | ||
<td>[[image:NotePad.PNG|link=]]</td> | <td>[[image:NotePad.PNG|link=]]</td> | ||
<td> | <td> | ||
− | If the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> EDIT SESSION </span> option is not present then the selected | + | If the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> EDIT SESSION </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=]] [[#Saving and Loading Sessions in Driver|Saving and Loading Sessions in Driver]]''' below. |
</td> | </td> | ||
</tr> | </tr> | ||
Line 787: | Line 859: | ||
=='''Loading a Session Into Surveyor From Content Manager'''== | =='''Loading a Session Into Surveyor From Content Manager'''== | ||
− | '''Trainz''' provides a shortcut that allows you to load an existing | + | '''Trainz''' provides a shortcut that allows you to load an existing session directly into '''Surveyor''' for editing from '''Content Manager'''.<br> |
<table> | <table> | ||
Line 802: | Line 874: | ||
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br> | ||
#in '''Content Manager''' select the filter '''Routes & Sessions''' | #in '''Content Manager''' select the filter '''Routes & Sessions''' | ||
− | #select the | + | #select the session to be loaded and edited in '''Surveyor''' |
#use the '''right-mouse-button''' to open the '''Command Menu''' | #use the '''right-mouse-button''' to open the '''Command Menu''' | ||
#select '''Open...''', then | #select '''Open...''', then | ||
Line 813: | Line 885: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | Both the | + | Both the route and the session will be loaded into '''Surveyor''' for editing. |
</td> | </td> | ||
</tr> | </tr> | ||
Line 819: | Line 891: | ||
=='''Loading a Session into Driver From Surveyor'''== | =='''Loading a Session into Driver From Surveyor'''== | ||
− | To start '''Driver''' simply select a | + | 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;"> DRIVE SESSION </span> button.<br> |
[[image:DriverButtons.png|link=|alt=Driver Game]]<br> | [[image:DriverButtons.png|link=|alt=Driver Game]]<br> | ||
− | This will load both the | + | 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=]] [[#Saving and Loading Sessions in Driver|Saving and Loading Sessions in Driver]]''' below. | You can save your "game play" in '''Driver''' at anytime. See '''[[file:PageLink.PNG|link=]] [[#Saving and Loading Sessions in Driver|Saving and Loading Sessions in Driver]]''' below. | ||
=='''Loading a Session into Driver From Content Manager'''== | =='''Loading a Session into Driver From Content Manager'''== | ||
− | '''Trainz''' provides a shortcut that allows you to load an existing | + | '''Trainz''' provides a shortcut that allows you to load an existing session directly into '''Driver''' from '''Content Manager'''.<br> |
<table> | <table> | ||
Line 843: | Line 915: | ||
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br> | ||
#in '''Content Manager''' select the filter '''Routes & Sessions''' | #in '''Content Manager''' select the filter '''Routes & Sessions''' | ||
− | #select the | + | #select the session to drive |
#use the '''right-mouse-button''' to open the '''Command Menu''' | #use the '''right-mouse-button''' to open the '''Command Menu''' | ||
#select '''Open...''', then | #select '''Open...''', then | ||
Line 854: | Line 926: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | The | + | The session and its parent route will be loaded into '''Driver''' and the simulation will be started. |
</td> | </td> | ||
</tr> | </tr> | ||
Line 867: | Line 939: | ||
</table> | </table> | ||
− | When you create a new | + | 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=]] [[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> | 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> | ||
Line 985: | Line 1,057: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>Selecting <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Save </span> or pressing <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Ctrl </span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> S </span> will save the | + | <td>Selecting <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Save </span> or pressing <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Ctrl </span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> S </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 if you wish) and the '''Save''' command.<br><br></td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>Selecting <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Save As... </span> will save the | + | <td>Selecting <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Save As... </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 if you wish) and the '''Save As''' command.<br><br></td> |
</tr> | </tr> | ||
</table> | </table> | ||
Line 999: | Line 1,071: | ||
<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 Saving: | + | <td><span style="font-size: 17px; font-weight: 700;">Notes on Saving Routes and Sessions:</span><br> |
---- | ---- | ||
<table bgcolor=#ffffb0> | <table bgcolor=#ffffb0> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>''' | + | <td>'''DLS routes and sessions''' can be modified and saved as new routes and sessions. |
+ | <span style="font-weight: 700; font-size: 15px;">Modifying and creating:-</span> | ||
+ | *if you have modified a '''DLS''' route then you can delete the original route if you no longer need it and your modified version will not be affected | ||
+ | *if you have modified a '''DLS''' session then you can delete the original session if you no longer need it and your modified version will not be affected. However, if you delete the original '''DLS''' route then your modified session <span style="font-weight: 700; color: white; background-color: red;"> will not work </span> | ||
+ | *you can create a new session for a '''DLS''' route but it <span style="font-weight: 700; color: white; background-color: red;"> will not work </span> if the original '''DLS''' route is deleted | ||
+ | <span style="font-weight: 700; font-size: 15px;">Saving:-</span> | ||
+ | *when saved, modified '''DLS''' routes and sessions will become '''Your Content''' and can be found using the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> MY CONTENT </span> search option in '''Surveyor/Driver''' | ||
+ | *the original '''DLS''' routes and sessions will not be altered or replaced by your modified versions | ||
+ | <span style="font-weight: 700; font-size: 15px;">Uploading:-</span> | ||
+ | *you can only upload your modified '''DLS''' route and session to the '''DLS''' if you have the <span style="font-weight: 700; text-decoration: underline;">permission</span> of the original creator | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>''' | + | <td>'''DLC routes and sessions''' can also be modified and saved as new routes and sessions '''''if the creators of the original DLC content have allowed it''''' - see [[image:PageLink.PNG|link=]] '''[[#Cloning a Route/Session|Cloning a Route/Session]]''' below for more details |
− | <span style=" | + | <span style="font-weight: 700; font-size: 15px;">Modifying and creating:-</span> |
− | + | *some '''DLC''' routes and sessions are encrypted and cannot be modified - that is a decision made by the content creator | |
− | + | *your modified '''DLC''' route or session will become an ''alias'' of the original and will need the original route and session to be present on your system to work | |
− | + | *if you delete or disable the original '''DLC''' route or session then your modified versions <span style="font-weight: 700; color: white; background-color: red;"> will not work </span> | |
− | + | *you can create a new session for a '''DLC''' route but it <span style="font-weight: 700; color: white; background-color: red;"> will not work </span> if the original '''DLC''' route is deleted or disabled | |
− | + | <span style="font-weight: 700; font-size: 15px;">Saving:-</span> | |
− | + | *when saved, a modified '''DLC''' route or session will become '''Your Content''' and can be found using the <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> MY CONTENT </span> search option in '''Surveyor/Driver''' | |
− | + | *the original '''DLC''' route and session will not be altered or replaced by your modified versions | |
− | + | <span style="font-weight: 700; font-size: 15px;">Uploading:-</span> | |
− | + | *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</td> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | < | + | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | * | + | |
− | + | ||
− | + | ||
− | < | + | |
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
</table> | </table> | ||
Line 1,055: | Line 1,105: | ||
</tr> | </tr> | ||
</table> <!-- END Notes Table --> | </table> <!-- END Notes Table --> | ||
− | + | <br> | |
=='''Saving a New Route and Session'''== | =='''Saving a New Route and Session'''== | ||
− | If you have created a new | + | 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> | <table width=900> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 1,064: | Line 1,114: | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td colspan=2>In both cases the name of the | + | <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> |
</tr> | </tr> | ||
</table> | </table> | ||
Line 1,072: | Line 1,122: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>If you have loaded the | + | <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> |
</tr> | </tr> | ||
</table> | </table> | ||
Line 1,087: | Line 1,137: | ||
<td>[[image:Gears.PNG|link=]]</td> | <td>[[image:Gears.PNG|link=]]</td> | ||
<td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br> | ||
− | [[image:DotPoint1.JPG|link=]] Overwrite | + | '''Option''' [[image:DotPoint1.JPG|link=]] Overwrite route only. This is the '''default''' selection so there is nothing to change. |
:[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | :[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | ||
::[[image:White_Select_Dot.png|link=]] '''Do not save session''' | ::[[image:White_Select_Dot.png|link=]] '''Do not save session''' | ||
− | ::*the | + | ::*the route will be saved ('''overwritten''' using its current name) but no session will be saved. |
− | [[image:DotPoint2.JPG|link=]] Overwrite | + | '''Option''' [[image:DotPoint2.JPG|link=]] Overwrite route and create a new session. Tick the box [[image:White_Select_Dot.png|link=]] '''Create new session'''. |
:[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | :[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | ||
::[[image:White_Select_Dot.png|link=]] '''Create new session:''' | ::[[image:White_Select_Dot.png|link=]] '''Create new session:''' | ||
− | ::*enter a name for the | + | ::*enter a name for the session (the suggested name '''Default''' is '''NOT''' recommended). |
− | ::*the | + | ::*the route will be saved ('''overwritten''' using its current name). |
− | ::*a new | + | ::*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 | + | ::*because you did not originally load a session, the new session will be saved with '''default''' values for all settings. |
− | [[image:DotPoint3.JPG|link=]] Create new ''' | + | '''Option''' [[image:DotPoint3.JPG|link=]] Create new route and a '''default Session'''. Tick the box [[image:White_Select_Dot.png|link=]] '''Save new route and session'''. |
:[[image:White_Select_Dot.png|link=]] '''Save new route and session:''' | :[[image:White_Select_Dot.png|link=]] '''Save new route and session:''' | ||
− | ::*enter a new name for the | + | ::*enter a new name for the route. The route will be saved with its new name. |
− | ::*the original | + | ::*the original route will not be changed. |
− | ::*a new | + | ::*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 | + | ::*because you did not originally load a session, the new session will be saved with the '''default''' values for all settings. |
</td> | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td colspan=2 align="right">After you have made your selections, click [[image:Tick.PNG|link=|25px]] to '''Accept''' or [[image:Cross.PNG|link=|25px]] to '''Cancel'''</td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 1,118: | Line 1,171: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>If you have loaded the | + | <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> |
</tr> | </tr> | ||
</table> | </table> | ||
<table> | <table> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[image:RouteSARSaveExistingNewSession.png|link=|alt=Save Route with Session]]<td> | + | <td>[[image:RouteSARSaveExistingNewSession.png|link=|alt=Save Route with Session]]</td> |
<td> | <td> | ||
<table bgcolor=#eeeeee width=800> | <table bgcolor=#eeeeee width=800> | ||
Line 1,133: | Line 1,186: | ||
<td>[[image:Gears.PNG|link=]]</td> | <td>[[image:Gears.PNG|link=]]</td> | ||
<td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br> | ||
− | [[image:DotPoint1.JPG|link=]] Overwrite | + | '''Option''' [[image:DotPoint1.JPG|link=]] Overwrite route and create a new session. This is the '''default''' selection so there is nothing to change. |
:[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | :[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | ||
::[[image:White_Select_Dot.png|link=]] '''Create new session:''' | ::[[image:White_Select_Dot.png|link=]] '''Create new session:''' | ||
− | ::*enter a name for the | + | ::*enter a name for the session (the suggested name '''Default''' is '''NOT''' recommended). |
− | ::*the | + | ::*the route will be saved ('''overwritten''' using its current name). |
− | ::*a new | + | ::*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=]] Overwrite ''' | + | '''Option''' [[image:DotPoint2.JPG|link=]] Overwrite route only. Tick the box [[image:White_Select_Dot.png|link=]] '''Do not save session'''. |
:[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | :[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | ||
::[[image:White_Select_Dot.png|link=]] '''Do not save session''' | ::[[image:White_Select_Dot.png|link=]] '''Do not save session''' | ||
− | ::*the | + | ::*the route will be saved ('''overwritten''' using its current name) but no session will be saved. |
− | ::*the changes you have made to the ''' | + | ::*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. |
− | [[image:DotPoint3.JPG|link=]] Create new ''' | + | '''Option''' [[image:DotPoint3.JPG|link=]] Create new route and a '''default Session'''. Tick the box [[image:White_Select_Dot.png|link=]] '''Save new route and session'''. |
:[[image:White_Select_Dot.png|link=]] '''Save new route and session:''' | :[[image:White_Select_Dot.png|link=]] '''Save new route and session:''' | ||
− | ::*enter a new name for the | + | ::*enter a new name for the route. The route will be saved with its new name. |
− | ::*the original | + | ::*the original route will not be changed. |
− | ::*a new | + | ::*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> | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td colspan=2 align="right">After you have made your selections, click [[image:Tick.PNG|link=|25px]] to '''Accept''' or [[image:Cross.PNG|link=|25px]] to '''Cancel'''</td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 1,160: | Line 1,216: | ||
</table> | </table> | ||
<br> | <br> | ||
− | + | <table bgcolor=#000000 width=900 cellpadding=2> | |
+ | <tr valign="top"> | ||
+ | <td> | ||
+ | <table bgcolor=#ffffb0 width=896 cellpadding=2> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:NotePad.PNG|link=]]</td> | ||
+ | <td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br> | ||
+ | ---- | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|link=]]</td> | ||
+ | <td>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).</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|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 and this '''will''' cause confusion. This is why it is not a good idea to use '''Default''' as a session name.</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <br> | ||
=='''Saving an Existing Route and Session'''== | =='''Saving an Existing Route and Session'''== | ||
<table> | <table> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>If you have loaded a | + | <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> |
</tr> | </tr> | ||
</table> | </table> | ||
<table> | <table> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[image:RouteSessionSARSaveExisting.png|link=|alt=Save Route and Session]]<td> | + | <td>[[image:RouteSessionSARSaveExisting.png|link=|alt=Save Route and Session]]</td> |
<td> | <td> | ||
<table bgcolor=#eeeeee width=800> | <table bgcolor=#eeeeee width=800> | ||
Line 1,180: | Line 1,256: | ||
<td>[[image:Gears.PNG|link=]]</td> | <td>[[image:Gears.PNG|link=]]</td> | ||
<td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br> | ||
− | [[image:DotPoint1.JPG|link=]] Overwrite | + | '''Option''' [[image:DotPoint1.JPG|link=]] Overwrite route and session. This is the '''default''' selection so there is nothing to change. |
:[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | :[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | ||
::[[image:White_Select_Dot.png|link=]] '''Overwrite existing session:''' | ::[[image:White_Select_Dot.png|link=]] '''Overwrite existing session:''' | ||
− | ::*both the | + | ::*both the route and the session will be saved ('''overwritten''' using their current names). |
− | [[image:DotPoint2.JPG|link=]] Overwrite existing | + | '''Option''' [[image:DotPoint2.JPG|link=]] Overwrite existing route and create a new session. Tick the box [[image:White_Select_Dot.png|link=]] '''Create new session'''. |
:[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | :[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | ||
::[[image:White_Select_Dot.png|link=]] '''Create new session:''' | ::[[image:White_Select_Dot.png|link=]] '''Create new session:''' | ||
− | ::*enter a new name for the | + | ::*enter a new name for the session. |
− | ::*the | + | ::*the route will be saved ('''overwritten''' using its current name). |
− | ::*a new | + | ::*a new session will be created using the name you enter and it will be added to the existing route. |
− | ::*the original | + | ::*the original session will not be changed. |
− | [[image:DotPoint3.JPG|link=]] Overwrite ''' | + | '''Option''' [[image:DotPoint3.JPG|link=]] Overwrite route only. Tick the box [[image:White_Select_Dot.png|link=]] '''Do not save session'''. |
:[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | :[[image:White_Select_Dot.png|link=]] '''Overwrite existing route and:''' | ||
::[[image:White_Select_Dot.png|link=]] '''Do not save session''' | ::[[image:White_Select_Dot.png|link=]] '''Do not save session''' | ||
− | ::*the | + | ::*the route will be saved ('''overwritten''' using its current name) but no session will be saved. |
− | ::*the changes you have made to the ''' | + | ::*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. |
− | [[image:DotPoint4.JPG|link=]] Create a new | + | '''Option''' [[image:DotPoint4.JPG|link=]] Create a new route and a new session. Tick the box [[image:White_Select_Dot.png|link=]] '''Save new route and session'''. |
:[[image:White_Select_Dot.png|link=]] '''Save new route and session:''' | :[[image:White_Select_Dot.png|link=]] '''Save new route and session:''' | ||
− | ::*enter a new name for the | + | ::*enter a new name for the route. |
− | ::*the | + | ::*the route will be saved with its new name. |
− | ::*a new | + | ::*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 | + | ::*the original session and route will not be changed. |
</td> | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td colspan=2 align="right">After you have made your selections, click [[image:Tick.PNG|link=|25px]] to '''Accept''' or [[image:Cross.PNG|link=|25px]] to '''Cancel'''</td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 1,212: | Line 1,291: | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | <br> | ||
+ | <table bgcolor=#000000 width=900 cellpadding=2> | ||
+ | <tr valign="top"> | ||
+ | <td> | ||
+ | <table bgcolor=#ffffb0 width=896 cellpadding=2> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:NotePad.PNG|link=]]</td> | ||
+ | <td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br> | ||
+ | ---- | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|link=]]</td> | ||
+ | <td>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).</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|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 and this '''will''' cause confusion. This is why it is not a good idea to use '''Default''' as a session name.</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <br> | ||
<table> | <table> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>If you have loaded a | + | <td>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'''.</td> |
</tr> | </tr> | ||
</table> | </table> | ||
Line 1,230: | Line 1,331: | ||
<td>[[image:Gears.PNG|link=]]</td> | <td>[[image:Gears.PNG|link=]]</td> | ||
<td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Settings:'''</span><br> | ||
− | [[image:DotPoint1.JPG|link=]] Overwrite the | + | [[image:DotPoint1.JPG|link=]] Overwrite the session only. This is the '''default''' selection so there is nothing to change. |
:[[image:White_Select_Dot.png|link=]] '''Overwrite existing session''' | :[[image:White_Select_Dot.png|link=]] '''Overwrite existing session''' | ||
− | :*the | + | :*the session will be saved ('''overwritten''' using its current name). |
− | :*the original | + | :*the original route will not be changed. |
− | [[image:DotPoint2.JPG|link=]] Create a new ''' | + | [[image:DotPoint2.JPG|link=]] Create a new session. Tick the box [[image:White_Select_Dot.png|link=]] '''Create new session'''. |
:[[image:White_Select_Dot.png|link=]] '''Create new session:''' | :[[image:White_Select_Dot.png|link=]] '''Create new session:''' | ||
− | :*you can enter a new name for the | + | :*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 | + | :*a new session will be created using the name you enter and it will be added to the existing route. |
− | :*the original | + | :*the original route and session will not be changed. |
</td> | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td colspan=2 align="right">After you have made your selections, click [[image:Tick.PNG|link=|25px]] to '''Accept''' or [[image:Cross.PNG|link=|25px]] to '''Cancel'''</td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 1,252: | Line 1,356: | ||
=='''Saving a Route and Session Using the UDS'''== | =='''Saving a Route and Session Using the UDS'''== | ||
− | + | The '''UDS''' ('''U'''nified '''D'''river '''S'''urveyor) Interface allows you to quickly switch from '''Driver''' to '''Surveyor''' and back to '''Driver''' again without having to restart the session from the beginning. You can edit a route and session while in '''Surveyor''' and then switch back to '''Driver''' to continue the session where you left it.<br> | |
− | This powerful ability does come with a warning. If you save the edited | + | <table bgcolor=#ff0000 cellpadding=2 width=900> |
− | + | <tr valign="top"> | |
− | 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 | + | <td> |
+ | <table bgcolor=#fcbcbc> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:Stop.PNG|link=]]</td> | ||
+ | <td><span style="font-size: 15px; font-weight: 700;">WARNING:</span><br> | ||
+ | This powerful ability does come with a warning. If you save the edited session before switching back into '''Driver''' then all the moving consists will be saved in their new positions. Other changes, such as the status of '''Session Rules''', will also be saved in their new states. See the '''Trainz Wiki Page [[image:WikiLink.PNG|link=]] [[How_to_Use_the_UDS_Interface|How to Use the UDS Interface]]''' for more details. | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <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> | <table cellpadding=4 bgcolor=#c1e7e7> | ||
Line 1,277: | Line 1,394: | ||
<td><span style="font-size: 17px; font-weight: 700;">Note:'''</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Note:'''</span><br> | ||
---- | ---- | ||
− | An important change that has been introduced by the '''UDS''' is that train vehicle '''placement''' is now saved as part of the | + | 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> | </td> | ||
</tr> | </tr> | ||
Line 1,285: | Line 1,402: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:PencilTips.PNG|link=]]</td> | <td>[[file:PencilTips.PNG|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 | + | <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> | </td> | ||
</tr> | </tr> | ||
Line 1,296: | Line 1,413: | ||
</table> | </table> | ||
<br> | <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 | + | 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"> Unless you have a particular reason for overwriting the original Session </span> then the '''recommended''' save options are:-</span><br> | <span style="font-size: 17px;"><span style="background-color: yellow; font-weight: 700"> Unless you have a particular reason for overwriting the original Session </span> then the '''recommended''' save options are:-</span><br> | ||
Line 1,309: | Line 1,426: | ||
<td width=20> </td> | <td width=20> </td> | ||
<td>[[image:UDS-DoNotSaveSession.png|link=]]<br> | <td>[[image:UDS-DoNotSaveSession.png|link=]]<br> | ||
− | This will only save the | + | 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> | ||
Line 1,321: | Line 1,438: | ||
<td width=20> </td> | <td width=20> </td> | ||
<td>[[image:UDS-CreateNewSession.png|link=]]<br> | <td>[[image:UDS-CreateNewSession.png|link=]]<br> | ||
− | This will save the | + | 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> | ||
Line 1,328: | Line 1,445: | ||
</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;"> Save </span> then you will be shown the '''Save Driver Session''' dialogue window to save the | + | 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;"> Save </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;"> Ctrl </span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> S </span> while in '''Driver'''.<br> |
[[image:RouteSARSaveDriverSession.png|link=|alte=Save Driver Session]]<br> | [[image:RouteSARSaveDriverSession.png|link=|alte=Save Driver Session]]<br> | ||
− | The '''Driver Game''' will appear in the '''Select Session''' menu for the | + | 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> <!-- BEGIN Nav Buttons Table --> | ||
Line 1,380: | Line 1,497: | ||
='''Cloning a Route/Session'''= | ='''Cloning a Route/Session'''= | ||
− | <table | + | <table bgcolor=#c1e7e7> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>A '''Clone''' is an exact or duplicate copy of an asset | + | <td>A '''Clone''' is an exact or duplicate copy of an asset</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td> | + | <td>Most routes and sessions can be cloned. Some '''Payware''' routes and sessions cannot be cloned</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>Cloned | + | <td>Cloned routes and sessions can be edited and saved as '''Your Content'''</td> |
</tr> | </tr> | ||
</table> | </table> | ||
Line 1,397: | Line 1,514: | ||
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> | 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 | + | <table bgcolor=#ff0000> |
<tr valign="top"> | <tr valign="top"> | ||
<td> | <td> | ||
Line 1,403: | Line 1,520: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:Stop.PNG|link=]]</td> | <td>[[image:Stop.PNG|link=]]</td> | ||
− | <td>'''Cloned assets are subject to copyright laws and they remain the property of the original creator | + | <td>'''Cloned assets are subject to copyright laws and they remain the property of the original creator''' |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,415: | Line 1,528: | ||
</table> | </table> | ||
<br> | <br> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<table bgcolor=#ffffb0> | <table bgcolor=#ffffb0> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>''' | + | <td>'''Freeware routes''', that have been downloaded and installed from the '''DLS''', can be cloned and saved as new routes.<br> |
+ | *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 <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> MY CONTENT </span> search option | ||
+ | *The original route from the '''DLS''' will not be altered or replaced by your new version. You can delete the original '''DLS''' route if you wish and your cloned version will be unaffected | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>''' | + | <td>'''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'''. |
− | <span style="background-color: | + | *Some '''Payware''' routes are encrypted and cannot be cloned. |
− | </td> | + | *When an approved '''DLC''' route is saved 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 <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> MY CONTENT </span> search option |
+ | *The original '''Payware''' route will not be altered or replaced by your new version | ||
+ | *If you delete or disable the original '''DLC''' route then your cloned route <span style="color: white; background-color: red; font-weight: 700;"> will NOT work </span> | ||
+ | *You are allowed to upload 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''' installed.</td> | ||
</tr> | </tr> | ||
− | </ | + | <tr valign="top"> |
− | </td> | + | <td>[[image:DotPoint.JPG|link=]]</td> |
+ | <td>'''Sessions''' that have been downloaded and installed from the '''DLS''' (freeware) or '''DLC''' (payware) follow the same rules as described for '''DLS''' and '''DLC''' routes above. | ||
+ | *Some '''Payware''' sessions are encrypted and cannot be cloned. | ||
+ | *When an approved '''DLC''' session is saved 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 <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> MY CONTENT </span> search option | ||
+ | *The original '''Payware''' session will not be altered or replaced by your new version | ||
+ | *If you delete or disable the original '''DLC''' session or the original '''DLC''' route then your cloned session <span style="color: white; background-color: red; font-weight: 700;"> will NOT work </span> | ||
+ | *You are allowed to upload 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.</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | < | + | <br> |
− | + | ||
− | + | ||
− | + | ||
=='''Using Surveyor'''== | =='''Using Surveyor'''== | ||
'''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;"> Save As... </span> command from the '''Surveyor''' <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> System Menu </span><br> | '''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;"> Save As... </span> command from the '''Surveyor''' <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> System Menu </span><br> | ||
Line 1,450: | Line 1,563: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | Enter a new name or edit the original name (as shown above) for your cloned | + | Enter a new name or edit the original name (as shown above) for your cloned route or session.<br> |
<table bgcolor=#000000 width=900> | <table bgcolor=#000000 width=900> | ||
Line 1,463: | Line 1,576: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>If the first option ([[image:White_Select_Dot.png|link=]] '''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 | + | <td>If the first option ([[image:White_Select_Dot.png|link=]] '''Save new route and session''') is selected then the '''Route will be cloned''' using your new or edited name. The '''Session will be also cloned''' using its original name but it will use the newly cloned Route as a '''dependency''' instead of the original Route. |
+ | *If the original route is '''Freeware''' (e.g. from the '''DLS''') and you do not want to keep it then it can be safely deleted, which will also delete the original session but the new cloned route and session will remain active on your system. | ||
+ | *If the original route is '''Payware''' (e.g. from the '''DLC''') then deleting or disabling it will disable your cloned route and session. When '''Payware''' is cloned it must remain active on your system for the clone to work. | ||
</td> | </td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>If the second option ([[image:White_Select_Dot.png|link=]] '''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 ''' | + | <td>If the second option ([[image:White_Select_Dot.png|link=]] '''Save new session''') is selected then only the '''Session will be cloned''' using your new or edited name (make sure that you change the "Default" to something else) but it will still use the original (uncloned) Route as a '''dependency''' - so it is vital that you '''DO NOT DELETE''' the original route. |
+ | *If the original session is '''Freeware''' then it can be safely deleted if you no longer need it. | ||
+ | *If the original session is '''Payware''' then deleting or disabling it will also disable your cloned session. | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,495: | Line 1,612: | ||
<td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Steps:</span><br> | ||
#In '''Content Manager''' select the filter '''Routes & Sessions''' | #In '''Content Manager''' select the filter '''Routes & Sessions''' | ||
− | #select the | + | #select the route or session to be cloned |
#either | #either | ||
#*from the '''Content Menu''' select '''Clone''' OR | #*from the '''Content Menu''' select '''Clone''' OR | ||
Line 1,607: | Line 1,724: | ||
<td> | <td> | ||
Load the cloned Route or Session into '''Surveyor''', then | Load the cloned Route or Session into '''Surveyor''', then | ||
− | *to rename a | + | *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;"> Ctrl </span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> E </span> - see [[image:PageLink.PNG|link=]] '''[[#Editing a Route|Editing a Route]]''' above |
− | *to rename a | + | *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;"> Ctrl </span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> R </span> - see [[image:PageLink.PNG|link=]] '''[[#Editing a Session|Editing a Session]]''' above |
Both will also allow you to edit the '''Name''' and '''Description''' of the cloned '''Route/Session'''. | Both will also allow you to edit the '''Name''' and '''Description''' of the cloned '''Route/Session'''. | ||
</td> | </td> | ||
Line 1,645: | Line 1,762: | ||
When you are in '''Driver''' select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Save </span> from the '''System Menu''' or press <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Ctrl </span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> S </span>.<br> | When you are in '''Driver''' select <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Save </span> from the '''System Menu''' or press <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Ctrl </span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> S </span>.<br> | ||
− | This will display the '''Save Driver Session''' dialogue window showing the name of the current | + | 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 | + | 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> | <td width=155>[[image:DriverSaveMenu.png|link=|alt=Save Menu]]</td> | ||
Line 1,660: | Line 1,777: | ||
</table> | </table> | ||
=='''Loading Driver Games'''== | =='''Loading Driver Games'''== | ||
− | Saved | + | Saved driver games will be shown with their sessions for a selected route. The section '''[[file:PageLink.PNG|link=]] [[#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 | + | '''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 | + | '''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 | + | Using '''Method 2:''' select the route first and then click the <span style="background-color: black; color: white; font-weight: 700; font-size: 15px;"> VIEW SESSIONS </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> | [[image:DriverLoadDriverSession.png|link=|alt=Load Driver Game]]<br> | ||
Line 1,680: | Line 1,797: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>Where a | + | <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> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:DotPoint.JPG|link=]]</td> | <td>[[image:DotPoint.JPG|link=]]</td> | ||
− | <td>It can also be difficult to tell which thumbnail is a | + | <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;"> EDIT SESSION </span> button is still visible. If it is not, because driver games cannot be edited, then the thumbnail is for a '''Driver Game'''. |
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,692: | Line 1,809: | ||
</table> | </table> | ||
− | Where there is only one session in a | + | 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;"> DRIVE SESSION </span> button.<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;"> DRIVE SESSION </span> button.<br> | ||
Line 1,698: | Line 1,815: | ||
[[image:DriverButtonsNoEdit.png|link=|alt=Driver Game]]<br> | [[image:DriverButtonsNoEdit.png|link=|alt=Driver Game]]<br> | ||
− | This will load the '''Driver Game''', the | + | This will load the '''Driver Game''', the session and the route into '''Driver'''.<br> |
<table bgcolor=#ff0000 width=900> | <table bgcolor=#ff0000 width=900> | ||
Line 1,706: | Line 1,823: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:Stop.PNG|link=]]</td> | <td>[[image:Stop.PNG|link=]]</td> | ||
− | <td>If you load a '''Driver Game''' after you have edited the original | + | <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> | </td> | ||
</tr> | </tr> | ||
Line 1,719: | Line 1,836: | ||
<span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Ok </span> - load the '''Driver Game''' wirh the changes<br> | <span style="color: white; background-color: black; font-weight: 700; font-size: 15px;"> Ok </span> - load the '''Driver Game''' wirh the changes<br> | ||
<br> | <br> | ||
− | If the changes to the | + | 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> | *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> | *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> | ||
Line 1,746: | Line 1,863: | ||
='''Deleting Routes and Sessions'''= | ='''Deleting Routes and Sessions'''= | ||
− | + | <table cellpadding=4 bgcolor=#c1e7e7> | |
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|link=]]</td> | ||
+ | <td>'''Deleting a Session will delete that Session and its Driver Games (if any), not the Route it was created from or any other Sessions'''</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|link=]]</td> | ||
+ | <td>'''Deleting a Driver Game will only delete that Driver Game, not the Route or Session it was created from or any other Driver Games'''</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <br> | ||
+ | All the '''Surveyor''' and '''Driver''' screens for loading routes and sessions have a <span style="font-weight: 700; background-color: black; color: white; font-size: 15px;"> DELETE ... </span> button as an option.<br> | ||
<table bgcolor=#ff0000> | <table bgcolor=#ff0000> | ||
Line 1,758: | Line 1,886: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:Stop.PNG|link=]]</td> | <td>[[file:Stop.PNG|link=]]</td> | ||
− | <td>'''If you delete a Route you will also delete all Sessions | + | <td>'''If you delete a Route you will also delete all the Sessions and Driver Games created using that Route''' |
</td> | </td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:Stop.PNG|link=]]</td> | <td>[[image:Stop.PNG|link=]]</td> | ||
− | <td>'''If you delete a Session you will also delete all Driver Games created using that Session | + | <td>'''If you delete a Session you will also delete all the Driver Games created using that Session |
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,771: | Line 1,899: | ||
</table> | </table> | ||
<br> | <br> | ||
− | + | If you need a more selective way of deleting routes, sessions and driver games, then use '''Content Manager''' from the '''Trainz''' Launch Screen. Select the Filter '''Routes & Sessions'''.<br> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | If you need a more selective way of deleting | + | |
[[image:RouteSessionCMList.png|link=|alt=CM list of routes and sessions]]<br> | [[image:RouteSessionCMList.png|link=|alt=CM list of routes and sessions]]<br> | ||
− | The '''Type''' column will identify each entry as a | + | The '''Type''' column will identify each entry as a route, session or '''Misc'''. '''Misc''' in this case means a saved '''Driver Game'''.<br> |
− | You can delete | + | You can delete routes and/or sessions individually but if you delete a route by itself then its dependant sessions and driver games will be shown as <span style="color: red; font-weight: 700;">faulty</span> with <span style="color: red; font-weight: 700;">Missing dependencies</span>. Likewise, if you delete a session by itself then its dependant driver games will be shown as <span style="color: red; font-weight: 700;">faulty</span> with <span style="color: red; font-weight: 700;">Missing dependencies</span>.<br> |
<br> | <br> | ||
<table> <!-- BEGIN Nav Buttons Table --> | <table> <!-- BEGIN Nav Buttons Table --> |
Revision as of 11:48, 25 July 2022
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.
Contents |
Trainz Worlds
The virtual worlds that Trainz creates can be classified as:-
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:-
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, regardless of whether you are driving them manually or using the AI. 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. A session can also contain scenery items that are specific to a particular railway operation, season of the year or time of day that will only appear in that specific session. Sessions also control some of the environment settings in your virtual world, such as lighting and the weather. A session can have many:-
|
What is a Route?
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 (TurfFX and Clutter), plus some "environmental" features.
A route consists of two parts:-
- Route Data and
- Route Layers.
When you save a Route, all the 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 | |
The Route Data stores all the Environmental Data including the World Origin (latitude, longitude, altitude) |
This covers all those visual elements that are "painted" in Surveyor with a brush tool and all the Environmental features.
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. 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 give you a way of organising or grouping the assets displayed in your route.
Route Layers have those scenery items that you want to always appear.
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) - Note: It is strongly recommended that all rolling stock be placed into a Session Layer
- Lineside and Fixed Cameras
- Trackmarks, Triggers, Direction and Priority Marks
|
A detailed description of Layers can be found on the Trainz Wiki Page How to Use Layers |
Loading (and Creating) a Route
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.
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.
The MAIN MENU button will take you back to the starting or main screen.
The Sort By A-Z (top right of the image above) will give you a drop down menu of sorting options for the thumbnail list.
The 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.
The thumbnail images are colour coded.
Payware on DLC | Must be purchased and downloaded, but some may be free. There will be a DOWNLOAD button 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
On the Driver/Surveyor screen the route options are shown as a set of buttons at the bottom of the screen.
Click CREATE ROUTE . This will start Trainz Surveyor and open the New Route Dialogue Window.
|
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.
Route name: | Enter a name for your new Route (keep it simple) |
Session name: | Enter a name for your Session (again keep it simple) - see Notes: below |
Geographical region: | Select a region from the drop down list |
|
Loading an Existing Route
You must first find and select the route to load from those already installed. At the top of the Driver/Surveyor screen the route search options are shown as a set of buttons.
Type: | ROUTES is the default selection. No need to change this. |
Source: | PURCHASED is the default selection, Click and change to MY CONTENT for a route you have created (or already modified) or to INSTALLED for one you have downloaded from the DLS. |
Region: | ALL is the default selection. You can select a particular geographic region if required and IF the route had a geographic region set when it was created. |
Search: | You can narrow down the list of routes by typing the first few letters of its name (e.g. SA) as shown in the image above. |
This will produce a display of thumbnails at the bottom of the screen.
Click on the thumbnail for the route you want to load, then click on the EDIT ROUTE button to load the route into Surveyor.
|
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.
|
Loading After an Unexpected Shutdown
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.
|
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.
The options you will see are:-
Use changes | 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 | |
Revert changes | Ignore the edited/changed versions and load the previous versions instead | |
Cancel | Cancel the Load and return to the Surveyor/Driver menu screen |
You could also use the Content Manager program (select Manage Content from the Trainz Launcher) to Submit the open route or route and session assets. This has the risk of replacing the last good copy of that asset or assets with a possibly faulty copy.
Editing a Route
When a Route is loaded or a new Route is created all the assets you add will be automatically placed into a Route Layer |
When you create a new route (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 How to Use Layers for more details.
Any ground textures, water, effect layers (turfFX and clutter) you add, or terrain changes (including new baseboards) you make, will be added to the Route Data.
|
You can edit the Route Characteristics at any time by selecting the Edit Route command from the Edit menu or simply pressing Ctrl E . |
|
|
Merging Routes
Two (or more) separate routes can be joined together (merged) to create a new route |
There are some important restrictions on the merging of two routes:-
- Payware (DLC) routes cannot be merged with Freeware (DLS) or other Payware routes
- The Session Data and Session Layers in the first route can be saved in the merger, if required, but those in the other route are not
- There may be a significant height difference between the two routes and this may not be easy to overcome
- The orientation of the two routes (East-West or North-South) cannot be changed
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?
A Session is always a part of an existing Route - you cannot have a Session that does not belong to a Route | |
If you create a Route without a Session then ALL the active industries and rolling stock, time, environmental conditions, etc, will revert to their original (default) values. There will be no AI drivers and drivers will have a very limited set of available commands for manual driving |
In general, while a route provides the physical structures (or "hardware"), a session provides the services (or "software"). While you can easily have a route without a session, it could be a very limited (or even a boring) experience.
A single route can have multiple sessions, or none, but a session must always belong to a route. To put it into Trainz terminology, a session has a route as a dependency.
A session consists of two parts:-
- Session Data and
- Session Layers.
When you save a Session, all the items in the Session Data and Session Layers will be saved |
Session Data:
Session Data are often the "invisibles" that control the operation of a session. Session rules, driver orders and loco assignments, commodities (loaded, unloaded and carried) and most of the Environmental Settings are examples of Session Data.
Session Data contains:-
- Drivers (names, AI commands and assigned locos)
- Driver Commands - those available for AI and manual driving
- Session Rules
- Industry Settings (commodities consumed and produced)
- Consist Settings (commodities carried)
- Consist Locations - this is stored in the session even if the consists are placed in the route
- Switch Settings (left/right) - but the default switch direction is stored in the route
- Environmental Settings - Water Surface (rough/calm/etc), Snow Altitude, Lighting (sun, ambient and water colours), Sky (clouds), Road Traffic (on/off), Date (day, month), Wind strength, Fog level, Weather (rain/fine/snow), Brightness level. You must edit and save the session for these settings to become part of the Session Data - see How to Use Environment Tools for more details. If both a route and a session have saved Environmental Settings, which do not have to be the same, then those in the session will be used. If the session does not have any saved Environmental Settings then those in the route will be used
Session Layers:
Session Layers are used to hold the scenery assets that you want to only appear in that particular Session and not in all Sessions | |
Session Layers can be left empty and the Route Layers can contain all the scenery assets |
Session Layers give you a way of organising or grouping the assets displayed in your session.
Session Layers can contain:-
|
|
A detailed description of Layers can be found on the Trainz Wiki Page How to Use Layers |
|
Loading (and Creating) a Session
Creating a New Session
To create a new Session you must first create a new Route or identify an existing Route |
A new session can be created in two ways:-
Method Automatically When a New Route is Created | |
Follow the steps shown in the section Creating a New Route above by entering:-
|
Method Adding a Session to an Existing Route | |||
The first step is to locate (but not load) the route as described in the section Loading an Existing Route above. Once you have selected the route from its thumbnail, click the VIEW SESSIONS button.
Then click the CREATE SESSION button. If no other session exists for this route then this will be the only choice available to you.
|
|||
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.
Method 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.
|
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.
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. There will be a DOWNLOAD button 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 |
Click on the thumbnail for the session you want to load and then click on the EDIT SESSION button. This will load BOTH the route and the session into Surveyor.
|
Method Select the Route First | |||
Select the route as described in the section Loading an Existing Route above. Then click the VIEW SESSIONS button.
This will display a list of thumbnails for all the sessions in that route. Select the session thumbnail you need and then click the EDIT SESSION button.
Again, both the selected route and its session will be loaded into Surveyor.
|
|||
Loading a Session Into Surveyor From Content Manager
Trainz provides a shortcut that allows you to load an existing session directly into Surveyor for editing from Content Manager.
Both the route and the session will be loaded into Surveyor for editing. |
Loading a Session into Driver From Surveyor
To start Driver simply select a session as described above in Loading an Existing Session and click the DRIVE SESSION button.
This will load both the session and the route into Driver.
You can save your "game play" in Driver at anytime. See Saving and Loading Sessions in Driver below.
Loading a Session into Driver From Content Manager
Trainz provides a shortcut that allows you to load an existing session directly into Driver from Content Manager.
The session and its parent route will be loaded into Driver and the simulation will be started. |
Editing a Session
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 |
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 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 also other changes that will be added to the Session Data.
You can edit the Session Characteristics at any time by selecting the Edit Session command from the Edit Menu or by simply pressing Ctrl R . |
|
|
You can edit the Environment Controls of a Session by selecting the Edit Environment command from the Edit Menu. |
|
Saving a Route and a Session
Routes and Sessions are saved from the System Menu on the Surveyor screen.
|
Notes on Saving Routes and Sessions:
|
Saving a New Route and Session
If you have created a new route and select Save or Save As..., then you will be presented with the following Save Route Dialogue Windows.
In both cases the name of the route that was entered when it was created will be shown and you can change the name, even in the Save option. However, there is no option in either case to change the name of the created session because the other options have been greyed out and cannot be selected. |
Saving an Existing Route
If you have loaded the route only and not the session and HAVE NOT edited any Session Data or Session Layers, then selecting Save will produce the following Save Route Dialogue Window. |
|
If you have loaded the route only and not the session and HAVE edited Session Data or Session Layers, then selecting Save will produce the following Save Route Dialogue Window. |
|
|
Saving an Existing Route and Session
If you have loaded a route and a session and have edited the route or the route and the session then selecting Save will produce the following Save Route Dialogue Window. |
|
|
If you have loaded a route and a session and have edited the session (Data or Layers) only and not the route, or have already saved the route but not the session, then selecting Save will produce the following Save Session Dialogue Window. |
|
Saving a Route and Session Using the UDS
The UDS (Unified Driver Surveyor) Interface allows you to quickly switch from Driver to Surveyor and back to Driver again without having to restart the session from the beginning. You can edit a route and session while in Surveyor and then switch back to Driver to continue the session where you left it.
|
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.
Using Driver Mode involves driving consists (either manually or through the AI) and activating rules. These will change the Session Data | |
Overwriting the Session will save changes to the consist locations and the Session Rules |
|
When you are in Driver Mode at least one of the consists will probably be moving. Some of the Session Rules may have already been completed while others may still be running or waiting for events (e.g. triggers to be activated). If, after switching to Surveyor Mode, you then choose to save using the Overwrite existing session option then you will be replacing your original starting session with a new one with the consists saved in their new positions and the Session Rules saved in their new states. So when you later load and restart the session things will not be the same as they were in the original or starting session.
Unless you have a particular reason for overwriting the original Session then the recommended save options are:-
Option Do not save session | |
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. |
|
Option Create new session | |
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. |
|
If you have have NOT edited anything while in Surveyor and select Save then you will be shown the Save Driver Session dialogue window to save the session in its current state as a Driver Game (also called a Game or Driver Game). This is exactly the same as pressing Ctrl S while in Driver.
The Driver Game will appear in the Select Session menu for the route. Loading it will resume Driver at the point where it was saved.
Exiting Surveyor
If you exit Surveyor after editing without saving then you will be prompted to Save.
Unsaved Route | Unsaved Session |
Selecting Don't Save will exit Surveyor without saving. Any changes you have made will be lost. | |
Selecting Save will exit Surveyor after saving. You will be prompted to select what to save as described in the section Saving a Route and a Session above | |
Selecting Cancel will cancel the save command and return you to Surveyor. |
Cloning a Route/Session
A Clone is an exact or duplicate copy of an asset | |
Most routes and sessions can be cloned. 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.
|
Freeware routes, that have been downloaded and installed from the DLS, can be cloned and saved as new routes.
| |
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.
|
|
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.
|
Using Surveyor
Routes and Sessions that have been loaded into Surveyor can be cloned using the Save As... command from the Surveyor System Menu
Enter a new name or edit the original name (as shown above) for your cloned route or session.
|
Using Content Manager
1. Select the Route or Session to Clone
|
A Task Window will open to display the result.
In the image above the original Route has been cloned and given a new <kuid> value.
The newly cloned Route will be shown in Content Manager as a New Asset that is Open for Editing.
|
|
Steps:
|
|
|
2. 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:
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.
|
|
|
3. Submit the Clone (a Necessary Step)
When submitted a cloned DLC Route or Session will be described as Payware, Modified |
|
|
Steps:
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. |
|
|
|
Saving and Loading Driver Games in Driver
Saving Driver Games
Driver Games (sometimes called "Saved Games" or "Driver Sessions") are "Game States" saved while in Driver Mode |
Driver Games save the "state of play" in Driver - the position of consists, the commodities and levels in rolling stock and industries, the state of the Driver Command queues, Session Rules, clock time, etc. Once saved, the Driver Game can be loaded back into Driver to continue the play at the point where it was saved. When you are in Driver select Save from the System Menu or press Ctrl S . This will display the Save Driver Session dialogue window showing the name of the current session with a date and time stamp (shown left below). If you 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). The space below the entered name will display any other saved driver games for that session. |
Loading Driver Games
Saved driver games will be shown with their sessions for a selected route. The section Loading an Existing Session shows two different methods of displaying saved sessions and their driver games.
Method will display ALL the saved sessions and driver games which may be a very long list.
Method will display ALL the saved sessions and driver games for a selected route, which should be a much shorter list.
Using Method 2: select the route first and then click the VIEW SESSIONS button. This will display a list of thumbnails for all the sessions and driver games in that route.
|
Where there is only one session in a route, the session will be the first thumbnail shown in the list followed by the driver games. Note that the session is selected by default.
Select (hightlight) the Driver Game you want to load and click the DRIVE SESSION button.
This will load the Driver Game, the session and the route into Driver.
|
Deleting Routes and Sessions
Deleting a Session will delete that Session and its Driver Games (if any), not the Route it was created from or any other Sessions | |
Deleting a Driver Game will only delete that Driver Game, not the Route or Session it was created from or any other Driver Games |
All the Surveyor and Driver screens for loading routes and sessions have a DELETE ... button as an option.
|
If you need a more selective way of deleting routes, sessions and driver games, then use Content Manager from the Trainz Launch Screen. Select the Filter Routes & Sessions.
The Type column will identify each entry as a route, session or Misc. Misc in this case means a saved Driver Game.
You can delete routes and/or sessions individually but if you delete a route by itself then its dependant sessions and driver games will be shown as faulty with Missing dependencies. Likewise, if you delete a session by itself then its dependant driver games will be shown as faulty with Missing dependencies.
Trainz Wiki
Route and Session Building Guides |
|
More Tutorials and Guides to Using Trainz |
This page was created by Trainz user pware in September 2021 and was last updated as shown below.