typed-factorio 1.8.1 → 1.10.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`.
    */
@@ -2290,7 +2290,7 @@ interface InfinityInventoryFilter {
    */
   readonly mode?: "at-least" | "at-most" | "exactly"
   /**
-   * The index of this filter in the filters list.
+   * The index of this filter in the filters list. Not required when writing a filter.
    */
   readonly index: uint
 }
@@ -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}/defines.d.ts

@@ -1323,6 +1323,10 @@ declare namespace defines {
      * Event type: {@link OnPlayerReverseSelectedAreaEvent}
      */
     const on_player_reverse_selected_area: EventId<OnPlayerReverseSelectedAreaEvent>
+    /**
+     * Event type: {@link OnPlayerAltReverseSelectedAreaEvent}
+     */
+    const on_player_alt_reverse_selected_area: EventId<OnPlayerAltReverseSelectedAreaEvent>
   }
   /**
    * See the {@linkplain https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain and when they get raised.
@@ -1377,6 +1381,7 @@ declare namespace defines {
     add_permission_group,
     add_train_station,
     admin_action,
+    alt_reverse_select_area,
     alt_select_area,
     alt_select_blueprint_entities,
     alternative_copy,

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

@@ -1537,6 +1537,45 @@ interface OnPickedUpItemEvent extends EventData {
   readonly tick: uint
 }
 
+/**
+ * Called after a player alt-reverse-selects an area with a selection-tool item.
+ * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_alt_reverse_selected_area Online documentation}
+ */
+interface OnPlayerAltReverseSelectedAreaEvent extends EventData {
+  /**
+   * The player doing the selection.
+   */
+  readonly player_index: PlayerIndex
+  /**
+   * The surface selected.
+   */
+  readonly surface: LuaSurface
+  /**
+   * The area selected.
+   */
+  readonly area: BoundingBox
+  /**
+   * The item used to select the area.
+   */
+  readonly item: string
+  /**
+   * The entities selected.
+   */
+  readonly entities: LuaEntity[]
+  /**
+   * The tiles selected.
+   */
+  readonly tiles: LuaTile[]
+  /**
+   * Identifier of the event
+   */
+  readonly name: typeof defines.events.on_player_alt_reverse_selected_area
+  /**
+   * Tick the event was generated.
+   */
+  readonly tick: uint
+}
+
 /**
  * Called after a player alt-selects an area with a selection-tool item.
  * @see {@link https://lua-api.factorio.com/latest/events.html#on_player_alt_selected_area Online documentation}
@@ -2056,7 +2095,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 +3134,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/.yarn/unplugged/open-npm-8.4.0-df63cfe537/node_modules/open/index.d.ts

@@ -1,153 +0,0 @@
-import {ChildProcess} from 'child_process';
-
-declare namespace open {
-	interface Options {
-		/**
-		Wait for the opened app to exit before fulfilling the promise. If `false` it's fulfilled immediately when opening the app.
-
-		Note that it waits for the app to exit, not just for the window to close.
-
-		On Windows, you have to explicitly specify an app for it to be able to wait.
-
-		@default false
-		*/
-		readonly wait?: boolean;
-
-		/**
-		__macOS only__
-
-		Do not bring the app to the foreground.
-
-		@default false
-		*/
-		readonly background?: boolean;
-
-		/**
-		__macOS only__
-
-		Open a new instance of the app even it's already running.
-
-		A new instance is always opened on other platforms.
-
-		@default false
-		*/
-		readonly newInstance?: boolean;
-
-		/**
-		Specify the `name` of the app to open the `target` with, and optionally, app `arguments`. `app` can be an array of apps to try to open and `name` can be an array of app names to try. If each app fails, the last error will be thrown.
-
-		The app name is platform dependent. Don't hard code it in reusable modules. For example, Chrome is `google chrome` on macOS, `google-chrome` on Linux and `chrome` on Windows. If possible, use [`open.apps`](#openapps) which auto-detects the correct binary to use.
-
-		You may also pass in the app's full path. For example on WSL, this can be `/mnt/c/Program Files (x86)/Google/Chrome/Application/chrome.exe` for the Windows installation of Chrome.
-
-		The app `arguments` are app dependent. Check the app's documentation for what arguments it accepts.
-		*/
-		readonly app?: App | readonly App[];
-
-		/**
-		Allow the opened app to exit with nonzero exit code when the `wait` option is `true`.
-
-		We do not recommend setting this option. The convention for success is exit code zero.
-
-		@default false
-		*/
-		readonly allowNonzeroExitCode?: boolean;
-	}
-
-	interface OpenAppOptions extends Omit<Options, 'app'> {
-		/**
-		Arguments passed to the app.
-
-		These arguments are app dependent. Check the app's documentation for what arguments it accepts.
-		*/
-		readonly arguments?: readonly string[];
-	}
-
-	type AppName =
-		| 'chrome'
-		| 'firefox'
-		| 'edge';
-
-	type App = {
-		name: string | readonly string[];
-		arguments?: readonly string[];
-	};
-}
-
-// eslint-disable-next-line no-redeclare
-declare const open: {
-	/**
-	Open stuff like URLs, files, executables. Cross-platform.
-
-	Uses the command `open` on macOS, `start` on Windows and `xdg-open` on other platforms.
-
-	There is a caveat for [double-quotes on Windows](https://github.com/sindresorhus/open#double-quotes-on-windows) where all double-quotes are stripped from the `target`.
-
-	@param target - The thing you want to open. Can be a URL, file, or executable. Opens in the default app for the file type. For example, URLs open in your default browser.
-	@returns The [spawned child process](https://nodejs.org/api/child_process.html#child_process_class_childprocess). You would normally not need to use this for anything, but it can be useful if you'd like to attach custom event listeners or perform other operations directly on the spawned process.
-
-	@example
-	```
-	import open = require('open');
-
-	// Opens the image in the default image viewer
-	await open('unicorn.png', {wait: true});
-	console.log('The image viewer app closed');
-
-	// Opens the url in the default browser
-	await open('https://sindresorhus.com');
-
-	// Opens the URL in a specified browser.
-	await open('https://sindresorhus.com', {app: {name: 'firefox'}});
-
-	// Specify app arguments.
-	await open('https://sindresorhus.com', {app: {name: 'google chrome', arguments: ['--incognito']}});
-	```
-	*/
-	(
-		target: string,
-		options?: open.Options
-	): Promise<ChildProcess>;
-
-	/**
-	An object containing auto-detected binary names for common apps. Useful to work around cross-platform differences.
-
-	@example
-	```
-	import open = require('open');
-
-	await open('https://google.com', {
-		app: {
-			name: open.apps.chrome
-		}
-	});
-	```
-	*/
-	apps: Record<open.AppName, string | readonly string[]>;
-
-	/**
-	Open an app. Cross-platform.
-
-	Uses the command `open` on macOS, `start` on Windows and `xdg-open` on other platforms.
-
-	@param name - The app you want to open. Can be either builtin supported `open.apps` names or other name supported in platform.
-	@returns The [spawned child process](https://nodejs.org/api/child_process.html#child_process_class_childprocess). You would normally not need to use this for anything, but it can be useful if you'd like to attach custom event listeners or perform other operations directly on the spawned process.
-
-	@example
-	```
-	const {apps, openApp} = require('open');
-
-	// Open Firefox
-	await openApp(apps.firefox);
-
-	// Open Chrome incognito mode
-	await openApp(apps.chrome, {arguments: ['--incognito']});
-
-	// Open Xcode
-	await openApp('xcode');
-	```
-	*/
-	openApp: (name: open.App['name'], options?: open.OpenAppOptions) => Promise<ChildProcess>;
-};
-
-export = open;