minetest.git - modified minetest for gpcfs purposes

diff options

Diffstat (limited to 'src/script/lua_api/l_mainmenu.cpp')

0 files changed, 0 insertions, 0 deletions

#### Advtrains - Lua Automation features This mod offers components that run LUA code and interface with each other through a global environment. It makes complex automated railway systems possible. ### atlatc The mod is sometimes abbreviated as 'atlatc'. This stands for AdvTrainsLuaATC. This short name has been chosen for user convenience, since the name of this mod ('advtrains_luaautomation') is very long. ### Privilege To perform any operations using this mod (except executing operation panels), players need the "atlatc" privilege. This privilege should never be granted to anyone except trusted administrators. Even though the LUA environment is sandboxed, it is still possible to DoS the server by coding infinite loops or requesting expotentially growing interrupts. ### Active and passive Active components are these who have LUA code running in them. They are triggered on specific events. Passive components are dumb, they only have a state and can be set to another state, they can't perform actions themselves. ### Environments Each active component is assigned to an environment. This is where all data are held. Components in different environments can't inferface with each other. This system allows multiple independent automation systems to run simultaneously without polluting each other's environment. /env_create <env_name> Create environment with the given name. To be able to do anything, you first need to create an environment. Choose the name wisely, you can't change it afterwards. /env_setup <env_name> Invoke the form to edit the environment's initialization code. For more information, see the section on active components. You can also delete an environment from here. ### Active components The code of every active component is run on specific events which are explained soon. When run, every variable written that is not local and is no function or userdata is saved over code re-runs and over server restarts. Additionally, the following global variables are defined: # event The variable 'event' contains a table with information on the current event. How this table can look is explained below. # S The variable 'S' contains a table which is shared between all components of the environment. Its contents are persistent over server restarts. May not contain functions, every other value is allowed. Example: Component 1: S.stuff="foo" Component 2: print(S.stuff) -> foo # F The variable 'F' also contains a table which is shared between all components of the environment. Its contents are discarded on server shutdown or when the init code gets re-run. Every data type is allowed, even functions. The purpose of this table is not to save data, but to provide static value and function definitions. The table should be populated by the init code. # Standard Lua functions The following standard Lua libraries are available: string, math, table, os The following standard Lua functions are available: assert, error, ipairs, pairs, next, select, tonumber, tostring, type, unpack Every attempt to overwrite any of the predefined values results in an error. # LuaAutomation-specific global functions POS(x,y,z) Shorthand function to create a position vector {x=?, y=?, z=?} with less characters In the following functions, all parameters named 'pos' designate a position. You can use either: - a default Minetest position vector (like {x=34, y=2, z=-18}) - the POS(34,2,-18) shorthand - A string, the passive component name. See 'passive component naming'. getstate(pos) Get the state of the passive component at position 'pos'. See section on passive components for more info. pos can be either a position vector (created by POS()) or a string, the name of this passive component. setstate(pos, newstate) Set the state of the passive component at position 'pos'. is_passive(pos) Checks whether there is a passive component at the position pos (and/or whether a passive component with this name exists) interrupt(time, message) Cause LuaAutomation to trigger an 'int' event on this component after the given time in seconds with the specified 'message' field. 'message' can be of any Lua data type. Not available in init code! interrupt_pos(pos, message) Immediately trigger an 'ext_int' event on the active component at position pos. 'message' is like in interrupt(). USE WITH CARE, or better don't use! Incorrect use can result in expotential growth of interrupts. digiline_send(channel, message) Make this active component send a digiline message on the specified channel. Not available in init code! -- The next 4 functions are available when advtrains_interlocking is enabled: -- can_set_route(pos, route_name) Returns whether it is possible to set the route designated by route_name from the signal at pos. set_route(pos, route_name) Requests the given route from the signal at pos. Has the same effect as clicking "Set Route" in the signalling dialog. cancel_route(pos) Cancels the route that is set from the signal at pos. Has the same effect as clicking "Cancel Route" in the signalling dialog. get_aspect(pos) Returns the signal aspect of the signal at pos. A signal aspect has the following format: asp = { main = <int speed>, -- Main signal aspect, tells state and permitted speed of next section -- 0 = section is blocked -- >0 = section is free, speed limit is this value -- -1 = section is free, maximum speed permitted -- false = Signal doesn't provide main signal information, retain current speed limit. shunt = <boolean>, -- Whether train may proceed as shunt move, on sight -- main aspect takes precedence over this -- When main==0, train switches to shunt move and is restricted to speed 8 proceed_as_main = <boolean>, -- If an approaching train is a shunt move and 'shunt' is false, -- the train may proceed as a train move under the "main" aspect -- if the main aspect permits it (i.e. main!=0) -- If this is not set, shunt moves are NOT allowed to switch to -- a train move, and must stop even if "main" would permit passing. -- This is intended to be used for "Halt for shunt moves" signs. dst = <int speed>, -- Distant signal aspect, tells state and permitted speed of the section after next section -- The character of these information is purely informational -- At this time, this field is not actively used -- 0 = section is blocked -- >0 = section is free, speed limit is this value -- -1 = section is free, maximum speed permitted -- false = Signal doesn't provide distant signal information. -- the character of call_on and dead_end is purely informative call_on = <boolean>, -- Call-on route, expect train in track ahead (not implemented yet)


context:
space:
mode: