factorio-types 1.2.38 → 1.2.39

package/dist/classes.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.54
+// Factorio version 2.0.55
 // API version 6
 
 declare namespace runtime {
@@ -11707,19 +11707,30 @@ interface LuaHeatEnergySourcePrototype {
     readonly valid: boolean;
 }
 /**
- * Provides various helper and utility functions. It is accessible through the global object named `helpers`.
+ * Provides various helper and utility functions. It is accessible through the global object named `helpers` in all stages (settings, prototype and runtime).
  */
 interface LuaHelpers {
     /**
      * Goes over all items, entities, tiles, recipes, technologies among other things and logs if the locale is incorrect.
      *
      * Also prints true/false if called from the console.
+     *
+     * Not available in settings and prototype stages.
      */
     check_prototype_translations(this: void): void;
+    /**
+     * Compares 2 version strings.
+     * @param first First version string to compare.
+     * @param second Second version string to compare.
+     * @returns -1 if first is smaller than second, 0 if first equal second, 1 if first is greater than second.
+     */
+    compare_versions(this: void, first: string, second: string): int;
     /**
      * Creates a {@link LuaProfiler | runtime:LuaProfiler}, which is used for measuring script performance.
      *
      * LuaProfiler cannot be serialized.
+     *
+     * Not available in settings and prototype stages.
      * @param stopped Create the timer stopped
      */
     create_profiler(this: void, stopped?: boolean): LuaProfiler;
@@ -11752,11 +11763,15 @@ interface LuaHelpers {
     evaluate_expression(this: void, expression: MathExpression, variables?: Record<string, double>): double;
     /**
      * Checks if the given SoundPath is valid.
+     *
+     * Not available in settings and prototype stages.
      * @param sound_path Path to the sound.
      */
     is_valid_sound_path(this: void, sound_path: SoundPath): boolean;
     /**
      * Checks if the given SpritePath is valid and contains a loaded sprite. The existence of the image is not checked for paths of type `file`.
+     *
+     * Not available in settings and prototype stages.
      * @param sprite_path Path to the image.
      */
     is_valid_sprite_path(this: void, sprite_path: SpritePath): boolean;
@@ -11768,6 +11783,8 @@ interface LuaHelpers {
     json_to_table(this: void, json: string): AnyBasic | null;
     /**
      * Convert a map exchange string to map gen settings and map settings.
+     *
+     * Not available in settings and prototype stages.
      */
     parse_map_exchange_string(this: void, map_exchange_string: string): MapExchangeStringData;
     /**
@@ -11784,9 +11801,13 @@ interface LuaHelpers {
      * @param filename The name of the file. Providing a directory path (ex. `"save/here/example.txt"`) will create the necessary folder structure in `script-output`.
      * @param data The content to write to the file.
      * @param append If `true`, `data` will be appended to the end of the file. Defaults to `false`, which will overwrite any pre-existing file with the new `data`.
-     * @param for_player If given, the file will only be written for this `player_index`. Providing `0` will only write to the server's output if present.
+     * @param for_player If given, the file will only be written for this `player_index`. Providing `0` will only write to the server's output if present. `for_player` cannot be used in settings and prototype stages.
      */
     write_file(this: void, filename: string, data: LocalisedString, append?: boolean, for_player?: uint): void;
+    /**
+     * Current version of game
+     */
+    readonly game_version: string;
     /**
      * 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.
      */

package/dist/concepts.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.54
+// Factorio version 2.0.55
 // API version 6
 
 declare namespace runtime {

package/dist/datacollection.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.54
+// Factorio version 2.0.55
 // API version 6
 
 declare namespace prototype {

package/dist/defines.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.54
+// Factorio version 2.0.55
 // API version 6
 
 declare namespace defines {

package/dist/events.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.54
+// Factorio version 2.0.55
 // API version 6
 
 declare namespace runtime {

package/dist/global.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.54
+// Factorio version 2.0.55
 // API version 6
 
 /**

package/dist/prototypes.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.54
+// Factorio version 2.0.55
 // API version 6
 
 declare namespace prototype {
@@ -5146,7 +5146,7 @@ interface LandMinePrototype extends EntityWithOwnerPrototype {
     trigger_collision_mask?: CollisionMaskConnector;
     trigger_force?: ForceCondition;
     /**
-     * Time between checks to detonate due to nearby enemies. A larger time will be more performant.
+     * Time between checks to detonate due to nearby enemies, in ticks. A larger time will be more performant.
      */
     trigger_interval?: uint32;
     trigger_radius: double;

package/dist/types.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.54
+// Factorio version 2.0.55
 // API version 6
 
 declare namespace prototype {
@@ -4462,7 +4462,7 @@ interface FastReplaceTipTrigger extends CountBasedTipTrigger {
     type: 'fast-replace';
 }
 /**
- * A dictionary of feature flags and their status. It can be used to adjust prototypes based on whether the feature flags are enabled.
+ * A dictionary of feature flags and their status. It can be used to adjust prototypes based on whether the feature flags are enabled. It is accessible through the global object named `feature_flags`.
  * @example ```
 -- sets coal to spoil only when the spoiling feature flag is enabled
 if feature_flags["spoiling"] then
@@ -6657,10 +6657,10 @@ if mods["pizza"] then
 end
 ```
  * @example ```
--- when the only active mod is the space-age mod with version 1.2.0
+-- when the only active mod is the space-age mod with version 2.0.7
 -- then this logs
 for name, version in pairs(mods) do
-  log(name .. " version " .. version) -- => space-age version 1.2.0
+  log(name .. " version " .. version) -- => space-age version 2.0.7
 end
 ```
  */
@@ -8886,7 +8886,7 @@ interface SetTileTriggerEffectItem extends TriggerEffectItem {
     type: 'set-tile';
 }
 /**
- * A struct that provides access to the user-set values of startup {@link mod settings | https://wiki.factorio.com/Tutorial:Mod_settings}.
+ * A struct that provides access to the user-set values of startup {@link mod settings | https://wiki.factorio.com/Tutorial:Mod_settings}. It is accessible through the global object named `settings`.
  * @example ```
 -- Accessing the value of a mod setting
 local val = settings.startup["my-mod-setting-name"].value

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "1.2.38",
+  "version": "1.2.39",
   "description": "Typescript declarations for the Factorio mod API",
   "main": "index.d.ts",
   "repository": "https://github.com/sguest/factorio-types.git",
@@ -23,7 +23,7 @@
     "src/**/*.d.ts",
     "dist/**/*.d.ts"
   ],
-  "factorioVersion": "2.0.54",
+  "factorioVersion": "2.0.55",
   "dependencies": {
     "lua-types": "^2.13.1"
   },