factorio-types 0.0.37 → 0.0.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/global.d.ts CHANGED
@@ -2,23 +2,23 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 1.1.86
6
- // API version 3
5
+ // Factorio version 1.1.89
6
+ // API version 4
7
7
 
8
8
  /**
9
- * Allows registering custom commands for the in-game console accessible via the grave key.
9
+ * Allows registration of custom commands for the in-game console.
10
10
  */
11
11
  declare const commands: LuaCommandProcessor
12
12
  /**
13
- * This is the main object, through which most of the API is accessed. It is, however, not available inside handlers registered with {@link LuaBootstrap::on_load | LuaBootstrap::on_load}.
13
+ * The main scripting interface through which most of the API is accessed.
14
14
  */
15
15
  declare const game: LuaGameScript
16
16
  /**
17
- * Allows printing messages to the calling RCON instance if any.
17
+ * Allows printing messages to the calling RCON instance, if any.
18
18
  */
19
19
  declare const rcon: LuaRCON
20
20
  /**
21
- * Allows inter-mod communication by way of providing a repository of interfaces that is shared by all mods.
21
+ * Allows registration and use of functions to communicate between mods.
22
22
  */
23
23
  declare const remote: LuaRemote
24
24
  /**
@@ -26,21 +26,21 @@ declare const remote: LuaRemote
26
26
  */
27
27
  declare const rendering: LuaRendering
28
28
  /**
29
- * Provides an interface for registering event handlers.
29
+ * Provides an interface for registering game event handlers.
30
30
  */
31
31
  declare const script: LuaBootstrap
32
32
  /**
33
- * Allows reading the current mod settings.
33
+ * Provides access to the current mod settings.
34
34
  */
35
35
  declare const settings: LuaSettings
36
36
  /**
37
- * `localised_print()` allows printing {@link LocalisedString | LocalisedString} to stdout without polluting the Factorio {@link log file | https://wiki.factorio.com/Log_file}. This is primarily useful when communicating with external tools that launch Factorio as a child process.
37
+ * `localised_print()` allows printing {@link LocalisedString | runtime:LocalisedString} to stdout without polluting the Factorio {@link log file | https://wiki.factorio.com/Log_file}. This is primarily useful when communicating with external tools that launch Factorio as a child process.
38
38
  */
39
39
  declare function localised_print(this: void,
40
40
  string: LocalisedString): void
41
41
 
42
42
  /**
43
- * `log()` can print {@link LocalisedStrings | LocalisedString} to the Factorio {@link log file | https://wiki.factorio.com/Log_file}. This, in combination with the serpent library, makes debugging in the data stage easier because it allows the inspection of entire prototype tables. For example, printing all properties of the sulfur item prototype can be done like so: `log(serpent.block(data.raw["item"]["sulfur"]))`
43
+ * `log()` can print {@link LocalisedStrings | runtime:LocalisedString} to the Factorio {@link log file | https://wiki.factorio.com/Log_file}. This, in combination with the serpent library, makes debugging in the data stage easier because it allows the inspection of entire prototype tables. For example, printing all properties of the sulfur item prototype can be done like so: `log(serpent.block(data.raw["item"]["sulfur"]))`
44
44
  */
45
45
  declare function log(this: void,
46
46
  string: LocalisedString): void
@@ -58,7 +58,7 @@ declare function log(this: void,
58
58
  * end
59
59
  * ```
60
60
  *
61
- * Note that `table_size()` does not work correctly for {@link LuaCustomTable | LuaCustomTable}, their size has to be determined with {@link LuaCustomTable::length_operator | LuaCustomTable::length_operator} instead.
61
+ * Note that `table_size()` does not work correctly for {@link LuaCustomTable | runtime:LuaCustomTable}, their size has to be determined with {@link LuaCustomTable::length_operator | runtime:LuaCustomTable::length_operator} instead.
62
62
  */
63
63
  declare function table_size(this: void,
64
64
  table: Table): void
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "factorio-types",
3
- "version": "0.0.37",
3
+ "version": "0.0.39",
4
4
  "description": "Typescript declarations for the factorio mod API",
5
5
  "main": "index.d.ts",
6
6
  "repository": "https://github.com/sguest/factorio-types.git",