typed-factorio 1.6.0 → 1.6.1

package/Changelog.md

@@ -1,3 +1,8 @@
+# v1.6.1
+
+- Fixed write type for `BoundingBox`.
+- Simplified types for BlueprintEntity.
+
 # v1.6.0
 
 - Updated to factorio version 1.1.64

package/generated/classes.d.ts

@@ -10842,7 +10842,7 @@ interface LuaForce {
    * ```
    * @see {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.chart Online documentation}
    */
-  chart(surface: SurfaceIdentification, area: BoundingBoxWrite): void
+  chart(surface: SurfaceIdentification, area: BoundingBoxWrite | BoundingBoxArray): void
   /**
    * Erases chart data for this force.
    * @param surface Which surface to erase chart data for or if not provided all surfaces charts are erased.
@@ -11005,7 +11005,7 @@ interface LuaForce {
    * Finds all custom chart tags within the given bounding box on the given surface.
    * @see {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.find_chart_tags Online documentation}
    */
-  find_chart_tags(surface: SurfaceIdentification, area?: BoundingBoxWrite): LuaCustomChartTag[]
+  find_chart_tags(surface: SurfaceIdentification, area?: BoundingBoxWrite | BoundingBoxArray): LuaCustomChartTag[]
   /**
    * Gets the saved progress for the given technology or `nil` if there is no saved progress.
    * @param technology The technology
@@ -16039,7 +16039,7 @@ interface LuaItemStack {
     /**
      * The area to deconstruct
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * If chunks covered by fog-of-war are skipped.
      */
@@ -16065,7 +16065,7 @@ interface LuaItemStack {
     /**
      * The area to deconstruct
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * If chunks covered by fog-of-war are skipped.
      */
@@ -16092,7 +16092,7 @@ interface LuaItemStack {
     /**
      * The bounding box
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * When true, blueprintable tiles are always included in the blueprint. When false they're only included if no entities exist in the setup area.
      */
@@ -16681,7 +16681,7 @@ interface BaseItemStack {
     /**
      * The area to deconstruct
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * If chunks covered by fog-of-war are skipped.
      */
@@ -16707,7 +16707,7 @@ interface BaseItemStack {
     /**
      * The area to deconstruct
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * If chunks covered by fog-of-war are skipped.
      */
@@ -16734,7 +16734,7 @@ interface BaseItemStack {
     /**
      * The bounding box
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * When true, blueprintable tiles are always included in the blueprint. When false they're only included if no entities exist in the setup area.
      */
@@ -21977,7 +21977,7 @@ interface HighlightBoxSurfaceCreateEntity extends BaseSurfaceCreateEntity {
   /**
    * The bounding box defining the highlight box using absolute map coordinates. If specified, the general `position` parameter still needs to be present, but will be ignored. If not specified, the game falls back to the `source` parameter first, then the `target` parameter second. One of these three parameters need to be specified.
    */
-  readonly bounding_box?: BoundingBoxWrite
+  readonly bounding_box?: BoundingBoxWrite | BoundingBoxArray
   /**
    * Specifies the graphical appearance (color) of the highlight box. Defaults to `"electricity"`.
    */
@@ -22141,7 +22141,7 @@ interface LuaSurface {
    * ```
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entities Online documentation}
    */
-  find_entities(area?: BoundingBoxWrite): LuaEntity[]
+  find_entities(area?: BoundingBoxWrite | BoundingBoxArray): LuaEntity[]
   /**
    * Find all entities of the given type or name in the given area.
    *
@@ -22164,7 +22164,7 @@ interface LuaSurface {
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entities_filtered Online documentation}
    */
   find_entities_filtered(params: {
-    readonly area?: BoundingBoxWrite
+    readonly area?: BoundingBoxWrite | BoundingBoxArray
     /**
      * Has precedence over area field.
      */
@@ -22195,7 +22195,7 @@ interface LuaSurface {
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_tiles_filtered Online documentation}
    */
   find_tiles_filtered(params: {
-    readonly area?: BoundingBoxWrite
+    readonly area?: BoundingBoxWrite | BoundingBoxArray
     /**
      * Ignored if not given with radius.
      */
@@ -22229,7 +22229,7 @@ interface LuaSurface {
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.count_entities_filtered Online documentation}
    */
   count_entities_filtered(params: {
-    readonly area?: BoundingBoxWrite
+    readonly area?: BoundingBoxWrite | BoundingBoxArray
     readonly position?: MapPosition | MapPositionArray
     /**
      * If given with position, will count all entities within the radius of the position.
@@ -22258,7 +22258,7 @@ interface LuaSurface {
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.count_tiles_filtered Online documentation}
    */
   count_tiles_filtered(params: {
-    readonly area?: BoundingBoxWrite
+    readonly area?: BoundingBoxWrite | BoundingBoxArray
     /**
      * Ignored if not given with radius.
      */
@@ -22314,7 +22314,7 @@ interface LuaSurface {
    */
   find_non_colliding_position_in_box(
     name: string,
-    search_space: BoundingBoxWrite,
+    search_space: BoundingBoxWrite | BoundingBoxArray,
     precision: double,
     force_to_tile_center?: boolean
   ): MapPosition | nil
@@ -22368,7 +22368,7 @@ interface LuaSurface {
     /**
      * Box to find units within.
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * Force performing the search.
      */
@@ -22656,7 +22656,7 @@ interface LuaSurface {
     /**
      * The area to mark for deconstruction.
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * The force whose bots should perform the deconstruction.
      */
@@ -22685,7 +22685,7 @@ interface LuaSurface {
     /**
      * The area to cancel deconstruction orders in.
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * The force whose deconstruction orders to cancel.
      */
@@ -22714,7 +22714,7 @@ interface LuaSurface {
     /**
      * The area to mark for upgrade.
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * The force whose bots should perform the upgrade.
      */
@@ -22743,7 +22743,7 @@ interface LuaSurface {
     /**
      * The area to cancel upgrade orders in.
      */
-    readonly area: BoundingBoxWrite
+    readonly area: BoundingBoxWrite | BoundingBoxArray
     /**
      * The force whose upgrade orders to cancel.
      */
@@ -22825,7 +22825,7 @@ interface LuaSurface {
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.destroy_decoratives Online documentation}
    */
   destroy_decoratives(params: {
-    readonly area?: BoundingBoxWrite
+    readonly area?: BoundingBoxWrite | BoundingBoxArray
     readonly position?: TilePosition | TilePositionArray
     readonly name?: string | readonly string[] | LuaDecorativePrototype | readonly LuaDecorativePrototype[]
     readonly collision_mask?: CollisionMaskLayer | readonly CollisionMaskLayer[]
@@ -22866,7 +22866,7 @@ interface LuaSurface {
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_decoratives_filtered Online documentation}
    */
   find_decoratives_filtered(params: {
-    readonly area?: BoundingBoxWrite
+    readonly area?: BoundingBoxWrite | BoundingBoxArray
     readonly position?: TilePosition | TilePositionArray
     readonly name?: string | readonly string[] | LuaDecorativePrototype | readonly LuaDecorativePrototype[]
     readonly collision_mask?: CollisionMaskLayer | readonly CollisionMaskLayer[]
@@ -22934,8 +22934,8 @@ interface LuaSurface {
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.clone_area Online documentation}
    */
   clone_area(params: {
-    readonly source_area: BoundingBoxWrite
-    readonly destination_area: BoundingBoxWrite
+    readonly source_area: BoundingBoxWrite | BoundingBoxArray
+    readonly destination_area: BoundingBoxWrite | BoundingBoxArray
     readonly destination_surface?: SurfaceIdentification
     readonly destination_force?: LuaForce | string
     /**
@@ -23054,7 +23054,7 @@ interface LuaSurface {
     /**
      * The dimensions of the object that's supposed to travel the path.
      */
-    readonly bounding_box: BoundingBoxWrite
+    readonly bounding_box: BoundingBoxWrite | BoundingBoxArray
     /**
      * The list of masks the `bounding_box` collides with.
      */
@@ -23219,7 +23219,7 @@ interface LuaSurface {
    * @param area The tile area.
    * @see {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.build_checkerboard Online documentation}
    */
-  build_checkerboard(area: BoundingBoxWrite): void
+  build_checkerboard(area: BoundingBoxWrite | BoundingBoxArray): void
   /**
    * The name of this surface. Names are unique among surfaces.
    * @remarks the default surface can't be renamed.

package/generated/concepts.d.ts

@@ -351,7 +351,7 @@ interface ScriptArea {
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#ScriptArea Online documentation}
  */
 interface ScriptAreaWrite {
-  readonly area: BoundingBoxWrite
+  readonly area: BoundingBoxWrite | BoundingBoxArray
   readonly name: string
   readonly color: Color | ColorArray
   readonly id: uint
@@ -1144,8 +1144,8 @@ interface BlueprintEntity {
   readonly output_priority?: "right" | "left"
   /** Filter of the splitter. Name of the item prototype the filter is set to. */
   readonly filter?: string
-  /** Filters of the filter inserter or loader. Array of {@link BlueprintItemFilter Item filter} objects. */
-  readonly filters?: BlueprintItemFilter[]
+  /** Filters of the filter inserter or loader. Array of {@link InventoryFilter} objects. */
+  readonly filters?: InventoryFilter[]
   /** Filter mode of the filter inserter. Either "whitelist" or "blacklist". */
   readonly filter_mode?: "whitelist" | "blacklist"
   /** The stack size the inserter is set to. */
@@ -1155,13 +1155,13 @@ interface BlueprintEntity {
   /** The pickup position the inserter is set to. */
   readonly pickup_position?: MapPosition
   /** Used by {@link https://wiki.factorio.com/Prototype/LogisticContainer Prototype/LogisticContainer}. */
-  readonly request_filters?: BlueprintLogisticFilter[]
+  readonly request_filters?: LogisticFilter[]
   /** Whether this requester chest can request from buffer chests. */
   readonly request_from_buffers?: boolean
   /** Used by {@link https://wiki.factorio.com/Programmable_speaker Programmable speaker}. */
-  readonly parameters?: BlueprintSpeakerParameter
+  readonly parameters?: ProgrammableSpeakerParameters
   /** Used by {@link https://wiki.factorio.com/Programmable_speaker Programmable speaker}. */
-  readonly alert_parameters?: BlueprintSpeakerAlertParameter
+  readonly alert_parameters?: ProgrammableSpeakerAlertParameters
   /** Used by the rocket silo, whether auto launch is enabled. */
   readonly auto_launch?: boolean
   /** Used by {@link https://wiki.factorio.com/Prototype/SimpleEntityWithForce Prototype/SimpleEntityWithForce} or {@link https://wiki.factorio.com/Prototype/SimpleEntityWithOwner Prototype/SimpleEntityWithOwner}. */
@@ -1215,63 +1215,58 @@ interface BlueprintCircuitConnection {
 }
 
 interface BlueprintInventory {
-  readonly filters?: BlueprintItemFilter[]
+  readonly filters?: InventoryFilter[]
   /** The index of the first inaccessible item slot due to limiting with the red "bar". 0-based. */
   readonly bar?: uint16
 }
 
-interface BlueprintItemFilter {
-  /** Name of the item prototype this filter is set to. */
-  readonly name: string
-  /** Index of the filter, 1-based. */
-  readonly index: uint
-}
-
 interface BlueprintInfinitySettings {
   /** Whether the "remove unfiltered items" checkbox is checked. */
   readonly remove_unfiltered_items: boolean
   /** Filters of the infinity container. */
-  readonly filters?: BlueprintInfinityFilter[]
-}
-
-interface BlueprintInfinityFilter {
-  /** Name of the item prototype this filter is set to. */
-  readonly name: string
-  /** Number the filter is set to. */
-  readonly count: uint
-  /** Mode of the filter. Either "at-least", "at-most", or "exactly". */
-  readonly mode: "at-least" | "at-most" | "exactly"
-  /** Index of the filter, 1-based. */
-  readonly index: uint
-}
-
-interface BlueprintLogisticFilter {
-  /** Name of the item prototype this filter is set to. */
-  readonly name: string
-  /** Index of the filter, 1-based. */
-  readonly index: uint
-  /** Number the filter is set to. Is 0 for storage chests. */
-  readonly count: uint
+  readonly filters?: InfinityInventoryFilter[]
 }
 
-interface BlueprintSpeakerParameter {
-  /** Volume of the speaker. */
-  readonly playback_volume: double
-  /** Whether global playback is enabled. */
-  readonly playback_globally: boolean
-  /** Whether polyphony is allowed. */
-  readonly allow_polyphony: boolean
-}
-
-interface BlueprintSpeakerAlertParameter {
-  /** Whether an alert is shown. */
-  readonly show_alert: boolean
-  /** Whether an alert icon is shown on the map. */
-  readonly show_on_map: boolean
-  /** The icon that is displayed with the alert. */
-  readonly icon_signal_id: SignalID
-  /** Message of the alert. */
-  readonly alert_message: string
+interface BlueprintControlBehavior {
+  readonly condition?: CircuitCondition
+  readonly circuit_condition?: CircuitCondition
+  readonly filters?: Signal[]
+  readonly is_on?: boolean
+  readonly arithmetic_conditions?: ArithmeticCombinatorParameters
+  readonly decider_conditions?: DeciderCombinatorParameters
+  readonly circuit_enable_disable?: boolean
+  readonly circuit_read_resources?: boolean
+  readonly circuit_resource_read_mode?: defines.control_behavior.mining_drill.resource_read_mode
+  readonly read_stopped_train?: boolean
+  readonly train_stopped_signal?: SignalID
+  readonly read_from_train?: boolean
+  readonly send_to_train?: boolean
+  readonly circuit_mode_of_operation?:
+    | defines.control_behavior.inserter.circuit_mode_of_operation
+    | defines.control_behavior.logistic_container.circuit_mode_of_operation
+    | defines.control_behavior.lamp.circuit_mode_of_operation
+  readonly circuit_read_hand_contents?: boolean
+  readonly circuit_hand_read_mode?: defines.control_behavior.inserter.hand_read_mode
+  readonly circuit_set_stack_size?: boolean
+  readonly stack_control_input_signal?: SignalID
+  readonly use_colors?: boolean
+  readonly read_robot_stats?: boolean
+  readonly read_logistics?: boolean
+  readonly available_logistic_output_signal?: boolean
+  readonly total_logistic_output_signal?: boolean
+  readonly available_construction_output_signal?: boolean
+  readonly total_construction_output_signal?: boolean
+  readonly circuit_contents_read_mode?: defines.control_behavior.transport_belt.content_read_mode
+  readonly output_signal?: SignalID
+  readonly circuit_close_signal?: boolean
+  readonly circuit_read_signal?: boolean
+  readonly red_output_signal?: SignalID
+  readonly orange_output_signal?: SignalID
+  readonly green_output_signal?: SignalID
+  readonly blue_output_signal?: SignalID
+  readonly circuit_open_gate?: boolean
+  readonly circuit_read_sensor?: boolean
+  readonly circuit_parameters?: ProgrammableSpeakerCircuitParameters
 }
 
 /**
@@ -1335,8 +1330,8 @@ interface BlueprintEntityWrite {
   readonly output_priority?: "right" | "left"
   /** Filter of the splitter. Name of the item prototype the filter is set to. */
   readonly filter?: string
-  /** Filters of the filter inserter or loader. Array of {@link BlueprintItemFilter Item filter} objects. */
-  readonly filters?: BlueprintItemFilter[]
+  /** Filters of the filter inserter or loader. Array of {@link InventoryFilter} objects. */
+  readonly filters?: InventoryFilter[]
   /** Filter mode of the filter inserter. Either "whitelist" or "blacklist". */
   readonly filter_mode?: "whitelist" | "blacklist"
   /** The stack size the inserter is set to. */
@@ -1346,13 +1341,13 @@ interface BlueprintEntityWrite {
   /** The pickup position the inserter is set to. */
   readonly pickup_position?: MapPosition
   /** Used by {@link https://wiki.factorio.com/Prototype/LogisticContainer Prototype/LogisticContainer}. */
-  readonly request_filters?: BlueprintLogisticFilter[]
+  readonly request_filters?: LogisticFilter[]
   /** Whether this requester chest can request from buffer chests. */
   readonly request_from_buffers?: boolean
   /** Used by {@link https://wiki.factorio.com/Programmable_speaker Programmable speaker}. */
-  readonly parameters?: BlueprintSpeakerParameter
+  readonly parameters?: ProgrammableSpeakerParameters
   /** Used by {@link https://wiki.factorio.com/Programmable_speaker Programmable speaker}. */
-  readonly alert_parameters?: BlueprintSpeakerAlertParameter
+  readonly alert_parameters?: ProgrammableSpeakerAlertParameters
   /** Used by the rocket silo, whether auto launch is enabled. */
   readonly auto_launch?: boolean
   /** Used by {@link https://wiki.factorio.com/Prototype/SimpleEntityWithForce Prototype/SimpleEntityWithForce} or {@link https://wiki.factorio.com/Prototype/SimpleEntityWithOwner Prototype/SimpleEntityWithOwner}. */
@@ -8847,45 +8842,3 @@ type RaiseableEvents =
   | typeof defines.events.script_raised_destroy
   | typeof defines.events.script_raised_revive
   | typeof defines.events.script_raised_set_tiles
-
-interface BlueprintControlBehavior {
-  readonly condition?: CircuitCondition
-  readonly circuit_condition?: CircuitCondition
-  readonly filters?: Signal[]
-  readonly is_on?: boolean
-  readonly arithmetic_conditions?: ArithmeticCombinatorParameters
-  readonly decider_conditions?: DeciderCombinatorParameters
-  readonly circuit_enable_disable?: boolean
-  readonly circuit_read_resources?: boolean
-  readonly circuit_resource_read_mode?: defines.control_behavior.mining_drill.resource_read_mode
-  readonly read_stopped_train?: boolean
-  readonly train_stopped_signal?: SignalID
-  readonly read_from_train?: boolean
-  readonly send_to_train?: boolean
-  readonly circuit_mode_of_operation?:
-    | defines.control_behavior.inserter.circuit_mode_of_operation
-    | defines.control_behavior.logistic_container.circuit_mode_of_operation
-    | defines.control_behavior.lamp.circuit_mode_of_operation
-  readonly circuit_read_hand_contents?: boolean
-  readonly circuit_hand_read_mode?: defines.control_behavior.inserter.hand_read_mode
-  readonly circuit_set_stack_size?: boolean
-  readonly stack_control_input_signal?: SignalID
-  readonly use_colors?: boolean
-  readonly read_robot_stats?: boolean
-  readonly read_logistics?: boolean
-  readonly available_logistic_output_signal?: boolean
-  readonly total_logistic_output_signal?: boolean
-  readonly available_construction_output_signal?: boolean
-  readonly total_construction_output_signal?: boolean
-  readonly circuit_contents_read_mode?: defines.control_behavior.transport_belt.content_read_mode
-  readonly output_signal?: SignalID
-  readonly circuit_close_signal?: boolean
-  readonly circuit_read_signal?: boolean
-  readonly red_output_signal?: SignalID
-  readonly orange_output_signal?: SignalID
-  readonly green_output_signal?: SignalID
-  readonly blue_output_signal?: SignalID
-  readonly circuit_open_gate?: boolean
-  readonly circuit_read_sensor?: boolean
-  readonly circuit_parameters?: ProgrammableSpeakerCircuitParameters
-}

package/package.json

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