typed-factorio 0.14.1 → 0.17.1

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
 }
@@ -900,7 +921,7 @@ interface MapAndDifficultySettings {
  */
 interface MapExchangeStringData {
   readonly map_settings: MapAndDifficultySettings
-  readonly map_gen_settings: MapGenSettings
+  readonly map_gen_settings: MapGenSettingsRead
 }
 
 interface BlueprintItemIcon {
@@ -998,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
@@ -1005,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
@@ -1600,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"
@@ -1864,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. */
@@ -1872,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. */
@@ -1892,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`. */
@@ -1938,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.
  *
@@ -2259,7 +2333,7 @@ interface BeamTarget {
   /** The target entity. */
   readonly entity?: LuaEntity
   /** The target position. */
-  readonly position?: Position
+  readonly position?: PositionTable
 }
 
 interface RidingState {
@@ -2853,7 +2927,7 @@ interface SelectedPrototypeData {
 interface ScriptRenderTarget {
   readonly entity?: LuaEntity
   readonly entity_offset?: Vector
-  readonly position?: Position
+  readonly position?: PositionTable
 }
 
 type MouseButtonFlag =
@@ -6565,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}.
  *