Help:QuickDrive

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
[[Help:QuickDrive|QuickDrive]] is a rule created to offer a general user interface (GUI) in driver mode to support most of world parameters setup on the fly while driving and to support adding and removing consists in driver mode without having to do a trip under surveyor.<br>
+
Quickdrive is a rule which adds a graphical user interface (GUI) in Driver to allow real-time editing of several game environment variables, and allow the player to place/remove trains.
  
This QuickDrive online help is organized in three parts : <br>[[#Surveyor setup|Surveyor setup]] for initial surveyor setup<br>[[#Opening the GUI|Opening the GUI]] for (re)opning the general user interface<br>[[#QuickDrive operations supported|Operations supported]] doe the details on operations supported<br><br>All help items are based on QuickDrive v8 available with TS2009 build 38841.<br><br>
+
This page relates to the use of the Quickdrive rule in Driver. For details on how to configure the Quickdrive interface in Surveyor, see the [[Help:QuickDrive_Rule|QuickDrive Rule help page]].
  
==Surveyor setup==
+
[[Image:Help_QuickDrive_MenuBarIcon.jpg|right]]
QuickDrive operations needs that two builtin rules are added to the session under surveyor.<br>
+
=== Opening Quickdrive===
These rules are :<br>
+
By default, the Quickdrive window is usually opened when you open a Driver session. However, it can be configured to not be initially visible, and it is not in every Session. If the Quickdrive window is not visible on entering a session, or if you've closed it and need to reopen it, you can open it from the main menu bar across the top of the screen.
- ConsistDataHandler rule<br>
+
- QuickDrive rule<br>
+
<br>
+
Both rules will be added by default on new maps and when a map is launch through quickdrive driver option.
+
<br><br>
+
[[Image:Help_QuickDrive_SurveyorSetup_Img1.jpg|frameless]]
+
<br><br>
+
ConsistDataHandler rule has no parameter and so needs no setup under surveyor.<br>
+
<br>
+
QuickDrive rule has two parameters. First one is a checkbox to tick if you want QuickDrive general user interface to be opened when the driver session is started. The second is the default consist list to use from the Global Consist Library for new consist placement. You can edit the rule under surveyor mode to look at the Global Consist Library lists available and select the default one to use. QuickDrive general user interface displayed in driver mode will offer either to use the default list or select a new one.<br>
+
<br>
+
[[Image:Help_QuickDrive_SurveyorSetup_Img2.jpg|frameless]]
+
<br><br>
+
<br><br>
+
  
==Opening the GUI==
+
It's possible to set the menu bar to auto-hide so first, ensure the menu bar is visible by moving the mouse to the top of the screen. Then, toward the far right of the menu bar you should see a series of round buttons. One of them will be the 'User Rules List', which displays the available user rules in the session. Locate the Quickdrive rule in the list and click it top open the main Quickdrive window. If it is not in the list then Quickdrive is not available in the current session.
When QuickDrive is loaded, there is a new system icon available in the system bar menu at the top of the screen.<br>
+
When you click on the icon, it displays the list of all available rules with driver mode general user interface ( QuickDrive and PortalManager  in the current example).
+
<br><br>
+
[[Image:Help_QuickDrive_OpeningTheGUI_Img1.jpg|frameless]]
+
<br><br>
+
Select QuickDrive in the list and the QuickDrive will be opened or reopened.
+
<br><br>
+
[[Image:Help_QuickDrive_OpeningTheGUI_Img2.jpg|frameless]]
+
<br><br>
+
Please refer to QuickDrive operations supported next section for the details about the QuickDrive GUI interface.
+
<br><br>
+
  
==QuickDrive operations supported==
+
[[Image:Help_QuickDrive_ControlType.jpg|right|200px]]
<br><br>
+
=== The Quickdrive Window ===
In current version v8 the GUI have 5 tabs :<br>
+
The Quickdrive window may seem overwhelming at first, but its operation is relatively simple. On the left side of the window is the list of available pages, click on any one of them to switch to that page and configure the various options. There may be up to 6 pages available, or there may be only one, depending on your version of Trainz and how the rule is configured. We will cover all of the possible pages below.
<br>
+
 
1 - session tab :<br>
+
==== Control Type ====
<br>
+
This page allows you to change the active control type for the current session. DCC mode is recommended for beginners and Cab mode allows a more realistic driving experience.
[[Image:Incubator_QuickDriveOper1.jpg|frameless]]
+
 
<br><br>
+
[[Image:Help_QuickDrive_Environment.jpg|right|200px]]
:This page display parameters options for current session setup.<br>
+
==== Environment ====
:You can setup :<br>
+
The environment page allows you to alter various environment variables for the current session. All changes take effect immediately.
:<br>
+
 
::DCC or CAB mode<br>
+
==== Consists ====
::weather conditions and dynamics<br>
+
This page lists all the trains currently in the world, if there are any. Clicking on any of the consist names will focus the camera on it. You can also clone or delete the train, or change the active driver.
::time and game rate selection<br>
+
 
::derailment level<br>
+
[[Image:Help_QuickDrive_NewTrain.jpg|right|200px]]
::metric or imperial mode<br>
+
==== New Train ====
:<br>
+
The new train page shows the currently active 'Consist List', and allows to to place new trains in the world.
:When selected, parameters change setup is immediate.<br>
+
 
<br>
+
To place a new train first select one and click on it in the list. Once you've clicked on the train the main Quickdrive window will disappear and be replaced by the placement helper window. Now, find a long and empty piece of track, and click on it in the 3D world (like you would in Surveyor when placing a train). If the train fits on the track it will be placed, and the placement helper will update to show several new options. If the placement failed the placement helper will show an error message, simply try again on a different piece of track or further down the line.
2 - consists tab :<br>
+
 
<br>
+
Once you've placed a train the placement helper will give you the option of placing the same train again, deleting the placed train, or reversing the placed trains direction. Simply click on any one these options to perform it. Once you're happy with your placed train(s) click on the 'X' button in the top right of the placement helper window to close it, and return to the main Quickdrive window.
[[Image:Incubator_QuickDriveOper2.jpg|frameless]]
+
 
<br><br>
+
==== Drivers ====
:display a list of all the consists allready available under the session.<br>
+
The drivers tab simply lists all of the installed drivers and allows you to add/remove them from the session. Simply click the checkbox beside a drivers name to add or remove them. Be aware that if you remove a driver who was controlling an AI train in the session, then that train will abort its current schedule and come to a halt.
:You can select any consist to move the camera to it.<br>
+
 
:You can delete with confirmation any selected consist.<br>
+
==== Commands ====
:You can clone any existing consist and place the new cloned consist on the route by clicking when asked on a track<br>
+
The commands tab lists all of the installed AI commands and allows you to add/remove them from the session. Simply click the checkbox beside a command to add or remove it.
<br>
+
3 - new consist tab :<br>
+
<br>
+
[[Image:Incubator_QuickDriveOper3.jpg|frameless]]
+
<br><br>
+
:Display a preset list of consist from the global consist library. <br>
+
:The global consist library offers consists lists management and a consist editor under the global settings window. It is available in either surveyor or driver mode or global mode. This editor can also be used under the future EE edition with no surveyor mode. Details are available at the [[Incubator/Global Consist Library]] page.
+
<br>
+
:You can select any of the consist and place the new consist on the route by clicking when asked on a track.<br>
+
<br>
+
4 - driver tab :<br>
+
<br>
+
[[Image:Incubator_QuickDriveOper4.jpg|frameless]]
+
<br><br>
+
:display a list of all the driver assets available in the world. Each driver has a checkbox to enable loading/unloading this driver in the current driver session.
+
:When a driver is selected, you have also a link to choose a locomotive vehicle in the available route consists to move the driver to.
+
:Remember that when you unselect a driver, he is removed from any train he was located and unloaded from the session. If he was driving a train driver commands schedule, the schedule and the the train will be stopped ...
+
<br>
+
5 - driver commands tab :<br>
+
<br>
+
[[Image:Incubator_QuickDriveOper5.jpg|frameless]]
+
<br><br>
+
:display a list of all the driver command assets available in the world. Each driver command has a checkbox to enable/disable the driver command in the current driver session.
+
<br>
+
  
<br><br>
 
  
 
[[Category:Help|Quickdrive]]
 
[[Category:Help|Quickdrive]]

Revision as of 22:50, 4 February 2013

Quickdrive is a rule which adds a graphical user interface (GUI) in Driver to allow real-time editing of several game environment variables, and allow the player to place/remove trains.

This page relates to the use of the Quickdrive rule in Driver. For details on how to configure the Quickdrive interface in Surveyor, see the QuickDrive Rule help page.

Help QuickDrive MenuBarIcon.jpg

Contents

Opening Quickdrive

By default, the Quickdrive window is usually opened when you open a Driver session. However, it can be configured to not be initially visible, and it is not in every Session. If the Quickdrive window is not visible on entering a session, or if you've closed it and need to reopen it, you can open it from the main menu bar across the top of the screen.

It's possible to set the menu bar to auto-hide so first, ensure the menu bar is visible by moving the mouse to the top of the screen. Then, toward the far right of the menu bar you should see a series of round buttons. One of them will be the 'User Rules List', which displays the available user rules in the session. Locate the Quickdrive rule in the list and click it top open the main Quickdrive window. If it is not in the list then Quickdrive is not available in the current session.

Help QuickDrive ControlType.jpg

The Quickdrive Window

The Quickdrive window may seem overwhelming at first, but its operation is relatively simple. On the left side of the window is the list of available pages, click on any one of them to switch to that page and configure the various options. There may be up to 6 pages available, or there may be only one, depending on your version of Trainz and how the rule is configured. We will cover all of the possible pages below.

Control Type

This page allows you to change the active control type for the current session. DCC mode is recommended for beginners and Cab mode allows a more realistic driving experience.

Help QuickDrive Environment.jpg

Environment

The environment page allows you to alter various environment variables for the current session. All changes take effect immediately.

Consists

This page lists all the trains currently in the world, if there are any. Clicking on any of the consist names will focus the camera on it. You can also clone or delete the train, or change the active driver.

Help QuickDrive NewTrain.jpg

New Train

The new train page shows the currently active 'Consist List', and allows to to place new trains in the world.

To place a new train first select one and click on it in the list. Once you've clicked on the train the main Quickdrive window will disappear and be replaced by the placement helper window. Now, find a long and empty piece of track, and click on it in the 3D world (like you would in Surveyor when placing a train). If the train fits on the track it will be placed, and the placement helper will update to show several new options. If the placement failed the placement helper will show an error message, simply try again on a different piece of track or further down the line.

Once you've placed a train the placement helper will give you the option of placing the same train again, deleting the placed train, or reversing the placed trains direction. Simply click on any one these options to perform it. Once you're happy with your placed train(s) click on the 'X' button in the top right of the placement helper window to close it, and return to the main Quickdrive window.

Drivers

The drivers tab simply lists all of the installed drivers and allows you to add/remove them from the session. Simply click the checkbox beside a drivers name to add or remove them. Be aware that if you remove a driver who was controlling an AI train in the session, then that train will abort its current schedule and come to a halt.

Commands

The commands tab lists all of the installed AI commands and allows you to add/remove them from the session. Simply click the checkbox beside a command to add or remove it.

Personal tools