factorio-types 1.2.43 → 1.2.45

package/dist/events.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.60
+// Factorio version 2.0.62
 // API version 6
 
 declare namespace runtime {
@@ -1037,27 +1037,27 @@ interface on_gui_click {
  */
 interface on_gui_closed {
     /**
-     * The custom GUI element that was open
+     * The custom GUI element that was closed.
      */
     element?: LuaGuiElement;
     /**
-     * The entity that was open
+     * The entity or entity grid whose GUI was closed.
      */
     entity?: LuaEntity;
     /**
-     * The equipment that was open
+     * The equipment whose GUI was closed.
      */
     equipment?: LuaEquipment;
     /**
-     * The GUI type that was open.
+     * The type of GUI that was closed.
      */
     gui_type: defines.gui_type;
     /**
-     * The script inventory that was open
+     * The script inventory whose GUI was closed.
      */
     inventory?: LuaInventory;
     /**
-     * The item that was open
+     * The item whose GUI was closed.
      */
     item?: LuaItemStack;
     /**
@@ -1065,23 +1065,23 @@ interface on_gui_closed {
      */
     name: defines.events;
     /**
-     * The other player that was open
+     * The other player whose GUI was closed.
      */
     other_player?: LuaPlayer;
     /**
-     * The player.
+     * The player closing the GUI.
      */
     player_index: uint;
     /**
-     * The technology that was automatically selected when opening the research GUI
+     * The surface index of the global electric network whose GUI was closed.
      */
-    technology?: LuaTechnology;
+    surface_index?: uint;
     /**
      * Tick the event was generated.
      */
     tick: uint;
     /**
-     * The tile position that was open
+     * The position of the tile whose GUI was closed.
      */
     tile_position?: TilePosition;
 }
@@ -1211,27 +1211,27 @@ interface on_gui_location_changed {
  */
 interface on_gui_opened {
     /**
-     * The custom GUI element that was opened
+     * The custom GUI element that was opened.
      */
     element?: LuaGuiElement;
     /**
-     * The entity that was opened
+     * The entity or entity grid whose GUI was opened.
      */
     entity?: LuaEntity;
     /**
-     * The equipment that was opened
+     * The equipment whose GUI was opened.
      */
     equipment?: LuaEquipment;
     /**
-     * The GUI type that was opened.
+     * The type of GUI that was opened.
      */
     gui_type: defines.gui_type;
     /**
-     * The script inventory that was opened
+     * The script inventory whose GUI was opened.
      */
     inventory?: LuaInventory;
     /**
-     * The item that was opened
+     * The item whose GUI was opened.
      */
     item?: LuaItemStack;
     /**
@@ -1239,17 +1239,25 @@ interface on_gui_opened {
      */
     name: defines.events;
     /**
-     * The other player that was opened
+     * The other player whose GUI was opened.
      */
     other_player?: LuaPlayer;
     /**
-     * The player.
+     * The player closing the GUI.
      */
     player_index: uint;
+    /**
+     * The surface index of the global electric network whose GUI was opened.
+     */
+    surface_index?: uint;
     /**
      * Tick the event was generated.
      */
     tick: uint;
+    /**
+     * The position of the tile whose GUI was opened.
+     */
+    tile_position?: TilePosition;
 }
 /**
  * Called when {@link LuaGuiElement | runtime:LuaGuiElement} selected tab is changed (related to tabbed-panes).
@@ -1626,7 +1634,7 @@ interface on_permission_string_imported {
  * Called when a player picks up an item.
  */
 interface on_picked_up_item {
-    item_stack: ItemWithCount;
+    item_stack: ItemWithQualityCount;
     /**
      * Identifier of the event
      */
@@ -2470,7 +2478,7 @@ interface on_player_mined_item {
     /**
      * The item given to the player
      */
-    item_stack: ItemWithQualityCounts;
+    item_stack: ItemWithQualityCount;
     /**
      * Identifier of the event
      */
@@ -3024,6 +3032,47 @@ interface on_post_entity_died {
      */
     unit_number?: uint;
 }
+/**
+ * Called after a segmented unit dies.
+ */
+interface on_post_segmented_unit_died {
+    /**
+     * The damage type that did the killing if any.
+     */
+    damage_type?: LuaDamagePrototype;
+    /**
+     * The force that did the killing if any.
+     */
+    force?: LuaForce;
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The prototype of the unit that died.
+     */
+    prototype: LuaEntityPrototype;
+    /**
+     * The quality of the unit that died.
+     */
+    quality: LuaQualityPrototype;
+    /**
+     * Information about each of the unit's individual segments when it died.
+     */
+    segments: PostSegmentDiedData;
+    /**
+     * The surface the entity was on.
+     */
+    surface_index: uint;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+    /**
+     * The unit number of the unit that died.
+     */
+    unit_number: uint;
+}
 /**
  * Called when players uses an item to build something. Called before {@link on_built_entity | runtime:on_built_entity}.
  */
@@ -3658,7 +3707,7 @@ interface on_robot_mined {
     /**
      * The entity the robot just picked up.
      */
-    item_stack: ItemWithCount;
+    item_stack: ItemWithQualityCount;
     /**
      * Identifier of the event
      */
@@ -3931,6 +3980,99 @@ interface on_segment_entity_created {
      */
     tick: uint;
 }
+/**
+ * Called when a segmented unit is created for any reason.
+ */
+interface on_segmented_unit_created {
+    /**
+     * The reason that the segmented unit was created.
+     */
+    cause: defines.segmented_unit_created_cause;
+    /**
+     * If the new segmented unit was cloned, the segmented unit from which the new unit was cloned.
+     */
+    clone_source?: LuaSegmentedUnit;
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The segmented unit that was created.
+     */
+    segmented_unit: LuaSegmentedUnit;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
+/**
+ * Called when a segmented unit is damaged. This is not called when a segmented unit's health is set directly by another mod.
+ */
+interface on_segmented_unit_damaged {
+    /**
+     * The entity that originally triggered the events that led to this damage, if available (e.g. the character, turret, etc. that pulled the trigger).
+     */
+    cause?: LuaEntity;
+    damage_type: LuaDamagePrototype;
+    /**
+     * The damage amount after resistances.
+     */
+    final_damage_amount: float;
+    /**
+     * The health of the unit after the damage was applied.
+     */
+    final_health: float;
+    /**
+     * The force that did the attacking.
+     */
+    force?: LuaForce;
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The damage amount before resistances.
+     */
+    original_damage_amount: float;
+    segmented_unit: LuaSegmentedUnit;
+    /**
+     * The entity that is directly dealing the damage, if available (e.g. the projectile, flame, sticker, grenade, laser beam, etc.).
+     */
+    source?: LuaEntity;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
+/**
+ * Called when a segmented unit dies.
+ */
+interface on_segmented_unit_died {
+    /**
+     * The entity that did the killing if available.
+     */
+    cause?: LuaEntity;
+    /**
+     * The damage type if any.
+     */
+    damage_type?: LuaDamagePrototype;
+    /**
+     * The force that did the killing if any.
+     */
+    force?: LuaForce;
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The unit that died.
+     */
+    segmented_unit: LuaSegmentedUnit;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
 /**
  * Called after the selected entity changes for a given player.
  */
@@ -4086,7 +4228,7 @@ interface on_space_platform_mined_item {
     /**
      * The entity the platform just picked up.
      */
-    item_stack: ItemWithCount;
+    item_stack: ItemWithQualityCount;
     /**
      * Identifier of the event
      */
@@ -4288,6 +4430,44 @@ interface on_technology_effects_reset {
      */
     tick: uint;
 }
+/**
+ * Called when a territory is created for any reason.
+ */
+interface on_territory_created {
+    /**
+     * The reason the territory was created.
+     */
+    cause: defines.territory_created_cause;
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The territory that was created.
+     */
+    territory: LuaTerritory;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
+/**
+ * Called when a territory is destroyed from a surface.
+ */
+interface on_territory_destroyed {
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The territory that will be destroyed. This object will be valid so that you can still read and modify its properties before it is finally destroyed.
+     */
+    territory: LuaTerritory;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
 /**
  * It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
  */
@@ -4301,6 +4481,81 @@ interface on_tick {
      */
     tick: uint;
 }
+/**
+ * Called after the results of an entity being mined are collected just before the entity is destroyed.
+ *
+ * After this event any items in the buffer will be transferred into the tower as if they came from mining the entity.
+ *
+ * The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding as more items are transferred into it.
+ */
+interface on_tower_mined_plant {
+    /**
+     * The temporary inventory that holds the result of mining the entity.
+     */
+    buffer: LuaInventory;
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The entity that has been mined.
+     */
+    plant: LuaEntity;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+    /**
+     * The tower doing the mining.
+     */
+    tower: LuaEntity;
+}
+/**
+ * Called before an agricultural tower planets a seed.
+ */
+interface on_tower_planted_seed {
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The plant which was planted.
+     */
+    plant: LuaEntity;
+    /**
+     * The seed that was used.
+     */
+    seed: ItemIDAndQualityIDPair;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+    /**
+     * The tower that's did the planting.
+     */
+    tower: LuaEntity;
+}
+/**
+ * Called before an agricultural tower mines a plant.
+ */
+interface on_tower_pre_mined_plant {
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The plant which is about to be mined.
+     */
+    plant: LuaEntity;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+    /**
+     * The tower that's about to do the mining.
+     */
+    tower: LuaEntity;
+}
 /**
  * Called when a train changes state (started to stopped and vice versa)
  */
@@ -4538,6 +4793,23 @@ interface script_raised_destroy {
      */
     tick: uint;
 }
+/**
+ * A static event that mods can use to tell other mods they destroyed a segmented unit by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event}, or {@link LuaBootstrap::raise_script_destroy_segmented_unit | runtime:LuaBootstrap::raise_script_destroy_segmented_unit}, or when `raise_destroy` is passed to {@link LuaSegmentedUnit::destroy | runtime:LuaSegmentedUnit::destroy}.
+ */
+interface script_raised_destroy_segmented_unit {
+    /**
+     * Identifier of the event
+     */
+    name: defines.events;
+    /**
+     * The segmented unit that was destroyed.
+     */
+    segmented_unit: LuaSegmentedUnit;
+    /**
+     * Tick the event was generated.
+     */
+    tick: uint;
+}
 /**
  * A static event mods can use to tell other mods they revived something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_revive | runtime:LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to {@link LuaEntity::revive | runtime:LuaEntity::revive}.
  */

package/dist/global.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.60
+// Factorio version 2.0.62
 // API version 6
 
 /**

package/dist/prototypes.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.60
+// Factorio version 2.0.62
 // API version 6
 
 declare namespace prototype {
@@ -1404,7 +1404,7 @@ interface CargoLandingPadPrototype extends EntityWithOwnerPrototype {
      */
     robot_animation?: Animation;
     /**
-     * Played when a robot brings/takes items from this landing pad. Ignored if `robot_animation` is not defined.
+     * Played when a robot brings/takes items from this landing pad. Only loaded if `robot_animation` is defined.
      */
     robot_animation_sound?: Sound;
     /**
@@ -5038,14 +5038,18 @@ interface LabPrototype extends EntityWithOwnerPrototype {
   type = "lamp",
   name = "small-lamp",
   icon = "__base__/graphics/icons/small-lamp.png",
-  icon_size = 64,
   flags = {"placeable-neutral", "player-creation"},
+  fast_replaceable_group = "lamp",
   minable = {mining_time = 0.1, result = "small-lamp"},
   max_health = 100,
   corpse = "lamp-remnants",
   dying_explosion = "lamp-explosion",
   collision_box = {{-0.15, -0.15}, {0.15, 0.15}},
   selection_box = {{-0.5, -0.5}, {0.5, 0.5}},
+  damaged_trigger_effect = hit_effects.entity(),
+  impact_category = "glass",
+  open_sound = {filename = "__base__/sound/open-close/electric-small-open.ogg", volume = 0.7},
+  close_sound = {filename = "__base__/sound/open-close/electric-small-close.ogg", volume = 0.7},
   energy_source =
   {
     type = "electric",
@@ -5054,8 +5058,8 @@ interface LabPrototype extends EntityWithOwnerPrototype {
   energy_usage_per_tick = "5kW",
   darkness_for_all_lamps_on = 0.5,
   darkness_for_all_lamps_off = 0.3,
-  light = {intensity = 0.9, size = 40, color = {r=1.0, g=1.0, b=0.75}},
-  light_when_colored = {intensity = 0, size = 6, color = {r=1.0, g=1.0, b=0.75}},
+  light = {intensity = 0.9, size = 40, color = {1, 1, 0.75}},
+  light_when_colored = {intensity = 0, size = 6, color = {1, 1, 0.75}},
   glow_size = 6,
   glow_color_intensity = 1,
   glow_render_mode = "multiplicative",
@@ -5066,23 +5070,19 @@ interface LabPrototype extends EntityWithOwnerPrototype {
       {
         filename = "__base__/graphics/entity/small-lamp/lamp.png",
         priority = "high",
-        width = 42,
-        height = 36,
-        frame_count = 1,
-        axially_symmetrical = false,
-        direction_count = 1,
-        shift = util.by_pixel(0,3)
+        width = 83,
+        height = 70,
+        shift = util.by_pixel(0.25,3),
+        scale = 0.5
       },
       {
         filename = "__base__/graphics/entity/small-lamp/lamp-shadow.png",
         priority = "high",
-        width = 38,
-        height = 24,
-        frame_count = 1,
-        axially_symmetrical = false,
-        direction_count = 1,
-        shift = util.by_pixel(4,5),
-        draw_as_shadow = true
+        width = 76,
+        height = 47,
+        shift = util.by_pixel(4, 4.75),
+        draw_as_shadow = true,
+        scale = 0.5
       }
     }
   },
@@ -5090,23 +5090,27 @@ interface LabPrototype extends EntityWithOwnerPrototype {
   {
     filename = "__base__/graphics/entity/small-lamp/lamp-light.png",
     priority = "high",
-    width = 46,
-    height = 40,
-    frame_count = 1,
-    axially_symmetrical = false,
-    direction_count = 1,
-    shift = util.by_pixel(0, -7)
+    width = 90,
+    height = 78,
+    shift = util.by_pixel(0, -7),
+    scale = 0.5
   },
   signal_to_color_mapping =
   {
-    {type = "virtual", name = "signal-red",    color = {r = 1, g = 0, b = 0}},
-    {type = "virtual", name = "signal-green",  color = {r = 0, g = 1, b = 0}},
-    {type = "virtual", name = "signal-blue",   color = {r = 0, g = 0, b = 1}},
-    {type = "virtual", name = "signal-yellow", color = {r = 1, g = 1, b = 0}},
-    {type = "virtual", name = "signal-pink",   color = {r = 1, g = 0, b = 1}},
-    {type = "virtual", name = "signal-cyan",   color = {r = 0, g = 1, b = 1}},
-    {type = "virtual", name = "signal-white",  color = {r = 1, g = 1, b = 1}}
+    {type = "virtual", name = "signal-red",    color = {1, 0, 0}},
+    {type = "virtual", name = "signal-green",  color = {0, 1, 0}},
+    {type = "virtual", name = "signal-blue",   color = {0, 0, 1}},
+    {type = "virtual", name = "signal-yellow", color = {1, 1, 0}},
+    {type = "virtual", name = "signal-pink",   color = {1, 0, 1}},
+    {type = "virtual", name = "signal-cyan",   color = {0, 1, 1}},
+    {type = "virtual", name = "signal-white",  color = {1, 1, 1}},
+    {type = "virtual", name = "signal-grey",   color = {0.5, 0.5, 0.5}},
+    {type = "virtual", name = "signal-black",  color = {0, 0, 0}}
   },
+  default_red_signal = { type = "virtual", name = "signal-red" },
+  default_green_signal = { type = "virtual", name = "signal-green" },
+  default_blue_signal = { type = "virtual", name = "signal-blue" },
+  default_rgb_signal = { type = "virtual", name = "signal-white" },
 
   circuit_connector = circuit_connector_definitions["lamp"],
   circuit_wire_max_distance = default_circuit_wire_max_distance
@@ -5408,7 +5412,7 @@ interface LogisticContainerPrototype extends ContainerPrototype {
      */
     animation?: Animation;
     /**
-     * Played when a robot brings/takes items from this container. Ignored if `animation` is not defined.
+     * Played when a robot brings/takes items from this container. Only loaded if `animation` is defined.
      */
     animation_sound?: Sound;
     /**
@@ -6522,6 +6526,8 @@ interface QualityPrototype extends Prototype {
     name: string;
     next?: QualityID;
     /**
+     * The quality {@link effect of the module | prototype:ModulePrototype::effect} is multiplied by this. For example, if a module's quality effect is 0.2 and the current quality's next_probability is 0.1, then the chance to get the next quality item is 2%.
+     *
      * Must be in range [0, 1.0].
      */
     next_probability?: double;
@@ -6939,6 +6945,7 @@ interface RecipePrototype extends Prototype {
      * The amount of time it takes to make this recipe. Must be `> 0.001`. Equals the number of seconds it takes to craft at crafting speed `1`.
      */
     energy_required?: double;
+    hide_from_bonus_gui?: boolean;
     /**
      * Hides the recipe from the player's crafting screen. The recipe will still show up for selection in machines.
      */
@@ -7864,7 +7871,7 @@ interface SegmentedUnitPrototype extends SegmentPrototype {
     /**
      * The number of ticks to remain enraged after last taking damage.
      */
-    enraged_duration: uint32;
+    enraged_duration: MapTick;
     /**
      * The movement speed while enraged, in tiles per tick. Cannot be negative.
      */
@@ -8446,6 +8453,10 @@ interface SpaceLocationPrototype extends Prototype {
      * Only loaded if `starmap_icons` is not defined.
      */
     starmap_icon?: FileName;
+    /**
+     * Orientation of the starmap icon, defaults to pointing towards the parent body.
+     */
+    starmap_icon_orientation?: RealOrientation;
     /**
      * The size of the starmap icon, in pixels. E.g. `32` for a 32px by 32px icon. Must be larger than `0`.
      *
@@ -9973,7 +9984,7 @@ interface UtilityConstants extends PrototypeBase {
     asteroid_collector_max_nurbs_control_point_separation: double;
     asteroid_collector_navmesh_refresh_tick_interval: uint32;
     asteroid_collector_static_head_swing_segment_count: uint32;
-    asteroid_collector_static_head_swing_strength_scale: double;
+    asteroid_collector_static_head_swing_strength_scale: float;
     asteroid_fading_range: float;
     asteroid_position_offset_to_speed_coefficient: double;
     asteroid_spawning_offset: SimpleBoundingBox;