Actions

What are Actions?

Actions are tasks that can be initiated automatically as a train, running in automatic mode, traverses the layout following a Transit. One or more Actions may be requested for each Section in a Transit. If a Section is in a Transit multiple times, different Actions may be specified for each occurrence of the Section. Actions only apply to trains run automatically under Dispatcher by a virtual engineer. If running trains in automatic mode is of interest read on. If your trains will only be run manually with a human engineer, Actions aren't used.

Actions are in addition to the standard actions that happen automatically when a train runs in automatic mode. Standard actions are things like following signals and using stop sensors, that are specified with each Section. Standard actions occur automatically whenever a Section is traversed in automatic mode. Other standard actions include automatically requesting allocation of Sections, and automatically changing locomotive speed according to signal restrictions.

Actions are tied to Sections, but are specified at the Transit level to provide maximum user flexibility. A Section is a piece of physical track, that may, for example, be used by passenger trains, through freight trains, or locals. Each of these uses may need different Actions in a specific Section. For example, a passenger train may make a station stop in a particular Section, whereas a through freight train may go straight through. Placing Actions in Transits allows Active Trains traveling the same path through the layout to have different Actions.

Requesting an Action

An Action is requested by specifying what action to be performed and when that action is to be performed. Any when event may be combined with any what action, providing a wide variety of Special Actions. An Action is initiated when the train enters the Section with the Action request. To decide when to perform the Action after the Section is entered, the program looks at the when event.
Currently available when events are:

An optional delay, specified in milliseconds, is available for each when event. No delay is the default. If an optional delay time is not entered (or a delay time of zero is entered), the action will be performed immediately after the when event occurs. If a delay time is specified, the program will wait for the specified time after the when event occurs before performing the action.

Currently available what actions are:

The View Actions Window

The View Actions window displays Actions that are currently set, and provides for adding, editing, or deleting Actions. The View Actions window (example below) is displayed for a specific Section in a Transit by pressing the View/Add/Edit Actions button on that Section's row in the Add/Edit Transit window.

For all Actions that have been created, the when event and the what action are described in the When and Action Requested columns. To add a new Action, click Add New Action to bring up the Add/Edit Action window. To edit an existing Action, click the Edit button in its row. To delete an existing Action, click the Delete button in its row. The order of the Actions is not important.

When the Actions are completely defined, click the Done button.