diff options
Diffstat (limited to 'assets/manual/man/man3advtrains')
6 files changed, 0 insertions, 152 deletions
diff --git a/assets/manual/man/man3advtrains/rwt_add.3advtrains.md b/assets/manual/man/man3advtrains/rwt_add.3advtrains.md deleted file mode 100644 index 5243b3e..0000000 --- a/assets/manual/man/man3advtrains/rwt_add.3advtrains.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -titles: -- rwt_add -- rwt_diff -- rwt_sub -section: 3advtrains -manual: 'Advtrains Developer''s Manual' -shortdesc: add or subtract railway time objects ---- - -# Synopsis - -* `add(t1, t2)` -* `diff(t1, t2)` -* `sub(t1, t2)` - -# Description - -* `add()` returns the result of adding `t1` and `t2`. -* `diff()` returns the result of subtracting `t1` from `t2`. -* `sub()` returns the result of subtracting `t2` from `t1`. - -# Return Value - -`add()` and `sub()` return their results as tables. `diff()` returns its result as a number. diff --git a/assets/manual/man/man3advtrains/rwt_copy.3advtrains.md b/assets/manual/man/man3advtrains/rwt_copy.3advtrains.md deleted file mode 100644 index 5a49048..0000000 --- a/assets/manual/man/man3advtrains/rwt_copy.3advtrains.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -titles: -- rwt_copy -- rwt_new -- rwt_to_table -- rwt_to_secs -- rwt_to_string -section: 3advtrains -manual: 'Advtrains Developer''s Manual' -shortdesc: create and copy railway time objects ---- - -# Synopsis - -* `copy(obj)` -* `new(cycles, minutes, seconds)` -* `to_table(obj)` -* `to_secs(obj [, cycles])` -* `to_string(obj [, no_cycles])` - -# Description - -* `copy()` returns a copy of `obj`. -* `new()` creates a new railway time object with the given number of cycles, minutes, and seconds. -* `to_table()`, `to_secs()`, and `to_string()` convert `obj` to a table, number, or string, respectively. If `cycles` is passed to `to_secs()`, that value is used as the number of cycles. If `no_cycles` is passed to `to_string()`, the number of cycles is set to zero. - -# Return Value - -* `copy()` returns the copy that is created. If `obj` is a table, the returned value is not identical to `obj`. -* `new()` returns the newly created object as a table. -* `to_table()`, `to_secs()`, `to_string()` returns the conveerted object. - -# Notes - -`to_table()` returns `obj` if it is a table. diff --git a/assets/manual/man/man3advtrains/rwt_last_rpt.3advtrains.md b/assets/manual/man/man3advtrains/rwt_last_rpt.3advtrains.md deleted file mode 100644 index b5149e7..0000000 --- a/assets/manual/man/man3advtrains/rwt_last_rpt.3advtrains.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -titles: -- rwt_last_rpt -- rwt_next_rpt -- rwt_time_from_last_rpt -- rwt_time_to_next_rpt -section: 3advtrains -manual: 'Advtrains Developer''s Manual' -shortdesc: calculate time for repeating events ---- - -# Synopsis - -* `last_rpt(time, interval, offset)` -* `next_rpt(time, interval, offset)` -* `time_from_last_rpt(interval, offset)` -* `time_to_next_rpt(interval, offset)` - -# Description -The functions described in this page calculates the time or time difference related to events scheduled to repeat with the given interval and at the given offset, in relation to the given time. Whether and when the event actually takes place is not relevant to the API. - -* `last_rpt()` returns the time at which the event was expected to occur the last time -* `next_rpt()` returns the time at which the event is expected to occur the next time -* `time_from_last_rpt()` returns the time since the event was expected to occur the last time -* `time_to_next_rpt()` return the time until the event is expected to occur the next time diff --git a/assets/manual/man/man3advtrains/rwt_now.3advtrains.md b/assets/manual/man/man3advtrains/rwt_now.3advtrains.md deleted file mode 100644 index 7eb3650..0000000 --- a/assets/manual/man/man3advtrains/rwt_now.3advtrains.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -titles: -- rwt_now -section: 3advtrains -manual: 'Advtrains Developer''s Manual' -shortdesc: get the current railway time ---- - -# Description -`now()` returns the current railway time as a table. diff --git a/assets/manual/man/man3advtrains/speed_lessp.3advtrains.md b/assets/manual/man/man3advtrains/speed_lessp.3advtrains.md deleted file mode 100644 index 61c37b2..0000000 --- a/assets/manual/man/man3advtrains/speed_lessp.3advtrains.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -titles: -- speed_lessp -- speed_greaterp -- speed_equalp -- speed_not_lessp -- speed_not_greaterp -- speed_not_equalp -- speed_min -- speed_max -section: 3advtrains -manual: 'Advtrains Developer''s Manual' -shortdesc: compare speed limits ---- - -# Synopsis - -* `lessp(a, b)` -* `greaterp(a, b)` -* `equalp(a, b)` -* `not_lessp(a, b)` -* `not_greaterp(a, b)` -* `min(a, b)` -* `max(a, b)` - -# Description -`lessp()`, `greaterp()`, `equalp()`, `not_lessp()`, `not_greaterp()`, and `not_equalp()` are predicate functions that returns, respectively, - -* Whether `a` is more strict than `b` -* Whether `a` is less strict than `b` -* Whether `a` and `b` indicate the same speed limit -* Whether `a` is not more strict than `b` -* Whether `a` is nor less strict than `b` -* Whether `a` and `b` do not indicate the same speed limit - -`min()` returns the speed limit that is more strict. `max()` returns the speed limit that is less strict. diff --git a/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md b/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md deleted file mode 100644 index 619cf3f..0000000 --- a/assets/manual/man/man3advtrains/speed_set_restriction.3advtrains.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -titles: -- speed_set_restriction -- speed_merge_aspect -section: 3advtrains -manual: 'Advtrains Developer''s Manual' -shortdesc: apply speed limits to trains ---- - -# Synopsis - -* `set_restriction(train, type, val)` -* `merge_aspect(train, asp)` - -# Description -`set_restriction()` sets the speed restriction of the given type of the given train to `val` and updates train object correspondingly. - -`merge_aspect()` sets the speed restriction of the given train based on the value of the signal aspect. - -# Return Value -`set_restriction()` and `merge_aspect()` do not return any value. |