typed-factorio 0.11.0-packagetypes → 0.12.0

package/Changelog.md

@@ -1,3 +1,11 @@
+# v0.12.0
+
+- Update to factorio version 1.1.48
+
+# v0.11.1
+
+- Localised strings now accept boolean and undefined.
+
 # v0.11.0
 
 - Update to factorio version 1.1.46

package/generated/classes.d.ts

@@ -1291,47 +1291,41 @@ interface LuaControl {
   /**
    * Sets a personal logistic request and auto-trash slot to the given value.
    *
-   * **Note**: This will silently fail if personal logistics are not researched yet.
-   *
    * {@link https://lua-api.factorio.com/next/LuaControl.html#LuaControl.set_personal_logistic_slot View documentation}
    *
    * @param slot_index - The slot to set.
    * @param value - The logistic request parameters.
-   * @returns Whether the slot was set successfully.
+   * @returns Whether the slot was set successfully. `false` if personal logistics are not researched yet.
    */
-  set_personal_logistic_slot(slot_index: uint, value: PersonalLogisticParameters): boolean
+  set_personal_logistic_slot(slot_index: uint, value: LogisticParameters): boolean
   /**
    * Sets a vehicle logistic request and auto-trash slot to the given value.
    *
-   * **Note**: This will silently fail if the vehicle does not use logistics.
-   *
    * {@link https://lua-api.factorio.com/next/LuaControl.html#LuaControl.set_vehicle_logistic_slot View documentation}
    *
    * @param slot_index - The slot to set.
    * @param value - The logistic request parameters.
-   * @returns Whether the slot was set successfully.
+   * @returns Whether the slot was set successfully. `false` if the vehicle does not use logistics.
    */
-  set_vehicle_logistic_slot(slot_index: uint, value: PersonalLogisticParameters): boolean
+  set_vehicle_logistic_slot(slot_index: uint, value: LogisticParameters): boolean
   /**
    * Gets the parameters of a personal logistic request and auto-trash slot.
    *
-   * **Note**: This will silently return an empty value (`name` will be `nil`) if personal logistics are not researched yet.
-   *
    * {@link https://lua-api.factorio.com/next/LuaControl.html#LuaControl.get_personal_logistic_slot View documentation}
    *
    * @param slot_index - The slot to get.
+   * @returns The logistic parameters. If personal logistics are not researched yet, their `name` will be `nil`.
    */
-  get_personal_logistic_slot(slot_index: uint): PersonalLogisticParameters
+  get_personal_logistic_slot(slot_index: uint): LogisticParameters | undefined
   /**
    * Gets the parameters of a vehicle logistic request and auto-trash slot.
    *
-   * **Note**: This will silently return an empty value (`name` will be `nil`) if the vehicle does not use logistics.
-   *
    * {@link https://lua-api.factorio.com/next/LuaControl.html#LuaControl.get_vehicle_logistic_slot View documentation}
    *
    * @param slot_index - The slot to get.
+   * @returns The logistic parameters. If the vehicle does not use logistics, their `name` will be `nil`.
    */
-  get_vehicle_logistic_slot(slot_index: uint): PersonalLogisticParameters
+  get_vehicle_logistic_slot(slot_index: uint): LogisticParameters | undefined
   /**
    * **Note**: This will silently fail if personal logistics are not researched yet.
    *
@@ -5834,6 +5828,12 @@ interface LuaEntityPrototype {
    * {@link https://lua-api.factorio.com/next/LuaEntityPrototype.html#LuaEntityPrototype.related_underground_belt View documentation}
    */
   readonly related_underground_belt: LuaEntityPrototype
+  /**
+   * Gets the current stack size bonus of this entity, returns nil if not an inserter.
+   *
+   * {@link https://lua-api.factorio.com/next/LuaEntityPrototype.html#LuaEntityPrototype.inserter_stack_size_bonus View documentation}
+   */
+  readonly inserter_stack_size_bonus: double | undefined
   /**
    * Gets the current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
    *
@@ -6827,6 +6827,7 @@ interface LuaFluidEnergySourcePrototype {
   readonly effectivity: double
   readonly burns_fluid: boolean
   readonly scale_fluid_usage: boolean
+  readonly destroy_non_fuel_fluid: boolean
   readonly fluid_usage_per_tick: double
   /**
    * The smoke sources for this prototype if any.
@@ -12140,7 +12141,7 @@ interface LuaItemStack {
    */
   transfer_stack(stack: ItemStackIdentification): boolean
   /**
-   * Export a supported item (blueprint, blueprint-book, deconstruction-planner, upgrade-planner, item-with-tags) to a string
+   * Export a supported item (blueprint, blueprint-book, deconstruction-planner, upgrade-planner, item-with-tags) to a string.
    *
    * {@link https://lua-api.factorio.com/next/LuaItemStack.html#LuaItemStack.export_stack View documentation}
    *
@@ -12148,7 +12149,7 @@ interface LuaItemStack {
    */
   export_stack(): string
   /**
-   * Import a supported item (blueprint, blueprint-book, deconstruction-planner, upgrade-planner, item-with-tags) from a string
+   * Import a supported item (blueprint, blueprint-book, deconstruction-planner, upgrade-planner, item-with-tags) from a string.
    *
    * {@link https://lua-api.factorio.com/next/LuaItemStack.html#LuaItemStack.import_stack View documentation}
    *
@@ -12199,8 +12200,6 @@ interface LuaItemStack {
    */
   get_inventory(inventory: defines.inventory): LuaInventory | undefined
   /**
-   * Build this blueprint
-   *
    * **Note**: Built entities can be come invalid between the building of the blueprint and the function returning if
    * by_player or raise_built is used and one of those events invalidates the entity.
    *
@@ -14688,6 +14687,12 @@ interface LuaPlayer extends LuaControl {
    * {@link https://lua-api.factorio.com/next/LuaPlayer.html#LuaPlayer.spectator View documentation}
    */
   spectator: boolean
+  /**
+   * If `true`, circle and name of given player is rendered on the map/chart.
+   *
+   * {@link https://lua-api.factorio.com/next/LuaPlayer.html#LuaPlayer.show_on_map View documentation}
+   */
+  show_on_map: boolean
   /**
    * If items not included in this map editor infinity inventory filters should be removed.
    *
@@ -17239,6 +17244,12 @@ interface LuaStyle {
    * {@link https://lua-api.factorio.com/next/LuaStyle.html#LuaStyle.use_header_filler View documentation}
    */
   use_header_filler: boolean
+  /**
+   * *Can only be used if this is LuaProgressBarStyle*
+   *
+   * {@link https://lua-api.factorio.com/next/LuaStyle.html#LuaStyle.bar_width View documentation}
+   */
+  bar_width: uint
   /**
    * *Can only be used if this is LuaProgressBarStyle*
    *

package/generated/concepts.d.ts

@@ -9,13 +9,13 @@
  *
  * 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.
+ * 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.
+ * which will not be translated, as well as a number or boolean, which will be converted to their textual representation.
  *
  * {@link https://lua-api.factorio.com/next/Concepts.html#LocalisedString View documentation}
  *
@@ -47,14 +47,14 @@
  *   game.print({"", {"item-name.iron-plate"}, ": ", 60})
  *   ```
  */
-type LocalisedString = readonly [string, ...LocalisedString[]] | string | number
+type LocalisedString = readonly [string, ...LocalisedString[]] | string | number | boolean | undefined
 
 interface DisplayResolution {
   readonly width: uint
   readonly height: uint
 }
 
-interface PersonalLogisticParameters {
+interface LogisticParameters {
   /** The item. `nil` clears the filter. */
   readonly name?: string
   readonly min?: uint

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "0.11.0-packagetypes",
+  "version": "0.12.0",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",