factorio-types 0.0.13 → 0.0.17

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 1.1.40
+// Factorio version 1.1.47
 // API version 1
 
 /**
@@ -1093,7 +1093,7 @@ type EntityPrototypeFlags = {
     [key in EntityPrototypeFlagsKey]: true
 }
 
-type EntityPrototypeFlagsKey = 'breaths-air' | 'building-direction-8-way' | 'fast-replaceable-no-build-while-moving' | 'fast-replaceable-no-cross-type-while-moving' | 'filter-directions' | 'hidden' | 'hide-alt-info' | 'no-automated-item-insertion' | 'no-automated-item-removal' | 'no-copy-paste' | 'no-gap-fill-while-building' | 'not-blueprintable' | 'not-deconstructable' | 'not-flammable' | 'not-on-map' | 'not-repairable' | 'not-rotatable' | 'not-selectable-in-game' | 'not-upgradable' | 'placeable-enemy' | 'placeable-neutral' | 'placeable-off-grid' | 'placeable-player' | 'player-creation'
+type EntityPrototypeFlagsKey = 'breaths-air' | 'building-direction-8-way' | 'fast-replaceable-no-build-while-moving' | 'fast-replaceable-no-cross-type-while-moving' | 'filter-directions' | 'hidden' | 'hide-alt-info' | 'no-automated-item-insertion' | 'no-automated-item-removal' | 'no-copy-paste' | 'no-gap-fill-while-building' | 'not-blueprintable' | 'not-deconstructable' | 'not-flammable' | 'not-in-kill-statistics' | 'not-on-map' | 'not-repairable' | 'not-rotatable' | 'not-selectable-in-game' | 'not-upgradable' | 'placeable-enemy' | 'placeable-neutral' | 'placeable-off-grid' | 'placeable-player' | 'player-creation'
 
 /**
  * @remarks
@@ -1540,7 +1540,7 @@ type ItemPrototypeFlags = {
     [key in ItemPrototypeFlagsKey]: true
 }
 
-type ItemPrototypeFlagsKey = 'always-show' | 'can-extend-inventory' | 'draw-logistic-overlay' | 'hidden' | 'hide-from-bonus-gui' | 'hide-from-fuel-tooltip' | 'mod-openable' | 'not-stackable' | 'only-in-cursor' | 'primary-place-result'
+type ItemPrototypeFlagsKey = 'always-show' | 'can-extend-inventory' | 'draw-logistic-overlay' | 'hidden' | 'hide-from-bonus-gui' | 'hide-from-fuel-tooltip' | 'mod-openable' | 'not-stackable' | 'only-in-cursor' | 'primary-place-result' | 'spawnable'
 
 /**
  * @remarks
@@ -1601,9 +1601,9 @@ interface ItemStackLocation {
  * Localised strings are a way to support translation of in-game text. It is an array where the first element is the key and the remaining elements are parameters that will be substituted for placeholders in the template designated by the key.
  * The key identifies the string template. For example, `"gui-alert-tooltip.attack"` (for the template `"__1__
  *     objects are being damaged"`; see the file `data/core/locale/en.cfg`).
- * The template can contain placeholders such as `__1__` or `__2__`. These will be replaced by the respective parameter in the LocalisedString. The parameters themselves can be other localised strings, which will be processed recursively in the same fashion. Localised strings cannot be recursed deeper than 20 levels and cannot have more than 20 parameters.
+ * The template can contain placeholders such as `__1__` or `__2__`. These will be replaced by the respective parameter in the LocalisedString. The parameters themselves can be other localised strings, which will be processed recursively in the same fashion. Localised strings can not be recursed deeper than 20 levels and can not have more than 20 parameters.
  * As a special case, when the key is just the empty string, all the parameters will be concatenated (after processing, if any are localised strings). If there is only one parameter, it will be used as is.
- * Furthermore, when an API function expects a localised string, it will also accept a regular string (i.e. not a table) which will not be translated, or number which will be converted to its textual representation.
+ * Furthermore, when an API function expects a localised string, it will also accept a regular string (i.e. not a table) which will not be translated, as well as a number or boolean, which will be converted to their textual representation.
  * @example
  * In the English translation, this will print `"No ammo"`; in the Czech translation, it will print `"Bez munice"`: 
  * ```
@@ -1651,6 +1651,18 @@ interface LogisticFilter {
     'name': string
 }
 
+/**
+ * @param name - The item. `nil` clears the filter.
+ */
+interface LogisticParameters {
+    'max'?: number
+    'min'?: number
+    /**
+     * The item. `nil` clears the filter.
+     */
+    'name'?: string
+}
+
 /**
  * @param count_max - Maximum amount of loot to drop.
  * @param count_min - Minimum amount of loot to drop.
@@ -2405,18 +2417,6 @@ interface PathfinderWaypoint {
     'position': Position
 }
 
-/**
- * @param name - The item. `nil` clears the filter.
- */
-interface PersonalLogisticParameters {
-    'max'?: number
-    'min'?: number
-    /**
-     * The item. `nil` clears the filter.
-     */
-    'name'?: string
-}
-
 /**
  * @param result - The tile prototype.
  */
@@ -2849,6 +2849,9 @@ interface SmokeSource {
  */
 type SoundPath = string
 
+/**
+ * Defines which slider in the game's sound settings affects the volume of this sound. Furthermore, some sound types are mixed differently than others, e.g. zoom level effects are applied.
+ */
 declare enum SoundType {
     'alert',
     'ambient',
@@ -3012,6 +3015,7 @@ interface TrainSchedule {
 
 /**
  * @param rail - Rail to path to. Ignored if `station` is present.
+ * @param rail_direction - When a train is allowed to reach rail target from any direction it will be `nil`. If rail has to be reached from specific direction, this value allows to choose the direction. This value corresponds to [LuaEntity::connected_rail_direction](LuaEntity::connected_rail_direction) of a TrainStop.
  * @param station - Name of the station.
  * @param temporary - Only present when the station is temporary, the value is then always `true`.
  */
@@ -3020,6 +3024,10 @@ interface TrainScheduleRecord {
      * Rail to path to. Ignored if `station` is present.
      */
     'rail'?: LuaEntity
+    /**
+     * When a train is allowed to reach rail target from any direction it will be `nil`. If rail has to be reached from specific direction, this value allows to choose the direction. This value corresponds to {@link LuaEntity::connected_rail_direction | LuaEntity::connected_rail_direction} of a TrainStop.
+     */
+    'rail_direction'?: defines.rail_direction
     /**
      * Name of the station.
      */

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 1.1.40
+// Factorio version 1.1.47
 // API version 1
 
 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 1.1.40
+// Factorio version 1.1.47
 // API version 1
 
 /**
@@ -541,6 +541,9 @@ interface on_forces_merging extends event  {
 }
 /**
  * Called when a game is created from a scenario. This is fired for every mod, even when the scenario's save data already includes it. In those cases however, {@link LuaBootstrap::on_init | LuaBootstrap::on_init} is not fired.
+ * @remarks
+ * This event is not fired when the scenario is loaded via the map editor.
+ *
  */
 interface on_game_created_from_scenario extends event  {
 }

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 1.1.40
+// Factorio version 1.1.47
 // API version 1
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-types",
-  "version": "0.0.13",
+  "version": "0.0.17",
   "description": "Typescript declarations for the factorio mod API",
   "main": "index.d.ts",
   "repository": "https://github.com/sguest/factorio-types.git",