How to Use Portals

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(Created page with "__TOC__ ='''What is a Portal?'''= <table cellpadding="4" bgcolor=#c1e7e7> <tr valign="top"> <td>file:DotPoint.JPG</td> <td>'''Portals are track objects that can add and re...")
 
(Return Consumed Trains)
Line 301: Line 301:
 
----</td>
 
----</td>
 
</tr>
 
</tr>
</table>
+
</table></td>
</td>
+
 
<td>
 
<td>
<table cellpadding="4" bgcolor=#ffffff>
+
<table cellpadding="4" bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
 
----</td>
 
----</td>
 
</tr>
 
</tr>
 +
<tr valign="top">
 +
<td>[[file:Gears.PNG]]</td>
 +
<td><font size="3">'''Settings:'''</font><br>
 +
#Tick the checkbox '''Train returns after ...'''
 +
#Set the time delay (in '''real minutes''') between the train being consumed and produced, then select '''one option''' from:-</td>
 +
</tr>
 +
</table>
 +
<table cellpadding="4" bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
 
<td>[[file:Choices.PNG]]</td>
 
<td>[[file:Choices.PNG]]</td>
 
<td><font size="3">'''Choices:'''</font><br>
 
<td><font size="3">'''Choices:'''</font><br>
#Tick the checkbox '''Train returns after ...'''
 
#Set the time delay (in '''real minutes''') between the train being consumed and produced, then select '''one option''' from:-
 
 
:*'''Train is not loaded or unloaded''' - no changes will be made to the loads carried in each vehicle
 
:*'''Train is not loaded or unloaded''' - no changes will be made to the loads carried in each vehicle
 
:*'''Train is loaded only''' - each vehicle will be loaded when it exits the portal
 
:*'''Train is loaded only''' - each vehicle will be loaded when it exits the portal
Line 327: Line 332:
 
</table>
 
</table>
 
<br>
 
<br>
 +
='''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 TANE. 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
 +
 +
 +
----
 +
----
 +
<br>
 +
 +
='''Trainz Wiki'''=
 +
<table cellpadding="4" bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td>[[file:TrainzWiki.png]]</td>
 +
<td>
 +
<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>'''
 +
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 +
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
 +
</td>
 +
</tr>
 +
</table>

Revision as of 23:53, 31 July 2018

Contents

What is a Portal?

DotPoint.JPG Portals are track objects that can add and remove trains during the running of a Session


NotePad.PNG Notes:

Portals come in a variety of forms - some resemble tunnels and others look like a section of normal track.

PortalTypeScreenShot.PNG The basic portals supplied with TANE 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:-
    • removed permanently, or
    • returned to the Session through the same portal or another portal after a set time delay
  • add new trains to the Session. The new trains:-
    • will have drivers with orders to follow
    • can be randomly selected from available consists


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

Enhanced portals can have features such as:-

  • 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


Configuring a Basic Portal

Open the properties window of a portal in the route.

PortalProperties01.PNG

Gears.PNG Settings:

This portal is set to:-

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

NotePad.PNG Notes:

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
  • 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


Produce Trains

PortalProduceNewTrains.PNG

Steps.PNG Steps:

To add consists to be produced by the portal:-

  1. check the box Produce new trains
  2. set the desired time interval (in minutes) between the trains
  3. click the link Add new consist


PortalProperties02.PNG

Gears.PNG Settings:

Click:-

  • PortalPlusIcon.PNG to manually construct a consist from the Session rolling stock list
  • Add driver to consist to add a driver from the Session list
  • Add an existing saved consist to add a saved consist from those that you have already saved in TANE


Construct a Consist

PortalProperties04.PNG

Gears.PNG Settings:

For each vehicle in the consist you can specify:-

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

You can also:-

  • delete vehicles or the entire consist
  • insert additional vehicles inside the consist
  • add additional vehicles at the end of the consist

NotePad.PNG Notes:
  • It is NOT possible to easily reorder the vehicles in a consist
  • Add another consist and driver by clicking the Add new consist link again


Add a Saved Consist

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

Add a Driver

PortalProperties03.PNG

Gears.PNG Settings:

You can:-

  • Select a new driver and icon
  • Rename the driver
  • Add driver commands
  • Delete the driver

NotePad.PNG Notes:
For information on adding driver commands see the Trainz Wiki Page WikiLink.PNG Driver Setup Rule


Consume Trains

To remove trains from the Session

PortalAcceptAllTrains.PNG

Choices.PNG Choices:
  • Tick the checkbox Consume trains then either
    • Select the option Accept all trains to remove any and all trains that enter the portal, or
    • Select the option Accept trains matching specific criteria to only remove certain trains that enter the portal


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:
  • You can set any one, any two or all three of the consist selection criteria
  • Any train that exactly matches the entered settings will be removed from the Session, other trains will be ignored


Specific Vehicles

  • 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
  • The order of the vehicles, if there is more than one, is not important
  • You only need to select enough names to correctly identify the consist that contains the vehicle or vehicles (the locomotive name is usually sufficient)


Vehicles Types

  • 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
  • If you have identified Specific Vehicles (above) then you would normally not need to set this option


Drivers

  • Select the driver or drivers from the Session driver list
  • If your drivers change trains or consists during a Session then it would be useful to combine this and one of the other two options


An example:-

PortalAcceptAllTrainsSpecifics.PNG


Return Consumed Trains

To return consumed trains back into the Session

PortalAcceptTrainReturns.PNG

Gears.PNG Settings:

To return the train from a different portal:-

  1. Tick the check box Train returns through alternate portal and
  2. Enter the exact name of the alternate portal


Gears.PNG Settings:
  1. Tick the checkbox Train returns after ...
  2. Set the time delay (in real minutes) between the train being consumed and produced, then select one option from:-
Choices.PNG Choices:
  • Train is not loaded or unloaded - no changes will be made to the loads carried in each vehicle
  • Train is loaded only - each vehicle will be loaded when it exits the portal
  • Train is unloaded only - each vehicle will be unloaded when it exits the portal
  • 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


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 TANE. 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





Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

Personal tools