@@ -237,6 +237,15 @@ final location).
237237If both arrival and departure time are to be defined, these must be separated by
238238'-'.
239239
240+ A request stop is set in a timetable by placing a 'x' between hours and minutes, e.g. 13x21, or by just
241+ setting an 'x' in the station departure field.
242+ For a request stop to work properly, details for this stop must be specified using :ref: `the '$req' command <timetable-cmd-request-stop >`.
243+
244+ In a timetable, it is indicated that a :ref: `train is allowed to depart early <timetable-depart-early >` by placing a '*'' between hours and
245+ minutes, e.g. 17*23, or by setting just a '*' in the station departure field.
246+
247+ A :ref: `passing time <timetable-passing-time >` can be defined by placing a 'P' between hours and minutes, e.g. 14P53
248+
240249Additional :ref: `timing commands <timetable-timing >` can be included. Such
241250commands can also be set for locations where the train does not stop and
242251therefore has no timing details, but the train must pass through that location
@@ -1077,6 +1086,172 @@ junction somewhere beyond that station.
10771086 Will activate the train as indicated, either when the train starts, when the
10781087 train is at the indicated stop or when it is terminated.
10791088
1089+ .. _timetable-cmd-request-stop :
1090+
1091+ ``$req `` Request Stop
1092+
1093+ A request stop is set in a timetable by placing an 'x' between hours and minutes, e.g. 13x21, or by just
1094+ setting an 'x' in the station departure field.
1095+ For a request stop to work properly, details for this stop must be specified using the ``$req `` command.
1096+ This command can be set as command for the station, or as command for each individual train. If set
1097+ for both station and train, the setting for the train will overrule the setting for the station for that
1098+ particular train.
1099+ Also, a special signal is required to set further required details, and also to visualize the requirement
1100+ to stop to pick up passengers for the player train.
1101+
1102+ Definition for ``$req `` command : $req /pu=n /pd=n [/laststop | /approach] [/message | /sound]
1103+
1104+ Details :
1105+
1106+ ``/pu=n `` : probability that stop is required to pick up passengers, n is percentage, 0 <= n <= 99.
1107+
1108+ ``/pd=n `` : probability that stop is required to set down passengers, n is percentage, 0 <= n <= 99.
1109+
1110+ ``/laststop `` : message is displayed at last fixed stop, indicating if stop at request stop is required
1111+ to set down passengers. Note that message is always displayed, indicating that stop is required, or not.
1112+
1113+ ``/approach `` : message is displayed, or sound is played, at preset fixed distance from stop if
1114+ request stop is required to set down passengers. Note that no indication if given if stop is not required.
1115+
1116+ ``/message `` : message is displayed on approach if stop is required. Only valid if ``/approach `` is set.
1117+
1118+ ``/sound `` : sound is played on approach if stop is required. Only valid if ``/approach `` is set.
1119+
1120+
1121+ Definition for special signal
1122+
1123+ Signals must be placed next to the platform. This signal may be any type of signal except NORMAL.
1124+ At least one signal is required for each direction.
1125+ A special function must be used for this signal in the related script :
1126+
1127+
1128+ TRAIN_HAS_REQUEST_STOP()
1129+
1130+ This function will return 'true' if approaching train is to stop at the request stop in order to set down
1131+ passengers, otherwise it returns 'false'.
1132+ Using this function, the state of the signal can be set as required. The signal can be visualized as an
1133+ actual signal, but also, for instance, a passenger figure can be animated to be visual on the plaƞorm
1134+ if the train is to stop, and otherwise not be visual.
1135+
1136+ Apart from this function, the signal must set two variables :
1137+
1138+ ``ORTSReqStopVisDistance `` : distance from station at which AI train is assumed to be able to
1139+ 'see' if stop is required to pick up passengers.
1140+
1141+ ``ORTSReqStopAnnDistance `` : distance from station at which message is displayed or sound is
1142+ played if ``/approach `` is set in ``$req `` command.
1143+
1144+ Functionality
1145+
1146+ Based on the values of ``/pu `` and ``/pd ``, it is determined if a request stop is required, either to set down
1147+ or to pick up passengers.
1148+
1149+ If the train is stopped and a departure time is set, the train will depart at the defined departure time
1150+ or after the defined station dwell time has passed, whichever is the latest time.
1151+
1152+ If the train is stopped and no departure time is set, the train will depart after the station dwell time
1153+ has passed.
1154+
1155+ Note that if a stop is not required, the train may pass through the station without stopping even if it
1156+ passes before the defined departure time.
1157+
1158+ Player train
1159+
1160+ Set down.
1161+
1162+ If ``/laststop `` is set, a message is shown at the moment of departure from the last fixed stop before
1163+ one or more request stops, which indicate, per stop, if the stop is required to set down passengers.
1164+ Note that the message is always shown.
1165+
1166+ If ``/approach `` is set, a message is shown or a sound is played when the train has reached the distance
1167+ from the request stop as defined in the signal definition using the ``ORTSReqStopAnnDistance ``
1168+ variable. Note that in this situation, the message is displayed or the sound is played only if the
1169+ request stop is required.
1170+
1171+ Pick Up
1172+
1173+ If a stop is required to pick up, this is visualized by the state of the special signal. It is up to the player
1174+ to approach the station at such a speed that a proper stop can be made in time if required. There is
1175+ no other indication of the state of this signal than the visualization, the state is not shown if the Track
1176+ Monitor window or otherwise.
1177+
1178+ Display in Next Station Window
1179+
1180+ A request stop will be shown in the next station window with an 'x' displayed in the arrival and
1181+ departure times. When the stop was required, normal arrival and departure times are shown for
1182+ previous stop. If the stop was not required and the train passed through the station, then when the
1183+ train has indeed cleared the station, that station is shown as previous stop but no arrival time is
1184+ shown, and the departure time is set to 'skipped'.
1185+
1186+ Spoiler
1187+
1188+ A 'spoiler' indication which shows if the stop is required to set down or pick up, can be shown if the
1189+ Next Station Window is displayed (normally using key F10), by pressing keys ALT+F10.
1190+
1191+ When ALT+F10 is pressed, and the next station is a request stop, a line is displayed at the boƩom of
1192+ the window showing if stop is required or not.
1193+
1194+ NOTE : this spoiler function is not yet available and will be included later.
1195+
1196+ Sound
1197+
1198+ When a sound is to be played on approach, as defined in the ``$req `` command, the definition for this
1199+ sound must be included in the .sms sound file for the cab for the locomotive on the player train.
1200+
1201+ The trigger for this sound is trigger 270.
1202+
1203+ AI Train
1204+
1205+ An AI train will approach the station as any normal station. When the stop is required, the train will
1206+ stop as normal. When no stop is required at all, the train will cease to slow down for the approach
1207+ when it has reached the distance from the station as defined in the signal variable
1208+ ``ORTSReqStopVisDistance ``, and will then start to accelerate again to regain to normal speed.
1209+
1210+ .. _timetable-depart-early :
1211+
1212+ Allow Depart Early
1213+
1214+ In a timetable, it is indicated that a train is allowed to depart early by placing a '*' between hours and
1215+ minutes, e.g. 17*23, or by setting just a '*' in the station departure field.
1216+
1217+ Functionality
1218+
1219+ Player Train
1220+
1221+ When a player train is allowed to depart early, the normal departure indication is given as soon as
1222+ the train has been stopped at the station for the normal required stop time as set for that station,
1223+ and the route ahead is clear.
1224+
1225+ Display in Next Station Window.
1226+
1227+ When “allow depart early” has been set for a station, a '*' is shown in the departure time. When the
1228+ train has departed, the '*' is also shown in the departure time for previous station stop.
1229+
1230+ AI Train
1231+
1232+ When an AI train is allowed to depart early, the train will depart as soon as the train has been
1233+ stopped at the station for the normal required stop time as set for that station, and the route ahead
1234+ is clear.
1235+
1236+ .. _timetable-passing-time :
1237+
1238+ Passing Time
1239+
1240+ Passing time can be defined by placing a 'P' between hours and minutes, e.g. 14P53.
1241+
1242+ Functionality
1243+
1244+ Player Train
1245+
1246+ When a passing time is set, the station will be shown in the NextStationWindow as a normal stop,
1247+ but showing a departure time only. When the station is passed, the actual passing time is also shown
1248+ as normal, but also a departure time only.
1249+
1250+ AI Train
1251+
1252+ There is no processing of passing time for AI trains.
1253+
1254+
10801255.. _timetable-start :
10811256
10821257Start Commands
0 commit comments