updated api

This commit is contained in:
Monica Moniot
2022-12-01 19:04:58 -05:00
parent 21abe6fb56
commit 30fe2946e6
104 changed files with 232 additions and 123 deletions
+11 -11
View File
@@ -1,7 +1,7 @@
---@meta
---@diagnostic disable
--$Factorio 1.1.70
--$Factorio 1.1.72
--$Overlay 5
--$Section LuaBootstrap
-- This file is automatically generated. Edits will be overwritten.
@@ -70,8 +70,8 @@ get_event_order=function()end,
---**Note:** For more context, refer to the page.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_configuration_changed)
---@param f fun(param1:ConfigurationChangedData)|nil@The handler for this event. Passing `nil` will unregister it.
on_configuration_changed=function(f)end,
---@param handler fun(param1:ConfigurationChangedData)|nil@The handler for this event. Passing `nil` will unregister it.
on_configuration_changed=function(handler)end,
---Register a handler to run on the specified event(s). Each mod can only register once for every event, as any additional registration will overwrite the previous one. This holds true even if different filters are used for subsequent registrations.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_event)
@@ -91,9 +91,9 @@ on_configuration_changed=function(f)end,
---{{filter = "name", name = "fast-inserter"}})
---```
---@param event defines.events|defines.events[]|string@The event(s) or custom-input to invoke the handler on.
---@param f fun(param1:EventData)|nil@The handler for this event. Passing `nil` will unregister it.
---@param handler fun(param1:EventData)|nil@The handler for this event. Passing `nil` will unregister it.
---@param filters EventFilter?@The filters for this event. Can only be used when registering for individual events.
on_event=function(event,f,filters)end,
on_event=function(event,handler,filters)end,
---Register a function to be run on mod initialization. This is only called when a new save game is created or when a save file is loaded that previously didn't contain the mod. During it, the mod gets the chance to set up initial values that it will use for its lifetime. It has full access to [LuaGameScript](https://lua-api.factorio.com/latest/LuaGameScript.html) and the table and can change anything about them that it deems appropriate. No other events will be raised for the mod until it has finished this step.
---
---**Note:** For more context, refer to the page.
@@ -107,8 +107,8 @@ on_event=function(event,f,filters)end,
--- global.players = {}
---end)
---```
---@param f fun()|nil@The handler for this event. Passing `nil` will unregister it.
on_init=function(f)end,
---@param handler fun()|nil@The handler for this event. Passing `nil` will unregister it.
on_init=function(handler)end,
---Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session. It gives the mod the opportunity to do some very specific actions, should it need to. Doing anything other than these three will lead to desyncs, which breaks multiplayer and replay functionality. Access to [LuaGameScript](https://lua-api.factorio.com/latest/LuaGameScript.html) is not available. The table can be accessed and is safe to read from, but not write to, as doing so will lead to an error.
---
---The only legitimate uses of this event are the following:
@@ -121,14 +121,14 @@ on_init=function(f)end,
---**Note:** For more context, refer to the page.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_load)
---@param f fun()|nil@The handler for this event. Passing `nil` will unregister it.
on_load=function(f)end,
---@param handler fun()|nil@The handler for this event. Passing `nil` will unregister it.
on_load=function(handler)end,
---Register a handler to run every nth-tick(s). When the game is on tick 0 it will trigger all registered handlers.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_nth_tick)
---@param tick uint|uint[]|nil@The nth-tick(s) to invoke the handler on. Passing `nil` as the only parameter will unregister all nth-tick handlers.
---@param f fun(param1:NthTickEventData)|nil@The handler to run. Passing `nil` will unregister it for the provided nth-tick(s).
on_nth_tick=function(tick,f)end,
---@param handler fun(param1:NthTickEventData)|nil@The handler to run. Passing `nil` will unregister it for the provided nth-tick(s).
on_nth_tick=function(tick,handler)end,
---[View documentation](https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_biter_base_built)
---@class LuaBootstrap.raise_biter_base_built_param
---The entity that was built.