aboutsummaryrefslogtreecommitdiff
path: root/advtrains/models
ModeNameSize
-rw-r--r--advtrains_across.obj13338logplain
-rw-r--r--advtrains_dtrack_bumper_st.b3d32927logplain
-rw-r--r--advtrains_dtrack_bumper_st_30.b3d48546logplain
-rw-r--r--advtrains_dtrack_bumper_st_45.b3d32926logplain
-rw-r--r--advtrains_dtrack_bumper_st_60.b3d48546logplain
-rw-r--r--advtrains_dtrack_cr.b3d28040logplain
-rw-r--r--advtrains_dtrack_cr_30.b3d28043logplain
-rw-r--r--advtrains_dtrack_cr_45.b3d34483logplain
-rw-r--r--advtrains_dtrack_cr_60.b3d34483logplain
-rw-r--r--advtrains_dtrack_st.b3d10712logplain
-rw-r--r--advtrains_dtrack_st_30.b3d20043logplain
-rw-r--r--advtrains_dtrack_st_45.b3d12235logplain
-rw-r--r--advtrains_dtrack_st_60.b3d20043logplain
-rw-r--r--advtrains_dtrack_swlcr.b3d36203logplain
-rw-r--r--advtrains_dtrack_swlcr_30.b3d39958logplain
-rw-r--r--advtrains_dtrack_swlcr_45.b3d41302logplain
-rw-r--r--advtrains_dtrack_swlcr_60.b3d46270logplain
-rw-r--r--advtrains_dtrack_swlst.b3d36203logplain
-rw-r--r--advtrains_dtrack_swlst_30.b3d39958logplain
-rw-r--r--advtrains_dtrack_swlst_45.b3d41302logplain
-rw-r--r--advtrains_dtrack_swlst_60.b3d46270logplain
-rw-r--r--advtrains_dtrack_swrcr.b3d36203logplain
-rw-r--r--advtrains_dtrack_swrcr_30.b3d46270logplain
-rw-r--r--advtrains_dtrack_swrcr_45.b3d41302logplain
-rw-r--r--advtrains_dtrack_swrcr_60.b3d39958logplain
-rw-r--r--advtrains_dtrack_swrst.b3d36203logplain
-rw-r--r--advtrains_dtrack_swrst_30.b3d46270logplain
-rw-r--r--advtrains_dtrack_swrst_45.b3d41302logplain
-rw-r--r--advtrains_dtrack_swrst_60.b3d39958logplain
-rw-r--r--advtrains_dtrack_vst1.obj8757logplain
-rw-r--r--advtrains_dtrack_vst1_45.obj10989logplain
-rw-r--r--advtrains_dtrack_vst2.obj9247logplain
-rw-r--r--advtrains_dtrack_vst2_45.obj11669logplain
-rw-r--r--advtrains_dtrack_vst31.obj8782logplain
-rw-r--r--advtrains_dtrack_vst32.obj9294logplain
-rw-r--r--advtrains_dtrack_vst33.obj9684logplain
-rw-r--r--advtrains_modernwagon.b3d172028logplain
-rw-r--r--advtrains_retrosignal_off.b3d13093logplain
-rw-r--r--advtrains_retrosignal_off_30.b3d13093logplain
-rw-r--r--advtrains_retrosignal_off_45.b3d13093logplain
-rw-r--r--advtrains_retrosignal_off_60.b3d13093logplain
-rw-r--r--advtrains_retrosignal_on.b3d13093logplain
-rw-r--r--advtrains_retrosignal_on_30.b3d13093logplain
-rw-r--r--advtrains_retrosignal_on_45.b3d13093logplain
-rw-r--r--advtrains_retrosignal_on_60.b3d13093logplain
-rw-r--r--advtrains_signal.b3d61544logplain
-rw-r--r--advtrains_signal_30.b3d61544logplain
-rw-r--r--advtrains_signal_45.b3d61544logplain
-rw-r--r--advtrains_signal_60.b3d61544logplain
-rw-r--r--advtrains_signal_wall_l.b3d40514logplain
-rw-r--r--advtrains_signal_wall_r.b3d40514logplain
-rw-r--r--advtrains_signal_wall_t.b3d40514logplain
-rw-r--r--advtrains_track_cr.b3d8023logplain
-rw-r--r--advtrains_track_st.b3d15831logplain
-rw-r--r--advtrains_track_st_45.b3d8935logplain
-rw-r--r--trackplane.b3d262logplain
generated by cgit v1.2.3 (git 2.39.1) at 2025-06-22 11:30:24 +0000
pan> `{type="int", int=true, msg=<message>}` * Fired when an interrupt set by the `interrupt` function runs out. `<message>` is the message passed to the interrupt function. * For backwards compatiblity reasons, `<message>` is also contained in an `event.message` variable. - `{type="ext_int", ext_int=true, message=<message>}` * Fired when another node called `interrupt_pos` on this position. `message` is the message passed to the interrupt_pos function. - `{type="digiline", digiline=true, channel=<channel>, msg=<message>}` * Fired when the controller receives a digiline message. #### Basic Lua Rail Functions and Variables In addition to the above environment functions, the following functions are available to whilst the train is in contact with the LuaATC rail: - `atc_send(<atc_command>)` Sends the specified ATC command to the train (a string) and returns true. If there is no train, returns false and does nothing. See [atc_command.txt](../atc_command.txt) for the ATC command syntax. - `atc_reset()` Resets the train's current ATC command. If there is no train, returns false and does nothing. - `atc_arrow` Boolean, true when the train is driving in the direction of the arrows of the ATC rail. Nil if there is no train. - `atc_id` Train ID of the train currently passing the controller. Nil if there's no train. - `atc_speed` Speed of the train, or nil if there is no train. - `atc_set_text_outside(text)` Set text shown on the outside of the train. Pass nil to show no text. `text` must be a string. - `atc_set_text_inside(text)` Set text shown to train passengers. Pass nil to show no text. `text` must be a string. - `atc_set_text_inside(text) / atc_set_text_outside(text)` Getters for inside/outside text, return nil when no train is there. - `get_line()` Returns the "Line" property of the train (a string). This can be used to distinguish between trains of different lines and route them appropriately. The interlocking system also uses this property for Automatic Routesetting. - `set_line(line)` Sets the "Line" property of the train (a string). If the first digit of this string is a number (0-9), any subway wagons on the train (from advtrains_train_subway) will have this one displayed as line number (where "0" is actually shown as Line 10 on the train) - `get_rc()` Returns the "Routingcode" property of the train (a string). The interlocking system uses this property for Automatic Routesetting. - `set_rc(routingcode)` Sets the "Routingcode" property of the train (a string). The interlocking system uses this property for Automatic Routesetting. #### Shunting Functions and Variables There are several functions available especially for shunting operations. Some of these functions make use of Freight Codes (FC) set in the Wagon Properties of each wagon and/or locomotive. FCs are composed of codes separated by exclamation marks (`!`), for instance `"foo!bar!baz"`. Each wagon has a current FC, indicating its next destination. - `split_at_index(index, atc_command)` Splits the train at the specified index, into a train with index-1 wagons and a second train starting with the index-th wagon. The `atc_command` specified is sent to the second train after decoupling. `"S0"` or `"B0"` is common to ensure any locomotives in the remaining train don't continue to move. `index` must be more than 1 to avoid trying to decouple the very front of a train. Example: train has wagons `"foo","foo","foo","bar","bar","bar"` Command: `split_at_index(4,"S0")` Result: first train (continues at previous speed): `"foo","foo","foo"`, second train (slows at S0): `"bar","bar","bar"` - `get_fc()` Returns a table with the entire FC list for each wagon in the train. Command: `get_fc()` Result: `{"", "foo!bar", "testing", "fc_1!fc_2!fc_3!?", "hello_world"}` - `set_fc(fc_list)` Overwrites the FC list according to a table `fc_list`. A false or nil entry will leave the wagon unaffected, however all others will be overwritten. Useful for mass-programming freight trains that use FC-shunting instead of walking to each wagon individually. Example: train has FC lists: `"", "foo!bar", "testing", "fc_1!fc_2!fc_3!?", "hello_world"` Command: `set_fc({"", "foo!turtle", nil, "4tehlulz", false})` Result: `""` `"foo!turtle"` `"testing"` `"4tehlulz"` `"hello_world"` - `split_at_fc(atc_command, len)` Splits the train in such a way that all cars with non-empty current FC of the first part of the train have the same FC. The `atc_command` specified is sent to the rear part, as with split_at_index. It returns the fc of the cars of the first part. Example : Train has current FCs `"" "" "bar" "foo" "bar"` Command: `split_at_fc(<atc_command>)` Result: `train "" "" "bar"` and `train "foo" "bar"` The function returns `"bar"` in this case. The optional argument `len` specifies the maximum length for the first part of the train. Example: Train has current FCs `"foo" "foo" "foo" "foo" "bar" "bar"` Command: `split_at_fc(<atc_command>,3)` Result: `"foo" "foo" "foo"` and `"foo" "bar" "bar"` The function returns `"foo"` in this case. - `split_off_locomotive(command, len)` Splits off the locomotives at the front of the train, which are identified by an empty FC. `command` specifies the ATC command to be executed by the rear half of the train. The optional argument `len` specifies the maximum length for the first part of the train as above. - `step_fc()` Steps the FCs of all train cars forward, selecting the next code after the `!`. If the end of the string is reached, then the first code is selected, except if the string ends with a question mark (`?`), then the order is reversed. - `train_length()` returns the number of cars the train is composed of. - `set_autocouple()` Sets the train into autocouple mode. The train will couple to the next train it collides with. - `unset_autocouple()` Unsets autocouple mode Deprecated: - `set_shunt()`, `unset_shunt()` deprecated aliases for set_autocouple() and unset_autocouple(), will be removed from a later release. #### Interlocking These additional functions are available when advtrains_interlocking is enabled: - `atc_set_ars_disable(boolean)` Disables (true) or enables (false) the use of ARS for this train. The train will not trigger ARS (automatic route setting) on signals then. Note: If you want to disable ARS from an approach callback, the call to `atc_set_ars_disable(true)` *must* happen during the approach callback, and may not be deferred to an interrupt(). Else the train might trigger an ARS before the interrupt fires. - `section_occupancy(section_id)` Returns a table of train ids for the specified section, nil if no section id is provided, false if the section id is invalid, an empty table if the section id is valid but empty of trains. #### Approach callbacks The LuaATC interface provides a way to hook into the approach callback system, which is for example used in the TSR rails (provided by advtrains_interlocking) or the station tracks (provided by advtrains_lines). However, for compatibility reasons, this behavior needs to be explicitly enabled. Enabling the receiving of approach events works by setting a variable in the local environment of the ATC rail, by inserting the following code: ```lua __approach_callback_mode = 1 -- to receive approach callbacks only in arrow direction -- or alternatively __approach_callback_mode = 2 -- to receive approach callbacks in both directions ``` The following event will be emitted when a train approaches: ```lua {type="approach", approach=true, id="<train_id>"} ``` Please note these important considerations when using approach callbacks: - Approach events might be generated multiple times for the same approaching train. If you are using atc_set_lzb_tsr(), you need to call this function on every run of the approach callback, even if you issued it before for the same train. - A reference to the train is available while executing this event, so that functions such as atc_send() or atc_set_text_outside() can be called. On any consecutive interrupts, that reference will no longer be available until the train enters the track ("train" event) - Unlike all other callbacks, approach callbacks are executed synchronous during the train step. This may cause unexpected side effects when performing certain actions (such as switching turnouts, setting signals/routes) from inside such a callback. I strongly encourage you to only run things that are absolutely necessary at this point in time, and defer anything else to an interrupt(). Be aware that certain things might trigger unexpected behavior. Operations that are safe to execute in approach callbacks: - anything related only to the global environment (setting things in S) - digiline_send() - atc_set_text_*() - atc_set_lzb_tsr() (see below) In the context of approach callbacks, one more function is available: - `atc_set_lzb_tsr(speed)` Impose a Temporary Speed Restriction at the location of this rail, making the train pass this rail at the specified speed. (Causes the same behavior as the TSR rail) #### Timetable Automation The advtrains_line_automation component adds a few contraptions that should make creating timeable systems easier. Part of its functionality is also available in LuaATC: - `rwt.*` All Railway Time functions are included as documented in https://advtrains.de/wiki/doku.php?id=dev:lines:rwt - `schedule(rw_time, msg)` - `schedule_in(rw_dtime, msg)` Schedules the following event `{type="schedule", schedule=true, msg=msg}` at (resp. after) the specified railway time (which can be in any format). You can only schedule one event this way. Uses the new lines-internal scheduler. ### Operator panel This simple node executes its actions when punched. It can be used to change a switch and update the corresponding signals or similar applications. It can also be connected to by the`digilines` mod. The event fired is `{type="punch", punch=true}` by default. In case of an interrupt or a digiline message, the events are similar to the ones of the ATC rail. ### Init code The initialization code is not a component as such, but rather a part of the whole environment. It can (and should) be used to make definitions that other components can refer to. A basic example function to define behavior for trains in stations: ```lua function F.station(station_name) if event.train then atc_send("B0WOL") atc_set_text_inside(station_name) interrupt(10,"depart") end if event.int and event.message="depart" then atc_set_text_inside("") --an empty string clears the displayed text atc_send("OCD1SM") end end ``` The corresponding Lua ATC Rail(s) would then contain the following or similar: ```lua F.station("Main Station") ``` The init code is run whenever the F table needs to be refilled with data. This is the case on server startup and whenever the init code is changed and you choose to run it. The event table of the init code is always `{type="init", init=true}` and can not be anything else. Functions are run in the environment of the currently active node, regardless of where they were defined. ### Passive components All passive components can be interfaced with the `setstate()` and `getstate()` functions (see above). Each node below has been mapped to specific "states": #### Signals The red/green light signals `advtrains:signal_on/off` are interfaceable. Others such as `advtrains:retrosignal_on/off` are not. If advtrains_interlocking is enabled, trains will obey the signal if the influence point is set. - "green" - Signal shows green light - "red" - Signal shows red light #### Switches/Turnouts All default rail switches are interfaceable, independent of orientation. - "cr" The switch is set in the direction that is not straight. - "st" The switch is set in the direction that is straight. The "Y" and "3-Way" switches have custom states. Looking from the convergence point: - "l" The switch is set towards the left. - "c" The switch is set towards the center (3-way only). - "r" The switch is set towards the right. #### Mesecon Switch The Mesecon switch can be switched using LuaAutomation. Note that this is not possible on levers or protected mesecon switches, only the unprotected full-node 'Switch' block `mesecons_switch:mesecon_switch_on/off`. - "on" - the switch is switched on. - "off" - the switch is switched off. #### Andrew's Cross - "on" - it blinks. - "off" - it does not blink. #### Passive Component Naming You can assign names to passive components using the Passive Component Naming tool. Once you set a name for any component, you can reference it by that name in the `getstate()` and `setstate()` functions. This way, you don't need to memorize positions. Example: signal named `"Stn_P1_out"` at `(1,2,3)` Use `setstate("Stn_P1_out", "green")` instead of `setstate(POS(1,2,3), "green")` If `advtrains_interlocking` is enabled, PC-Naming can also be used to name interlocking signals for route setting via the `set_route()` functions. **Important**: The "Signal Name" field in the signalling formspec is completely independent from PC-Naming and can't be used to look up the position. You need to explicitly use the PC-Naming tool.