Advanced Trains

User Tools

Site Tools

You are here: Advanced Trains » User Guide » Lua ATC » Events
usage:atlatc:events

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
usage:atlatc:events [2020-01-28 10:25]
orwell 		usage:atlatc:events [2021-04-28 14:28]
orwell approach callbacks nouw released
Line 33: Line 33:
  
 ===== Event Types ===== ===== Event Types =====
 +
 +==== init ====
 +The ''event'' table of the [[usage:atlatc:environment#Initialization Code]] is always ''{type="init", init=true}''.
  
 ==== int ==== ==== int ====
Line 108: Line 111:
     approach = true,     approach = true,
     id = <train_id>,     id = <train_id>,
 +    has_entered = <boolean>, (latest development version only)
 } }
 </code> </code>
Line 114: Line 118:
   * **This function is available only in the ''[[http://git.bananach.space/advtrains.git/tree/?h=luaatc-extensions|luaatc-extensions]]'' branch of Advtrains.**   * **This function is available only in the ''[[http://git.bananach.space/advtrains.git/tree/?h=luaatc-extensions|luaatc-extensions]]'' branch of Advtrains.**
   * **This function is available only when the [[#approach_callback_mechanism|approach callback mechanism]] is enabled.**   * **This function is available only when the [[#approach_callback_mechanism|approach callback mechanism]] is enabled.**
 +
 +`has_entered` is set to true when the tip of the train is already standing on the node, i.e. the "train" event has already fired.
  
 === Approach callback mechanism === === Approach callback mechanism ===
-The approach callback mechanism is a new feature that allows LuaAutomation ATC rails to hook into the approach callback system, which is used by the [[usage:nodes:npr|Point Speed Restriction Rails]] (from ''advtrains_interlocking'') or by [[usage:nodes:stoprail|Station/Stop Rails]] (by ''advtrains_line_automation''). Since it is relatively a recent feature, it needs to be explicitly enabled. 
  
-**At the time of writing (2019-12-18), this feature is available only in ''[[http://git.bananach.space/advtrains.git/tree/?h=luaatc-extensions|luaatc-extensions]]'' branch of Advtrains. To use this branch, clone the Git repo in the Minetest mods directory and then ''git checkout luaatc-extensions'' on the mod directory.**+//since version 2.3.0// 
 + 
 +The approach callback mechanism is a new feature that allows LuaAutomation ATC rails to hook into the approach callback system, which is used by the [[usage:nodes:npr|Point Speed Restriction Rails]] (from ''advtrains_interlocking'') or by [[usage:nodes:stoprail|Station/Stop Rails]] (by ''advtrains_line_automation''). Since it is relatively a recent feature, it needs to be explicitly enabled.
  
 To enable the feature, define the following global variable in the local environment of the ATC rail: To enable the feature, define the following global variable in the local environment of the ATC rail:
usage/atlatc/events.txt · Last modified: 2023-10-29 16:30 by orwell

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki