1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
|
-- Signal API implementation
--[[
Signal aspect table:
asp = {
main = {
free = <boolean>,
speed = <int km/h>,
},
shunt = {
free = <boolean>,
-- Whether train may proceed as shunt move, on sight
-- main aspect takes precedence over this
proceed_as_main = <boolean>,
-- If an approaching train is a shunt move and "main.free" is set,
-- the train may proceed as a train move under the "main" aspect
-- If this is not set, shunt moves are NOT allowed to switch to
-- a train move, and must stop even if "main.free" is set.
-- This is intended to be used for "Halt for shunt moves" signs.
}
dst = {
free = <boolean>,
speed = <int km/h>,
}
info = {
call_on = <boolean>, -- Call-on route, expect train in track ahead (not implemented yet)
dead_end = <boolean>, -- Route ends on a dead end (e.g. bumper) (not implemented yet)
w_speed = <integer>,
-- "Warning speed restriction". Supposed for short-term speed
-- restrictions which always override any other restrictions
-- imposed by "speed" fields, until lifted by a value of -1
-- (Example: german Langsamfahrstellen-Signale)
}
}
-- For "speed" and "w_speed" fields, a value of -1 means that the
-- restriction is lifted. If they are omitted, the value imposed at
-- the last aspect received remains valid.
-- The "dst" subtable can be completely omitted when no explicit dst
-- aspect should be signalled to the train. In this case, the last
-- signalled dst aspect remains valid.
== How signals actually work in here ==
Each signal (in the advtrains universe) is some node that has at least the
following things:
- An "influence point" that is set somewhere on a rail
- An aspect which trains that pass the "influence point" have to obey
There can be static and dynamic signals. Static signals are, roughly
spoken, signs, while dynamic signals are "real" signals which can display
different things.
The node definition of a signal node should contain those fields:
groups = {
advtrains_signal = 2,
save_in_at_nodedb = 1,
}
advtrains = {
set_aspect = function(pos, node, asp)
-- This function gets called whenever the signal should display
-- a new or changed signal aspect. It is not required that
-- the signal actually displays the exact same aspect, since
-- some signals can not do this by design.
-- Example: pure shunt signals can not display a "main" aspect
-- and have no effect on train moves, so they will only ever
-- honor the shunt.free field for their aspect.
-- In turn, it is not guaranteed that the aspect will fulfill the
-- criteria put down in supported_aspects.
-- If set_aspect is present, supported_aspects should also be declared.
-- The aspect passed in here can always be queried using the
-- advtrains.interlocking.signal_get_supposed_aspect(pos) function.
-- It is always DANGER when the signal is not used as route signal.
-- For static signals, this function should be completely omitted
-- If this function is omitted, it won't be possible to use
-- route setting on this signal.
end,
supported_aspects = {
-- A table which tells which different types of aspects this signal
-- is able to display. It is used to construct the "aspect editing"
-- formspec for route programming (and others) It should always be
-- present alongside with set_aspect. If this is not specified but
-- set_aspect is, the user will be allowed to select any aspect.
-- Any of the fields marked with <boolean/nil> support 3 types of values:
nil: if this signal can switch between free/blocked
false: always shows "blocked", unchangable
true: always shows "free", unchangable
-- Any of the "speed" fields should contain a list of possible values
-- to be set as restriction. If omitted, this signal should never
-- set the corresponding "speed" field in the aspect, which means
-- that the previous speed limit stays valid
-- If your signal can only display a single speed (may it be -1),
-- always enclose that single value into a list. (such as {-1})
main = {
free = <boolean/nil>,
speed = {<speed1>, ..., <speedn>} or nil,
},
dst = {
free = <boolean/nil>,
speed = {<speed1>, ..., <speedn>} or nil,
},
shunt = {
free = <boolean/nil>,
},
info = {
call_on = <boolean/nil>,
dead_end = <boolean/nil>,
w_speed = {<speed1>, ..., <speedn>} or nil,
}
},
get_aspect = function(pos, node)
-- This function gets called by the train safety system. It
should return the aspect that this signal actually displays,
not preferably the input of set_aspect.
-- For regular, full-featured light signals, they will probably
honor all entries in the original aspect, however, e.g.
simple shunt signals always return main.free=true regardless of
the set_aspect input because they can not signal "Halt" to
train moves.
-- advtrains.interlocking.DANGER contains a default "all-danger" aspect.
-- If your signal does not cover certain sub-tables of the aspect,
the following reasonable defaults are automatically assumed:
main = {
free = true,
}
dst = {
free = true,
}
shunt = {
free = false,
proceed_as_main = false,
}
end,
}
on_rightclick = advtrains.interlocking.signal_rc_handler
can_dig = advtrains.interlocking.signal_can_dig
after_dig_node = advtrains.interlocking.signal_after_dig
(If you need to specify custom can_dig or after_dig_node callbacks,
please call those functions anyway!)
Important note: If your signal should support external ways to set its
aspect (e.g. via mesecons), there are some things that need to be considered:
- advtrains.interlocking.signal_get_supposed_aspect(pos) won't respect this
- Whenever you change the signal aspect, and that aspect change
did not happen through a call to
advtrains.interlocking.signal_set_aspect(pos, asp), you are
*required* to call this function:
advtrains.interlocking.signal_on_aspect_changed(pos)
in order to notify trains about the aspect change.
This function will query get_aspect to retrieve the new aspect.
]]--
local DANGER = {
main = {
free = false,
speed = 0,
},
shunt = {
free = false,
},
dst = {
free = false,
speed = 0,
},
info = {}
}
advtrains.interlocking.DANGER = DANGER
local function fillout_aspect(asp)
if not asp.main then
asp.main = {
free = true,
}
end
if not asp.dst then
asp.dst = {
free = true,
}
end
if not asp.shunt then
asp.shunt = {
free = false,
proceed_as_main = false,
}
end
if not asp.info then
asp.info = {}
end
end
function advtrains.interlocking.update_signal_aspect(tcbs)
if tcbs.signal then
local asp = tcbs.aspect or DANGER
advtrains.interlocking.signal_set_aspect(tcbs.signal, asp)
end
end
function advtrains.interlocking.signal_can_dig(pos)
return not advtrains.interlocking.db.get_sigd_for_signal(pos)
end
function advtrains.interlocking.signal_after_dig(pos)
-- clear influence point
advtrains.interlocking.db.clear_ip_by_signalpos(pos)
end
function advtrains.interlocking.signal_set_aspect(pos, asp)
fillout_aspect(asp)
local node=advtrains.ndb.get_node(pos)
local ndef=minetest.registered_nodes[node.name]
if ndef and ndef.advtrains and ndef.advtrains.set_aspect then
ndef.advtrains.set_aspect(pos, node, asp)
advtrains.interlocking.signal_on_aspect_changed(pos)
end
end
-- should be called when aspect has changed on this signal.
function advtrains.interlocking.signal_on_aspect_changed(pos)
local ipts, iconn = advtrains.interlocking.db.get_ip_by_signalpos(pos)
if not ipts then return end
local ipos = minetest.string_to_pos(ipts)
local tns = advtrains.occ.get_trains_over(ipos)
for id, sidx in pairs(tns) do
-- local train = advtrains.trains[id]
--if train.index <= sidx then
minetest.after(0, advtrains.invalidate_path, id)
--end
end
|
