typed-factorio 1.8.0 → 1.9.0

package/{generated → runtime/generated}/concepts.d.ts

@@ -654,7 +654,7 @@ interface PollutionMapSettings {
   /**
    * The amount of pollution eaten by a chunk's tiles as a percentage of 1. Defaults to `1`.
    */
-  readonly aeging: double
+  readonly ageing: double
   /**
    * Any amount of pollution larger than this value is visualized as this value instead. Defaults to `150`.
    */
@@ -3166,11 +3166,11 @@ interface WaitCondition {
    */
   readonly compare_type: "and" | "or"
   /**
-   * Number of ticks to wait or of inactivity. Only present when `type` is `"time"` or `"inactivity"`.
+   * Number of ticks to wait when `type` is `"time"`, or number of ticks of inactivity when `type` is `"inactivity"`.
    */
   readonly ticks?: uint
   /**
-   * Only present when `type` is `"item_count"`, `"circuit"` or `"fluid_count"`.
+   * Only present when `type` is `"item_count"`, `"circuit"` or `"fluid_count"`, and a circuit condition is configured.
    */
   readonly condition?: CircuitCondition
 }
@@ -3199,11 +3199,11 @@ interface WaitConditionWrite {
    */
   readonly compare_type: "and" | "or"
   /**
-   * Number of ticks to wait or of inactivity. Only present when `type` is `"time"` or `"inactivity"`.
+   * Number of ticks to wait when `type` is `"time"`, or number of ticks of inactivity when `type` is `"inactivity"`.
    */
   readonly ticks?: uint
   /**
-   * Only present when `type` is `"item_count"`, `"circuit"` or `"fluid_count"`.
+   * Only present when `type` is `"item_count"`, `"circuit"` or `"fluid_count"`, and a circuit condition is configured.
    */
   readonly condition?: CircuitConditionWrite
 }
@@ -3537,7 +3537,7 @@ interface ModuleEffects {
 }
 
 /**
- * A set of flags. Set flags are in the dictionary as `true`, while unset flags aren't present at all.
+ * A set of flags. Active flags are in the dictionary as `true`, while inactive flags aren't present at all.
  *
  * By default, none of these flags are set.
  *
@@ -3675,7 +3675,7 @@ interface EntityPrototypeFlags {
 }
 
 /**
- * A set of flags. Set flags are in the dictionary as `true`, while unset flags aren't present at all.
+ * A set of flags. Active flags are in the dictionary as `true`, while inactive flags aren't present at all.
  *
  * By default, none of these flags are set.
  *
@@ -3778,7 +3778,7 @@ type CollisionMaskLayer =
   | `layer-${bigint}`
 
 /**
- * A set of flags. Set flags are in the dictionary as `true`, while unset flags aren't present at all.
+ * A set of flags. Active flags are in the dictionary as `true`, while inactive flags aren't present at all.
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#CollisionMask Online documentation}
  */
 type CollisionMask = {
@@ -4018,87 +4018,198 @@ interface OtherAttackParameters extends BaseAttackParameters {
  */
 type AttackParameters = ProjectileAttackParameters | StreamAttackParameters | OtherAttackParameters
 
-interface CapsuleAction {
+interface BaseCapsuleAction {
   /**
-   * One of `"throw"`, `"equipment-remote"`, `"use-on-self"`.
+   * One of `"throw"`, `"equipment-remote"`, `"use-on-self"`, `"artillery-remote"`, `"destroy-cliffs"`.
    */
-  readonly type: "throw" | "equipment-remote" | "use-on-self"
+  readonly type: "throw" | "equipment-remote" | "use-on-self" | "artillery-remote" | "destroy-cliffs"
+}
+
+/**
+ * `"throw"` variant of {@link CapsuleAction}.
+ */
+interface ThrowCapsuleAction extends BaseCapsuleAction {
+  readonly type: "throw"
+  readonly attack_parameters: AttackParameters
+  /**
+   * Whether using the capsule consumes an item from the stack.
+   */
+  readonly uses_stack: boolean
+}
+
+/**
+ * `"equipment-remote"` variant of {@link CapsuleAction}.
+ */
+interface EquipmentRemoteCapsuleAction extends BaseCapsuleAction {
+  readonly type: "equipment-remote"
   /**
-   * Only present when `type` is `"throw"` or `"use-on-self"`.
+   * Name of the {@link LuaEquipmentPrototype}.
    */
-  readonly attack_parameters?: AttackParameters
+  readonly equipment: string
+}
+
+/**
+ * `"use-on-self"` variant of {@link CapsuleAction}.
+ */
+interface UseOnSelfCapsuleAction extends BaseCapsuleAction {
+  readonly type: "use-on-self"
+  readonly attack_parameters: AttackParameters
+}
+
+/**
+ * `"artillery-remote"` variant of {@link CapsuleAction}.
+ */
+interface ArtilleryRemoteCapsuleAction extends BaseCapsuleAction {
+  readonly type: "artillery-remote"
   /**
-   * Only present when `type` is `"equipment-remote"`. It is the equipment prototype name.
+   * Name of the {@link LuaEntityPrototype flare prototype}.
    */
-  readonly equipment?: string
+  readonly flare: string
+}
+
+/**
+ * `"destroy-cliffs"` variant of {@link CapsuleAction}.
+ */
+interface DestroyCliffsCapsuleAction extends BaseCapsuleAction {
+  readonly type: "destroy-cliffs"
+  readonly attack_parameters: AttackParameters
+  readonly radius: float
+  readonly timeout: uint
 }
 
 /**
- * A set of flags. Set flags are in the dictionary as `true`, while unset flags aren't present at all.
+ * Other attributes may be specified depending on `type`:
+ * - `"throw"`: {@link ThrowCapsuleAction}
+ * - `"equipment-remote"`: {@link EquipmentRemoteCapsuleAction}
+ * - `"use-on-self"`: {@link UseOnSelfCapsuleAction}
+ * - `"artillery-remote"`: {@link ArtilleryRemoteCapsuleAction}
+ * - `"destroy-cliffs"`: {@link DestroyCliffsCapsuleAction}
+ * @see {@link https://lua-api.factorio.com/latest/Concepts.html#CapsuleAction Online documentation}
+ */
+type CapsuleAction =
+  | ThrowCapsuleAction
+  | EquipmentRemoteCapsuleAction
+  | UseOnSelfCapsuleAction
+  | ArtilleryRemoteCapsuleAction
+  | DestroyCliffsCapsuleAction
+
+/**
+ * A set of flags on a selection tool that define how entities and tiles are selected. Active flags are in the dictionary as `true`, while inactive flags aren't present at all.
  *
  * **Options:**
- * - `"blueprint"`: Entities that can be selected for blueprint.
- * - `"deconstruct"`: Entities that can be marked for deconstruction.
- * - `"cancel-deconstruct"`: Entities that can be marked for deconstruction cancelling.
- * - `"item"`
- * - `"trees"`
- * - `"buildable-type"`: Buildable entities.
- * - `"nothing"`: Only select an area.
- * - `"items-to-place"`: Entities that can be placed using an item.
- * - `"any-entity"`
- * - `"any-tile"`
- * - `"same-force"`: Entities with the same force as the selector.
- * - `"not-same-force"`
- * - `"friend"`
- * - `"enemy"`
- * - `"upgrade"`
- * - `"cancel-upgrade"`
- * - `"entity-with-health"`
- * - `"entity-with-force"`
- * - `"entity-with-owner"`
+ * - `"blueprint"`: Selects entities and tiles as if selecting them for a blueprint.
+ * - `"deconstruct"`: Selects entities and tiles as if selecting them for deconstruction.
+ * - `"cancel-deconstruct"`: Selects entities and tiles as if selecting them for deconstruction cancellation.
+ * - `"items"`: Selects items on the ground.
+ * - `"trees"`: Selects trees.
+ * - `"buildable-type"`: Selects entities which are considered a {@link LuaEntityPrototype#is_building building}, plus landmines.
+ * - `"nothing"`: Selects no entities or tiles, but is useful to select an area.
+ * - `"items-to-place"`: Selects entities and tiles that can be {@link LuaItemPrototype#place_result built by an item}.
+ * - `"any-entity"`: Selects all entities.
+ * - `"any-tile"`: Selects all tiles.
+ * - `"same-force"`: Selects entities with the same force as the selecting player.
+ * - `"not-same-force"`: Selects entities with a different force as the selecting player.
+ * - `"friend"`: Selects entities from a {@link LuaForce#is_friend friendly} force.
+ * - `"enemy"`: Selects entities from an {@link LuaForce#is_enemy enemy} force.
+ * - `"upgrade"`: Selects entities as if selecting them for upgrading.
+ * - `"cancel-upgrade"`: Selects entities as if selecting them for upgrade cancellation.
+ * - `"downgrade"`: Selects entities as if selecting them for downgrading.
+ * - `"entity-with-health"`: Selects entities that are {@link LuaEntity#is_entity_with_health entities with health}.
+ * - `"entity-with-force"`: Deprecated. Replaced by `is-military-target`.
+ * - `"is-military-target"`: Selects entities that are {@link LuaEntity#is_military_target military targets}.
+ * - `"entity-with-owner"`: Selects entities that are {@link LuaEntity#is_entity_with_owner entities with owner}.
+ * - `"avoid-rolling-stock"`: Selects entities that are not `rolling-stocks`.
  * @see {@link https://lua-api.factorio.com/latest/Concepts.html#SelectionModeFlags Online documentation}
  */
 interface SelectionModeFlags {
   /**
-   * Entities that can be selected for blueprint.
+   * Selects entities and tiles as if selecting them for a blueprint.
    */
   readonly blueprint?: true
   /**
-   * Entities that can be marked for deconstruction.
+   * Selects entities and tiles as if selecting them for deconstruction.
    */
   readonly deconstruct?: true
   /**
-   * Entities that can be marked for deconstruction cancelling.
+   * Selects entities and tiles as if selecting them for deconstruction cancellation.
    */
   readonly "cancel-deconstruct"?: true
-  readonly item?: true
+  /**
+   * Selects items on the ground.
+   */
+  readonly items?: true
+  /**
+   * Selects trees.
+   */
   readonly trees?: true
   /**
-   * Buildable entities.
+   * Selects entities which are considered a {@link LuaEntityPrototype#is_building building}, plus landmines.
    */
   readonly "buildable-type"?: true
   /**
-   * Only select an area.
+   * Selects no entities or tiles, but is useful to select an area.
    */
   readonly nothing?: true
   /**
-   * Entities that can be placed using an item.
+   * Selects entities and tiles that can be {@link LuaItemPrototype#place_result built by an item}.
    */
   readonly "items-to-place"?: true
+  /**
+   * Selects all entities.
+   */
   readonly "any-entity"?: true
+  /**
+   * Selects all tiles.
+   */
   readonly "any-tile"?: true
   /**
-   * Entities with the same force as the selector.
+   * Selects entities with the same force as the selecting player.
    */
   readonly "same-force"?: true
+  /**
+   * Selects entities with a different force as the selecting player.
+   */
   readonly "not-same-force"?: true
+  /**
+   * Selects entities from a {@link LuaForce#is_friend friendly} force.
+   */
   readonly friend?: true
+  /**
+   * Selects entities from an {@link LuaForce#is_enemy enemy} force.
+   */
   readonly enemy?: true
+  /**
+   * Selects entities as if selecting them for upgrading.
+   */
   readonly upgrade?: true
+  /**
+   * Selects entities as if selecting them for upgrade cancellation.
+   */
   readonly "cancel-upgrade"?: true
+  /**
+   * Selects entities as if selecting them for downgrading.
+   */
+  readonly downgrade?: true
+  /**
+   * Selects entities that are {@link LuaEntity#is_entity_with_health entities with health}.
+   */
   readonly "entity-with-health"?: true
+  /**
+   * Deprecated. Replaced by `is-military-target`.
+   */
   readonly "entity-with-force"?: true
+  /**
+   * Selects entities that are {@link LuaEntity#is_military_target military targets}.
+   */
+  readonly "is-military-target"?: true
+  /**
+   * Selects entities that are {@link LuaEntity#is_entity_with_owner entities with owner}.
+   */
   readonly "entity-with-owner"?: true
+  /**
+   * Selects entities that are not `rolling-stocks`.
+   */
+  readonly "avoid-rolling-stock"?: true
 }
 
 interface LogisticFilter {
@@ -4298,7 +4409,7 @@ interface ScriptRenderTarget {
 }
 
 /**
- * A set of flags. Set flags are in the dictionary as `true`, while unset flags aren't present at all.
+ * A set of flags. Active flags are in the dictionary as `true`, while inactive flags aren't present at all.
  *
  * To write to this, use an array[`string`] of the mouse buttons that should be possible to use with on button. The flag `"left-and-right"` can also be set, which will set `"left"` and `"right"` to `true`.
  *

package/{generated → runtime/generated}/events.d.ts

@@ -2056,7 +2056,8 @@ interface OnPlayerDisplayScaleChangedEvent extends EventData {
 }
 
 /**
- * Called when the player's driving state has changed, this means a player has either entered or left a vehicle.
+ * Called when the player's driving state has changed, meaning a player has either entered or left a vehicle.
+ * @remarks This event is not raised when the player is ejected from a vehicle due to it being destroyed.
  * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_driving_changed_state Online documentation}
  */
 interface OnPlayerDrivingChangedStateEvent extends EventData {
@@ -3094,7 +3095,7 @@ interface OnPrePlayerLeftGameEvent extends EventData {
 }
 
 /**
- * Called when the player finishes mining an entity, before the entity is removed from map. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter}.
+ * Called when the player completes a mining action, but before the entity is potentially removed from the map. This is called even if the entity does not end up being removed. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter}.
  * @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_mined_item Online documentation}
  */
 interface OnPrePlayerMinedItemEvent extends EventData {

package/{generated → runtime/generated}/global-functions.d.ts

@@ -27,7 +27,7 @@ declare function localised_print(string: LocalisedString): void
  * end
  * ```
  *
- * Note that `table_size()` does not work correctly for {@link LuaCustomTable}, their size has to be determined with {@link LuaCustomTable#length LuaCustomTable::length} instead.
+ * Note that `table_size()` does not work correctly for {@link LuaCustomTable}, their size has to be determined with {@link LuaCustomTable#length LuaCustomTable::length_operator} instead.
  * @see {@link https://lua-api.factorio.com/latest/Libraries.html#2.-new-functions Online documentation}
  */
 declare function table_size(table: table): uint

package/runtime/index.d.ts

@@ -1,14 +1,14 @@
 /// <reference types="lua-types/5.2" />
 
 // generated
-/// <reference path="../generated/builtin-types.d.ts" />
-/// <reference path="../generated/global-objects.d.ts" />
-/// <reference path="../generated/global-functions.d.ts" />
-/// <reference path="../generated/defines.d.ts" />
-/// <reference path="../generated/events.d.ts" />
-/// <reference path="../generated/classes.d.ts" />
-/// <reference path="../generated/concepts.d.ts" />
-/// <reference path="../generated/index-types.d.ts" />
+/// <reference path="./generated/builtin-types.d.ts" />
+/// <reference path="./generated/global-objects.d.ts" />
+/// <reference path="./generated/global-functions.d.ts" />
+/// <reference path="./generated/defines.d.ts" />
+/// <reference path="./generated/events.d.ts" />
+/// <reference path="./generated/classes.d.ts" />
+/// <reference path="./generated/concepts.d.ts" />
+/// <reference path="./generated/index-types.d.ts" />
 
 // other runtime
 /// <reference path="librariesAndFunctions.d.ts" />

package/Changelog.md

@@ -1,256 +0,0 @@
-# v1.8.0
-
-- Updated to factorio version 1.1.69
-
-# v1.7.4
-
-- Fix advanced types of method returns (nullability, string unions, etc.)
-
-# v1.7.3
-
-- Improve types of "util" lualib module
-- Made compatible with typescript v4.8
-
-# v1.7.1
-
-- Added proper nullablity to members with different read/write types
-- Deduped union types
-
-# v1.7.0
-
-- Updated to factorio version 1.1.67
-
-# v1.6.1
-
-- Fixed write type for `BoundingBox`.
-- Simplified types for BlueprintEntity.
-
-# v1.6.0
-
-- Updated to factorio version 1.1.64
-
-# v1.5.1
-
-- Added old `Read` types as deprecated type aliases of new types; to help with migration.
-
-# v1.5.0
-
-### BREAKING
-
-- Read-only forms of concepts (the most common form used) is now specified with just the name; forms with a `Read` or `Table` suffix have been removed.
-- Write forms are now specified as either a union of table and array forms, or with a `Write` suffix for concepts.
-    - For table-or-array concepts: `MapPositionRead` -> `MapPosition`, `MapPosition` -> `MapPosition | PositionArray`
-    - For table concepts: `ScriptAreaRead` -> `ScriptArea`, `ScriptArea` -> `ScriptAreaWrite`
-- The minimum TSTL version has been increased to v1.6.1 (A bug with documentation comments was fixed in that version).
-
-### Other
-
-- Updated to factorio version 1.1.63.
-- Upgraded to factorio api docs json version 3.
-- The new type `nil` is used instead of `undefined` (they are equivalent).
-- More complete type for `BlueprintEntity`.
-- Fixed missing read-write forms for more concepts.
-- Improved documentation comments (enabled by json docs version 3).
-- Improved documentation comments for variant parameter groups.
-
-# v1.4.0
-
-- Improve doc comments for enum concepts
-- Improve doc comment formatting
-- Improve types of concepts with literal union types
-- Add read-specific types to AutoplaceControl and ComparatorString
-
-# v1.3.2
-
-- Move "notes" comment into the main body of doc comment, instead of in @remarks. This works around #13.
-- Add manually defined overload for LuaControl::teleport().
-
-# v1.3.1
-
-- Use @linkplain instead of @link for web links. This hopefully works around issue #13
-
-# v1.3.0
-
-- Updated to factorio version 1.1.61
-
-# v1.2.0
-
-- Updated to factorio version 1.1.60
-
-# v1.1.0
-
-- Updated to factorio version 1.1.59
-
-# v1.0.0
-
-- This project now has all the features that was originally planned, and can now guarantee reasonable backwards compatibility for future releases.
-- Updated to factorio version 1.1.57
-
-# v0.20.0
-
-- Updated to factorio version 1.1.56
-- This is an **opt-in** feature: Some numeric types which represent indices/number,e.g. player_index, entity_number, are now branded numbers with their own type, e.g. `PlayerIndex` and `EntityNumber`. See the README for more info.
-- Added custom-index-template.d.ts to assist trying out custom changes to types in a project.
-
-# v0.19.0
-
-- Updated to factorio version 1.1.53
-- Updated to json api version 2
-- Improved documentation comments
-
-## Changes
-
-- `Position`, `PositionArray`, and `PositionTable` have been replaced by `MapPosition`, `MapPositionArray`, and `MapPositionTable` respectively. These are now deprecated and may be removed in a future version.
-
-# v0.18.1
-
-- `TechnologyIdentification` now also has a more specific type when read.
-
-# v0.18.0
-
-- `ForceIdentification` and `ItemPrototypeIdentification` now have more specific types when read.
-- Properties which represent a flag concept now have the correct specific type, instead of `string`.
-
-# v0.17.1
-
-- Fixed documentation links for events
-
-# v0.17.0
-
-- Updated to factorio version 1.1.52
-
-# v0.16.0
-
-- `LuaCustomTable` can be iterated on in a for-of loop directly (without using `pairs`). This requires TSTL v1.3.0 or later.
-- TSTL dependency minimum version is now v1.3.0.
-
-# v0.15.0
-
-- Table or array concepts are now declared in table form wherever it is an "read" position.
-    - This works with setter overloading for applicable properties: `player.color.x; player.color = [1, 1, 1]` is now valid!
-    - This also applies to concepts/complex types which contain table_or_array properties.
-- Some concepts now also have a special form where it is known to be in a "read" position, where all table_or_array concepts are declared in table form. These concepts are suffixed with "Read", e.g. `ScriptAreaRead`.
-- Arrays which are known to be in a "write" only form (e.g. method parameters) now are marked readonly. This means you can now pass readonly arrays to these methods.
-- `MapPosition` is now a table or array concept.
-- Classes with subclasses are now declared with all properties, instead of an intersection of subclasses (reversion)
-- Subclass specializations added for some missing classes
-
-# v0.14.1
-
-- LuaStyle: `extra_margin/padding_when_activated` is now for subclass scroll_pane
-
-# v0.14.0
-
-- LuaStyle size, margin/padding setters now have more specific array types. These array types are `SizeArray` and `StyleValuesArray` for size and margin/padding, respectively.
-- `@noSelf` annotation is now only present when necessary.
-- For classes with subclasses:
-    - The original class name (e.g. `LuaItemStack`) still contains attributes of all subclasses (same as before).
-    - There is now a `Base` type (e.g. `BaseItemStack`) which only includes attributes common to all subclasses.
-    - There is a separate type definition for each subclass, e.g. `BlueprintItem`. Note that one instance may still belong to multiple subclasses (the subclasses are not mutually exclusive).
-    - The above two can be optionally used for stricter types.
-
-# v0.13.2
-
-- Fix: resize_to_sprite property should not be on subclass sprite-button
-- Fix: ChooseElemButtonSpec filters should be named elem_filters
-- Switch back to `/latest` api docs link
-    - New version of web api docs is now active
-
-# v0.13.0
-
-- Update to factorio version 1.1.49
-
-# v0.12.0
-
-- Update to factorio version 1.1.48
-
-# v0.11.1
-
-- Localised strings now accept boolean and undefined.
-
-# v0.11.0
-
-- Update to factorio version 1.1.46
-
-# v0.10.0
-
-- LuaGuiElement.style and LuaControl.opened now have different get/set types (more specific get type).
-- The array form of LocalizedString is now readonly.
-
-# v0.9.0
-
-- Update to factorio version 1.1.43
-- The `defines.events `_type_ was renamed to `defines.Events`, to reduce confusion between the namespace/type
-
-# v0.8.0
-
-- All event types now explicitly extend `EventData`
-- Variant parameter groups without additional fields now have their own type, instead of all being grouped into `Other`
-
-# v0.7.3
-
-- Update to factorio version 1.1.42
-    - No api changes, but improvements to descriptions
-
-# v0.7.2
-
-- Fix minor issue for event types
-
-# v0.7.0
-
-- Updated to factorio version 1.1.41 (no changes to lua api)
-- Improved smart types for events
-
-# v0.6.1
-
-- Added type for BlueprintControlBehavior
-
-# v0.6.0
-
-- Updated to factorio version 1.1.40
-- Fixed regression with duplicate strings in string union types
-
-# v0.5.0
-
-- Updated to factorio version 1.1.39
-- Documentation links now point to the new API docs website. More info here: https://forums.factorio.com/viewtopic.php?f=34&t=99797
-
-# v0.4.1
-
-### Changed
-
-- LuaRemote.addInterface now lets remote functions take any arguments.
-
-# v0.4.0
-
-## **BREAKING**
-
-- Only the latest version api is now provided.
-- It is now accessed using `typed-factorio/runtime` instead of `typed-factorio/<version>`
-
-### Added
-
-- Basic types for settings and data stage. See README for more details.
-- Types for "util" and "mod-gui" lualib modules
-
-### Fixed
-
-- LuaGuiElement::add with a literal now give diagnostic if you supply a field that shouldn't be there.
-
-### Internal
-
-- Split generated files into multiple files
-- Improved compilation tests
-
-# v0.3.0
-
-- Added factorio version `1.1.38`
-
-# v0.2.0
-
-- `AnyBasic` now uses type `table` instead of type `Record<any, AnyBasic>`
-- README changes
-
-# v0.1.0
-
-- Initial release