Files
project-cybersyn/.vscode/factorio/runtime-api-LuaTrainStopControlBehavior.lua
Monica Moniot 30fe2946e6 updated api
2022-12-01 19:04:58 -05:00

77 lines
4.0 KiB
Lua

---@meta
---@diagnostic disable
--$Factorio 1.1.72
--$Overlay 5
--$Section LuaTrainStopControlBehavior
-- This file is automatically generated. Edits will be overwritten.
---Control behavior for train stops.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html)
---@class LuaTrainStopControlBehavior:LuaGenericOnOffControlBehavior
---[RW]
---`true` if the train stop is enabled/disabled through the circuit network.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.enable_disable)
---@field enable_disable boolean
---[R]
---The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.object_name)
---@field object_name string
---[RW]
---`true` if the train stop should send the train contents to the circuit network.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.read_from_train)
---@field read_from_train boolean
---[RW]
---`true` if the train stop should send the stopped train id to the circuit network.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.read_stopped_train)
---@field read_stopped_train boolean
---[RW]
---`true` if the train stop should send amount of incoming trains to the circuit network.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.read_trains_count)
---@field read_trains_count boolean
---[RW]
---`true` if the train stop should send the circuit network contents to the train to use.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.send_to_train)
---@field send_to_train boolean
---[RW]
---`true` if the trains_limit_signal is used to set a limit of trains incoming for train stop.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.set_trains_limit)
---@field set_trains_limit boolean
---[RW]
---The signal that will be sent when using the send-train-id option.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.stopped_train_signal)
---@field stopped_train_signal SignalID
---[RW]
---The signal that will be sent when using the read-trains-count option.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.trains_count_signal)
---@field trains_count_signal SignalID
---[RW]
---The signal to be used by set-trains-limit to limit amount of incoming trains
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.trains_limit_signal)
---@field trains_limit_signal SignalID
---[R]
---Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.valid)
---@field valid boolean
local LuaTrainStopControlBehavior={
---All methods and properties that this object supports.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaTrainStopControlBehavior.html#LuaTrainStopControlBehavior.help)
---@return string
help=function()end,
}