How to Use Portals
m (→Consume Trains) |
m (→What is a Portal?) |
||
(20 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
+ | The information in this Wiki Page applies to both '''TANE''' and '''TRS19'''. | ||
+ | |||
__TOC__ | __TOC__ | ||
='''What is a Portal?'''= | ='''What is a Portal?'''= | ||
Line 17: | Line 19: | ||
<td><font size="3">'''Notes:'''</font><br> | <td><font size="3">'''Notes:'''</font><br> | ||
Portals come in a variety of forms - some resemble tunnels and others look like a section of normal track.<br><br> | Portals come in a variety of forms - some resemble tunnels and others look like a section of normal track.<br><br> | ||
− | The basic portals supplied with | + | The basic portals supplied with Trainz can be configured to:- |
*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:- | *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:- | ||
**removed permanently, or | **removed permanently, or | ||
Line 40: | Line 42: | ||
</table> | </table> | ||
<br> | <br> | ||
+ | <table> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:PortalSearchSettings.PNG]]</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 cellpadding="4" bgcolor=#ffffff> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | ----</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:Steps.PNG]]</td> | ||
+ | <td><font size="3">'''Steps:'''</font><br> | ||
+ | Set an advanced search filter by:- | ||
+ | #Pressing '''Ctrl Shift F''' | ||
+ | #Enter ''Name'' '''portal''' (upper/lower case is not important) | ||
+ | #Select ''Category'' '''Industry''' | ||
+ | The '''Objects''' selection window will now show only those objects that match your search criteria.</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | ----</td> | ||
+ | </tr> | ||
+ | </table></td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <br> | ||
+ | <table cellpadding="4" bgcolor=#ff0000> | ||
+ | <tr valign="top"> | ||
+ | <td> | ||
+ | <table cellpadding="4" bgcolor=#fcbcbc> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:Stop.PNG]]</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'''. | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table></td> | ||
+ | </tr> | ||
+ | </table> | ||
='''Configuring a Basic Portal'''= | ='''Configuring a Basic Portal'''= | ||
Line 122: | Line 163: | ||
*[[file:PortalPlusIcon.PNG]] to manually '''construct a consist''' from the Session rolling stock list | *[[file:PortalPlusIcon.PNG]] to manually '''construct a consist''' from the Session rolling stock list | ||
*'''''<u>Add driver to consist</u>''''' to '''add a driver''' from the Session list | *'''''<u>Add driver to consist</u>''''' to '''add a driver''' from the Session list | ||
− | *'''''<u>Add an existing saved consist</u>''''' to '''add a saved consist''' from those that you have already saved in | + | *'''''<u>Add an existing saved consist</u>''''' 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"> | ||
Line 162: | Line 203: | ||
<td>[[file:NotePad.PNG]]</td> | <td>[[file:NotePad.PNG]]</td> | ||
<td><font size="3">'''Notes:'''</font><br> | <td><font size="3">'''Notes:'''</font><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 | *It is NOT possible to easily reorder the vehicles in a consist | ||
*To add more of the same vehicles in a different location in the consist, add the vehicles as a separate entry in the list | *To add more of the same vehicles in a different location in the consist, add the vehicles as a separate entry in the list | ||
Line 170: | Line 212: | ||
</table> | </table> | ||
<br> | <br> | ||
+ | |||
==='''Add a Saved Consist'''=== | ==='''Add a Saved Consist'''=== | ||
− | If you have already saved your consists in | + | 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. |
<br> | <br> | ||
+ | <table> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:PortalExitingConsist.PNG]]</td> | ||
+ | <td> | ||
+ | <table cellpadding="4" bgcolor=#ffffff> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | ----</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:Steps.PNG]]</td> | ||
+ | <td><font size="3">'''Steps:'''</font><br> | ||
+ | #Scroll through the list to find the saved consist | ||
+ | #Select the consist, then either:- | ||
+ | :*Click the [[file:Tick.PNG]] icon to accept the selection and load it into the portal consist list, or | ||
+ | :*Click the [[file:Cross.PNG]] icon to reject the selection and return to the previous screen</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="2"> | ||
+ | ----</td> | ||
+ | </tr> | ||
+ | </table></td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <br> | ||
+ | |||
==='''Add a Driver'''=== | ==='''Add a Driver'''=== | ||
<table> | <table> | ||
Line 222: | Line 291: | ||
<td>[[file:Choices.PNG]]</td> | <td>[[file:Choices.PNG]]</td> | ||
<td><font size="3">'''Choices:'''</font><br> | <td><font size="3">'''Choices:'''</font><br> | ||
− | + | [[file:CheckBox.PNG]] '''Consume trains''' then either | |
− | + | :[[file:PortalOptionButtonEmpty.PNG]] '''Accept all trains''' to remove any and all trains that enter the portal, or | |
− | + | :[[file:PortalOptionButtonEmpty.PNG]] '''Accept trains matching specific criteria''' to only remove certain trains that enter the portal</td> | |
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 236: | Line 305: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:PencilTips.PNG]]</td> | <td>[[file:PencilTips.PNG]]</td> | ||
− | <td>For "dead end" portals (those that have no exit) the '''Accept all trains''' option is the | + | <td>For "dead end" portals (those that have no exit) the '''Accept all trains''' option is the option that ''should'' be used</td> |
</tr> | </tr> | ||
</table> | </table> | ||
Line 254: | Line 323: | ||
<td>[[file:Gears.PNG]]</td> | <td>[[file:Gears.PNG]]</td> | ||
<td><font size="3">'''Settings:'''</font><br> | <td><font size="3">'''Settings:'''</font><br> | ||
+ | [[file:PortalOptionButtonFilled.PNG]] '''Accept trains matching specific criteria''' | ||
*You can set any one, any two or all three of the '''consist selection criteria''' | *You can set any one, any two or all three of the '''consist selection criteria''' | ||
*Any train that matches the entered settings will be removed from the Session as it enters the portal, other trains will be ignored | *Any train that matches the entered settings will be removed from the Session as it enters the portal, other trains will be ignored | ||
Line 283: | Line 353: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:PortalAcceptAllTrainsSpecifics.PNG]]</td> | <td>[[file:PortalAcceptAllTrainsSpecifics.PNG]]</td> | ||
+ | <td> | ||
+ | <table cellpadding="4" bgcolor=#ffffb0> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:NotePad.PNG]]</td> | ||
+ | <td><font size="3">'''Notes:'''</font><br> | ||
+ | This will remove ''any'' train that:- | ||
+ | *contains locomotive '''BR HST 125''' with the running number '''253007''' | ||
+ | or has ''any of'' the following vehicles:- | ||
+ | *'''BR HST MK3 TF''' with ''any'' running numbers | ||
+ | *'''BR HST MK3 TRUK''' with ''any'' running numbers | ||
+ | or is driven by ''any of'' the following drivers:- | ||
+ | *'''Alan''' | ||
+ | *'''Andrea'''</td> | ||
+ | </tr> | ||
+ | </table></td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Line 301: | Line 386: | ||
<td><font size="3">'''Settings:'''</font><br> | <td><font size="3">'''Settings:'''</font><br> | ||
To return the train from a different portal:- | To return the train from a different portal:- | ||
− | #[[file:CheckBox.PNG]] '''Train returns through alternate portal''' and | + | #Set [[file:CheckBox.PNG]] '''Train returns through alternate portal''' and |
#Enter the exact name of the alternate portal</td> | #Enter the exact name of the alternate portal</td> | ||
</tr> | </tr> | ||
Line 318: | Line 403: | ||
<td>[[file:Gears.PNG]]</td> | <td>[[file:Gears.PNG]]</td> | ||
<td><font size="3">'''Settings:'''</font><br> | <td><font size="3">'''Settings:'''</font><br> | ||
− | #[[file:CheckBox.PNG]] '''Train returns after ...''' | + | #Set [[file:CheckBox.PNG]] '''Train returns after ...''' |
#Set the time delay (in '''real minutes''') between the train being consumed and produced, then select '''one option''' from:-</td> | #Set the time delay (in '''real minutes''') between the train being consumed and produced, then select '''one option''' from:-</td> | ||
</tr> | </tr> | ||
Line 326: | Line 411: | ||
<td>[[file:Choices.PNG]]</td> | <td>[[file:Choices.PNG]]</td> | ||
<td><font size="3">'''Choices:'''</font><br> | <td><font size="3">'''Choices:'''</font><br> | ||
− | : | + | :[[file:PortalOptionButtonEmpty.PNG]] '''Train is not loaded or unloaded''' - no changes will be made to the loads carried in each vehicle |
− | : | + | :[[file:PortalOptionButtonEmpty.PNG]] '''Train is loaded only''' - each vehicle will be loaded when it exits the portal |
− | : | + | :[[file:PortalOptionButtonEmpty.PNG]] '''Train is unloaded only''' - each vehicle will be unloaded when it exits the portal |
− | : | + | :[[file: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</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 336: | Line 421: | ||
</tr> | </tr> | ||
</table></td> | </table></td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <br> | ||
+ | <table cellpadding="4" bgcolor=#c1e7e7> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:DotPoint.JPG]]</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> | ||
+ | <table cellpadding="4" bgcolor=#fcbcbc> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:Stop.PNG]]</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> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Line 342: | Line 442: | ||
='''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 | + | 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. |
=='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''== | =='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''== | ||
Line 350: | Line 450: | ||
*'''<kuid2:61392:5011:45>''' - correct at the time this document was written | *'''<kuid2:61392:5011:45>''' - correct at the time this document was written | ||
− | + | '''This is still a work in progress - more to come''' | |
+ | <br> | ||
---- | ---- | ||
---- | ---- | ||
Line 362: | Line 463: | ||
<font size="3">'''More Tutorials and Guides to Using Trainz'''</font><br> | <font size="3">'''More Tutorials and Guides to Using Trainz'''</font><br> | ||
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>''' | *'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>''' | ||
+ | *'''[[Driver Commands List]]''' | ||
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]''' | *'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]''' | ||
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]''' | *'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]''' | ||
Line 367: | Line 469: | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | |||
+ | [[Category:How-to guides]] |
Revision as of 12:21, 20 April 2019
The information in this Wiki Page applies to both TANE and TRS19.
Contents |
What is a Portal?
Portals are track objects that can add and remove trains during the running of a Session |
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.
|
|
Configuring a Basic Portal
Open the properties window of a portal in the route.
|
Produce Trains
|
|
Construct a Consist
|
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.
|
Add a Driver
|
Consume Trains
To remove trains from the Session
|
For "dead end" portals (those that have no exit) the Accept all trains option is the option that should be used |
Consume Only Specific Trains
After selecting the option Accept trains matching specific criteria a new set of controls will appear
|
An example:-
|
Return Consumed Trains
To return consumed trains back into the Session
|
|
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. |
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. |
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.
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
This is still a work in progress - more to come
Trainz Wiki
More Tutorials and Guides to Using Trainz |