How to Use Portals

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
(Updated to include S2.0 Filter Palette)
 
(20 intermediate revisions by one user not shown)
Line 1: Line 1:
The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''.
+
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''.
 
+
<table>
 +
<tr valign="top">
 +
<td>
 
__TOC__
 
__TOC__
 +
</td>
 +
<td width=700>
 +
<table bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>'''Portals''' are track objects that can add and remove trains during the running of a Session</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>'''Portals''' can be used to move trains from one part of a Route to another</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepWhat"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>[[image:NextDown.png|link=#stepConfiguring|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 
='''What is a Portal?'''=
 
='''What is a Portal?'''=
<table cellpadding="4" bgcolor=#c1e7e7>
+
<table width=1000>
 +
<tr valign="top">
 +
<td>[[image:PortalTypeScreenShot.PNG|link=]]</td>
 +
<td>
 +
Portals come in a variety of forms - some resemble tunnels and others look like a section of normal track. One portal is a '''Track Marker'''.<br><br>
 +
The basic portals supplied with Trainz can be configured to:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>remove trains that are sent to them or pass through them (the portals that look like track can be used to let certain trains pass through while "swallowing" others).<br>
 +
The removed trains can be:-
 +
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
<td>'''Portals are track objects that can add and remove trains during the running of a Session'''</td>
+
<td>removed permanently, or</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>returned to the Session through the same portal or another portal after a set time delay</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>add new trains to the Session. The new trains:-
 +
<table>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>will have drivers with orders to follow</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>can be randomly selected from available consists</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>Portals can be "enhanced" by using '''Session Rules''' that add additional features and capabilities
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 12: Line 80:
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalTypeScreenShot.PNG|link=]]</td>
+
<td>Enhanced portals can have features such as:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>adding new trains to the Session according to a set schedule ranging from ''once only'', ''once per day'' or at ''set clock times''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>varying the drivers of added trains and their commands according to a set schedule</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>varying the consists of added trains</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
='''Adding a Portal'''=
 +
=='''<span style="color: black; background-color: cyan;">&#160;In Surveyor Classic (S10)&#160;</span>'''==
 +
 
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>[[image:PortalSearchSettings.PNG|link=]]</td>
 +
<td>The quickest way to find all the train producing and consuming portals in the '''Surveyor Object Tool''' window is to set up a search filter. This will sort the portals you want from all the objects named "portal" such as tunnel portals.
 +
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#ffffff cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
+
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Steps:</span> To find a '''Portal''' in '''Content Manager''':-<br>
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
+
Set an advanced search filter by:-</td>
Portals come in a variety of forms - some resemble tunnels and others look like a section of normal track.<br><br>
+
</tr>
The basic portals supplied with Trainz can be configured to:-
+
<tr valign="top">
*remove trains that are sent to them or pass through them (the portals that look like track can be used to let certain trains pass through while "swallowing" others). The removed trains can be:-
+
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
**removed permanently, or
+
<td>Pressing <span style="font-weight: 700; font-size: 15px;"><span style="color: white; background-color: black;">&#160;Ctrl&#160;</span>&#160;+&#160;<span style="color: white; background-color: black;">&#160;Shift&#160;</span>&#160;+&#160;<span style="color: white; background-color: black;">&#160;F&#160;</span></span></td>
**returned to the Session through the same portal or another portal after a set time delay
+
</tr>
*add new trains to the Session. The new trains:-
+
<tr valign="top">
**will have drivers with orders to follow
+
<td>[[image:DotPoint2.JPG|link=]]</td>
**can be randomly selected from available consists
+
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;+&#160;</span> and add the filter <span style="color: white; background-color: black; font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Name&#160;</span> and enter '''Portal''' (upper/lower case is not important) in its text entry box</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint3.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> <span style="color: white; background-color: black; font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;+&#160;</span> and add the filter <span style="color: white; background-color: black; font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Category&#160;</span> and its sub-category '''Industry'''<br>
 +
:The '''Objects''' selection window will now show only those objects that match your search criteria.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint4.JPG|link=]]</td>
 +
<td>Open the '''Object Tools''' "fly-out" (or press the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;F3&#160;</span> key)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>The objects list will show all scenery assets that meet your entered search</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 
<br>
 
<br>
<table cellpadding="4" bgcolor=#c1e7e7>
+
<table bgcolor=#ff0000 width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>
<td>Portals can be "enhanced" by using '''Session Rules''' that add additional features and capabilities</td>
+
<table bgcolor=#fcbcbc>
 +
<tr valign="top">
 +
<td>[[image:Stop.PNG|link=]]</td>
 +
<td>
 +
The portals will '''NOT''' work correctly if the '''Trainz Settings - Dev Tab - Compatibility mode:''' from the '''Trainz Launcher''' is set to '''Maximize performance'''. This setting should be left at '''Maximize compatibility'''
 +
</td>
 
</tr>
 
</tr>
</table><br>
+
</table>
Enhanced portals can have features such as:-
+
</td>
*adding new trains to the Session according to a set schedule ranging from ''once only'', ''once per day'' or at ''set clock times''
+
*varying the drivers of added trains and their commands according to a set schedule
+
*varying the consists of added trains</td>
+
 
</tr>
 
</tr>
</table></td>
+
</table>
 +
 
 +
=='''<span style="color: white; background-color: blue;">&#160;In Surveyor 2.0 (S20)&#160;</span>'''==
 +
 
 +
<table width=1000 bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table width=996 bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td><span style="font-size: 15px;">'''Surveyor 2.0''' is currently only available for '''Trainz Plus''' and '''TRS22 Platinum Edition'''</span></td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Steps:</span> To find a '''Portal''' in the '''Assets Palette''':-</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
 +
<td>In the '''Filter Palette''' <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the '''Scenery Objects''' icon or select '''Scenery Objects''' from the '''Content Drop Down''' box</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalSearchSettings.PNG|link=]]</td>
+
<td width=210>[[image:FilterAssetsPaletteSearchPortals_S20.png|link=]]</td>
<td>The quickest way to find all the train producing and consuming portals in the Surveyor Object Tool window is to set up a search filter. This will sort the portals you want from all the objects named "portal" such as tunnel portals.
+
<td>
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=786 bgcolor=#000000 cellpadding=2>
<tr>
+
<tr valign="top">
<td colspan="2">
+
<td>
----</td>
+
<table width=782 bgcolor=#ffffb0 cellpadding=2>
 +
<tr valign="top">
 +
<td width=22>[[image:NotePad.PNG|link=]]</td>
 +
<td width=374><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
 +
----
 +
</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
+
<td colspan=2>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
+
If both the '''Filter Palette''' and '''Assets Palette''' are not shown on the screen, then:-
Set an advanced search filter by:-
+
<table>
#Pressing '''Ctrl Shift F'''
+
<tr valign="top">
#Enter ''Name'' '''portal''' (upper/lower case is not important)
+
<td width=175>[[image:WindowsMenu_S20.png|link=|alt=Windows Menu]]</td>
#Select ''Category'' '''Industry'''
+
<td>
The '''Objects''' selection window will now show only those objects that match your search criteria.</td>
+
<table>
 +
<tr valign="top">
 +
<td width=25>[[image:DotPoint1Blue.png|link=]]</td>
 +
<td>open the [[image:SurveyorWindowIcon.png|link=]]&#160;'''Window&#160;Menu''' from the menu icons at the top of the screen</td>
 
</tr>
 
</tr>
<tr>
+
<tr valign="top">
<td colspan="2">
+
<td>[[image:DotPoint2Blue.png|link=]]</td>
----</td>
+
<td>If either palette does not have a [[image:Tick.PNG|link=]] next to its name then <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the palette name to add a [[image:Tick.PNG|link=]] and make it visible</td>
 
</tr>
 
</tr>
</table></td>
+
<tr valign="top">
 +
<td>[[image:DotPoint3Blue.png|link=]]</td>
 +
<td>If the palettes have ticks but are not visible then check the minimised area at the bottom of the list where '''Mini Map''' is located. If their names appear there then they have been minimised. To restore the palettes to the screen <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the palette names in '''the minimised area''', '''NOT''' in the palette area above.</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=25>[[image:DotPoint2.JPG|link=]]</td>
 +
<td>In the '''Assets Palette''' enter the text "portal" ('''UPPER/lower case''' does not matter) into the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Search&#160;</span> text box</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint3.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on an entry to select it. If you are not sure about an asset then <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Double Left Click&#160;</span> on the name to bring up its image and description</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint4.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> in your '''Trainz World''' to add the portal to the scene</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table cellpadding="4" bgcolor=#ff0000>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
 +
<td>[[image:PortalObject_S20.png|link=|alt=Portal Context menu S20]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#fcbcbc>
+
<table bgcolor=#000000 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Stop.PNG|link=]]</td>
 
 
<td>
 
<td>
In '''TRS19''' the portals will '''not''' work correctly if the '''Trainz Settings - Dev Tab - Compatibility mode:''' from the '''TRS19 Launcher''' is set to '''Maximize performance'''. This setting should be left at '''Maximize compatibility'''.
+
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Steps:</span> To open the '''Properties''' window of an asset, including a Portal, in '''Surveyor 2.0'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on its '''Context Icon''' as shown in the image left</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint2.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on <span style="Font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Edit Properties&#160;</span> to configure the portal</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
</table></td>
+
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
<br>
+
 
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepConfiguring"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepWhat|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepEnhanced|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
</table>
+
</table> <!-- END Nav Buttons Table -->
  
 
='''Configuring a Basic Portal'''=
 
='''Configuring a Basic Portal'''=
Line 94: Line 293:
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalProperties01.PNG|link=]]</td>
+
<td>[[image:PortalProperties01.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#eeeeee>
+
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 102: Line 301:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
This portal is set to:-<br>
+
This portal is set to:-
*Produce a train every 15 minutes (but the train consist has not yet been specified)
+
<table>
*Consume all trains that are sent to the portal or pass through the portal
+
<tr valign="top">
*The consumed trains will not be returned to the Session</td>
+
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Produce a train every 15 minutes (but the train consist has not yet been specified)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Consume all trains that are sent to the portal or pass through the portal</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>The consumed trains will not be returned to the Session</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 115: Line 326:
 
</table>
 
</table>
  
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#000000 width=550>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
+
<td>
 +
<table bgcolor=#ffffb0 width=546>
 +
<tr valign="top">
 +
<td>[[image:NotePad.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
The difference between the two time setting shown is:-
+
----
*'''Trainz Minutes''' refers to the "virtual" minutes as shown on the Session clock in the Heads Up Display in Driver. For example: If you have set the Session time to run at 2x normal speed then 10 minutes of Session time will be 5 minutes according to your watch
+
In '''TRS19''', '''Trainz Plus''' and '''TRS22''' the time entered is in '''real minutes''' as determined by an external clock and not according to the '''Trainz Clock Time''' which may be set to run at a higher speed (e.g. 10X normal).
*'''Real Minutes''' refers to the actual minutes as shown on your watch or computer date/time display, which may not be the same as shown on the Session clock as described above</td>
+
</td>
 
</tr>
 
</tr>
</table></td>
+
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
  
==Produce Trains==
+
=='''Produce Trains'''==
  
 
<table>
 
<table>
 
<tr>
 
<tr>
<td>[[file:PortalProduceNewTrains.PNG|link=]]</td>
+
<td>[[image:PortalProduceNewTrains.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#ffffff>
+
 
<tr>
+
<table bgcolor=#000000 cellpadding=2>
<td colspan="2">
+
<tr valign="top">
----</td>
+
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Steps:</span> To add consists to be produced by the portal:-</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
+
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
+
<td>[[image:CheckBox.PNG|link=]] '''Produce new trains'''</td>
To add consists to be produced by the portal:-
+
#[[file:CheckBox.PNG|link=]] '''Produce new trains'''
+
#set the desired time interval (in minutes) between the trains
+
#click the link '''''<span style="text-decoration: underline;">Add new consist</span>'''''</td>
+
 
</tr>
 
</tr>
<tr>
+
<tr valign="top">
<td colspan="2">
+
<td>[[image:DotPoint2.JPG|link=]]</td>
----</td>
+
<td>set the desired time interval (in minutes) between the trains</td>
 
</tr>
 
</tr>
</table></td>
+
<tr valign="top">
 +
<td>[[image:DotPoint3.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> the ; '''<span style="text-decoration: underline;">Add new consist</span>'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<table>
 
<table>
 
<tr>
 
<tr>
<td>[[file:PortalProperties02.PNG|link=]]</td>
+
<td>[[image:PortalProperties02.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#ffffff>
+
 
<tr>
+
 
<td colspan="2">
+
<table bgcolor=#000000 cellpadding=2>
----</td>
+
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Steps:</span> To manually add rolling stock objects:-</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
+
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
+
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> [[image:PortalPlusIcon.PNG|link=]] to manually '''construct a consist''' from the Session rolling stock list</td>
Click:-
+
*[[file:PortalPlusIcon.PNG|link=]] to manually '''construct a consist''' from the Session rolling stock list
+
*'''''<span style="text-decoration: underline;">Add driver to consist</span>''''' to '''add a driver''' from the Session list
+
*'''''<span style="text-decoration: underline;">Add an existing saved consist</span>''''' to '''add a saved consist''' from those that you have already saved in the Trainz '''Train Tool'''</td>
+
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td colspan="2">
+
<td>[[image:DotPoint2.JPG|link=]]</td>
----</td>
+
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> '''<span style="text-decoration: underline;">Add driver to consist</span>''' to '''add a driver''' from the Session list</td>
 
</tr>
 
</tr>
</table></td>
+
<tr valign="top">
 +
<td>[[image:DotPoint3.JPG|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> '''<span style="text-decoration: underline;">Add an existing saved consist</span>''' to '''add a saved consist''' from those that you have already saved as '''Train Consist Assets'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 182: Line 415:
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalProperties04.PNG|link=]]</td>
+
<td>[[image:PortalProperties04.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#eeeeee>
+
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 190: Line 423:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
For each vehicle in the consist you can specify:-
 
For each vehicle in the consist you can specify:-
*how many to add (they will be coupled together)
+
<table>
*the direction the vehicle(s) will face
+
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>how many to add (they will be coupled together)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>the direction the vehicle(s) will face</td>
 +
</tr>
 +
</table>
 
You can also:-
 
You can also:-
*delete vehicles or the entire consist
+
<table>
*insert additional vehicles ''inside'' the consist
+
<tr valign="top">
*add additional vehicles at the end of the consist</td>
+
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>delete vehicles or the entire consist</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td colspan="2">
+
<td>[[image:BlackDot10x10.png|link=]]</td>
----</td>
+
<td>insert additional vehicles ''inside'' the consist</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>add additional vehicles at the end of the consist</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#000000 width=550>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
+
<td>
 +
<table bgcolor=#ffffb0 width=546>
 +
<tr valign="top">
 +
<td width=25>[[image:NotePad.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
*The first vehicle in the list will be the first vehicle produced by the portal
+
----
*It is NOT possible to easily reorder the vehicles in a consist
+
</td>
*To add more of the same vehicles in a different location in the consist, add the vehicles as a separate entry in the list
+
*Add another consist and driver by clicking the '''''<span style="text-decoration: underline;">Add new consist</span>''''' link again</td>
+
 
</tr>
 
</tr>
</table></td>
+
<tr valign="top">
 +
<td colspan=2>
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>the first vehicle in the list will be the first vehicle produced by the portal</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>it is NOT possible to easily reorder the vehicles in a consist</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>to add more of the same vehicles in a different location in the consist, add the vehicles as a separate entry in the list</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>add another consist and driver by a <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> on the '''<span style="text-decoration: underline;">Add new consist</span>''' ; again</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 224: Line 500:
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalExitingConsist.PNG|link=]]</td>
+
<td>[[image:PortalExitingConsist.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#ffffff>
+
 
<tr>
+
<table bgcolor=#000000 cellpadding=2>
<td colspan="2">
+
<tr valign="top">
----</td>
+
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<tr valign="top">
 +
<td colspan=2><span style="font-weight: 700; font-size: 17px;">Steps:</span> To add a saved consist to a portal:-</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
+
<td width=25>[[image:DotPoint1.JPG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
+
<td>Scroll through the list to find the saved consist</td>
#Scroll through the list to find the saved consist
+
#Select the consist, then either:-
+
:*Click the [[file:Tick.PNG|link=]] icon to accept the selection and load it into the portal consist list, or
+
:*Click the [[file:Cross.PNG|link=]] icon to reject the selection and return to the previous screen</td>
+
 
</tr>
 
</tr>
<tr>
+
<tr valign="top">
<td colspan="2">
+
<td>[[image:DotPoint2.JPG|link=]]</td>
----</td>
+
<td>Select the consist, then either:-
 +
<table>
 +
<tr valign="top">
 +
<td width=25>[[image:Ablue.png|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> the [[image:Tick.PNG|link=]] icon to accept the selection and load it into the portal consist list, <span style="font-weight: 700; font-size: 15px;">OR</span></td>
 
</tr>
 
</tr>
</table></td>
+
<tr valign="top">
 +
<td>[[image:Bblue.png|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Left Click&#160;</span> the [[image:Cross.PNG|link=]] icon to reject the selection and return to the previous screen</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 251: Line 541:
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalProperties03.PNG|link=]]</td>
+
<td>[[image:PortalProperties03.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#eeeeee>
+
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 259: Line 549:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
You can:-
 
You can:-
*Select a new driver and icon
+
<table>
*Rename the driver
+
<tr valign="top">
*Add driver commands
+
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
*Delete the driver</td>
+
<td>Select a new driver and icon</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Rename the driver</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Add driver commands</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Delete the driver</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 275: Line 580:
 
</table>
 
</table>
  
<table cellpadding="4" bgcolor="Aquamarine">
+
<table cellpadding=4 bgcolor="Aquamarine">
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td>[[image:LinkWiki.PNG|link=]]</td>
 
<td>
 
<td>
 
For information on adding driver commands see the '''Trainz Wiki Page''' at:-
 
For information on adding driver commands see the '''Trainz Wiki Page''' at:-
Line 284: Line 589:
 
</table>
 
</table>
 
<br>
 
<br>
==Consume Trains==
+
=='''Consume Trains'''==
 
To remove trains from the Session<br>
 
To remove trains from the Session<br>
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalAcceptAllTrains.PNG|link=]]</td>
+
<td>[[image:PortalAcceptAllTrains.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#ffffff>
+
<table cellpadding=4 bgcolor=#ffffff>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 296: Line 601:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Choices.PNG|link=]]</td>
+
<td>[[image:Choices.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Choices:'''</span><br>
 
<td><span style="font-size: 17px;">'''Choices:'''</span><br>
[[file:CheckBox.PNG|link=]] '''Consume trains''' then either
+
[[image:CheckBox.PNG|link=]] '''Consume trains''' then either
:[[file:PortalOptionButtonEmpty.PNG|link=]] '''Accept all trains''' to remove any and all trains that enter the portal, or
+
:[[image:PortalOptionButtonEmpty.PNG|link=]] '''Accept all trains''' to remove any and all trains that enter the portal, <span style="font-weight: 700; font-size: 15px;">OR</span>
:[[file:PortalOptionButtonEmpty.PNG|link=]] '''Accept trains matching specific criteria''' to only remove certain trains that enter the portal</td>
+
:[[image:PortalOptionButtonEmpty.PNG|link=]] '''Accept trains matching specific criteria''' to only remove certain trains that enter the portal</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 306: Line 611:
 
----</td>
 
----</td>
 
</tr>
 
</tr>
</table></td>
+
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#000000 width=800>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PencilTips.PNG|link=]]</td>
+
<td>
<td>For "dead end" portals (those that have no exit) the '''Accept all trains''' option is the option that ''should'' be used</td>
+
<table bgcolor=#ffffe0 width=796>
 +
<tr valign="top">
 +
<td>[[image:PencilTips.PNG|link=]]</td>
 +
<td>For "dead end" portals (those that have no exit) the '''Accept all trains''' option is the option that ''should'' be used
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 318: Line 631:
 
==='''Consume Only Specific Trains'''===
 
==='''Consume Only Specific Trains'''===
 
After selecting the option '''Accept trains matching specific criteria''' a new set of controls will appear<br>
 
After selecting the option '''Accept trains matching specific criteria''' a new set of controls will appear<br>
<table>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalAcceptAllTrainsOpen.PNG|link=]]</td>
+
<td>[[image:PortalAcceptAllTrainsOpen.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#eeeeee>
+
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 328: Line 641:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
[[file:PortalOptionButtonFilled.PNG|link=]] '''Accept trains matching specific criteria'''
+
[[image:PortalOptionButtonFilled.PNG|link=]] '''Accept trains matching specific criteria'''
*You can set any one, any two or all three of the '''consist selection criteria'''
+
<table>
*Any train that matches the entered settings will be removed from the Session as it enters the portal, other trains will be ignored
+
<tr valign="top">
<br>
+
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
'''Specific Vehicles''' - normally used to specify just ''one'' particular train in the Session
+
<td>You can set any one, any two or all three of the '''consist selection criteria'''</td>
*You must select, from the Session list, the '''exact name''' given to a vehicle. This is the name that has been entered into the property window of that vehicle
+
</tr>
*The order of the vehicles, if there is more than one, is not important
+
<tr valign="top">
*You only need to select enough names to correctly identify the consist that contains the vehicle or vehicles (the locomotive name is ''usually'' sufficient)
+
<td>[[image:BlackDot10x10.png|link=]]</td>
<br>
+
<td>Any train that matches the entered settings will be removed from the Session as it enters the portal, other trains will be ignored</td>
'''Vehicles Types''' - normally used to specify a number of different trains in the session e.g. all trains with a particular type of coal wagon
+
</tr>
*You must select, from the Session list, the '''general name''' of the type of vehicle or vehicles - this is the name shown in the Trains Tool when the vehicle is added to a layout
+
</table>
*If you have identified '''Specific Vehicles''' (above) then you would normally not need to set this option
+
<span style="font-weight: 700; font-size: 15px;">Control Options:-</span>
<br>
+
<table>
'''Drivers''' - used to specify trains driven by particular drivers
+
<tr valign="top">
*Select the driver or drivers from the Session driver list
+
<td width=10>[[image:DotPointBlack.JPG|10px|link=]]</td>
*If your drivers change trains or consists during a Session then it ''may'' be useful to combine this with one of the other two options
+
<td>'''Specific Vehicles''' - normally used to specify just ''one'' particular train in the Session
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>You must select, from the Session list, the '''exact name''' given to a vehicle. This is the name that has been entered into the property window of that vehicle</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>The order of the vehicles, if there is more than one, is not important</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>You only need to select enough names to correctly identify the consist that contains the vehicle or vehicles (the locomotive name is ''usually'' sufficient)</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPointBlack.JPG|10px|link=]]</td>
 +
<td>'''Vehicles Types''' - normally used to specify a number of different trains in the session e.g. all trains with a particular type of coal wagon
 +
<table>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>You must select, from the Session list, the '''general name''' of the type of vehicle or vehicles - this is the name shown in the Trains Tool when the vehicle is added to a layout</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>If you have identified '''Specific Vehicles''' (above) then you would normally not need to set this option</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPointBlack.JPG|10px|link=]]</td>
 +
<td>'''Drivers''' - used to specify trains driven by particular drivers
 +
<table>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Select the driver or drivers from the Session driver list</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>If your drivers change trains or consists during a Session then it '''may''' be useful to combine this with one of the other two options</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 352: Line 718:
 
----</td>
 
----</td>
 
</tr>
 
</tr>
</table></td>
+
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
An example:-
+
'''An example:-'''
<table>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalAcceptAllTrainsSpecifics.PNG|link=]]</td>
+
<td>[[image:PortalAcceptAllTrainsSpecifics.PNG|link=]]</td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#000000 width=500>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
+
<td>
 +
<table bgcolor=#ffffb0 width=496>
 +
<tr valign="top">
 +
<td>[[image:NotePad.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
This will remove ''any'' train that:-
+
----
*contains locomotive '''BR HST 125''' with the running number '''253007'''
+
In this example, the portal will remove ''any'' train that:-
or has ''any of'' the following vehicles:-
+
<table>
*'''BR HST MK3 TF''' with ''any'' running numbers
+
<tr valign="top">
*'''BR HST MK3 TRUK''' with ''any'' running numbers
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
or is driven by ''any of'' the following drivers:-
+
<td>contains locomotive '''BR HST 125''' with the running number '''253007'''</td>
*'''Alan'''
+
*'''Andrea'''</td>
+
 
</tr>
 
</tr>
</table></td>
+
<tr valign="top">
 +
<td colspan=2><span style="font-weight: 700; font-size: 15px;">OR</span> has ''any of'' the following vehicles:-</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''BR HST MK3 TF''' with ''any'' running numbers</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''BR HST MK3 TRUK''' with ''any'' running numbers</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>
 +
<span style="font-weight: 700; font-size: 15px;">OR</span> is driven by ''any of'' the following drivers:-</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''Alan'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''Andrea'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 380: Line 778:
  
 
==='''Return Consumed Trains'''===
 
==='''Return Consumed Trains'''===
 +
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>A train that has been returned after entering a portal will return to the Session with any remaining driver commands still in its Driver Schedule. It will then immediately start obeying those commands</td>
 +
</tr>
 +
</table>
 +
<br>
 
To return consumed trains back into the Session<br>
 
To return consumed trains back into the Session<br>
<table>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:PortalAcceptTrainReturns.PNG|link=]]<br><br>
+
<td>[[image:PortalAcceptTrainReturns.PNG|link=]]<br><br>
<table cellpadding="4" bgcolor=#eeeeee>
+
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 390: Line 795:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 
To return the train from a different portal:-
 
To return the train from a different portal:-
#Set [[file:CheckBox.PNG|link=]] '''Train returns through alternate portal''' and
+
<table>
#Enter the exact name of the alternate portal</td>
+
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Set [[image:CheckBox.PNG|link=]] '''Train returns through alternate portal''', and</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Enter the exact name of the alternate portal</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
Line 402: Line 816:
 
</table></td>
 
</table></td>
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#eeeeee>
+
<table cellpadding=4 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 408: Line 822:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span>
#Set [[file:CheckBox.PNG|link=]] '''Train returns after ...'''
+
<table>
#Set the time delay (in '''real minutes''') between the train being consumed and produced, then select '''one option''' from:-</td>
+
<tr valign="top">
 +
<td width=10>[[image:BlackDot10x10.png|link=]]</td>
 +
<td>Set [[image:CheckBox.PNG|link=]] '''Train returns after ...''' and</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">&#160;Double Left Click&#160;</span> on '''<u>5 real minutes</u>''' to set the time delay (in '''real minutes''', not '''Trainz Clock minutes''') between the train being consumed and produced, then select '''one option''' from:-</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
<table cellpadding="4" bgcolor=#ffffff>
+
<table cellpadding=4 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Choices.PNG|link=]]</td>
+
<td>[[image:Choices.PNG|link=]]</td>
 
<td><span style="font-size: 17px;">'''Choices:'''</span><br>
 
<td><span style="font-size: 17px;">'''Choices:'''</span><br>
:[[file:PortalOptionButtonEmpty.PNG|link=]] '''Train is not loaded or unloaded''' - no changes will be made to the loads carried in each vehicle
+
:[[image:PortalOptionButtonEmpty.PNG|link=]] '''Train is not loaded or unloaded''' - no changes will be made to the loads carried in each vehicle
:[[file:PortalOptionButtonEmpty.PNG|link=]] '''Train is loaded only''' - each vehicle will be loaded when it exits the portal
+
:[[image:PortalOptionButtonEmpty.PNG|link=]] '''Train is loaded only''' - each vehicle will be loaded when it exits the portal
:[[file:PortalOptionButtonEmpty.PNG|link=]] '''Train is unloaded only''' - each vehicle will be unloaded when it exits the portal
+
:[[image:PortalOptionButtonEmpty.PNG|link=]] '''Train is unloaded only''' - each vehicle will be unloaded when it exits the portal
:[[file:PortalOptionButtonEmpty.PNG|link=]] '''Empty trains are loaded, other trains are unloaded''' - vehicles that are empty when entering the portal will be loaded when they exit the portal, all other vehicles will be unloaded</td>
+
:[[image:PortalOptionButtonEmpty.PNG|link=]] '''Empty trains are loaded, other trains are unloaded''' - vehicles that are empty when entering the portal will be loaded when they exit the portal, all other vehicles will be unloaded</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 431: Line 854:
 
</table>
 
</table>
 
<br>
 
<br>
<table cellpadding="4" bgcolor=#c1e7e7>
+
<table bgcolor="red" width=900>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>
<td>'''A train that has been returned after entering a portal will return to the Session with any remaining driver commands still in its Driver Schedule.''' It will then immediately start obeying those commands.</td>
+
<table bgcolor=#fcbcbc width=896>
</tr>
+
</table>
+
<br>
+
<table cellpadding="4" bgcolor=#fcbcbc>
+
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:Stop.PNG|link=]]</td>
+
<td>[[image:Stop.PNG|link=]]</td>
 
<td>
 
<td>
If the driver command that sent a train to the consuming portal was the '''final command''' in its schedule, then it will emerge from the portal with an '''empty Driver Schedule'''. It will come to a halt immediately after leaving the portal.</td>
+
If the driver command that sent a train to the consuming portal was the '''final command''' in its schedule, then it will emerge from the portal with an '''empty Driver Schedule'''. It will come to a halt immediately after leaving the portal.
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepEnhanced"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepConfiguring|alt=Next Up|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
</table>
+
</table> <!-- END Nav Buttons Table -->
  
 
='''Configuring an Enhanced Portal'''=
 
='''Configuring an Enhanced Portal'''=
  
There are a number of portals available on the DLS that have additional features or capabilities that are not found in the basic portals built into Trainz. There are also Session Rules available on the DLS that will give additional features or capabilities to the basic portals.
+
<table width=1000>
 +
<tr valign="top">
 +
<td>There are a number of portals available on the DLS that have additional features or capabilities that are not found in the basic portals built into Trainz. There are also Session Rules available on the DLS that will give additional features or capabilities to the basic portals.</td>
 +
</tr>
 +
</table>
  
 
=='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''==
 
=='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''==
  
This is a Session Rule, by '''pguy''', that manages the portals and adds flexible timetables to their operations. It is available on the DLS.
+
<table width=1000>
 +
<tr valign="top">
 +
<td>This is a Session Rule, by '''pguy''', that manages the portals and adds flexible timetables to their operations. It is available on the DLS.
  
*'''<kuid2:61392:5011:45>''' - correct at the time this document was written
+
*'''&lt;kuid2:61392:5011:45&gt;''' - correct at the time this document was written</td>
 +
</tr>
 +
</table>
  
'''This is still a work in progress - more to come'''
+
='''Portals and the UDS (Unified Driver Surveyor) Interface'''=
<br>
+
 
<table width="100%">
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td>The '''UDS''' is an option for rapid switching, in both directions, between '''Driver''' and '''Surveyor'''. It is available in '''TRS19 Platinum Edition''' and later versions of '''Trainz'''. The '''UDS''' does not affect the operation of portals but it has revealed one previously unnoticed property of portals.<br>
 +
 
 +
A train that is driven into a portal and later returned to the layout will be returned in the same layer as the portal and not in the trains originally assigned layer. Trains that are produced by a portal will be assigned to the same layer as the portal. This has <span style="background-color: yellow; font-weight: 700;">&nbsp;possibly always been the case with portals&nbsp;</span> but was probably unnoticed until the arrival of the '''UDS'''. It seems to have no other noticeable effect on trains.<br>
 +
 
 +
This could become an issue if you make the switch from '''Driver''' to '''Surveyor''' after a train has been '''returned''' to the layout from a portal. For example, if a train is originally in a '''Session Layer''' then it is part of a '''Session'''. If it is returned from a portal then it will now be in a '''Route Layer''' and will be part of the '''Route'''. If you then switch from '''Driver''' to '''Surveyor''' and save the '''Route''' then the train will be saved in the '''Route''' not in the '''Session'''. If this is an issue then the remedy is to open the property dialogue window of any wagon in the train after it has left the portal and change its assigned layer to the correct one. This will set all vehicles in that train to the same correct layer.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
<br>
 +
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="bottom"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepEnhanced|alt=Next Up|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 
----
 
----
 
----
 
----
  
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
<table cellpadding="4" bgcolor=#ffffff>
+
<table cellpadding=4 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
<td>[[file:TrainzWiki.png|link=]]</td>
+
<td>[[image:TrainzWiki.png|link=]]</td>
 
<td>
 
<td>
 
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
 
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
+
*'''<span class="plain;s">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
 
*'''[[Driver Commands List]]'''
 
*'''[[Driver Commands List]]'''
 
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
Line 485: Line 934:
 
</tr>
 
</tr>
 
</table>
 
</table>
 
+
----
 +
This page was created by Trainz user '''<span class="plain;s">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in July 2018 and was last updated as shown below.
 +
----
 
[[Category:How-to guides]]
 
[[Category:How-to guides]]

Latest revision as of 14:41, 27 July 2024

The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22.

Contents

BlueDot10x10.png Portals are track objects that can add and remove trains during the running of a Session
BlueDot10x10.png Portals can be used to move trains from one part of a Route to another


  Top   Next Down Bottom

[edit] What is a Portal?

PortalTypeScreenShot.PNG

Portals come in a variety of forms - some resemble tunnels and others look like a section of normal track. One portal is a Track Marker.

The basic portals supplied with Trainz can be configured to:-

BlueDot10x10.png remove trains that are sent to them or pass through them (the portals that look like track can be used to let certain trains pass through while "swallowing" others).

The removed trains can be:-

BlueDot10x10.png removed permanently, or
BlueDot10x10.png returned to the Session through the same portal or another portal after a set time delay
BlueDot10x10.png add new trains to the Session. The new trains:-
BlueDot10x10.png will have drivers with orders to follow
BlueDot10x10.png can be randomly selected from available consists


BlueDot10x10.png Portals can be "enhanced" by using Session Rules that add additional features and capabilities


Enhanced portals can have features such as:-
BlueDot10x10.png adding new trains to the Session according to a set schedule ranging from once only, once per day or at set clock times
BlueDot10x10.png varying the drivers of added trains and their commands according to a set schedule
BlueDot10x10.png varying the consists of added trains


[edit] Adding a Portal

[edit]  In Surveyor Classic (S10) 

PortalSearchSettings.PNG The quickest way to find all the train producing and consuming portals in the Surveyor Object Tool window is to set up a search filter. This will sort the portals you want from all the objects named "portal" such as tunnel portals.
Steps: To find a Portal in Content Manager:-
Set an advanced search filter by:-
DotPoint1.JPG Pressing  Ctrl  +  Shift  +  F 
DotPoint2.JPG  Left Click   +  and add the filter  Name  and enter Portal (upper/lower case is not important) in its text entry box
DotPoint3.JPG  Left Click   +  and add the filter  Category  and its sub-category Industry
The Objects selection window will now show only those objects that match your search criteria.
DotPoint4.JPG Open the Object Tools "fly-out" (or press the  F3  key)
The objects list will show all scenery assets that meet your entered search


Stop.PNG

The portals will NOT work correctly if the Trainz Settings - Dev Tab - Compatibility mode: from the Trainz Launcher is set to Maximize performance. This setting should be left at Maximize compatibility

[edit]  In Surveyor 2.0 (S20) 

Surveyor 2.0 is currently only available for Trainz Plus and TRS22 Platinum Edition


Steps: To find a Portal in the Assets Palette:-
DotPoint1.JPG In the Filter Palette  Left Click  on the Scenery Objects icon or select Scenery Objects from the Content Drop Down box
FilterAssetsPaletteSearchPortals S20.png
NotePad.PNG Notes:

If both the Filter Palette and Assets Palette are not shown on the screen, then:-

Windows Menu
DotPoint1Blue.png open the SurveyorWindowIcon.png Window Menu from the menu icons at the top of the screen
DotPoint2Blue.png If either palette does not have a Tick.PNG next to its name then  Left Click  on the palette name to add a Tick.PNG and make it visible
DotPoint3Blue.png If the palettes have ticks but are not visible then check the minimised area at the bottom of the list where Mini Map is located. If their names appear there then they have been minimised. To restore the palettes to the screen  Left Click  on the palette names in the minimised area, NOT in the palette area above.


DotPoint2.JPG In the Assets Palette enter the text "portal" (UPPER/lower case does not matter) into the  Search  text box
DotPoint3.JPG  Left Click  on an entry to select it. If you are not sure about an asset then  Double Left Click  on the name to bring up its image and description
DotPoint4.JPG  Left Click  in your Trainz World to add the portal to the scene


Portal Context menu S20
Steps: To open the Properties window of an asset, including a Portal, in Surveyor 2.0
DotPoint1.JPG  Left Click  on its Context Icon as shown in the image left
DotPoint2.JPG  Left Click  on  Edit Properties  to configure the portal
  Top Next Up Next Down Bottom

[edit] Configuring a Basic Portal

Open the properties window of a portal in the route.

PortalProperties01.PNG

Gears.PNG Settings:

This portal is set to:-

BlackDot10x10.png Produce a train every 15 minutes (but the train consist has not yet been specified)
BlackDot10x10.png Consume all trains that are sent to the portal or pass through the portal
BlackDot10x10.png The consumed trains will not be returned to the Session

NotePad.PNG Notes:

In TRS19, Trainz Plus and TRS22 the time entered is in real minutes as determined by an external clock and not according to the Trainz Clock Time which may be set to run at a higher speed (e.g. 10X normal).


[edit] Produce Trains

PortalProduceNewTrains.PNG
Steps: To add consists to be produced by the portal:-
DotPoint1.JPG CheckBox.PNG Produce new trains
DotPoint2.JPG set the desired time interval (in minutes) between the trains
DotPoint3.JPG  Left Click  the ; Add new consist
PortalProperties02.PNG


Steps: To manually add rolling stock objects:-
DotPoint1.JPG  Left Click  PortalPlusIcon.PNG to manually construct a consist from the Session rolling stock list
DotPoint2.JPG  Left Click  Add driver to consist to add a driver from the Session list
DotPoint3.JPG  Left Click  Add an existing saved consist to add a saved consist from those that you have already saved as Train Consist Assets


[edit] Construct a Consist

PortalProperties04.PNG

Gears.PNG Settings:

For each vehicle in the consist you can specify:-

BlackDot10x10.png how many to add (they will be coupled together)
BlackDot10x10.png the direction the vehicle(s) will face

You can also:-

BlackDot10x10.png delete vehicles or the entire consist
BlackDot10x10.png insert additional vehicles inside the consist
BlackDot10x10.png add additional vehicles at the end of the consist
NotePad.PNG Notes:

DotPoint.JPG the first vehicle in the list will be the first vehicle produced by the portal
DotPoint.JPG it is NOT possible to easily reorder the vehicles in a consist
DotPoint.JPG to add more of the same vehicles in a different location in the consist, add the vehicles as a separate entry in the list
DotPoint.JPG add another consist and driver by a  Left Click  on the Add new consist ; again


[edit] Add a Saved Consist

If you have already saved your consists in Trainz using the Trainz Tool then those consists can be quickly and easily added to the portal consist list.

PortalExitingConsist.PNG
Steps: To add a saved consist to a portal:-
DotPoint1.JPG Scroll through the list to find the saved consist
DotPoint2.JPG Select the consist, then either:-
Ablue.png  Left Click  the Tick.PNG icon to accept the selection and load it into the portal consist list, OR
Bblue.png  Left Click  the Cross.PNG icon to reject the selection and return to the previous screen


[edit] Add a Driver

PortalProperties03.PNG

Gears.PNG Settings:

You can:-

BlackDot10x10.png Select a new driver and icon
BlackDot10x10.png Rename the driver
BlackDot10x10.png Add driver commands
BlackDot10x10.png Delete the driver

LinkWiki.PNG

For information on adding driver commands see the Trainz Wiki Page at:-


[edit] Consume Trains

To remove trains from the Session

PortalAcceptAllTrains.PNG

Choices.PNG Choices:

CheckBox.PNG Consume trains then either

PortalOptionButtonEmpty.PNG Accept all trains to remove any and all trains that enter the portal, OR
PortalOptionButtonEmpty.PNG Accept trains matching specific criteria to only remove certain trains that enter the portal

PencilTips.PNG For "dead end" portals (those that have no exit) the Accept all trains option is the option that should be used


[edit] Consume Only Specific Trains

After selecting the option Accept trains matching specific criteria a new set of controls will appear

PortalAcceptAllTrainsOpen.PNG

Gears.PNG Settings:

PortalOptionButtonFilled.PNG Accept trains matching specific criteria

BlackDot10x10.png You can set any one, any two or all three of the consist selection criteria
BlackDot10x10.png Any train that matches the entered settings will be removed from the Session as it enters the portal, other trains will be ignored

Control Options:-

DotPointBlack.JPG Specific Vehicles - normally used to specify just one particular train in the Session
BlackDot10x10.png You must select, from the Session list, the exact name given to a vehicle. This is the name that has been entered into the property window of that vehicle
BlackDot10x10.png The order of the vehicles, if there is more than one, is not important
BlackDot10x10.png You only need to select enough names to correctly identify the consist that contains the vehicle or vehicles (the locomotive name is usually sufficient)
DotPointBlack.JPG Vehicles Types - normally used to specify a number of different trains in the session e.g. all trains with a particular type of coal wagon
BlackDot10x10.png You must select, from the Session list, the general name of the type of vehicle or vehicles - this is the name shown in the Trains Tool when the vehicle is added to a layout
BlackDot10x10.png If you have identified Specific Vehicles (above) then you would normally not need to set this option
DotPointBlack.JPG Drivers - used to specify trains driven by particular drivers
BlackDot10x10.png Select the driver or drivers from the Session driver list
BlackDot10x10.png If your drivers change trains or consists during a Session then it may be useful to combine this with one of the other two options


An example:-

PortalAcceptAllTrainsSpecifics.PNG
NotePad.PNG Notes:

In this example, the portal will remove any train that:-

DotPoint.JPG contains locomotive BR HST 125 with the running number 253007
OR has any of the following vehicles:-
DotPoint.JPG BR HST MK3 TF with any running numbers
DotPoint.JPG BR HST MK3 TRUK with any running numbers
OR is driven by any of the following drivers:-
DotPoint.JPG Alan
DotPoint.JPG Andrea


[edit] Return Consumed Trains

BlueDot10x10.png A train that has been returned after entering a portal will return to the Session with any remaining driver commands still in its Driver Schedule. It will then immediately start obeying those commands


To return consumed trains back into the Session

PortalAcceptTrainReturns.PNG


Gears.PNG Settings:

To return the train from a different portal:-

BlackDot10x10.png Set CheckBox.PNG Train returns through alternate portal, and
BlackDot10x10.png Enter the exact name of the alternate portal


Gears.PNG Settings:
BlackDot10x10.png Set CheckBox.PNG Train returns after ... and
BlackDot10x10.png  Double Left Click  on 5 real minutes to set the time delay (in real minutes, not Trainz Clock minutes) between the train being consumed and produced, then select one option from:-
Choices.PNG Choices:
PortalOptionButtonEmpty.PNG Train is not loaded or unloaded - no changes will be made to the loads carried in each vehicle
PortalOptionButtonEmpty.PNG Train is loaded only - each vehicle will be loaded when it exits the portal
PortalOptionButtonEmpty.PNG Train is unloaded only - each vehicle will be unloaded when it exits the portal
PortalOptionButtonEmpty.PNG Empty trains are loaded, other trains are unloaded - vehicles that are empty when entering the portal will be loaded when they exit the portal, all other vehicles will be unloaded


Stop.PNG

If the driver command that sent a train to the consuming portal was the final command in its schedule, then it will emerge from the portal with an empty Driver Schedule. It will come to a halt immediately after leaving the portal.


  Top Next Up   Bottom

[edit] Configuring an Enhanced Portal

There are a number of portals available on the DLS that have additional features or capabilities that are not found in the basic portals built into Trainz. There are also Session Rules available on the DLS that will give additional features or capabilities to the basic portals.

[edit] Quick Portal Manager Standard Edition Rule (SP2 and later)

This is a Session Rule, by pguy, that manages the portals and adds flexible timetables to their operations. It is available on the DLS.
  • <kuid2:61392:5011:45> - correct at the time this document was written

[edit] Portals and the UDS (Unified Driver Surveyor) Interface

The UDS is an option for rapid switching, in both directions, between Driver and Surveyor. It is available in TRS19 Platinum Edition and later versions of Trainz. The UDS does not affect the operation of portals but it has revealed one previously unnoticed property of portals.

A train that is driven into a portal and later returned to the layout will be returned in the same layer as the portal and not in the trains originally assigned layer. Trains that are produced by a portal will be assigned to the same layer as the portal. This has  possibly always been the case with portals  but was probably unnoticed until the arrival of the UDS. It seems to have no other noticeable effect on trains.

This could become an issue if you make the switch from Driver to Surveyor after a train has been returned to the layout from a portal. For example, if a train is originally in a Session Layer then it is part of a Session. If it is returned from a portal then it will now be in a Route Layer and will be part of the Route. If you then switch from Driver to Surveyor and save the Route then the train will be saved in the Route not in the Session. If this is an issue then the remedy is to open the property dialogue window of any wagon in the train after it has left the portal and change its assigned layer to the correct one. This will set all vehicles in that train to the same correct layer.


  Top Next Up    


[edit] Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz


This page was created by Trainz user pware in July 2018 and was last updated as shown below.


Personal tools