typed-factorio 0.11.0-packagetypes-1 → 0.13.0

package/Changelog.md

@@ -1,3 +1,15 @@
+# v0.13.0
+
+- Update to factorio version 1.1.49
+
+# 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

@@ -1187,7 +1187,7 @@ interface LuaControl {
    *   players, cars, and spidertrons can be teleported cross-surface.
    * @returns `true` when the entity was successfully teleported.
    */
-  teleport(position: Position, surface?: SurfaceIdentification): boolean
+  teleport(position: MapPosition, surface?: SurfaceIdentification): boolean
   /**
    * Select an entity, as if by hovering the mouse above it.
    *
@@ -1195,7 +1195,7 @@ interface LuaControl {
    *
    * @param position - Position of the entity to select
    */
-  update_selected_entity(position: Position): void
+  update_selected_entity(position: MapPosition): void
   /**
    * Unselect any selected entity.
    *
@@ -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.
    *
@@ -1384,7 +1378,7 @@ interface LuaControl {
    *
    * {@link https://lua-api.factorio.com/next/LuaControl.html#LuaControl.position View documentation}
    */
-  readonly position: PositionTable
+  readonly position: MapPosition
   /**
    * The vehicle the player is currently sitting in; `nil` if none.
    *
@@ -3002,7 +2996,7 @@ interface LuaEntity extends LuaControl {
    */
   clone(params: {
     /** The destination position */
-    readonly position: Position
+    readonly position: MapPosition
     /** The destination surface */
     readonly surface?: LuaSurface
     readonly force?: ForceIdentification
@@ -3145,7 +3139,7 @@ interface LuaEntity extends LuaControl {
    * @param target
    * @param position
    */
-  can_shoot(target: LuaEntity, position: Position): boolean
+  can_shoot(target: LuaEntity, position: MapPosition): boolean
   /**
    * Only works if the entity is a speech-bubble, with an "effect" defined in its wrapper_flow_style. Starts animating
    * the opacity of the speech bubble towards zero, and destroys the entity when it hits zero.
@@ -3285,7 +3279,7 @@ interface LuaEntity extends LuaControl {
    *
    * @param position - The position the spidertron should move to.
    */
-  add_autopilot_destination(position: Position): void
+  add_autopilot_destination(position: MapPosition): void
   /**
    * Connects current linked belt with another one.
    *
@@ -4507,7 +4501,7 @@ interface LuaEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.autopilot_destination View documentation}
    */
-  autopilot_destination: Position | undefined
+  autopilot_destination: MapPosition | undefined
   /**
    * The queued destination positions of spidertron's autopilot.
    *
@@ -4515,7 +4509,7 @@ interface LuaEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.autopilot_destinations View documentation}
    */
-  readonly autopilot_destinations: PositionTable[]
+  readonly autopilot_destinations: MapPosition[]
   /**
    * Amount of trains related to this particular train stop. Includes train stopped at this train stop (until it finds
    * a path to next target) and trains having this train stop as goal or waypoint. Writing nil will disable the limit
@@ -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 built-in stack size bonus of this inserter prototype. `nil` if this is 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.
@@ -7824,6 +7825,12 @@ interface LuaGameScript {
     readonly can_continue: boolean
     readonly victorious_force: ForceIdentification
   }): void
+  /**
+   * Reset scenario state (game_finished, player_won, etc.).
+   *
+   * {@link https://lua-api.factorio.com/next/LuaGameScript.html#LuaGameScript.reset_game_state View documentation}
+   */
+  reset_game_state(): void
   /**
    * {@link https://lua-api.factorio.com/next/LuaGameScript.html#LuaGameScript.get_entity_by_tag View documentation}
    *
@@ -8833,11 +8840,17 @@ interface LuaGameScript {
    */
   ticks_to_run: uint
   /**
-   * Is the scenario finished?
+   * True while the victory screen is shown.
    *
    * {@link https://lua-api.factorio.com/next/LuaGameScript.html#LuaGameScript.finished View documentation}
    */
   readonly finished: boolean
+  /**
+   * True after players finished the game and clicked "continue".
+   *
+   * {@link https://lua-api.factorio.com/next/LuaGameScript.html#LuaGameScript.finished_but_continuing View documentation}
+   */
+  readonly finished_but_continuing: boolean
   /**
    * Speed to update the map at. 1.0 is normal speed -- 60 UPS.
    *
@@ -12140,7 +12153,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 +12161,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 +12212,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.
    *
@@ -13956,7 +13967,7 @@ interface LuaPlayer extends LuaControl {
      * Position at which cursor was clicked. Used only to decide which side of arithmetic combinator, decider
      * combinator or power switch is to be connected. Entity itself to be connected is based on the player's selected entity.
      */
-    readonly position: Position
+    readonly position: MapPosition
   }): boolean
   /**
    * Disable recipe groups.
@@ -14162,7 +14173,7 @@ interface LuaPlayer extends LuaControl {
     /** Name of the entity to check */
     readonly name: string
     /** Where the entity would be placed */
-    readonly position: Position
+    readonly position: MapPosition
     /** Direction the entity would be placed */
     readonly direction?: defines.direction
   }): boolean
@@ -14173,7 +14184,7 @@ interface LuaPlayer extends LuaControl {
    */
   can_build_from_cursor(params: {
     /** Where the entity would be placed */
-    readonly position: Position
+    readonly position: MapPosition
     /** Direction the entity would be placed */
     readonly direction?: defines.direction
     /** If alt build should be used instead of normal build. Defaults to normal. */
@@ -14194,7 +14205,7 @@ interface LuaPlayer extends LuaControl {
    */
   build_from_cursor(params: {
     /** Where the entity would be placed */
-    readonly position: Position
+    readonly position: MapPosition
     /** Direction the entity would be placed */
     readonly direction?: defines.direction
     /** If alt build should be used instead of normal build. Defaults to normal. */
@@ -14280,7 +14291,7 @@ interface LuaPlayer extends LuaControl {
     /** The flying text to show. */
     readonly text: LocalisedString
     /** The location on the map at which to show the flying text. */
-    readonly position?: Position
+    readonly position?: MapPosition
     /** If `true`, the flying text is created at the player's cursor. Defaults to `false`. */
     readonly create_at_cursor?: boolean
     /** The color of the flying text. Defaults to white text. */
@@ -14351,7 +14362,7 @@ interface LuaPlayer extends LuaControl {
    * @param position
    * @param scale
    */
-  open_map(position: Position, scale?: double): void
+  open_map(position: MapPosition, scale?: double): void
   /**
    * Queues a request to zoom to world at the specified position. If the player is already zooming to world, the
    * request will simply set the position (and scale). Render mode change requests are processed before rendering of
@@ -14362,7 +14373,7 @@ interface LuaPlayer extends LuaControl {
    * @param position
    * @param scale
    */
-  zoom_to_world(position: Position, scale?: double): void
+  zoom_to_world(position: MapPosition, scale?: double): void
   /**
    * Queues request to switch to the normal game view from the map or zoom to world view. Render mode change requests
    * are processed before rendering of the next frame.
@@ -14500,7 +14511,7 @@ interface LuaPlayer extends LuaControl {
    * @param position - The position to start selection from.
    * @param selection_mode - The type of selection to start. Can be `select`, `alternative-select`, `reverse-select`.
    */
-  start_selection(position: Position, selection_mode: string): void
+  start_selection(position: MapPosition, selection_mode: string): void
   /**
    * Clears the players selection tool selection position.
    *
@@ -14688,6 +14699,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 +17256,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*
    *
@@ -18799,7 +18822,7 @@ interface LuaSurface {
    *
    * {@link https://lua-api.factorio.com/next/LuaSurface.html#LuaSurface.daytime View documentation}
    */
-  daytime: float
+  daytime: double
   /**
    * Amount of darkness at the current time.
    *

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
@@ -99,6 +99,17 @@ type PositionArray = readonly [x: int, y: int]
  */
 type Position = PositionTable | PositionArray
 
+/**
+ * Coordinates of an entity on a map. This uses the same format as {@link Position}, meaning it can be specified either
+ * with or without explicit keys.
+ *
+ * {@link https://lua-api.factorio.com/next/Concepts.html#MapPosition View documentation}
+ */
+interface MapPosition {
+  readonly x: double
+  readonly y: double
+}
+
 interface ChunkPositionTable {
   readonly x: int
   readonly y: int
@@ -705,7 +716,10 @@ interface SteeringMapSettings {
 }
 
 interface PathFinderMapSettings {
-  /** Determines whether forwards (`>1`), backwards (`<-1`), or symmetrical (`1`) search is preferred. Defaults to `5`. */
+  /**
+   * The pathfinder performs a step of the backward search every `fwd2bwd_ratio`'th step. The minimum allowed value is
+   * `2`, which means symmetric search. The default value is `5`.
+   */
   readonly fwd2bwd_ratio: uint
   /**
    * When looking at which node to check next, their heuristic value is multiplied by this ratio. The higher it is,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "0.11.0-packagetypes-1",
+  "version": "0.13.0",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -13,10 +13,9 @@
   "files": [
     "**/*.d.ts"
   ],
-  "types": "runtime/index.d.ts",
   "homepage": "https://github.com/GlassBricks/typed-factorio#readme",
   "scripts": {
-    "gen": "ts-node generator/index.ts",
+    "gen": "ts-node -P generator/tsconfig.json generator/index.ts",
     "generate": "yarn run gen --in ./generatorSrc --out ./generated --warn-as-error",
     "generate:dev": "yarn run gen --in ./generatorSrc --out ./generated --no-format",
     "clean": "rimraf generated",
@@ -27,31 +26,33 @@
     "prepublishOnly": "yarn run check",
     "download-latest-runtime-api": "ts-node ./scripts/downloadLatest.ts"
   },
-  "dependencies": {
-    "lua-types": "^2.10.1",
+  "peerDependencies": {
+    "lua-types": "^2.11.0",
     "typescript-to-lua": "^1.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.24",
-    "@types/node": "^16.7.1",
-    "@types/prettier": "^2.3.2",
-    "@typescript-eslint/eslint-plugin": "^4.27.0",
-    "@typescript-eslint/parser": "^4.27.0",
-    "chalk": "^4.1.2",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^16.11.12",
+    "@types/prettier": "^2.4.2",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "@typescript-eslint/parser": "^5.6.0",
+    "chalk": "^3.0.0",
     "commander": "^8.3.0",
-    "eslint": "^7.29.0",
+    "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-config-standard": "^16.0.3",
-    "eslint-import-resolver-typescript": "^2.4.0",
-    "eslint-plugin-import": "^2.23.4",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "jest": "^27.0.6",
-    "prettier": "^2.3.2",
-    "prettier-plugin-jsdoc": "^0.3.23",
-    "ts-jest": "^27.0.4",
-    "ts-node": "^10.1.0",
-    "typescript": "~4.3.5"
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^5.2.0",
+    "jest": "^27.4.3",
+    "lua-types": "^2.11.0",
+    "prettier": "^2.5.1",
+    "prettier-plugin-jsdoc": "^0.3.30",
+    "ts-jest": "^27.1.0",
+    "ts-node": "^10.4.0",
+    "typescript": "4.5.2",
+    "typescript-to-lua": "^1.2.0"
   }
 }