typed-factorio 1.16.0 → 1.17.0

package/package.json

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

package/runtime/generated/classes.d.ts

@@ -4020,7 +4020,7 @@ interface LuaEntity extends LuaControl {
    * The storage filter for this logistic storage container.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.storage_filter Online documentation}
    */
-  storage_filter: LuaItemPrototype
+  storage_filter?: LuaItemPrototype
   /**
    * Whether this requester chest is set to also request from buffer chests.
    * @remarks Useable only on entities that have requester slots.
@@ -5165,7 +5165,7 @@ interface BaseEntity extends LuaControl {
    * The storage filter for this logistic storage container.
    * @see {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.storage_filter Online documentation}
    */
-  storage_filter: LuaItemPrototype
+  storage_filter?: LuaItemPrototype
   /**
    * Whether this requester chest is set to also request from buffer chests.
    * @remarks Useable only on entities that have requester slots.
@@ -10831,6 +10831,11 @@ interface LuaFluidBox extends Array<Fluid | nil> {
    * @see {@link https://lua-api.factorio.com/latest/LuaFluidBox.html#LuaFluidBox.get_connections Online documentation}
    */
   get_connections(index: uint): LuaFluidBox[]
+  /**
+   * Get the fluid box's connections and associated data.
+   * @see {@link https://lua-api.factorio.com/latest/LuaFluidBox.html#LuaFluidBox.get_pipe_connections Online documentation}
+   */
+  get_pipe_connections(index: uint): PipeConnection[]
   /**
    * Get a fluid box filter
    * @param index The index of the filter to get.
@@ -10864,6 +10869,12 @@ interface LuaFluidBox extends Array<Fluid | nil> {
    * @see {@link https://lua-api.factorio.com/latest/LuaFluidBox.html#LuaFluidBox.get_fluid_system_id Online documentation}
    */
   get_fluid_system_id(index: uint): uint | nil
+  /**
+   * Gets counts of all fluids in the fluid system. May return `nil` for fluid wagon, fluid turret's internal buffer, or a fluidbox which does not belong to a fluid system.
+   * @returns The counts, indexed by fluid name.
+   * @see {@link https://lua-api.factorio.com/latest/LuaFluidBox.html#LuaFluidBox.get_fluid_system_contents Online documentation}
+   */
+  get_fluid_system_contents(index: uint): Record<string, uint> | nil
   /**
    * Flushes all fluid from this fluidbox and its fluid system.
    * @param fluid If provided, only this fluid is flushed.
@@ -20263,6 +20274,10 @@ interface LuaRendering {
      * Length of the dashes that this line has. Used only if gap_length > 0. Default is 0.
      */
     readonly dash_length?: double
+    /**
+     * Starting offset to apply to dashes. Cannot be greater than dash_length + gap_length. Default is 0.
+     */
+    readonly dash_offset?: double
     readonly from: (MapPosition | MapPositionArray) | LuaEntity
     /**
      * Only used if `from` is a LuaEntity.
@@ -20610,6 +20625,9 @@ interface LuaRendering {
      */
     readonly y_scale?: double
     readonly tint?: Color | ColorArray
+    /**
+     * Render layer of the sprite. Defaults to `"arrow"`.
+     */
     readonly render_layer?: RenderLayer
     /**
      * If given, the sprite rotates so that it faces this target. Note that `orientation` is still applied to the sprite.
@@ -20742,6 +20760,9 @@ interface LuaRendering {
      */
     readonly y_scale?: double
     readonly tint?: Color | ColorArray
+    /**
+     * Render layer of the animation. Defaults to `"arrow"`.
+     */
     readonly render_layer?: RenderLayer
     /**
      * How many frames the animation goes forward per tick. Default is 1.

package/runtime/generated/concepts.d.ts

@@ -627,6 +627,11 @@ interface GameViewSettings {
    * @see {@link https://lua-api.factorio.com/latest/Concepts.html#GameViewSettings#GameViewSettings.show_map_view_options Online documentation}
    */
   show_map_view_options: boolean
+  /**
+   * Shows or hides the tooltip that is displayed when selecting an entity.
+   * @see {@link https://lua-api.factorio.com/latest/Concepts.html#GameViewSettings#GameViewSettings.show_entity_tooltip Online documentation}
+   */
+  show_entity_tooltip: boolean
   /**
    * Shows or hides quickbar of shortcuts.
    * @see {@link https://lua-api.factorio.com/latest/Concepts.html#GameViewSettings#GameViewSettings.show_quickbar Online documentation}
@@ -637,6 +642,21 @@ interface GameViewSettings {
    * @see {@link https://lua-api.factorio.com/latest/Concepts.html#GameViewSettings#GameViewSettings.show_shortcut_bar Online documentation}
    */
   show_shortcut_bar: boolean
+  /**
+   * Shows or hides the crafting queue.
+   * @see {@link https://lua-api.factorio.com/latest/Concepts.html#GameViewSettings#GameViewSettings.show_crafting_queue Online documentation}
+   */
+  show_crafting_queue: boolean
+  /**
+   * Shows or hides the tool window with the weapons and armor.
+   * @see {@link https://lua-api.factorio.com/latest/Concepts.html#GameViewSettings#GameViewSettings.show_tool_bar Online documentation}
+   */
+  show_tool_bar: boolean
+  /**
+   * Shows or hides the mouse and keyboard/controller button hints in the bottom left corner if they are enabled in the interface settings.
+   * @see {@link https://lua-api.factorio.com/latest/Concepts.html#GameViewSettings#GameViewSettings.show_hotkey_suggestions Online documentation}
+   */
+  show_hotkey_suggestions: boolean
 }
 
 /**
@@ -2387,7 +2407,7 @@ interface HeatConnection {
  */
 interface FluidBoxConnection {
   /**
-   * The connection type: "input", "output", or "input-output".
+   * One of "input", "output", or "input-output".
    */
   readonly type: "input" | "output" | "input-output"
   /**
@@ -2400,6 +2420,37 @@ interface FluidBoxConnection {
   readonly max_underground_distance?: uint
 }
 
+/**
+ * A single pipe connection for a given fluidbox.
+ * @see {@link https://lua-api.factorio.com/latest/Concepts.html#PipeConnection Online documentation}
+ */
+interface PipeConnection {
+  /**
+   * One of "input", "output", or "input-output".
+   */
+  readonly flow_direction: "input" | "output" | "input-output"
+  /**
+   * One of "normal" or "underground".
+   */
+  readonly connection_type: "normal" | "underground"
+  /**
+   * The absolute position of this connection within the entity.
+   */
+  readonly position: MapPosition
+  /**
+   * The absolute position of the connection's intended target.
+   */
+  readonly target_position: MapPosition
+  /**
+   * The connected fluidbox, if any.
+   */
+  readonly target?: LuaFluidBox
+  /**
+   * The index of the connected fluidbox, if any.
+   */
+  readonly target_index?: uint
+}
+
 interface ArithmeticCombinatorParameters {
   /**
    * First signal to use in an operation. If not specified, the second argument will be the value of `first_constant`.

package/runtime/generated/events.d.ts

@@ -554,6 +554,7 @@ interface OnEntityClonedEvent extends EventData {
 
 /**
  * Called after an entity has been recolored either by the player or through script.
+ * @remarks Automatic recoloring due to {@link LuaPlayer#color LuaPlayer::color} will not raise events, as that is a separate mechanism.
  * @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_color_changed Online documentation}
  */
 interface OnEntityColorChangedEvent extends EventData {