User Tools

Site Tools


actioncond-en

Action Condition

Description

The conditions defined in this dialog apply to the action control of the action selected in the "Index" list.
An action control can have one or more optional conditions per action to dynamically decide if it is to be executed.

Setup


The list in the tab conditions shows the objects whose conditions defined in this dialog must be fulfilled before the action can be triggered

Must be true

In case the All conditions must be true is disabled this option will overrule it for this condition; This condition must be unconditionally true.

Type & ID

The Type can be selected from the drop-down list. (see the table below)
The ID of an existing object in the Type category can be selected from the dropdown list.
The selected object is added to the list with the Add button

Sub-ID

Only for use with Variables.

State

The state of the referenced object must match to this condition at the time the action should be triggered.
The following state values, depended of the object type, are available in the State drop-down combo-box:
The field can be edited with the Loco ID or other values if necessary.

Type Possible state values Remark
output on, off, active
switch straight, turnout, left, right
signal red, yellow, green, white Multiple values are allowed as comma separated list: "green,yellow".
sensor true, false, identifier² As second state value, separated with a comma, can the loco direction, "forwards" or "reverse".
loco¹ Loco ID must match.³
block, fiddleyard, stageblock, tunrntable free, !free or occupied, open, closed
system go, stop, init
route locked, unlocked, closed, open, = "=" can be used to compare the route ID with the locked route ID
train¹ Train ID must match of the loco. The related loco ID is used for evaluating state values.³
variable =number, >number, <number, !number, #text, ?text The value of the variable is compared with the state value.
text text The contents of the text object will be compared with the status field.
location free, !free

¹) This only works in auto mode and with objects that contain a loco ID. The loco ID specified in the action condition must match with the loco ID contained in the object with the action control that triggers the action. The condition is checked using the loco ID contained in the object calling the action, not by using the loco ID in the action control.
Objects containing a loco ID are routes, schedules, blocks, sensors linked to a block, switches and signals. With objects without a loco ID the action condition type loco will not work, also not when using a * for the loco ID in the action condition.
²) Read the ident event description for an explanation.
³) See below for all possible state descriptions.

Possible states for type loco

Loco direction

This condition can only be used with block sensors; Stand alone sensors will not have this information. (RailCom sensors are an exception on this rule.)
Possible loco direction values: forwards/reverse
The ID must be set to * if this condition should be for all locos.
The loco placing is also evaluated to determine the running direction.

Loco type

Possible state values are: diesel, steam or electric (case sensitive). The condition is fulfilled when the loco type matches the state. The ID must be set to * (using this condition for one particular loco does not make sense because the type is then already known). This also means that this condition can only be used with objects that can identify the loco (such as block sensors, blocks, routes).

Loco class

Format:
class:MyClass

Block enter side¹

The side on which the loc entered a block can be used as state, possible values are + and -. This only works with blocks.
The ID must be set to * if this condition should be for all locos.

Loco Speed¹

The speed of the loco must match with one of the preset values min, mid, cruise or max.

Note 1: Please note that when using block enter side or loco speed in combination with the action control block enter, the action(s) are evaluated before the block enter side and the loco speed are updated.

Loco address

If the state field starts with a '#' it will be interpreted as a loco address.
The Loco ID will not be evaluated in this case and can be set to *.
Format:

#addr[,#addr]...

The addr can also be defined as a range:

#addr-addr

Example:
Loco address range between 1 and 80, and address 4711; the action condition is true when the loco address is between 1 and 80 or equal to 4711:

#1-80,#4711

By using x in stead of # the action condition will be true when the loc address does not match with the listed addresses.
Example:

x1-80,x4711

When the loc address is not between 1 and 80 and not equal to 4711, the action condition is true.

Loco Function

The function number must be between 1 and 28, and works only with locoID "*".
Format:

fon,function-No.
foff,function-No.

To have the loc lights as condition function number 0 can be used.


Example:
Loco function 3 must be switched on:

fon,3

Loco Schedule

Format:

schedule:id[:index]

The index parameter is optional and represents the schedule destination index. (Zero based.)

Buttons

Add

The selected type and ID will be added to the list

Delete

The object selected in the list will be deleted

Modify

Changes to an object must be confirmed with this button.

actioncond-en.txt · Last modified: 2021/05/11 08:24 by rjversluis