Skip to content

Commit 1b56aa6

Browse files
committed
Updated manual
1 parent 6f6ad69 commit 1b56aa6

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

Source/Documentation/Manual/cabs.rst

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,24 @@ The following controls are available for the cabview:
7979
- ``ORTS_BATTERY_SWITCH_COMMAND_BUTTON_CLOSE`` and ``ORTS_BATTERY_SWITCH_COMMAND_BUTTON_OPEN`` can be used if the switch is controlled with two pushbuttons (one to close the switch and the other to open it)
8080
- ``ORTS_BATTERY_SWITCH_ON`` can be used to control a light on the cab showing the state of the battery switch
8181

82-
Other controls can be hidden if the low voltage power supply is not available using the following parameter::
82+
Other controls can be disabled if the low voltage power supply is not available using the following parameter::
8383

8484
TwoState (
85-
Type ( ORTS_CIRCUIT_BREAKER_CLOSED TWO_STATE)
85+
Type ( ORTS_CIRCUIT_BREAKER_CLOSED TWO_STATE )
8686
...
8787
DisabledIfLowVoltagePowerSupplyOff ( 1 )
8888
)
8989

90+
By default, the cabview control will be completely hidden. You can also set a specific value for the control when it is disabled::
91+
92+
TwoState (
93+
Type ( SPEEDOMETER DIAL )
94+
...
95+
DisabledIfLowVoltagePowerSupplyOff ( 1 )
96+
HideIfDisabled ( 0 )
97+
ValueIfDisabled ( 0 )
98+
)
99+
90100
.. _cabs-master-key:
91101

92102
Master key
@@ -105,12 +115,22 @@ The following controls are available for the cabview:
105115
- ``ORTS_CURRENT_CAB_IN_USE`` can be used to indicate that the current cab is active
106116
- ``ORTS_OTHER_CAB_IN_USE`` can be used to indicate that another cab of the train is active
107117

108-
Other controls can be hidden if the cab power supply is not available using the following parameter::
118+
Other controls can be disabled if the cab power supply is not available using the following parameter::
119+
120+
TwoState (
121+
Type ( ORTS_CIRCUIT_BREAKER_CLOSED TWO_STATE )
122+
...
123+
DisabledIfCabPowerSupplyOff ( 1 )
124+
)
125+
126+
By default, the cabview control will be completely hidden. You can also set a specific value for the control when it is disabled::
109127

110128
TwoState (
111-
Type ( ORTS_CIRCUIT_BREAKER_CLOSED TWO_STATE)
129+
Type ( SPEEDOMETER DIAL )
112130
...
113131
DisabledIfCabPowerSupplyOff ( 1 )
132+
HideIfDisabled ( 0 )
133+
ValueIfDisabled ( 0 )
114134
)
115135

116136
.. _cabs-service-retention:

0 commit comments

Comments
 (0)