typed-factorio 0.14.0 → 0.17.0

package/generated/concepts.d.ts

@@ -101,16 +101,20 @@ type PositionArray = readonly [x: int, y: int]
  */
 type Position = PositionTable | PositionArray
 
+interface MapPositionTable {
+  readonly x: double
+  readonly y: double
+}
+
+type MapPositionArray = readonly [x: double, y: double]
+
 /**
  * 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/latest/Concepts.html#MapPosition View documentation}
  */
-interface MapPosition {
-  readonly x: double
-  readonly y: double
-}
+type MapPosition = MapPositionTable | MapPositionArray
 
 interface ChunkPositionTable {
   readonly x: int
@@ -167,7 +171,7 @@ type GuiLocation = GuiLocationTable | GuiLocationArray
 interface ChunkPositionAndArea {
   readonly x: int
   readonly y: int
-  readonly area: BoundingBox
+  readonly area: BoundingBoxRead
 }
 
 /**
@@ -201,7 +205,7 @@ interface TabAndContent {
 
 interface OldTileAndPosition {
   readonly old_tile: LuaTilePrototype
-  readonly position: TilePosition
+  readonly position: TilePositionTable
 }
 
 /**
@@ -230,7 +234,7 @@ interface SmokeSource {
   readonly east_position?: PositionTable
   readonly south_position?: PositionTable
   readonly west_position?: PositionTable
-  readonly deviation?: Position
+  readonly deviation?: PositionTable
   readonly starting_frame_speed: uint16
   readonly starting_frame_speed_deviation: double
   readonly starting_frame: uint16
@@ -285,6 +289,13 @@ type BoundingBoxArray = readonly [left_top: Position, right_bottom: Position, or
  */
 type BoundingBox = BoundingBoxTable | BoundingBoxArray
 
+/** @addAfter BoundingBox */
+interface BoundingBoxRead extends BoundingBoxTable {
+  readonly left_top: PositionTable
+  readonly right_bottom: PositionTable
+  readonly orientation?: RealOrientation
+}
+
 /**
  * An area defined using the map editor.
  *
@@ -297,6 +308,11 @@ interface ScriptArea {
   readonly id: uint
 }
 
+interface ScriptAreaRead extends ScriptArea {
+  readonly area: BoundingBoxRead
+  readonly color: ColorTable
+}
+
 /**
  * A position defined using the map editor.
  *
@@ -309,6 +325,11 @@ interface ScriptPosition {
   readonly id: uint
 }
 
+interface ScriptPositionRead extends ScriptPosition {
+  readonly position: PositionTable
+  readonly color: ColorTable
+}
+
 interface ColorTable {
   readonly r?: float
   readonly g?: float
@@ -368,7 +389,7 @@ interface Alert {
   readonly tick: uint
   readonly target?: LuaEntity
   readonly prototype?: LuaEntityPrototype
-  readonly position?: Position
+  readonly position?: PositionTable
   /** The SignalID used for a custom alert. Only present for custom alerts. */
   readonly icon?: SignalID
   /** The message for a custom alert. Only present for custom alerts. */
@@ -388,7 +409,7 @@ interface ScriptRenderVertexTarget {
 
 interface PathfinderWaypoint {
   /** The position of the waypoint on its surface. */
-  readonly position: Position
+  readonly position: PositionTable
   /** `true` if the path from the previous waypoint to this one goes through an entity that must be destroyed. */
   readonly needs_destroy_to_reach: boolean
 }
@@ -414,7 +435,7 @@ interface Decorative {
 }
 
 interface DecorativeResult {
-  readonly position: TilePosition
+  readonly position: TilePositionTable
   readonly decorative: LuaDecorativePrototype
   readonly amount: uint
 }
@@ -873,18 +894,34 @@ interface DifficultySettings {
   readonly research_queue_setting: "after-victory" | "always" | "never"
 }
 
+/**
+ * All regular {@link MapSettings} plus an additional table that contains the {@link DifficultySettings}.
+ *
+ * {@link https://lua-api.factorio.com/latest/Concepts.html#MapAndDifficultySettings View documentation}
+ */
+interface MapAndDifficultySettings {
+  readonly pollution: PollutionMapSettings
+  readonly enemy_evolution: EnemyEvolutionMapSettings
+  readonly enemy_expansion: EnemyExpansionMapSettings
+  readonly unit_group: UnitGroupMapSettings
+  readonly steering: SteeringMapSettings
+  readonly path_finder: PathFinderMapSettings
+  /**
+   * If a behavior fails this many times, the enemy (or enemy group) is destroyed. This solves biters getting stuck
+   * within their own base.
+   */
+  readonly max_failed_behavior_count: uint
+  readonly difficulty_settings: DifficultySettings
+}
+
 /**
  * The data that can be extracted from a map exchange string, as a plain table.
  *
  * {@link https://lua-api.factorio.com/latest/Concepts.html#MapExchangeStringData View documentation}
  */
 interface MapExchangeStringData {
-  /**
-   * All the regular map settings plus an additional table called `difficulty_settings` that contains the
-   * {@link DifficultySettings}.
-   */
-  readonly map_settings: MapSettings
-  readonly map_gen_settings: MapGenSettings
+  readonly map_settings: MapAndDifficultySettings
+  readonly map_gen_settings: MapGenSettingsRead
 }
 
 interface BlueprintItemIcon {
@@ -982,6 +1019,11 @@ interface BlueprintEntity {
   readonly schedule?: TrainScheduleRecord[]
 }
 
+interface BlueprintEntityRead extends BlueprintEntity {
+  /** The position of the entity. */
+  readonly position: PositionTable
+}
+
 interface Tile {
   /** The position of the tile. */
   readonly position: Position
@@ -989,6 +1031,11 @@ interface Tile {
   readonly name: string
 }
 
+interface TileRead extends Tile {
+  /** The position of the tile. */
+  readonly position: PositionTable
+}
+
 interface Fluid {
   /** Fluid prototype name of the fluid. */
   readonly name: string
@@ -1584,6 +1631,11 @@ interface MapGenSettings {
   readonly property_expression_names: Record<string, string>
 }
 
+interface MapGenSettingsRead extends MapGenSettings {
+  /** Positions of the starting areas. */
+  readonly starting_points: PositionTable[]
+}
+
 interface SignalID {
   /** `"item"`, `"fluid"`, or `"virtual"`. */
   readonly type: "item" | "fluid" | "virtual"
@@ -1848,6 +1900,15 @@ interface GoToLocationCommand extends BaseCommand {
   readonly radius?: double
 }
 
+interface GoToLocationCommandRead extends BaseCommand, GoToLocationCommand {
+  readonly type: defines.command.go_to_location
+  /**
+   * The position to path to. Either this or `destination_entity` need to be specified. If both are,
+   * `destination_entity` is used.
+   */
+  readonly destination?: PositionTable
+}
+
 interface CompoundCommand extends BaseCommand {
   readonly type: defines.command.compound
   /** How the commands should be chained together. */
@@ -1856,6 +1917,12 @@ interface CompoundCommand extends BaseCommand {
   readonly commands: Command[]
 }
 
+interface CompoundCommandRead extends BaseCommand, CompoundCommand {
+  readonly type: defines.command.compound
+  /** The sub-commands. */
+  readonly commands: CommandRead[]
+}
+
 interface GroupCommand extends BaseCommand {
   readonly type: defines.command.group
   /** The group whose command to follow. */
@@ -1876,6 +1943,12 @@ interface AttackAreaCommand extends BaseCommand {
   readonly distraction?: defines.distraction
 }
 
+interface AttackAreaCommandRead extends BaseCommand, AttackAreaCommand {
+  readonly type: defines.command.attack_area
+  /** Center of the attack area. */
+  readonly destination: PositionTable
+}
+
 interface WanderCommand extends BaseCommand {
   readonly type: defines.command.wander
   /** Defaults to `defines.distraction.by_enemy`. */
@@ -1922,6 +1995,23 @@ interface BuildBaseCommand extends BaseCommand {
   readonly ignore_planner?: boolean
 }
 
+interface BuildBaseCommandRead extends BaseCommand, BuildBaseCommand {
+  readonly type: defines.command.build_base
+  /** Where to build the base. */
+  readonly destination: PositionTable
+}
+
+type CommandRead =
+  | AttackCommand
+  | GoToLocationCommandRead
+  | CompoundCommandRead
+  | GroupCommand
+  | AttackAreaCommandRead
+  | WanderCommand
+  | StopCommand
+  | FleeCommand
+  | BuildBaseCommandRead
+
 /**
  * Commands can be given to enemies and unit groups.
  *
@@ -2243,7 +2333,7 @@ interface BeamTarget {
   /** The target entity. */
   readonly entity?: LuaEntity
   /** The target position. */
-  readonly position?: Position
+  readonly position?: PositionTable
 }
 
 interface RidingState {
@@ -2837,7 +2927,7 @@ interface SelectedPrototypeData {
 interface ScriptRenderTarget {
   readonly entity?: LuaEntity
   readonly entity_offset?: Vector
-  readonly position?: Position
+  readonly position?: PositionTable
 }
 
 type MouseButtonFlag =
@@ -6549,6 +6639,17 @@ type StyleValuesArray =
 
 type SizeArray = readonly [width: int, height: int]
 
+type RaiseableEvents =
+  | typeof defines.events.on_console_chat
+  | typeof defines.events.on_player_crafted_item
+  | typeof defines.events.on_player_fast_transferred
+  | typeof defines.events.on_biter_base_built
+  | typeof defines.events.on_market_item_purchased
+  | typeof defines.events.script_raised_built
+  | typeof defines.events.script_raised_destroy
+  | typeof defines.events.script_raised_revive
+  | typeof defines.events.script_raised_set_tiles
+
 /**
  * A map gen preset. Used in {@link https://wiki.factorio.com/Prototype/MapGenPresets Prototype/MapGenPresets}.
  *

package/generated/events.d.ts

@@ -13,7 +13,7 @@ interface CustomInputEvent extends EventData {
   /** The prototype name of the custom input that was activated. */
   readonly input_name: string
   /** The mouse cursor position when the custom input was activated. */
-  readonly cursor_position: Position
+  readonly cursor_position: PositionTable
   /** Information about the prototype that is selected when the custom input is used. `nil` if none is selected. */
   readonly selected_prototype?: SelectedPrototypeData
   /** Identifier of the event */
@@ -46,9 +46,9 @@ interface OnAiCommandCompletedEvent extends EventData {
  */
 interface OnAreaClonedEvent extends EventData {
   readonly source_surface: LuaSurface
-  readonly source_area: BoundingBox
+  readonly source_area: BoundingBoxRead
   readonly destination_surface: LuaSurface
-  readonly destination_area: BoundingBox
+  readonly destination_area: BoundingBoxRead
   readonly destination_force?: LuaForce
   readonly clone_tiles: boolean
   readonly clone_entities: boolean
@@ -84,10 +84,10 @@ interface OnBiterBaseBuiltEvent extends EventData {
  * {@link https://lua-api.factorio.com/latest/Events.html#on_brush_cloned View documentation}
  */
 interface OnBrushClonedEvent extends EventData {
-  readonly source_offset: TilePosition
-  readonly destination_offset: TilePosition
+  readonly source_offset: TilePositionTable
+  readonly destination_offset: TilePositionTable
   readonly source_surface: LuaSurface
-  readonly source_positions: TilePosition[]
+  readonly source_positions: TilePositionTable[]
   readonly destination_surface: LuaSurface
   readonly destination_force?: LuaForce
   readonly clone_tiles: boolean
@@ -236,9 +236,9 @@ interface OnChartTagRemovedEvent extends EventData {
  */
 interface OnChunkChartedEvent extends EventData {
   readonly surface_index: uint
-  readonly position: ChunkPosition
+  readonly position: ChunkPositionTable
   /** Area of the chunk. */
-  readonly area: BoundingBox
+  readonly area: BoundingBoxRead
   readonly force: LuaForce
   /** Identifier of the event */
   readonly name: typeof defines.events.on_chunk_charted
@@ -254,7 +254,7 @@ interface OnChunkChartedEvent extends EventData {
 interface OnChunkDeletedEvent extends EventData {
   readonly surface_index: uint
   /** The chunks deleted. */
-  readonly positions: ChunkPosition[]
+  readonly positions: ChunkPositionTable[]
   /** Identifier of the event */
   readonly name: typeof defines.events.on_chunk_deleted
   /** Tick the event was generated. */
@@ -268,9 +268,9 @@ interface OnChunkDeletedEvent extends EventData {
  */
 interface OnChunkGeneratedEvent extends EventData {
   /** Area of the chunk. */
-  readonly area: BoundingBox
+  readonly area: BoundingBoxRead
   /** Position of the chunk. */
-  readonly position: ChunkPosition
+  readonly position: ChunkPositionTable
   /** The surface the chunk is on. */
   readonly surface: LuaSurface
   /** Identifier of the event */
@@ -748,7 +748,7 @@ interface OnGuiClosedEvent extends EventData {
   /** The technology that was automatically selected when opening the research GUI */
   readonly technology?: LuaTechnology
   /** The tile position that was open */
-  readonly tile_position?: TilePosition
+  readonly tile_position?: TilePositionTable
   /** Identifier of the event */
   readonly name: typeof defines.events.on_gui_closed
   /** Tick the event was generated. */
@@ -1120,7 +1120,7 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
   /** The surface selected. */
   readonly surface: LuaSurface
   /** The area selected. */
-  readonly area: BoundingBox
+  readonly area: BoundingBoxRead
   /** The item used to select the area. */
   readonly item: string
   /** The entities selected. */
@@ -1307,7 +1307,7 @@ interface OnPlayerClickedGpsTagEvent extends EventData {
   /** Index of the player */
   readonly player_index: uint
   /** Map position contained in gps tag */
-  readonly position: Position
+  readonly position: PositionTable
   /** Surface name contained in gps tag, even when such surface does not exists */
   readonly surface: string
   /** Identifier of the event */
@@ -1402,7 +1402,7 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
   /** The surface selected. */
   readonly surface: LuaSurface
   /** The area selected. */
-  readonly area: BoundingBox
+  readonly area: BoundingBoxRead
   /** The item used to select the area. */
   readonly item: string
   /** If normal selection or alt selection was used. */
@@ -1824,7 +1824,7 @@ interface OnPlayerSelectedAreaEvent extends EventData {
   /** The surface selected. */
   readonly surface: LuaSurface
   /** The area selected. */
-  readonly area: BoundingBox
+  readonly area: BoundingBoxRead
   /** The item used to select the area. */
   readonly item: string
   /** The entities selected. */
@@ -1861,7 +1861,7 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
   /** The surface selected. */
   readonly surface: LuaSurface
   /** The area selected. */
-  readonly area: BoundingBox
+  readonly area: BoundingBoxRead
   /** The item used to select the area. */
   readonly item: string
   /** If normal selection or alt selection was used. */
@@ -1963,7 +1963,7 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
   /** The capsule item used. */
   readonly item: LuaItemPrototype
   /** The position the capsule was used. */
-  readonly position: Position
+  readonly position: PositionTable
   /** Identifier of the event */
   readonly name: typeof defines.events.on_player_used_capsule
   /** Tick the event was generated. */
@@ -1981,7 +1981,7 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
   /** Spider vehicle which was requested to move. */
   readonly vehicle: LuaEntity
   /** Goal position to which spidertron was sent to. */
-  readonly position: Position
+  readonly position: PositionTable
   /** If the use was successful. It may fail when spidertron has different driver or when player is on different surface. */
   readonly success: boolean
   /** Identifier of the event */
@@ -2001,7 +2001,7 @@ interface OnPostEntityDiedEvent extends EventData {
   /** The force that did the killing if any. */
   readonly force?: LuaForce
   /** Position where the entity died. */
-  readonly position: Position
+  readonly position: PositionTable
   /** The entity prototype of the entity that died. */
   readonly prototype: LuaEntityPrototype
   /** The damage type if any. */
@@ -2027,7 +2027,7 @@ interface OnPreBuildEvent extends EventData {
   /** The player who did the placing. */
   readonly player_index: uint
   /** Where the item was placed. */
-  readonly position: Position
+  readonly position: PositionTable
   /** Item was placed using shift building. */
   readonly shift_build: boolean
   /** The direction the item was facing when placed. */
@@ -2052,7 +2052,7 @@ interface OnPreBuildEvent extends EventData {
 interface OnPreChunkDeletedEvent extends EventData {
   readonly surface_index: uint
   /** The chunks to be deleted. */
-  readonly positions: ChunkPosition[]
+  readonly positions: ChunkPositionTable[]
   /** Identifier of the event */
   readonly name: typeof defines.events.on_pre_chunk_deleted
   /** Tick the event was generated. */
@@ -2574,9 +2574,9 @@ interface OnScriptTriggerEffectEvent extends EventData {
   readonly effect_id: string
   /** The surface the effect happened on. */
   readonly surface_index: uint
-  readonly source_position?: Position
+  readonly source_position?: PositionTable
   readonly source_entity?: LuaEntity
-  readonly target_position?: Position
+  readonly target_position?: PositionTable
   readonly target_entity?: LuaEntity
   /** Identifier of the event */
   readonly name: typeof defines.events.on_script_trigger_effect
@@ -2594,9 +2594,9 @@ interface OnSectorScannedEvent extends EventData {
   /** The radar that did the scanning. */
   readonly radar: LuaEntity
   /** The chunk scanned. */
-  readonly chunk_position: ChunkPosition
+  readonly chunk_position: ChunkPositionTable
   /** Area of the scanned chunk. */
-  readonly area: BoundingBox
+  readonly area: BoundingBoxRead
   /** Identifier of the event */
   readonly name: typeof defines.events.on_sector_scanned
   /** Tick the event was generated. */
@@ -2958,7 +2958,7 @@ interface ScriptRaisedSetTilesEvent extends EventData {
   /** The surface whose tiles were changed. */
   readonly surface_index: uint
   /** The tiles that were changed. */
-  readonly tiles: Tile[]
+  readonly tiles: TileRead[]
   /** Identifier of the event */
   readonly name: typeof defines.events.script_raised_set_tiles
   /** Tick the event was generated. */

package/generated/index.d.ts

@@ -2,8 +2,8 @@
 
 ///<reference types="lua-types/5.2" />
 ///<reference path="builtin-types.d.ts" />
+///<reference path="global-objects.d.ts" />
 ///<reference path="defines.d.ts" />
 ///<reference path="events.d.ts" />
 ///<reference path="classes.d.ts" />
 ///<reference path="concepts.d.ts" />
-///<reference path="global-objects.d.ts" />

package/generator/typescript-internal.d.ts

@@ -0,0 +1,9 @@
+declare module "typescript" {
+  interface JSDocContainer {
+    jsDoc?: JSDoc[]
+  }
+  interface Node {
+    emitNode?: unknown
+  }
+}
+export {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "0.14.0",
+  "version": "0.17.0",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -28,7 +28,7 @@
   },
   "peerDependencies": {
     "lua-types": "^2.11.0",
-    "typescript-to-lua": "^1.0.0"
+    "typescript-to-lua": "^1.3.1"
   },
   "devDependencies": {
     "@types/jest": "^27.0.3",
@@ -53,6 +53,6 @@
     "ts-jest": "^27.1.0",
     "ts-node": "^10.4.0",
     "typescript": "4.5.2",
-    "typescript-to-lua": "^1.2.0"
+    "typescript-to-lua": "^1.3.1"
   }
 }

package/runtime/pairs.d.ts

@@ -1,13 +1,14 @@
 /** @noSelfInFile */
 
-/** Iterating with `pairs` will only iterate the array part of a {@link LuaCustomTable}. */
-declare function pairs<V>(table: LuaCustomTable<number | string, V>): LuaIterable<LuaMultiReturn<[number, V]>>
-
-declare function pairs<K extends keyof any, V>(table: LuaCustomTable<K, V>): LuaIterable<LuaMultiReturn<[K, V]>>
-
 /**
- * {@link LuaCustomTable} cannot be iterated with `ipairs`. Use `pairs` instead.
+ * Iterating with `pairs` will only iterate the array part of a {@link LuaCustomTable}.
  *
- * @deprecated
+ * **Note**: you can also iterate on a LuaCustomTable directly without using `pairs`, e.g. `for(const [k, v] of table)`.
  */
+declare function pairs<V>(table: LuaCustomTable<number | string, V>): LuaIterable<LuaMultiReturn<[number, V]>>
+
+/** **Note**: you can also iterate on a LuaCustomTable directly without using `pairs`, e.g. `for(const [k, v] of table)`. */
+declare function pairs<K extends number | string, V>(table: LuaCustomTable<K, V>): LuaIterable<LuaMultiReturn<[K, V]>>
+
+/** @deprecated {@link LuaCustomTable} cannot be iterated with `ipairs`; Use {@link pairs} instead. */
 declare function ipairs(table: LuaCustomTable<any, any>): never

package/runtime/util.d.ts

@@ -33,11 +33,7 @@ declare module "util" {
     direction: defines.direction.north | defines.direction.east | defines.direction.south | defines.direction.west,
     distance: number
   ): Position
-  function moveposition(
-    position: Position,
-    direction: defines.direction, //todo: cardinal only
-    distance: number
-  ): Position | undefined
+  function moveposition(position: Position, direction: defines.direction, distance: number): Position | undefined
 
   function oppositedirection(direction: defines.direction): defines.direction