// This is an auto-generated file. Do not edit directly! /** @noSelfInFile */ import type { EntityType } from "factorio:prototype" import type { VersionString } from "factorio:common" /** * @noResolution */ declare module "factorio:runtime" { /** * Identifies a statistics prototype, depending on the statistics type. * * ## Union members * - {@link ItemWithQualityID}: Used with item production statistics. * - {@link FluidID}: Used with fluid production statistics. * - {@link EntityWithQualityID}: Used with electric network, entity build count, and kill count statistics. * - {@link EntityID}: Used with pollution statistics. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/FlowStatisticsID.html Online documentation} */ export type FlowStatisticsID = ItemWithQualityID | FluidID | EntityWithQualityID | EntityID export type ItemStackIndex = uint16 export type LogisticFilterIndex = uint16 export type ItemCountType = uint export type InventoryIndex = uint8 /** * A string that specifies how the inputs should be compared. * * While the API accepts both versions for `"less/greater than or equal to"` and `"not equal"`, it'll always return `"≥"`, `"≤"` or `"≠"` respectively when reading them back. * * ## Union members * - `"="`: "equal to" * - `">"`: "greater than" * - `"<"`: "lesser than" * - `"≥"`: "greater than or equal to" * - `">="`: "greater than or equal to" * - `"≤"`: "lesser than or equal to" * - `"<="`: "lesser than or equal to" * - `"≠"`: "not equal to" * - `"!="`: "not equal to" * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ComparatorString.html Online documentation} */ export type ComparatorString = "=" | ">" | "<" | "≥" | ">=" | "≤" | "<=" | "≠" | "!=" export type ComparatorStringRead = "=" | ">" | "<" | "≥" | "≤" | "≠" export type SpriteType = | "item" | "entity" | "technology" | "recipe" | "fluid" | "tile" | "item-group" | "virtual-signal" | "shortcut" | "achievement" | "equipment" | "ammo-category" | "decorative" | "space-connection" | "space-location" | "surface" | "airborne-pollutant" | "asteroid-chunk" | "quality" | "file" | "utility" /** * It can be either the name of a {@link import("factorio:prototype").SpritePrototype SpritePrototype} defined in the data stage, or a path in form "type/name" or "type.name". * * The validity of a SpritePath can be verified at runtime using {@link LuaHelpers#is_valid_sprite_path LuaHelpers::is_valid_sprite_path}. * * {@link https://lua-api.factorio.com/2.0.45/concepts/SpritePath.html > The supported types are:} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SpritePath.html Online documentation} */ export type SpritePath = (string & { _?: never }) | `${SpriteType}${"/" | "."}${string}` /** * @example * -- Most common collision mask of buildings: * collision_mask = {layers = {item = true, meltable = true, object = true, player = true, water_tile = true, is_object = true, is_lower_object = true}} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CollisionMask.html Online documentation} */ export interface CollisionMask { /** * Every key in the dictionary is the name of one {@link LuaCollisionLayerPrototype layer} the object collides with. The value is meaningless and always `true`. An empty table means that no layers are set. */ readonly layers: Record /** * Any two entities that both have this option enabled on their prototype and have an identical collision mask layers list will not collide. Other collision mask options are not included in the identical layer list check. This does mean that two different prototypes with the same collision mask layers and this option enabled will not collide. Defaults to `false`. */ readonly not_colliding_with_itself?: boolean /** * Uses the prototypes position rather than its collision box when doing collision checks with tile prototypes. Allows the prototype to overlap colliding tiles up until its center point. This is only respected for character movement and cars driven by players. Defaults to `false`. */ readonly consider_tile_transitions?: boolean /** * Any prototype with this collision option will only be checked for collision with other prototype's collision masks if they are a tile. Defaults to `false`. */ readonly colliding_with_tiles_only?: boolean } /** * The percentual increase of the attribute. A value of `0.6` means a 60% increase. * * Quality values are divided by 10 internally, allowing for one more decimal of precision. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ModuleEffectValue.html Online documentation} */ export type ModuleEffectValue = float /** * @example * -- These are the effects of the vanilla Speed Module 3 * {speed = 0.5, consumption = 0.7, quality = -0.25} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ModuleEffects.html Online documentation} */ export interface ModuleEffects { readonly consumption?: ModuleEffectValue readonly speed?: ModuleEffectValue readonly productivity?: ModuleEffectValue readonly pollution?: ModuleEffectValue readonly quality?: ModuleEffectValue } /** * `math.huge` represents the maximum possible tick. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapTick.html Online documentation} */ export type MapTick = uint64 /** * A number between 0 and 255 inclusive, represented by one of the following named strings or the string version of the number. For example `"10"` and `"decals"` are both valid. Higher values are rendered above lower values. * * ## Union members * - `string`: A string of a number * - `"zero"`: 0 * - `"background-transitions"`: 1 * - `"under-tiles"`: 2 * - `"decals"`: 10 * - `"above-tiles"`: 11 * - `"ground-layer-1"`: 12 * - `"ground-layer-2"`: 13 * - `"ground-layer-3"`: 14 * - `"ground-layer-4"`: 15 * - `"ground-layer-5"`: 16 * - `"lower-radius-visualization"`: 29 * - `"radius-visualization"`: 30 * - `"transport-belt-integration"`: 65 * - `"resource"`: 66 * - `"building-smoke"`: 67 * - `"rail-stone-path-lower"`: 68 * - `"rail-stone-path"`: 76 * - `"rail-tie"`: 84 * - `"decorative"`: 92 * - `"ground-patch"`: 93 * - `"ground-patch-higher"`: 94 * - `"ground-patch-higher2"`: 95 * - `"rail-chain-signal-metal"`: 96 * - `"rail-screw"`: 97 * - `"rail-metal"`: 100 * - `"remnants"`: 102 * - `"floor"`: 103 * - `"transport-belt"`: 104 * - `"transport-belt-endings"`: 105 * - `"floor-mechanics-under-corpse"`: 106 * - `"corpse"`: 107 * - `"floor-mechanics"`: 108 * - `"item"`: 109 * - `"transport-belt-reader"`: 117 * - `"lower-object"`: 118 * - `"transport-belt-circuit-connector"`: 120 * - `"lower-object-above-shadow"`: 121 * - `"lower-object-overlay"`: 122 * - `"object-under"`: 123 * - `"object"`: 124 * - `"cargo-hatch"`: 125 * - `"higher-object-under"`: 126 * - `"higher-object-above"`: 127 * - `"train-stop-top"`: 128 * - `"item-in-inserter-hand"`: 129 * - `"above-inserters"`: 130 * - `"wires"`: 131 * - `"under-elevated"`: 132 * - `"elevated-rail-stone-path-lower"`: 133 * - `"elevated-rail-stone-path"`: 134 * - `"elevated-rail-tie"`: 135 * - `"elevated-rail-screw"`: 136 * - `"elevated-rail-metal"`: 137 * - `"elevated-lower-object"`: 141 * - `"elevated-object"`: 142 * - `"elevated-higher-object"`: 143 * - `"fluid-visualization"`: 149 * - `"wires-above"`: 150 * - `"entity-info-icon"`: 153 * - `"entity-info-icon-above"`: 154 * - `"explosion"`: 157 * - `"projectile"`: 158 * - `"smoke"`: 159 * - `"air-object"`: 160 * - `"air-entity-info-icon"`: 161 * - `"light-effect"`: 162 * - `"selection-box"`: 187 * - `"higher-selection-box"`: 188 * - `"collision-selection-box"`: 189 * - `"arrow"`: 190 * - `"cursor"`: 226 * @see {@link https://lua-api.factorio.com/2.0.45/concepts/RenderLayer.html Online documentation} */ export type RenderLayer = | `${bigint}` | "zero" | "background-transitions" | "under-tiles" | "decals" | "above-tiles" | "ground-layer-1" | "ground-layer-2" | "ground-layer-3" | "ground-layer-4" | "ground-layer-5" | "lower-radius-visualization" | "radius-visualization" | "transport-belt-integration" | "resource" | "building-smoke" | "rail-stone-path-lower" | "rail-stone-path" | "rail-tie" | "decorative" | "ground-patch" | "ground-patch-higher" | "ground-patch-higher2" | "rail-chain-signal-metal" | "rail-screw" | "rail-metal" | "remnants" | "floor" | "transport-belt" | "transport-belt-endings" | "floor-mechanics-under-corpse" | "corpse" | "floor-mechanics" | "item" | "transport-belt-reader" | "lower-object" | "transport-belt-circuit-connector" | "lower-object-above-shadow" | "lower-object-overlay" | "object-under" | "object" | "cargo-hatch" | "higher-object-under" | "higher-object-above" | "train-stop-top" | "item-in-inserter-hand" | "above-inserters" | "wires" | "under-elevated" | "elevated-rail-stone-path-lower" | "elevated-rail-stone-path" | "elevated-rail-tie" | "elevated-rail-screw" | "elevated-rail-metal" | "elevated-lower-object" | "elevated-object" | "elevated-higher-object" | "fluid-visualization" | "wires-above" | "entity-info-icon" | "entity-info-icon-above" | "explosion" | "projectile" | "smoke" | "air-object" | "air-entity-info-icon" | "light-effect" | "selection-box" | "higher-selection-box" | "collision-selection-box" | "arrow" | "cursor" /** * What is shown in the map view. If a field is not given, that setting will not be changed. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapViewSettings.html Online documentation} */ export interface MapViewSettings { readonly "show-logistic-network"?: boolean readonly "show-electric-network"?: boolean readonly "show-turret-range"?: boolean readonly "show-pollution"?: boolean readonly "show-networkless-logistic-members"?: boolean readonly "show-train-station-names"?: boolean readonly "show-player-names"?: boolean readonly "show-tags"?: boolean readonly "show-worker-robots"?: boolean readonly "show-rail-signal-states"?: boolean readonly "show-recipe-icons"?: boolean readonly "show-pipelines"?: boolean readonly "show-non-standard-map-info"?: boolean } /** * ## Union members * - `"entity"`: The normal entity selection box. Yellow by default. * - `"multiplayer-entity"`: The multiplayer entity selection box which gets tinted using {@link LuaPlayer#chat_color LuaPlayer::chat_color}. White by default. * - `"electricity"`: The selection box used to specify electric poles an entity is connected to. Light blue by default. * - `"copy"`: The selection box used when doing entity copy-paste. Green by default. * - `"not-allowed"`: The selection box used when specifying colliding entities. Red by default. * - `"pair"`: Light blue by default. * - `"logistics"`: Light blue by default. * - `"train-visualization"`: White by default. * - `"blueprint-snap-rectangle"`: Green by default. * - `"spidertron-remote-selected"` * - `"spidertron-remote-to-be-selected"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CursorBoxRenderType.html Online documentation} */ export type CursorBoxRenderType = | "entity" | "multiplayer-entity" | "electricity" | "copy" | "not-allowed" | "pair" | "logistics" | "train-visualization" | "blueprint-snap-rectangle" | "spidertron-remote-selected" | "spidertron-remote-to-be-selected" /** * The name of a {@link LuaCollisionLayerPrototype}. * @example * "is_lower_object" * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CollisionLayerID.html Online documentation} */ export type CollisionLayerID = string /** * State of a GUI {@link LuaGuiElement#switch_state switch}. * * ## Union members * - `"left"` * - `"right"` * - `"none"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SwitchState.html Online documentation} */ export type SwitchState = "left" | "right" | "none" export interface PrototypeWithQuality { /** * Name of a prototype. */ readonly name: string /** * Name of a quality prototype. Always defined when reading, defaults to "normal" when writing. */ readonly quality?: string } export interface PrototypeWithQualityRead { readonly name: string readonly quality: string } /** * A `string` specifying a type for {@link LuaGuiElement#elem_type choose elem buttons}. It's also used by {@link ElemID} for {@link LuaGuiElement#elem_tooltip LuaGuiElement::elem_tooltip}. * * ## Union members * - `"achievement"` * - `"decorative"` * - `"entity"` * - `"equipment"` * - `"fluid"` * - `"item"` * - `"item-group"` * - `"recipe"` * - `"signal"` * - `"technology"` * - `"tile"` * - `"asteroid-chunk"` * - `"space-location"` * - `"item-with-quality"` * - `"entity-with-quality"` * - `"recipe-with-quality"` * - `"equipment-with-quality"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ElemType.html Online documentation} */ export type ElemType = | "achievement" | "decorative" | "entity" | "equipment" | "fluid" | "item" | "item-group" | "recipe" | "signal" | "technology" | "tile" | "asteroid-chunk" | "space-location" | "item-with-quality" | "entity-with-quality" | "recipe-with-quality" | "equipment-with-quality" export interface ElemID { readonly type: ElemType /** * Name of a prototype as defined by `type`. */ readonly name: string /** * Name of a quality prototype if `type` use quality. */ readonly quality?: string } /** * An item filter may be specified in two ways, either as a string which is an item prototype name or as a table. * @see ItemFilterWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemFilter.html Online documentation} */ export type ItemFilter = | { /** * The item. */ readonly name?: LuaItemPrototype /** * The quality. */ readonly quality?: LuaQualityPrototype /** * The quality comparison type. */ readonly comparator?: ComparatorStringRead } | string /** * Write form of {@link ItemFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemFilter.html Online documentation} */ export type ItemFilterWrite = | { /** * The item. */ readonly name?: ItemID /** * The quality. */ readonly quality?: QualityID /** * The quality comparison type. */ readonly comparator?: ComparatorString } | string /** * Common attributes to all variants of {@link GuiArrowSpecification}. */ export interface BaseGuiArrowSpecification { readonly margin: uint /** * This determines which of the following fields will be required. */ readonly type: GuiArrowType } /** * `"entity"` variant of {@link GuiArrowSpecification}. */ export interface EntityGuiArrowSpecification extends BaseGuiArrowSpecification { readonly type: "entity" readonly entity: LuaEntity } /** * `"position"` variant of {@link GuiArrowSpecification}. */ export interface PositionGuiArrowSpecification extends BaseGuiArrowSpecification { readonly type: "position" readonly position: MapPosition | MapPositionArray } /** * `"crafting_queue"` variant of {@link GuiArrowSpecification}. */ export interface CraftingQueueGuiArrowSpecification extends BaseGuiArrowSpecification { readonly type: "crafting_queue" /** * Index in the crafting queue to point to. */ readonly crafting_queueindex: uint } /** * `"item_stack"` variant of {@link GuiArrowSpecification}. */ export interface ItemStackGuiArrowSpecification extends BaseGuiArrowSpecification { readonly type: "item_stack" /** * Which inventory the stack is in. */ readonly inventory_index: defines.inventory /** * Which stack to point to. */ readonly item_stack_index: uint readonly source: "player" | "target" | "player-quickbar" } /** * Variants of {@link GuiArrowSpecification} with no additional attributes. */ export interface OtherGuiArrowSpecification extends BaseGuiArrowSpecification { readonly type: "nowhere" | "goal" | "entity_info" | "active_window" } /** * Used for specifying where a GUI arrow should point to. * * Base attributes: {@link BaseGuiArrowSpecification} * * Other attributes may be specified depending on `type`: * - `"entity"`: {@link EntityGuiArrowSpecification} * - `"position"`: {@link PositionGuiArrowSpecification} * - `"crafting_queue"`: {@link CraftingQueueGuiArrowSpecification} * - `"item_stack"`: {@link ItemStackGuiArrowSpecification} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GuiArrowSpecification.html Online documentation} */ export type GuiArrowSpecification = | EntityGuiArrowSpecification | PositionGuiArrowSpecification | CraftingQueueGuiArrowSpecification | ItemStackGuiArrowSpecification | OtherGuiArrowSpecification /** * Reading this always returns the table with the named keys. * * If this is specified as a three-element array then the array items are x, y and z, in that order. * @see Vector3DArray * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Vector3D.html Online documentation} */ export interface Vector3D { readonly x: float readonly y: float readonly z: float } /** * Array form of {@link Vector3D}. * @see Vector3D * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Vector3D.html Online documentation} */ export type Vector3DArray = readonly [float, float, float] export interface ItemWithQualityCounts { /** * Name of the item prototype. */ readonly name: string /** * The number of items. */ readonly count: uint /** * Name of the item's quality prototype. */ readonly quality: string } export interface EquipmentWithQualityCounts { /** * Name of the equipment prototype. */ readonly name: string /** * The number of equipment items. */ readonly count: uint /** * Name of the equipment's quality prototype. */ readonly quality: string } /** * @see TrainScheduleWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TrainSchedule.html Online documentation} */ export interface TrainSchedule { /** * Index of the currently active record */ readonly current: uint readonly records: ScheduleRecord[] } /** * Write form of {@link TrainSchedule}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TrainSchedule.html Online documentation} */ export interface TrainScheduleWrite { /** * Index of the currently active record */ readonly current: uint readonly records: readonly ScheduleRecordWrite[] } /** * @see PlatformScheduleWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PlatformSchedule.html Online documentation} */ export interface PlatformSchedule { /** * Index of the currently active record */ readonly current: uint readonly records: ScheduleRecord[] } /** * Write form of {@link PlatformSchedule}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PlatformSchedule.html Online documentation} */ export interface PlatformScheduleWrite { /** * Index of the currently active record */ readonly current: uint readonly records: readonly ScheduleRecordWrite[] } export interface EffectReceiver { readonly base_effect: ModuleEffects readonly uses_module_effects: boolean readonly uses_beacon_effects: boolean readonly uses_surface_effects: boolean } /** * A recipe prototype with optional quality specification. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/RecipeIDAndQualityIDPair.html Online documentation} */ export interface RecipeIDAndQualityIDPair { /** * Recipe prototype. */ readonly name: LuaRecipePrototype /** * Quality prototype. */ readonly quality: LuaQualityPrototype } export interface WorkerRobotOrder { /** * The type of the order. */ readonly type: defines.robot_order_type /** * The target of the order. */ readonly target?: LuaEntity /** * The item to place if relevant. */ readonly item_to_place?: SimpleItemStack /** * The secondary target of the upgrade order. */ readonly secondary_target?: LuaEntity /** * The cliff explosive for the cliff explode job. */ readonly cliff_explosive_id?: LuaItemPrototype /** * The target item of the pickup or deliver order. */ readonly target_item?: ItemIDAndQualityIDPair /** * The target count of the pickup or deliver order. */ readonly target_count?: ItemCountType } /** * A force may be specified in one of three ways. * * ## Union members * - `string`: Name of the force, same as {@link LuaForce#name LuaForce::name}. * - {@link uint8}: Index of the force, same as {@link LuaForce#index LuaForce::index}. * - {@link LuaForce}: A reference to {@link LuaForce} may be passed directly. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ForceID.html Online documentation} */ export type ForceID = string | uint8 | LuaForce /** * A fluid may be specified in one of three ways. * * ## Union members * - `string`: The fluid name. * - {@link LuaFluidPrototype}: The fluid prototype. * - {@link Fluid}: The fluid. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/FluidID.html Online documentation} */ export type FluidID = string | LuaFluidPrototype | Fluid /** * An entity prototype with optional quality specification. Can be specified in one of four ways. * * ## Union members * - {@link LuaEntity}: The entity. Both prototype and quality of the entity will be used. * - {@link LuaEntityPrototype}: The entity prototype. Normal quality will be used. * - `string`: The prototype name. Normal quality will be used. * - {@link EntityIDAndQualityIDPair}: A table of entity prototype and quality. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EntityWithQualityID.html Online documentation} */ export type EntityWithQualityID = LuaEntity | LuaEntityPrototype | string | EntityIDAndQualityIDPair /** * An entity prototype with optional quality specification. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EntityIDAndQualityIDPair.html Online documentation} */ export interface EntityIDAndQualityIDPair { /** * Entity prototype. */ readonly name: EntityID /** * Quality prototype. Normal quality will be used if not specified. */ readonly quality?: QualityID } /** * An item prototype with optional quality specification. Can be specified in one of four ways. * * ## Union members * - {@link LuaItemStack}: The item stack. Both prototype and quality of the item stack will be used. * - {@link LuaItemPrototype}: The item prototype. Normal quality will be used. * - `string`: The prototype name. Normal quality will be used. * - {@link ItemIDAndQualityIDPair}: A table of entity prototype and quality. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemWithQualityID.html Online documentation} */ export type ItemWithQualityID = LuaItemStack | LuaItemPrototype | string | ItemIDAndQualityIDPairWrite /** * An item prototype with optional quality specification. * @see ItemIDAndQualityIDPairWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemIDAndQualityIDPair.html Online documentation} */ export interface ItemIDAndQualityIDPair { /** * Item prototype. Returns `LuaItemPrototype` when read. */ readonly name: LuaItemPrototype /** * Quality prototype. Normal quality will be used if not specified. Returns `LuaQualityPrototype` when read. */ readonly quality?: LuaQualityPrototype } /** * Write form of {@link ItemIDAndQualityIDPair}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemIDAndQualityIDPair.html Online documentation} */ export interface ItemIDAndQualityIDPairWrite { /** * Item prototype. Returns `LuaItemPrototype` when read. */ readonly name: ItemID /** * Quality prototype. Normal quality will be used if not specified. Returns `LuaQualityPrototype` when read. */ readonly quality?: QualityID } /** * An item prototype may be specified in one of four ways. * * ## Union members * - {@link LuaItemPrototype}: Item prototype. * - {@link LuaItemStack}: Non empty item stack. * - {@link LuaItem}: The item. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemID.html Online documentation} */ export type ItemID = LuaItemPrototype | LuaItemStack | LuaItem | string /** * An entity prototype may be specified in one of three ways. * * ## Union members * - {@link LuaEntityPrototype}: The entity prototype. * - {@link LuaEntity}: The entity. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EntityID.html Online documentation} */ export type EntityID = LuaEntityPrototype | LuaEntity | string /** * An technology prototype may be specified in one of three ways. * * ## Union members * - {@link LuaTechnologyPrototype}: The technology prototype. * - {@link LuaTechnology}: Instance of the technology. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TechnologyID.html Online documentation} */ export type TechnologyID = LuaTechnologyPrototype | LuaTechnology | string /** * A particle prototype may be specified in one of two ways. * * ## Union members * - {@link LuaParticlePrototype}: The particle prototype. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ParticleID.html Online documentation} */ export type ParticleID = LuaParticlePrototype | string /** * A damage type prototype may be specified in one of two ways. * * ## Union members * - {@link LuaDamagePrototype}: The damage type prototype. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/DamageTypeID.html Online documentation} */ export type DamageTypeID = LuaDamagePrototype | string /** * A trivial smoke prototype may be specified in one of two ways. * * ## Union members * - {@link LuaTrivialSmokePrototype}: The trivial smoke prototype. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TrivialSmokeID.html Online documentation} */ export type TrivialSmokeID = LuaTrivialSmokePrototype | string /** * The text is aligned so that the target position is at the given side of the text. * * For example, `"right"` aligned text means the right side of the text is at the target position. Or in other words, the target is on the right of the text. * * ## Union members * - `"left"` * - `"right"` * - `"center"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TextAlign.html Online documentation} */ export type TextAlign = "left" | "right" | "center" /** * The text is aligned so that the target position is at the given side of the text. * * For example, `"top"` aligned text means the top of the text is at the target position. Or in other words, the target is at the top of the text. * * ## Union members * - `"top"` * - `"middle"` * - `"baseline"` * - `"bottom"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/VerticalTextAlign.html Online documentation} */ export type VerticalTextAlign = "top" | "middle" | "baseline" | "bottom" /** * A quality prototype may be specified in one of two ways. * * ## Union members * - {@link LuaQualityPrototype}: The quality prototype. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/QualityID.html Online documentation} */ export type QualityID = LuaQualityPrototype | string /** * A recipe may be specified in one of three ways. * * ## Union members * - {@link LuaRecipePrototype}: By recipe prototype. * - {@link LuaRecipe}: By instance of recipe. * - `string`: By name of the recipe prototype. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/RecipeID.html Online documentation} */ export type RecipeID = LuaRecipePrototype | LuaRecipe | string /** * A tile may be specified in one of three ways. * * ## Union members * - {@link LuaTilePrototype}: By tile prototype. * - {@link LuaTile}: By instance of tile. * - `string`: By name of the tile prototype. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TileID.html Online documentation} */ export type TileID = LuaTilePrototype | LuaTile | string export interface Fluid { /** * Fluid prototype name of the fluid. */ readonly name: string /** * Amount of the fluid. */ readonly amount: double /** * The temperature. When reading from {@link LuaFluidBox}, this field will always be present. It is not necessary to specify it when writing, however. When not specified, the fluid will be set to the fluid's default temperature as specified in the fluid's prototype. */ readonly temperature?: float } /** * An equipment prototype may be specified in one of three ways. * * ## Union members * - {@link LuaEquipmentPrototype}: The equipment prototype. * - {@link LuaEquipment}: The equipment. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EquipmentID.html Online documentation} */ export type EquipmentID = LuaEquipmentPrototype | LuaEquipment | string /** * An equipment prototype with optional quality specification. * * ## Union members * - {@link LuaEquipmentPrototype}: The equipment prototype. Normal quality will be used. * - {@link LuaEquipment}: The equipment. Both prototype and quality of the provided equipment will be used. * - `string`: The prototype name. Normal quality will be used. * - {@link EquipmentIDAndQualityIDPair}: A table of equipment prototype and quality. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EquipmentWithQualityID.html Online documentation} */ export type EquipmentWithQualityID = LuaEquipmentPrototype | LuaEquipment | string | EquipmentIDAndQualityIDPair /** * An equipment prototype with optional quality specification. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EquipmentIDAndQualityIDPair.html Online documentation} */ export interface EquipmentIDAndQualityIDPair { /** * Equipment prototype. */ readonly name: EquipmentID /** * Quality prototype. Normal quality will be used if not specified. */ readonly quality?: QualityID } /** * Two positions, specifying the top-left and bottom-right corner of the box respectively. Like with {@link MapPosition}, the names of the members may be omitted. When read from the game, the third member `orientation` is present if it is non-zero. * @see BoundingBoxArray * @example * -- Explicit definition * {left_top = {x = -2, y = -3}, right_bottom = {x = 5, y = 8}} * @example * -- Shorthand * {{-2, -3}, {5, 8}} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BoundingBox.html Online documentation} */ export interface BoundingBox { readonly left_top: MapPosition readonly right_bottom: MapPosition readonly orientation?: RealOrientation } /** * Array form of {@link BoundingBox}. * @see BoundingBox * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BoundingBox.html Online documentation} */ export type BoundingBoxArray = readonly [MapPosition | MapPositionArray, MapPosition | MapPositionArray] export interface BoundingBoxWrite { readonly left_top: (MapPosition | MapPositionArray) | MapPositionArray readonly right_bottom: (MapPosition | MapPositionArray) | MapPositionArray readonly orientation?: RealOrientation } /** * Space platform may be specified in one of one ways. * * ## Union members * - {@link LuaSpacePlatform} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SpacePlatformIdentification.html Online documentation} */ export type SpacePlatformIdentification = LuaSpacePlatform /** * Set of forces. Can be specified in one of two ways. * * ## Union members * - {@link LuaForce}[]: Array of many forces. * - {@link LuaForce}: A single force. * @see ForceSetWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ForceSet.html Online documentation} */ export type ForceSet = LuaForce[] | LuaForce /** * Write form of {@link ForceSet}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ForceSet.html Online documentation} */ export type ForceSetWrite = readonly ForceID[] | ForceID /** * A decorative prototype may be specified in one of two ways. * * ## Union members * - {@link LuaDecorativePrototype}: The decorative prototype. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/DecorativeID.html Online documentation} */ export type DecorativeID = LuaDecorativePrototype | string /** * An asteroid chunk prototype may be specified in one of two ways. * * ## Union members * - {@link LuaAsteroidChunkPrototype}: The asteroid chunk prototype. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AsteroidChunkID.html Online documentation} */ export type AsteroidChunkID = LuaAsteroidChunkPrototype | string /** * A space location prototype may be specified in one of two ways. * * ## Union members * - {@link LuaSpaceLocationPrototype}: The space location prototype. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SpaceLocationID.html Online documentation} */ export type SpaceLocationID = LuaSpaceLocationPrototype | string /** * A signal filter may be specified in two ways, either as a string which is a virtual signal name or item prototype name or as a table. * @see SignalFilterWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SignalFilter.html Online documentation} */ export type SignalFilter = | { /** * The type of the signal filter. */ readonly type?: SignalIDType /** * Name of the signal. */ readonly name: string /** * The prototype name of the signal's quality. `nil` for any quality. */ readonly quality?: LuaQualityPrototype /** * The comparator for quality. `nil` if any quality. */ readonly comparator?: ComparatorStringRead } | string /** * Write form of {@link SignalFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SignalFilter.html Online documentation} */ export type SignalFilterWrite = | { /** * The type of the signal filter. */ readonly type?: SignalIDType /** * Name of the signal. */ readonly name: string /** * The prototype name of the signal's quality. `nil` for any quality. */ readonly quality?: QualityID /** * The comparator for quality. `nil` if any quality. */ readonly comparator?: ComparatorString } | string /** * @see LogisticFilterWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LogisticFilter.html Online documentation} */ export interface LogisticFilter { /** * The item filter to put into the slot. */ readonly value?: SignalFilter /** * The minimum amount to satisfy. */ readonly min?: int /** * The maximum amount to keep in inventory. `nil` for infinite. */ readonly max?: ItemCountType /** * The minimum count that will be delivered to a space platform. `nil` if unchanged from the default. */ readonly minimum_delivery_count?: ItemCountType /** * The space location to import from. */ readonly import_from?: LuaSpaceLocationPrototype } /** * Write form of {@link LogisticFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LogisticFilter.html Online documentation} */ export interface LogisticFilterWrite { /** * The item filter to put into the slot. */ readonly value?: SignalFilterWrite /** * The minimum amount to satisfy. */ readonly min?: int /** * The maximum amount to keep in inventory. `nil` for infinite. */ readonly max?: ItemCountType /** * The minimum count that will be delivered to a space platform. `nil` if unchanged from the default. */ readonly minimum_delivery_count?: ItemCountType /** * The space location to import from. */ readonly import_from?: SpaceLocationID } export interface PrintSettings { /** * Color of the message to print. Defaults to white. */ readonly color?: Color | ColorArray /** * If a sound should be emitted for this message. Defaults to `defines.print_sound.use_player_settings`. */ readonly sound?: defines.print_sound /** * Condition when to skip adding message. Defaults to `defines.print_skip.if_redundant`. */ readonly skip?: defines.print_skip /** * The sound to play. If not given, {@link import("factorio:prototype").UtilitySounds#console_message UtilitySounds::console_message} will be used instead. */ readonly sound_path?: SoundPath /** * The volume of the sound to play. Must be between 0 and 1 inclusive. Defaults to 1. */ readonly volume_modifier?: float /** * If set to false, message will not be part of game state and will disappear from output console after save-load. Defaults to `true`. */ readonly game_state?: boolean } /** * Surface property prototype may be specified in one of two ways. * * ## Union members * - {@link LuaSurfacePropertyPrototype}: The surface property prototype. * - `string`: The prototype name. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SurfacePropertyID.html Online documentation} */ export type SurfacePropertyID = LuaSurfacePropertyPrototype | string /** * When writing it is possible to give LuaEntity or MapPosition directly. However, reading always returns the full ScriptRenderTargetTable. * @see ScriptRenderTargetWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScriptRenderTarget.html Online documentation} */ export type ScriptRenderTarget = LuaEntity | MapPosition | ScriptRenderTargetTable /** * Write form of {@link ScriptRenderTarget}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScriptRenderTarget.html Online documentation} */ export type ScriptRenderTargetWrite = LuaEntity | (MapPosition | MapPositionArray) | ScriptRenderTargetTableWrite /** * @see ScriptRenderTargetTableWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScriptRenderTargetTable.html Online documentation} */ export interface ScriptRenderTargetTable { readonly entity?: LuaEntity /** * Only used if `entity` was given. */ readonly offset?: Vector /** * Only used, and mandatory if `entity` is not given. */ readonly position?: MapPosition } /** * Write form of {@link ScriptRenderTargetTable}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScriptRenderTargetTable.html Online documentation} */ export interface ScriptRenderTargetTableWrite { readonly entity?: LuaEntity /** * Only used if `entity` was given. */ readonly offset?: Vector /** * Only used, and mandatory if `entity` is not given. */ readonly position?: MapPosition | MapPositionArray } /** * An item filter may be specified in two ways, either as a string which is a quality prototype name or as a table. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/QualityCondition.html Online documentation} */ export type QualityCondition = | { /** * The prototype name of the quality. */ readonly quality?: string /** * The comparator for quality. */ readonly comparator?: ComparatorString } | string /** * The destination of a cargo pod. * @see CargoDestinationWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CargoDestination.html Online documentation} */ export interface CargoDestination { /** * The type of destination. */ readonly type: defines.cargo_destination /** * Only used if `type` is {@link defines.cargo_destination.station station}. Must be entity of type `cargo-landing-pad` or `space-platform-hub`. */ readonly station?: LuaEntity /** * Only used if `type` is {@link defines.cargo_destination.station station}. Must be connected to the station and not reserved. */ readonly hatch?: LuaCargoHatch /** * Only used if `type` is {@link defines.cargo_destination.station station} or {@link defines.cargo_destination.surface surface}. If true, items with {@link import("factorio:prototype").ItemPrototype#rocket_launch_products rocket_launch_products} defined will be transformed into their products before starting descent. Defaults to `false`. */ readonly transform_launch_products?: boolean /** * Only used if `type` is {@link defines.cargo_destination.surface surface}. */ readonly surface?: SurfaceIdentification /** * Only used if `type` is {@link defines.cargo_destination.surface surface}. Determines the position on the surface to land near. If not provided, cargo pod will switch destination type from {@link defines.cargo_destination.surface surface} to {@link defines.cargo_destination.station station} before starting descent if there is a station available, and will land at {0, 0} if there is no station available. */ readonly position?: MapPosition /** * Only used if `type` is {@link defines.cargo_destination.surface surface} and `position` is specified. Determines whether to land at `position` exactly or at a random location nearby. Defaults to `false`. */ readonly land_at_exact_position?: boolean /** * Only used if `type` is {@link defines.cargo_destination.space_platform space_platform}. Only used for sending space platform starter packs to a platform that is waiting for a starter pack. */ readonly space_platform?: SpacePlatformIdentification } /** * Write form of {@link CargoDestination}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CargoDestination.html Online documentation} */ export interface CargoDestinationWrite { /** * The type of destination. */ readonly type: defines.cargo_destination /** * Only used if `type` is {@link defines.cargo_destination.station station}. Must be entity of type `cargo-landing-pad` or `space-platform-hub`. */ readonly station?: LuaEntity /** * Only used if `type` is {@link defines.cargo_destination.station station}. Must be connected to the station and not reserved. */ readonly hatch?: LuaCargoHatch /** * Only used if `type` is {@link defines.cargo_destination.station station} or {@link defines.cargo_destination.surface surface}. If true, items with {@link import("factorio:prototype").ItemPrototype#rocket_launch_products rocket_launch_products} defined will be transformed into their products before starting descent. Defaults to `false`. */ readonly transform_launch_products?: boolean /** * Only used if `type` is {@link defines.cargo_destination.surface surface}. */ readonly surface?: SurfaceIdentification /** * Only used if `type` is {@link defines.cargo_destination.surface surface}. Determines the position on the surface to land near. If not provided, cargo pod will switch destination type from {@link defines.cargo_destination.surface surface} to {@link defines.cargo_destination.station station} before starting descent if there is a station available, and will land at {0, 0} if there is no station available. */ readonly position?: MapPosition | MapPositionArray /** * Only used if `type` is {@link defines.cargo_destination.surface surface} and `position` is specified. Determines whether to land at `position` exactly or at a random location nearby. Defaults to `false`. */ readonly land_at_exact_position?: boolean /** * Only used if `type` is {@link defines.cargo_destination.space_platform space_platform}. Only used for sending space platform starter packs to a platform that is waiting for a starter pack. */ readonly space_platform?: SpacePlatformIdentification } export interface ScheduleRecordPosition { /** * The schedule index */ readonly schedule_index?: uint /** * The interrupt index */ readonly interrupt_index?: uint } /** * Event name may be specified in one of four ways. * * ## Union members * - {@link LuaCustomEventPrototype}: Custom event prototype. * - {@link LuaCustomInputPrototype}: Custom input prototype. * - {@link defines.events}: Event identifier. * - `string`: Name of the event. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaEventType.html Online documentation} */ export type LuaEventType = LuaCustomEventPrototype | LuaCustomInputPrototype | defines.events | string | EventId /** * ## Union members * - `"center-to-center"` * - `"bounding-box-to-bounding-box"` * - `"center-to-bounding-box"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/RangeMode.html Online documentation} */ export type RangeMode = "center-to-center" | "bounding-box-to-bounding-box" | "center-to-bounding-box" /** * The representation of an entity inside of a blueprint. It has at least these fields, but can contain additional ones depending on the kind of entity. * @see BlueprintEntityWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintEntity.html Online documentation} */ export interface BlueprintEntity { /** * The entity's unique identifier in the blueprint. */ readonly entity_number: uint /** * The prototype name of the entity. */ readonly name: string /** * The position of the entity. */ readonly position: MapPosition /** * The direction the entity is facing. Only present for entities that can face in different directions and when the entity is not facing north. */ readonly direction?: defines.direction /** * Whether this entity is mirrored. */ readonly mirror?: boolean /** * The prototype name of the entity's quality. */ readonly quality?: string /** * The control behavior of the entity, if it has one. The format of the control behavior depends on the entity's type. Only relevant for entities that support control behaviors. */ readonly control_behavior?: BlueprintControlBehavior /** * The items that the entity will request when revived, if any. */ readonly items?: BlueprintInsertPlan[] /** * The entity tags of the entity, if there are any. */ readonly tags?: Tags /** * The schedule of the entity, if it has one. Only relevant for locomotives. */ readonly schedule?: BlueprintSchedule /** * Wires connected to this entity in the blueprint. */ readonly wires?: BlueprintWire[] /** * Used by assembling machines. Name of the recipe prototype */ readonly recipe?: string /** * Used by assembling machines; quality of the recipe. */ readonly recipe_quality?: LuaQualityPrototype /** * Used by containers (chests). The index of the first inaccessible item slot due to limiting with the red "bar". 0-based. */ readonly bar?: uint16 /** * Cargo wagon or filtered container inventory configuration, for item filters and bar. */ readonly inventory?: BlueprintInventory /** * Used by Infinity containers and infinity pipes. */ readonly infinity_settings?: InfinityContainerFilter | InfinityPipeFilter /** * Used by heat interfaces. */ readonly mode?: "at-least" | "at-most" | "exactly" | "add" | "remove" /** * Used by heat interfaces. */ readonly temperature?: uint /** * Type of the underground belt or loader. Either "input" or "output". */ readonly type?: "input" | "output" /** * Input priority of the splitter. Either "right" or "left", "none" is omitted. */ readonly input_priority?: "right" | "left" /** * Output priority of the splitter. Either "right" or "left", "none" is omitted. */ readonly output_priority?: "right" | "left" /** * Filter of the splitter. */ readonly filter?: BlueprintLogisticFilter /** * Filters of the filter inserter or loader. */ readonly filters?: BlueprintLogisticFilter[] /** * Filter mode of the filter inserter. */ readonly filter_mode?: "whitelist" | "blacklist" /** * The stack size the inserter is set to. */ readonly override_stack_size?: uint8 /** * The drop position the inserter is set to. */ readonly drop_position?: MapPosition /** * The pickup position the inserter is set to. */ readonly pickup_position?: MapPosition /** * Spoiled priority of an inserter. "spoiled-first" or "fresh-first", "none" is omitted. */ readonly spoil_priority?: "spoiled-first" | "fresh-first" /** * Used by all entities with logistics sections, except for combinators. */ readonly request_filters?: BlueprintRequestFilters /** * Used by programmable speakers. */ readonly parameters?: ProgrammableSpeakerParameters /** * Used by programmable speakers. */ readonly alert_parameters?: ProgrammableSpeakerAlertParameters /** * Used by rocket silos. I have no idea what this is. */ readonly transitional_request_index?: uint /** * Used by {@link https://wiki.factorio.com/Prototype/SimpleEntityWithForce Prototype/SimpleEntityWithForce} or {@link https://wiki.factorio.com/Prototype/SimpleEntityWithOwner Prototype/SimpleEntityWithOwner}. */ readonly variation?: uint8 /** * Color of the entity. Used by SimpleEntityWithForce, SimpleEntityWithOwner, train stations, locomotives, and vehicles. */ readonly color?: Color /** * The name of the train station. */ readonly station?: string /** * The train limit of a train stop. */ readonly manual_trains_limit?: uint /** * The priority of the train station. */ readonly priority?: uint8 /** * Orientation of the cargo wagon or locomotive, value from 0 to 1 */ readonly orientation?: RealOrientation /** * If this locomotive copies its color from the train stop. Default true. */ readonly copy_color_from_train_stop?: boolean /** * Used by spidertons. */ readonly vehicle_automatic_targeting_parameters?: VehicleAutomaticTargetingParameters /** * Used by vehicles. */ readonly driver_is_main_gunner?: boolean /** * Used by vehicles. */ readonly selected_gun_index?: uint /** * Used to vehicles and rolling stock. */ readonly enable_logistics_while_moving?: boolean /** * Equipment grid. Note that [items] requests also needs to be set for bots to insert into the grid. */ readonly grid?: BlueprintEquipment[] readonly artillery_auto_targeting?: boolean /** * Combinator description. */ readonly player_description?: string /** * Used by display panels. */ readonly always_show?: boolean /** * Used by display panels. */ readonly show_in_chart?: boolean /** * Display panel icon. */ readonly icon?: SignalID /** * Display panel text. */ readonly text?: string /** * Turret configuration. */ readonly "ignore-unprioritised"?: boolean /** * Turret configuration. */ readonly "priority-list"?: { readonly index: uint readonly entity_id: LuaEntityPrototype }[] } /** * Write form of {@link BlueprintEntity}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintEntity.html Online documentation} */ export interface BlueprintEntityWrite { /** * The entity's unique identifier in the blueprint. */ readonly entity_number: uint /** * The prototype name of the entity. */ readonly name: string /** * The position of the entity. */ readonly position: MapPosition | MapPositionArray /** * The direction the entity is facing. Only present for entities that can face in different directions and when the entity is not facing north. */ readonly direction?: defines.direction /** * Whether this entity is mirrored. */ readonly mirror?: boolean /** * The prototype name of the entity's quality. */ readonly quality?: string /** * The control behavior of the entity, if it has one. The format of the control behavior depends on the entity's type. Only relevant for entities that support control behaviors. */ readonly control_behavior?: BlueprintControlBehaviorWrite /** * The items that the entity will request when revived, if any. */ readonly items?: readonly BlueprintInsertPlanWrite[] /** * The entity tags of the entity, if there are any. */ readonly tags?: Tags /** * The schedule of the entity, if it has one. Only relevant for locomotives. */ readonly schedule?: BlueprintScheduleWrite /** * Wires connected to this entity in the blueprint. */ readonly wires?: BlueprintWire[] /** * Used by assembling machines. Name of the recipe prototype */ readonly recipe?: string /** * Used by assembling machines; quality of the recipe. */ readonly recipe_quality?: QualityID /** * Used by containers (chests). The index of the first inaccessible item slot due to limiting with the red "bar". 0-based. */ readonly bar?: uint16 /** * Cargo wagon or filtered container inventory configuration, for item filters and bar. */ readonly inventory?: BlueprintInventoryWrite /** * Used by Infinity containers and infinity pipes. */ readonly infinity_settings?: InfinityContainerFilter | InfinityPipeFilter /** * Used by heat interfaces. */ readonly mode?: "at-least" | "at-most" | "exactly" | "add" | "remove" /** * Used by heat interfaces. */ readonly temperature?: uint /** * Type of the underground belt or loader. Either "input" or "output". */ readonly type?: "input" | "output" /** * Input priority of the splitter. Either "right" or "left", "none" is omitted. */ readonly input_priority?: "right" | "left" /** * Output priority of the splitter. Either "right" or "left", "none" is omitted. */ readonly output_priority?: "right" | "left" /** * Filter of the splitter. */ readonly filter?: BlueprintLogisticFilterWrite /** * Filters of the filter inserter or loader. */ readonly filters?: readonly BlueprintLogisticFilterWrite[] /** * Filter mode of the filter inserter. */ readonly filter_mode?: "whitelist" | "blacklist" /** * The stack size the inserter is set to. */ readonly override_stack_size?: uint8 /** * The drop position the inserter is set to. */ readonly drop_position?: MapPosition | MapPositionArray /** * The pickup position the inserter is set to. */ readonly pickup_position?: MapPosition | MapPositionArray /** * Spoiled priority of an inserter. "spoiled-first" or "fresh-first", "none" is omitted. */ readonly spoil_priority?: "spoiled-first" | "fresh-first" /** * Used by all entities with logistics sections, except for combinators. */ readonly request_filters?: BlueprintRequestFilters /** * Used by programmable speakers. */ readonly parameters?: ProgrammableSpeakerParameters /** * Used by programmable speakers. */ readonly alert_parameters?: ProgrammableSpeakerAlertParametersWrite /** * Used by rocket silos. I have no idea what this is. */ readonly transitional_request_index?: uint /** * Used by {@link https://wiki.factorio.com/Prototype/SimpleEntityWithForce Prototype/SimpleEntityWithForce} or {@link https://wiki.factorio.com/Prototype/SimpleEntityWithOwner Prototype/SimpleEntityWithOwner}. */ readonly variation?: uint8 /** * Color of the entity. Used by SimpleEntityWithForce, SimpleEntityWithOwner, train stations, locomotives, and vehicles. */ readonly color?: Color | ColorArray /** * The name of the train station. */ readonly station?: string /** * The train limit of a train stop. */ readonly manual_trains_limit?: uint /** * The priority of the train station. */ readonly priority?: uint8 /** * Orientation of the cargo wagon or locomotive, value from 0 to 1 */ readonly orientation?: RealOrientation /** * If this locomotive copies its color from the train stop. Default true. */ readonly copy_color_from_train_stop?: boolean /** * Used by spidertons. */ readonly vehicle_automatic_targeting_parameters?: VehicleAutomaticTargetingParameters /** * Used by vehicles. */ readonly driver_is_main_gunner?: boolean /** * Used by vehicles. */ readonly selected_gun_index?: uint /** * Used to vehicles and rolling stock. */ readonly enable_logistics_while_moving?: boolean /** * Equipment grid. Note that [items] requests also needs to be set for bots to insert into the grid. */ readonly grid?: readonly BlueprintEquipmentWrite[] readonly artillery_auto_targeting?: boolean /** * Combinator description. */ readonly player_description?: string /** * Used by display panels. */ readonly always_show?: boolean /** * Used by display panels. */ readonly show_in_chart?: boolean /** * Display panel icon. */ readonly icon?: SignalIDWrite /** * Display panel text. */ readonly text?: string /** * Turret configuration. */ readonly "ignore-unprioritised"?: boolean /** * Turret configuration. */ readonly "priority-list"?: readonly { readonly index: uint readonly entity_id: EntityID }[] } export interface BlueprintRequestFilters { /** * False if disabled in a vehicle. */ readonly enabled?: boolean readonly request_from_buffers?: boolean } /** * @see BlueprintEquipmentWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintEquipment.html Online documentation} */ export interface BlueprintEquipment { readonly equipment: ItemIDAndQualityIDPair readonly position: EquipmentPosition } /** * Write form of {@link BlueprintEquipment}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintEquipment.html Online documentation} */ export interface BlueprintEquipmentWrite { readonly equipment: ItemIDAndQualityIDPairWrite readonly position: EquipmentPosition | EquipmentPositionArray } /** * @see BlueprintInventoryWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintInventory.html Online documentation} */ export interface BlueprintInventory { readonly filters?: BlueprintLogisticFilter[] /** * The index of the first inaccessible item slot due to limiting with the red "bar". 0-based. */ readonly bar?: uint16 } /** * Write form of {@link BlueprintInventory}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintInventory.html Online documentation} */ export interface BlueprintInventoryWrite { readonly filters?: readonly BlueprintLogisticFilterWrite[] /** * The index of the first inaccessible item slot due to limiting with the red "bar". 0-based. */ readonly bar?: uint16 } export interface InfinityContainerFilter { /** * Whether the "remove unfiltered items" checkbox is checked. */ readonly remove_unfiltered_items: boolean /** * Filters of the infinity container. */ readonly filters?: InfinityInventoryFilter[] } /** * @see BlueprintControlBehaviorWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintControlBehavior.html Online documentation} */ export interface BlueprintControlBehavior { /** * If this entity is enabled/disabled by the circuit network. * * Does **not** apply to logistic containers, see instead {@link circuit_condition_enabled }. * * Corresponds to {@link LuaGenericOnOffControlBehavior.circuit_enable_disable } */ readonly circuit_enabled?: boolean /** * Applies to any entity that can be enabled/disabled by the circuit network. */ readonly circuit_condition?: CircuitCondition /** * Corresponds to {@link LuaGenericOnOffControlBehavior.connect_to_logistic_network }. */ readonly connect_to_logistic_network?: boolean /** * Corresponds to {@link LuaGenericOnOffControlBehavior.logistic_condition }. */ readonly logistic_condition?: CircuitCondition /** * If this entity with inventory reads its contents to the circuit network. Default true. * * Does not apply to asteroid collectors, see {@link circuit_read_contents }. */ readonly read_contents?: boolean /** * For assembling machines, whether to include items in crafting for {@link read_contents }. * * Default true. */ readonly include_in_crafting?: boolean /** * If an **asteroid collector** reads its contents to the circuit network. Default false. */ readonly circuit_read_contents?: boolean /** * On a turret, if the ammo is read by the circuit network. Default true. */ readonly read_ammo?: boolean /** * Used by turrets. */ readonly set_priority_list?: boolean /** * Used by turrets. */ readonly set_ignore_unlisted_targets?: boolean /** * Used by turrets. */ readonly ignore_unlisted_targets_condition?: CircuitCondition readonly circuit_mode_of_operation?: | defines.control_behavior.logistic_container.exclusive_mode | defines.control_behavior.cargo_landing_pad.exclusive_mode /** * If this **logistics container** is enabled/disabled by the circuit network. * * For other machines, see {@link circuit_enabled }. */ readonly circuit_condition_enabled?: boolean /** * Accumulator or gate output signal. */ readonly output_signal?: SignalID /** * If the accumulator sends its charge to the circuit network. Default true. */ readonly read_charge?: boolean /** * Used by walls connected to gates. */ readonly circuit_open_gate?: boolean /** * Used by walls connected to gates. The signal is defined by {@link output_signal }. */ readonly circuit_read_sensor?: boolean /** * If this inserter or belt is read by the circuit network. */ readonly circuit_read_hand_contents?: boolean /** * For reading contents of an inserter. */ readonly circuit_hand_read_mode?: defines.control_behavior.inserter.hand_read_mode /** * For reading contents of a belt. */ readonly circuit_contents_read_mode?: defines.control_behavior.transport_belt.content_read_mode /** * If this inserter, loader, or asteroid collector has its filters set by the circuit network. */ readonly circuit_set_filters?: boolean /** * If this pump should set its only filter from the circuit network */ readonly set_filter?: boolean /** * If this loader pulses its transfers to the circuit network. */ readonly circuit_read_transfers?: boolean /** * If this inserter has its stack size set by the circuit network. */ readonly circuit_set_stack_size?: boolean readonly stack_control_input_signal?: SignalID /** * Used by assembling machines. */ readonly set_recipe?: boolean readonly read_ingredients?: boolean readonly read_recipe_finished?: boolean readonly read_recipe_finished_signal?: SignalID readonly read_working?: boolean readonly read_working_signal?: SignalID /** * If this mining drill reads its resources to the circuit network. */ readonly circuit_read_resources?: boolean readonly circuit_resource_read_mode?: defines.control_behavior.mining_drill.resource_read_mode /** * Used by constant combinators. */ readonly is_on?: boolean /** * Used by constant combinators. */ readonly sections?: LogisticSections readonly arithmetic_conditions?: ArithmeticCombinatorParameters readonly decider_conditions?: DeciderCombinatorParameters /** * Used by selector combinators. */ readonly index_signal?: SignalID /** * Used by selector combinators. */ readonly index_constant?: uint /** * Used by selector combinators. */ readonly count_signal?: SignalID /** * Used by selector combinators. When not specified, defaults to "select". */ readonly operation?: "select" | "count" | "random" /** * Used by selector combinators. */ readonly select_max?: boolean /** * Applies to train stop. Default true. */ readonly send_to_train?: boolean readonly read_from_train?: boolean readonly set_trains_limit?: boolean readonly trains_limit_signal?: SignalID readonly read_stopped_train?: boolean readonly train_stopped_signal?: SignalID readonly read_trains_count?: boolean readonly trains_count_signal?: SignalID readonly set_priority?: boolean readonly priority_signal?: SignalID /** * Used by lamps. */ readonly use_colors?: boolean readonly color_mode?: defines.control_behavior.lamp.color_mode /** * Used by **lamps**. For rail signals, see {@link red_output_signal }. */ readonly red_signal?: SignalID /** * Used by **lamps**. For rail signals, see {@link green_output_signal }. */ readonly green_signal?: SignalID /** * Used by **lamps**. For rail signals, see {@link orange_output_signal }. */ readonly blue_signal?: SignalID /** * Used by lamps. */ readonly rgb_signal?: SignalID /** * Used by roboports. */ readonly read_items_mode?: | defines.control_behavior.roboport.read_items_mode | defines.control_behavior.rocket_silo.read_mode readonly read_robot_stats?: boolean readonly available_logistic_output_signal?: SignalID readonly total_logistic_output_signal?: SignalID readonly available_construction_output_signal?: SignalID readonly total_construction_output_signal?: SignalID readonly roboport_count_output_signal?: SignalID /** * Used by train signals. */ readonly circuit_close_signal?: boolean /** * Used by train signals. */ readonly circuit_read_signal?: boolean /** * Used by **train signals**. For lamps, seed {@link red_signal }. */ readonly red_output_signal?: SignalID /** * used by train signals. */ readonly orange_output_signal?: SignalID /** * Used by **train signals**. For lamps, seed {@link green_signal }. */ readonly green_output_signal?: SignalID /** * Used by **train signals**. For lamps, seed {@link blue_signal }. */ readonly blue_output_signal?: SignalID /** * Used by programmable speakers. */ readonly circuit_parameters?: ProgrammableSpeakerCircuitParameters /** * Display panel configuration. */ readonly parameters?: DisplayPanelMessageDefinition /** * If this reads the fuel contents of this reactor. */ readonly read_burner_fuel?: boolean /** * If this reads the temperature of this reactor. */ readonly read_temperature?: boolean readonly temperature_signal?: SignalID /** * Used by space platform hub. */ readonly send_to_platform?: boolean readonly read_moving_from?: boolean readonly read_moving_to?: boolean readonly read_speed?: boolean readonly speed_signal?: SignalID readonly read_damage_taken?: boolean readonly damage_taken_signal?: SignalID } /** * Write form of {@link BlueprintControlBehavior}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintControlBehavior.html Online documentation} */ export interface BlueprintControlBehaviorWrite { /** * If this entity is enabled/disabled by the circuit network. * * Does **not** apply to logistic containers, see instead {@link circuit_condition_enabled }. * * Corresponds to {@link LuaGenericOnOffControlBehavior.circuit_enable_disable } */ readonly circuit_enabled?: boolean /** * Applies to any entity that can be enabled/disabled by the circuit network. */ readonly circuit_condition?: CircuitConditionWrite /** * Corresponds to {@link LuaGenericOnOffControlBehavior.connect_to_logistic_network }. */ readonly connect_to_logistic_network?: boolean /** * Corresponds to {@link LuaGenericOnOffControlBehavior.logistic_condition }. */ readonly logistic_condition?: CircuitConditionWrite /** * If this entity with inventory reads its contents to the circuit network. Default true. * * Does not apply to asteroid collectors, see {@link circuit_read_contents }. */ readonly read_contents?: boolean /** * For assembling machines, whether to include items in crafting for {@link read_contents }. * * Default true. */ readonly include_in_crafting?: boolean /** * If an **asteroid collector** reads its contents to the circuit network. Default false. */ readonly circuit_read_contents?: boolean /** * On a turret, if the ammo is read by the circuit network. Default true. */ readonly read_ammo?: boolean /** * Used by turrets. */ readonly set_priority_list?: boolean /** * Used by turrets. */ readonly set_ignore_unlisted_targets?: boolean /** * Used by turrets. */ readonly ignore_unlisted_targets_condition?: CircuitConditionWrite readonly circuit_mode_of_operation?: | defines.control_behavior.logistic_container.exclusive_mode | defines.control_behavior.cargo_landing_pad.exclusive_mode /** * If this **logistics container** is enabled/disabled by the circuit network. * * For other machines, see {@link circuit_enabled }. */ readonly circuit_condition_enabled?: boolean /** * Accumulator or gate output signal. */ readonly output_signal?: SignalIDWrite /** * If the accumulator sends its charge to the circuit network. Default true. */ readonly read_charge?: boolean /** * Used by walls connected to gates. */ readonly circuit_open_gate?: boolean /** * Used by walls connected to gates. The signal is defined by {@link output_signal }. */ readonly circuit_read_sensor?: boolean /** * If this inserter or belt is read by the circuit network. */ readonly circuit_read_hand_contents?: boolean /** * For reading contents of an inserter. */ readonly circuit_hand_read_mode?: defines.control_behavior.inserter.hand_read_mode /** * For reading contents of a belt. */ readonly circuit_contents_read_mode?: defines.control_behavior.transport_belt.content_read_mode /** * If this inserter, loader, or asteroid collector has its filters set by the circuit network. */ readonly circuit_set_filters?: boolean /** * If this pump should set its only filter from the circuit network */ readonly set_filter?: boolean /** * If this loader pulses its transfers to the circuit network. */ readonly circuit_read_transfers?: boolean /** * If this inserter has its stack size set by the circuit network. */ readonly circuit_set_stack_size?: boolean readonly stack_control_input_signal?: SignalIDWrite /** * Used by assembling machines. */ readonly set_recipe?: boolean readonly read_ingredients?: boolean readonly read_recipe_finished?: boolean readonly read_recipe_finished_signal?: SignalIDWrite readonly read_working?: boolean readonly read_working_signal?: SignalIDWrite /** * If this mining drill reads its resources to the circuit network. */ readonly circuit_read_resources?: boolean readonly circuit_resource_read_mode?: defines.control_behavior.mining_drill.resource_read_mode /** * Used by constant combinators. */ readonly is_on?: boolean /** * Used by constant combinators. */ readonly sections?: LogisticSectionsWrite readonly arithmetic_conditions?: ArithmeticCombinatorParametersWrite readonly decider_conditions?: DeciderCombinatorParameters /** * Used by selector combinators. */ readonly index_signal?: SignalIDWrite /** * Used by selector combinators. */ readonly index_constant?: uint /** * Used by selector combinators. */ readonly count_signal?: SignalIDWrite /** * Used by selector combinators. When not specified, defaults to "select". */ readonly operation?: "select" | "count" | "random" /** * Used by selector combinators. */ readonly select_max?: boolean /** * Applies to train stop. Default true. */ readonly send_to_train?: boolean readonly read_from_train?: boolean readonly set_trains_limit?: boolean readonly trains_limit_signal?: SignalIDWrite readonly read_stopped_train?: boolean readonly train_stopped_signal?: SignalIDWrite readonly read_trains_count?: boolean readonly trains_count_signal?: SignalIDWrite readonly set_priority?: boolean readonly priority_signal?: SignalIDWrite /** * Used by lamps. */ readonly use_colors?: boolean readonly color_mode?: defines.control_behavior.lamp.color_mode /** * Used by **lamps**. For rail signals, see {@link red_output_signal }. */ readonly red_signal?: SignalIDWrite /** * Used by **lamps**. For rail signals, see {@link green_output_signal }. */ readonly green_signal?: SignalIDWrite /** * Used by **lamps**. For rail signals, see {@link orange_output_signal }. */ readonly blue_signal?: SignalIDWrite /** * Used by lamps. */ readonly rgb_signal?: SignalIDWrite /** * Used by roboports. */ readonly read_items_mode?: | defines.control_behavior.roboport.read_items_mode | defines.control_behavior.rocket_silo.read_mode readonly read_robot_stats?: boolean readonly available_logistic_output_signal?: SignalIDWrite readonly total_logistic_output_signal?: SignalIDWrite readonly available_construction_output_signal?: SignalIDWrite readonly total_construction_output_signal?: SignalIDWrite readonly roboport_count_output_signal?: SignalIDWrite /** * Used by train signals. */ readonly circuit_close_signal?: boolean /** * Used by train signals. */ readonly circuit_read_signal?: boolean /** * Used by **train signals**. For lamps, seed {@link red_signal }. */ readonly red_output_signal?: SignalIDWrite /** * used by train signals. */ readonly orange_output_signal?: SignalIDWrite /** * Used by **train signals**. For lamps, seed {@link green_signal }. */ readonly green_output_signal?: SignalIDWrite /** * Used by **train signals**. For lamps, seed {@link blue_signal }. */ readonly blue_output_signal?: SignalIDWrite /** * Used by programmable speakers. */ readonly circuit_parameters?: ProgrammableSpeakerCircuitParameters /** * Display panel configuration. */ readonly parameters?: DisplayPanelMessageDefinitionWrite /** * If this reads the fuel contents of this reactor. */ readonly read_burner_fuel?: boolean /** * If this reads the temperature of this reactor. */ readonly read_temperature?: boolean readonly temperature_signal?: SignalIDWrite /** * Used by space platform hub. */ readonly send_to_platform?: boolean readonly read_moving_from?: boolean readonly read_moving_to?: boolean readonly read_speed?: boolean readonly speed_signal?: SignalIDWrite readonly read_damage_taken?: boolean readonly damage_taken_signal?: SignalIDWrite } /** * A string that represents a math expression. The expression parser recognizes four basic token types (with their regex): * * - Whitespace: `[ \n\r\t]*` * * - Number: `(0x[0-9a-f]+|([0-9]+\.?[0-9]*|\.[0-9]+)(e-?[0-9]+)?)` (e.g. `3.2`, `100`, `.6`, `4.2e-5`, `0x2a5f`). Supports hexadecimal input and scientific notation for decimal numbers. * * - Operator: `+`, `-`, `*`, `/`, `^`, and `()` for brackets, which may be nested. * * - Identifier: The functions listed below and any variables listed where the expression is used. * * Identifiers are used to name functions and variables, which result in or represent numbers. The following functions are always available: * * - `abs(value)`: Returns absolute value of the given argument; i.e. if the argument is negative, it is inverted. * * - `log2(value)`: Returns a binary logarithm of the given value. * * - `sign(value)`: Returns `-1` for negative numbers, `0` for zero (regardless of sign), `1` for positive numbers * * - `max(value1, value2, ...)`: Returns the greater of the given values. Supports between 2 and 255 arguments. * * - `min(value1, value2, ...)`: Returns the smaller of the given values. Supports between 2 and 255 arguments. * * The property where the expression is used may provide variables. For example in {@link import("factorio:prototype").TechnologyUnit#count_formula TechnologyUnit::count_formula} `L` and `l` may be used for the technology level. * * The formula is executed following the {@linkplain https://en.wikipedia.org/wiki/Order_of_operations#Conventional_order BODMAS} order (also known as PEMDAS). * @example * "2500 * (L - 3)" * @example * "(4e5 * (abs(speed) + 10.5)) / weight" * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MathExpression.html Online documentation} */ export type MathExpression = string /** * Common attributes to all variants of {@link UndoRedoAction}. */ export interface BaseUndoRedoAction { /** * The type of action that was undone or redone. */ type: | "built-entity" | "removed-entity" | "built-tile" | "removed-tile" | "upgraded-entity" | "upgraded-modules" | "wire-added" | "wire-removed" | "rotated-entity" | "copy-entity-settings" /** * The tags attached to the undo action, if any. */ readonly tags?: Tags } /** * `"built-entity"` variant of {@link UndoRedoAction}. */ export interface BuiltEntityUndoRedoAction extends BaseUndoRedoAction { readonly type: "built-entity" /** * The specification of the built entity. */ readonly target: BlueprintEntity } /** * `"removed-entity"` variant of {@link UndoRedoAction}. */ export interface RemovedEntityUndoRedoAction extends BaseUndoRedoAction { readonly type: "removed-entity" /** * The specification of the removed entity. */ readonly target: BlueprintEntity /** * The surface from which the entity was removed. Not present for entities the game can't restore, like trees or rocks. */ readonly surface_index?: SurfaceIndex /** * The items that the entity will request when revived, if there are any. It's a mapping of prototype names to amounts. Not present for entities the game can't restore, like trees or rocks. */ readonly insert_plan?: BlueprintInsertPlan[] /** * The schedule of the entity, if it has one. Only relevant for locomotives. Not present for entities the game can't restore, like trees or rocks. */ readonly schedule?: BlueprintSchedule } /** * `"built-tile"` variant of {@link UndoRedoAction}. */ export interface BuiltTileUndoRedoAction extends BaseUndoRedoAction { readonly type: "built-tile" /** * The position of the newly built tile. */ readonly position: TilePosition /** * The surface on which the tile was built. */ readonly surface_index: SurfaceIndex /** * The prototype name of the replaced tile, if any was replaced. */ readonly previous_tile?: string /** * The prototype name of the newly built tile. */ readonly new_tile: string } /** * `"removed-tile"` variant of {@link UndoRedoAction}. */ export interface RemovedTileUndoRedoAction extends BaseUndoRedoAction { readonly type: "removed-tile" /** * The position of the removed tile. */ readonly position: TilePosition /** * The surface from which the tile was removed. */ readonly surface_index: SurfaceIndex /** * The prototype name of the removed tile. */ readonly previous_tile: string } /** * `"upgraded-entity"` variant of {@link UndoRedoAction}. */ export interface UpgradedEntityUndoRedoAction extends BaseUndoRedoAction { readonly type: "upgraded-entity" /** * The specification of the upgraded entity. */ readonly target: BlueprintEntity /** * The prototype name of the upgraded entity. */ readonly original_name: string /** * The quality prototype name of the entity before upgrading. */ readonly original_quality_name: string } /** * `"upgraded-modules"` variant of {@link UndoRedoAction}. */ export interface UpgradedModulesUndoRedoAction extends BaseUndoRedoAction { readonly type: "upgraded-modules" /** * The specification of the upgraded entity. */ readonly target: BlueprintEntity /** * The modules present in the target before the upgrade. */ readonly modules_before: BlueprintInsertPlan } /** * `"wire-added"` variant of {@link UndoRedoAction}. */ export interface WireAddedUndoRedoAction extends BaseUndoRedoAction { readonly type: "wire-added" readonly a: BlueprintWireEnd readonly b: BlueprintWireEnd } /** * `"wire-removed"` variant of {@link UndoRedoAction}. */ export interface WireRemovedUndoRedoAction extends BaseUndoRedoAction { readonly type: "wire-removed" readonly a: BlueprintWireEnd readonly b: BlueprintWireEnd } /** * `"rotated-entity"` variant of {@link UndoRedoAction}. */ export interface RotatedEntityUndoRedoAction extends BaseUndoRedoAction { readonly type: "rotated-entity" /** * The specification of the rotated entity. */ readonly target: BlueprintEntity /** * The direction of the entity before upgrading. */ readonly original_direction: defines.direction readonly original_mirroring: boolean } /** * `"copy-entity-settings"` variant of {@link UndoRedoAction}. */ export interface CopyEntitySettingsUndoRedoAction extends BaseUndoRedoAction { readonly type: "copy-entity-settings" readonly target?: BlueprintEntity readonly entity_with_previous_settings?: BlueprintEntity } /** * Base attributes: {@link BaseUndoRedoAction} * * Other attributes may be specified depending on `type`: * - `"built-entity"`: {@link BuiltEntityUndoRedoAction} * - `"removed-entity"`: {@link RemovedEntityUndoRedoAction} * - `"built-tile"`: {@link BuiltTileUndoRedoAction} * - `"removed-tile"`: {@link RemovedTileUndoRedoAction} * - `"upgraded-entity"`: {@link UpgradedEntityUndoRedoAction} * - `"upgraded-modules"`: {@link UpgradedModulesUndoRedoAction} * - `"wire-added"`: {@link WireAddedUndoRedoAction} * - `"wire-removed"`: {@link WireRemovedUndoRedoAction} * - `"rotated-entity"`: {@link RotatedEntityUndoRedoAction} * - `"copy-entity-settings"`: {@link CopyEntitySettingsUndoRedoAction} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/UndoRedoAction.html Online documentation} */ export type UndoRedoAction = | BuiltEntityUndoRedoAction | RemovedEntityUndoRedoAction | BuiltTileUndoRedoAction | RemovedTileUndoRedoAction | UpgradedEntityUndoRedoAction | UpgradedModulesUndoRedoAction | WireAddedUndoRedoAction | WireRemovedUndoRedoAction | RotatedEntityUndoRedoAction | CopyEntitySettingsUndoRedoAction export interface BlueprintWireEnd { readonly entity: BlueprintEntity readonly connector: defines.wire_connector_id } /** * The internal name of a game control (key binding). * * ## Union members * - `"move-up"` * - `"move-down"` * - `"move-left"` * - `"move-right"` * - `"open-character-gui"` * - `"open-gui"` * - `"confirm-gui"` * - `"toggle-free-cursor"` * - `"mine"` * - `"build"` * - `"build-ghost"` * - `"super-forced-build"` * - `"clear-cursor"` * - `"pipette"` * - `"rotate"` * - `"reverse-rotate"` * - `"flip-horizontal"` * - `"flip-vertical"` * - `"pick-items"` * - `"drop-cursor"` * - `"show-info"` * - `"shoot-enemy"` * - `"shoot-selected"` * - `"next-weapon"` * - `"toggle-driving"` * - `"zoom-in"` * - `"zoom-out"` * - `"use-item"` * - `"alternative-use-item"` * - `"toggle-console"` * - `"copy-entity-settings"` * - `"paste-entity-settings"` * - `"controller-gui-logistics-tab"` * - `"controller-gui-character-tab"` * - `"controller-gui-crafting-tab"` * - `"toggle-rail-layer"` * - `"select-for-blueprint"` * - `"select-for-cancel-deconstruct"` * - `"select-for-super-forced-deconstruct"` * - `"reverse-select"` * - `"alt-reverse-select"` * - `"deselect"` * - `"cycle-blueprint-forwards"` * - `"cycle-blueprint-backwards"` * - `"focus-search"` * - `"larger-terrain-building-area"` * - `"smaller-terrain-building-area"` * - `"remove-pole-cables"` * - `"build-with-obstacle-avoidance"` * - `"add-station"` * - `"add-temporary-station"` * - `"rename-all"` * - `"fast-wait-condition"` * - `"drag-map"` * - `"move-tag"` * - `"place-in-chat"` * - `"place-ping"` * - `"pin"` * - `"activate-tooltip"` * - `"next-surface"` * - `"previous-surface"` * - `"cycle-quality-up"` * - `"cycle-quality-down"` * - `"craft"` * - `"craft-5"` * - `"craft-all"` * - `"cancel-craft"` * - `"cancel-craft-5"` * - `"cancel-craft-all"` * - `"pick-item"` * - `"stack-transfer"` * - `"inventory-transfer"` * - `"fast-entity-transfer"` * - `"cursor-split"` * - `"stack-split"` * - `"inventory-split"` * - `"fast-entity-split"` * - `"toggle-filter"` * - `"open-item"` * - `"copy-inventory-filter"` * - `"paste-inventory-filter"` * - `"show-quick-panel"` * - `"next-quick-panel-page"` * - `"previous-quick-panel-page"` * - `"next-quick-panel-tab"` * - `"previous-quick-panel-tab"` * - `"rotate-active-quick-bars"` * - `"next-active-quick-bar"` * - `"previous-active-quick-bar"` * - `"quick-bar-button-1"` * - `"quick-bar-button-2"` * - `"quick-bar-button-3"` * - `"quick-bar-button-4"` * - `"quick-bar-button-5"` * - `"quick-bar-button-6"` * - `"quick-bar-button-7"` * - `"quick-bar-button-8"` * - `"quick-bar-button-9"` * - `"quick-bar-button-10"` * - `"quick-bar-button-1-secondary"` * - `"quick-bar-button-2-secondary"` * - `"quick-bar-button-3-secondary"` * - `"quick-bar-button-4-secondary"` * - `"quick-bar-button-5-secondary"` * - `"quick-bar-button-6-secondary"` * - `"quick-bar-button-7-secondary"` * - `"quick-bar-button-8-secondary"` * - `"quick-bar-button-9-secondary"` * - `"quick-bar-button-10-secondary"` * - `"action-bar-select-page-1"` * - `"action-bar-select-page-2"` * - `"action-bar-select-page-3"` * - `"action-bar-select-page-4"` * - `"action-bar-select-page-5"` * - `"action-bar-select-page-6"` * - `"action-bar-select-page-7"` * - `"action-bar-select-page-8"` * - `"action-bar-select-page-9"` * - `"action-bar-select-page-10"` * - `"copy"` * - `"cut"` * - `"paste"` * - `"cycle-clipboard-forwards"` * - `"cycle-clipboard-backwards"` * - `"undo"` * - `"redo"` * - `"toggle-menu"` * - `"toggle-map"` * - `"close-menu"` * - `"open-technology-gui"` * - `"production-statistics"` * - `"logistic-networks"` * - `"toggle-blueprint-library"` * - `"open-trains-gui"` * - `"open-factoriopedia"` * - `"back"` * - `"forward"` * - `"pause-game"` * - `"confirm-message"` * - `"previous-technology"` * - `"previous-mod"` * - `"connect-train"` * - `"disconnect-train"` * - `"submit-feedback"` * - `"editor-next-variation"` * - `"editor-previous-variation"` * - `"editor-clone-item"` * - `"editor-delete-item"` * - `"editor-toggle-pause"` * - `"editor-tick-once"` * - `"editor-speed-up"` * - `"editor-speed-down"` * - `"editor-reset-speed"` * - `"editor-set-clone-brush-source"` * - `"editor-set-clone-brush-destination"` * - `"editor-switch-to-surface"` * - `"editor-remove-scripting-object"` * - `"debug-toggle-atlas-gui"` * - `"debug-toggle-gui-visibility"` * - `"debug-toggle-debug-settings"` * - `"debug-toggle-basic"` * - `"debug-reset-zoom"` * - `"debug-reset-zoom-2x"` * - `"toggle-gui-debug"` * - `"toggle-gui-style-view"` * - `"toggle-gui-shadows"` * - `"toggle-gui-glows"` * - `"open-prototypes-gui"` * - `"open-prototype-explorer-gui"` * - `"increase-ui-scale"` * - `"decrease-ui-scale"` * - `"reset-ui-scale"` * - `"slash-editor"` * - `"toggle-entity"` * - `"next-player-in-replay"` * - `"move-blueprint-absolute-grid-up"` * - `"move-blueprint-absolute-grid-down"` * - `"move-blueprint-absolute-grid-left"` * - `"move-blueprint-absolute-grid-right"` * - `"move-blueprint-entities-up"` * - `"move-blueprint-entities-down"` * - `"move-blueprint-entities-left"` * - `"move-blueprint-entities-right"` * - `"play-next-track"` * - `"play-previous-track"` * - `"pause-resume-music"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LinkedGameControl.html Online documentation} */ export type LinkedGameControl = | "move-up" | "move-down" | "move-left" | "move-right" | "open-character-gui" | "open-gui" | "confirm-gui" | "toggle-free-cursor" | "mine" | "build" | "build-ghost" | "super-forced-build" | "clear-cursor" | "pipette" | "rotate" | "reverse-rotate" | "flip-horizontal" | "flip-vertical" | "pick-items" | "drop-cursor" | "show-info" | "shoot-enemy" | "shoot-selected" | "next-weapon" | "toggle-driving" | "zoom-in" | "zoom-out" | "use-item" | "alternative-use-item" | "toggle-console" | "copy-entity-settings" | "paste-entity-settings" | "controller-gui-logistics-tab" | "controller-gui-character-tab" | "controller-gui-crafting-tab" | "toggle-rail-layer" | "select-for-blueprint" | "select-for-cancel-deconstruct" | "select-for-super-forced-deconstruct" | "reverse-select" | "alt-reverse-select" | "deselect" | "cycle-blueprint-forwards" | "cycle-blueprint-backwards" | "focus-search" | "larger-terrain-building-area" | "smaller-terrain-building-area" | "remove-pole-cables" | "build-with-obstacle-avoidance" | "add-station" | "add-temporary-station" | "rename-all" | "fast-wait-condition" | "drag-map" | "move-tag" | "place-in-chat" | "place-ping" | "pin" | "activate-tooltip" | "next-surface" | "previous-surface" | "cycle-quality-up" | "cycle-quality-down" | "craft" | "craft-5" | "craft-all" | "cancel-craft" | "cancel-craft-5" | "cancel-craft-all" | "pick-item" | "stack-transfer" | "inventory-transfer" | "fast-entity-transfer" | "cursor-split" | "stack-split" | "inventory-split" | "fast-entity-split" | "toggle-filter" | "open-item" | "copy-inventory-filter" | "paste-inventory-filter" | "show-quick-panel" | "next-quick-panel-page" | "previous-quick-panel-page" | "next-quick-panel-tab" | "previous-quick-panel-tab" | "rotate-active-quick-bars" | "next-active-quick-bar" | "previous-active-quick-bar" | "quick-bar-button-1" | "quick-bar-button-2" | "quick-bar-button-3" | "quick-bar-button-4" | "quick-bar-button-5" | "quick-bar-button-6" | "quick-bar-button-7" | "quick-bar-button-8" | "quick-bar-button-9" | "quick-bar-button-10" | "quick-bar-button-1-secondary" | "quick-bar-button-2-secondary" | "quick-bar-button-3-secondary" | "quick-bar-button-4-secondary" | "quick-bar-button-5-secondary" | "quick-bar-button-6-secondary" | "quick-bar-button-7-secondary" | "quick-bar-button-8-secondary" | "quick-bar-button-9-secondary" | "quick-bar-button-10-secondary" | "action-bar-select-page-1" | "action-bar-select-page-2" | "action-bar-select-page-3" | "action-bar-select-page-4" | "action-bar-select-page-5" | "action-bar-select-page-6" | "action-bar-select-page-7" | "action-bar-select-page-8" | "action-bar-select-page-9" | "action-bar-select-page-10" | "copy" | "cut" | "paste" | "cycle-clipboard-forwards" | "cycle-clipboard-backwards" | "undo" | "redo" | "toggle-menu" | "toggle-map" | "close-menu" | "open-technology-gui" | "production-statistics" | "logistic-networks" | "toggle-blueprint-library" | "open-trains-gui" | "open-factoriopedia" | "back" | "forward" | "pause-game" | "confirm-message" | "previous-technology" | "previous-mod" | "connect-train" | "disconnect-train" | "submit-feedback" | "editor-next-variation" | "editor-previous-variation" | "editor-clone-item" | "editor-delete-item" | "editor-toggle-pause" | "editor-tick-once" | "editor-speed-up" | "editor-speed-down" | "editor-reset-speed" | "editor-set-clone-brush-source" | "editor-set-clone-brush-destination" | "editor-switch-to-surface" | "editor-remove-scripting-object" | "debug-toggle-atlas-gui" | "debug-toggle-gui-visibility" | "debug-toggle-debug-settings" | "debug-toggle-basic" | "debug-reset-zoom" | "debug-reset-zoom-2x" | "toggle-gui-debug" | "toggle-gui-style-view" | "toggle-gui-shadows" | "toggle-gui-glows" | "open-prototypes-gui" | "open-prototype-explorer-gui" | "increase-ui-scale" | "decrease-ui-scale" | "reset-ui-scale" | "slash-editor" | "toggle-entity" | "next-player-in-replay" | "move-blueprint-absolute-grid-up" | "move-blueprint-absolute-grid-down" | "move-blueprint-absolute-grid-left" | "move-blueprint-absolute-grid-right" | "move-blueprint-entities-up" | "move-blueprint-entities-down" | "move-blueprint-entities-left" | "move-blueprint-entities-right" | "play-next-track" | "play-previous-track" | "pause-resume-music" export interface PipeConnectionDefinition { readonly connection_type: "normal" | "underground" | "linked" /** * The 4 cardinal direction connection points for this pipe. */ readonly positions: MapPosition[] /** * The maximum tile distance this underground connection can connect. */ readonly max_underground_distance?: uint readonly flow_direction: "input-output" | "input" | "output" readonly direction: defines.direction readonly connection_category: string[] /** * Only supplied if `connection_type` is `"linked"`. */ linked_connection_id: uint } /** * 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. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemPrototypeFlags.html Online documentation} */ export type ItemPrototypeFlags = { readonly [T in ItemPrototypeFlag]?: true } /** * A `string` specifying an item prototype flag. * * ## Union members * - `"draw-logistic-overlay"`: Determines whether the logistics areas of roboports should be drawn when holding this item. Used by the deconstruction planner by default. * - `"excluded-from-trash-unrequested"`: If this item is skipped by the trash-unrequested logic. * - `"always-show"`: Always shows the item in the logistic requests and filters GUIs (among others) even when the recipe for that item is locked. * - `"hide-from-bonus-gui"`: Hides the item from the bonus GUI. * - `"hide-from-fuel-tooltip"`: Hides the item from the tooltip that's shown when hovering over a burner inventory. * - `"not-stackable"`: Prevents the item from being stacked. It also prevents the item from stacking in assembling machine input slots, which can otherwise exceed the item stack size if required by the recipe. Additionally, the item does not show an item count when in the cursor. * - `"primary-place-result"`: Makes construction bots prefer this item when building the entity specified by its `place_result`. * - `"mod-openable"`: Allows the item to be opened by the player, firing the `on_mod_item_opened` event. Only has an effect for selection tool items. * - `"only-in-cursor"`: Makes it so the item is deleted when clearing the cursor, instead of being put into the player's inventory. The copy-paste tools use this by default, for example. * - `"spawnable"`: Allows the item to be spawned by a quickbar shortcut or custom input. * - `"spoil-result"` * - `"ignore-spoil-time-modifier"`: Controls whether the spoil time ignores the spoil time modifier in the {@link DifficultySettings}. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemPrototypeFlag.html Online documentation} */ export type ItemPrototypeFlag = | "draw-logistic-overlay" | "excluded-from-trash-unrequested" | "always-show" | "hide-from-bonus-gui" | "hide-from-fuel-tooltip" | "not-stackable" | "primary-place-result" | "mod-openable" | "only-in-cursor" | "spawnable" | "spoil-result" | "ignore-spoil-time-modifier" /** * @see UpgradeMapperSourceWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/UpgradeMapperSource.html Online documentation} */ export interface UpgradeMapperSource { readonly type: "item" | "entity" /** * Name of the item, or entity. */ readonly name?: string /** * Name of the quality prototype. */ readonly quality?: string /** * The quality comparison type. */ readonly comparator?: ComparatorStringRead } /** * Write form of {@link UpgradeMapperSource}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/UpgradeMapperSource.html Online documentation} */ export interface UpgradeMapperSourceWrite { readonly type: "item" | "entity" /** * Name of the item, or entity. */ readonly name?: string /** * Name of the quality prototype. */ readonly quality?: string /** * The quality comparison type. */ readonly comparator?: ComparatorString } export interface ItemStackDefinition { /** * Prototype name of the item the stack holds. */ readonly name: string /** * Number of items the stack holds. Defaults to `1`. */ readonly count?: ItemCountType /** * Quality of the item the stack holds. Defaults to `"normal"`. */ readonly quality?: string /** * Health of the items in the stack. Defaults to `1.0`. */ readonly health?: float /** * Durability of the tool items in the stack. */ readonly durability?: double /** * Amount of ammo in the ammo items in the stack. */ readonly ammo?: float /** * Tags of the items with tags in the stack. */ readonly tags?: string[] /** * Description of the items with tags in the stack. */ readonly custom_description?: LocalisedString /** * The spoil percent for this item if the item can spoil. Defaults to `0`. */ readonly spoil_percent?: double } /** * 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. * * ## Union members * - `"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}. * - `"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-stock`s. * - `"avoid-vehicle"` * - `"controllable"` * - `"controllable-add"` * - `"controllable-remove"` * - `"entity-ghost"`: Selects entities that are `entity-ghost`s. * - `"tile-ghost"`: Selects entities that are `tile-ghost`s. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SelectionModeFlags.html Online documentation} */ export interface SelectionModeFlags { /** * Selects entities and tiles as if selecting them for a blueprint. */ readonly blueprint?: true /** * Selects entities and tiles as if selecting them for deconstruction. */ readonly deconstruct?: true /** * Selects entities and tiles as if selecting them for deconstruction cancellation. */ readonly "cancel-deconstruct"?: true /** * Selects items on the ground. */ readonly items?: true /** * Selects trees. */ readonly trees?: true /** * Selects entities which are considered a {@link LuaEntityPrototype#is_building building}, plus landmines. */ readonly "buildable-type"?: true /** * Selects no entities or tiles, but is useful to select an area. */ readonly nothing?: true /** * 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 /** * 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 /** * 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-stock`s. */ readonly "avoid-rolling-stock"?: true readonly "avoid-vehicle"?: true readonly controllable?: true readonly "controllable-add"?: true readonly "controllable-remove"?: true /** * Selects entities that are `entity-ghost`s. */ readonly "entity-ghost"?: true /** * Selects entities that are `tile-ghost`s. */ readonly "tile-ghost"?: true } /** * ## Union members * - `"none"` * - `"whitelist"` * - `"blacklist"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PrototypeFilterMode.html Online documentation} */ export type PrototypeFilterMode = "none" | "whitelist" | "blacklist" export interface UpgradeMapperDestination { /** * `"item"`, or `"entity"`. */ readonly type: "item" | "entity" /** * Name of the item, or entity. */ readonly name?: string /** * Name of the quality. */ readonly quality?: string /** * when type is `"item"` and the mapper is configured to install modules the limit per machine. If `0` then no limit. */ readonly count?: uint } export interface AmmoType { readonly action?: TriggerItem[] readonly target_type: TargetType /** * When `true`, the gun will be able to shoot even when the target is out of range. Only applies when `target_type` is `position`. The gun will fire at the maximum range in the direction of the target position. Defaults to `false`. */ readonly clamp_position?: boolean /** * Energy consumption of a single shot, if applicable. Defaults to `0`. */ readonly energy_consumption?: double readonly range_modifier?: double readonly cooldown_modifier?: double readonly consumption_modifier?: float } /** * @see DisplayPanelMessageDefinitionWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/DisplayPanelMessageDefinition.html Online documentation} */ export interface DisplayPanelMessageDefinition { /** * The message to show. */ readonly text: string /** * The icon to show alongside the message. */ readonly icon: SignalID /** * The circuit condition under which to show the message. */ readonly condition: CircuitConditionDefinition } /** * Write form of {@link DisplayPanelMessageDefinition}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/DisplayPanelMessageDefinition.html Online documentation} */ export interface DisplayPanelMessageDefinitionWrite { /** * The message to show. */ readonly text: string /** * The icon to show alongside the message. */ readonly icon: SignalIDWrite /** * The circuit condition under which to show the message. */ readonly condition: CircuitConditionDefinitionWrite } /** * @see SignalIDWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SignalID.html Online documentation} */ export interface SignalID { /** * The type of the signal. If the type is `"item"`, this will be `nil` when reading. */ readonly type?: SignalIDType /** * Name of the prototype. */ readonly name?: string /** * The prototype name of the signal's quality. Defaults to `normal`. */ readonly quality?: LuaQualityPrototype } /** * Write form of {@link SignalID}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SignalID.html Online documentation} */ export interface SignalIDWrite { /** * The type of the signal. If the type is `"item"`, this will be `nil` when reading. */ readonly type?: SignalIDType /** * Name of the prototype. */ readonly name?: string /** * The prototype name of the signal's quality. Defaults to `normal`. */ readonly quality?: QualityID } /** * ## Union members * - `"item"` * - `"fluid"` * - `"virtual"` * - `"entity"` * - `"recipe"` * - `"space-location"` * - `"asteroid-chunk"` * - `"quality"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SignalIDType.html Online documentation} */ export type SignalIDType = | "item" | "fluid" | "virtual" | "entity" | "recipe" | "space-location" | "asteroid-chunk" | "quality" /** * Returns one of the subtypes, depending on the value of `type`. * * ## Union members * - {@link ItemProduct}: Returned when the `type` is `"item"`. * - {@link FluidProduct}: Returned when the `type` is `"fluid"`. * - {@link ResearchProgressProduct}: Returned when the `type` is `"research-progress"`. * @example * -- Products of the "steel-chest" recipe (an array of Product) * {{type="item", name="steel-chest", amount=1}} * @example * -- Products of the "advanced-oil-processing" recipe * {{type="fluid", name="heavy-oil", amount=1}, * {type="fluid", name="light-oil", amount=4.5}, * {type="fluid", name="petroleum-gas", amount=5.5}} * @example * -- What a custom recipe would look like that had a probability of 0.5 to return a * -- minimum amount of 1 and a maximum amount of 5 * {{type="item", name="custom-item", probability=0.5, amount_min=1, amount_max=5}} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Product.html Online documentation} */ export type Product = ItemProduct | FluidProduct | ResearchProgressProduct /** * @example * -- Products of the "steel-chest" recipe (an array of Product) * {{type="item", name="steel-chest", amount=1}} * @example * -- What a custom recipe would look like that had a probability of 0.5 to return a * -- minimum amount of 1 and a maximum amount of 5 * {{type="item", name="custom-item", probability=0.5, amount_min=1, amount_max=5}} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemProduct.html Online documentation} */ export interface ItemProduct { readonly type: "item" /** * Prototype name of the result. */ readonly name: string /** * Amount of the item to give. If not returned, `amount_min` and `amount_max` will be present instead. */ readonly amount?: uint16 /** * Minimal amount of the item to give. Not returned if `amount` is returned. */ readonly amount_min?: uint16 /** * Maximum amount of the item to give. Not returned if `amount` is returned. */ readonly amount_max?: uint16 /** * A value in range `[0, 1]`. Item is only given with this probability; otherwise no product is produced. */ readonly probability: double /** * How much of this product is ignored by statistics. */ readonly ignored_by_stats?: uint16 /** * How much of this product is ignored by productivity. */ readonly ignored_by_productivity?: uint16 /** * Probability that a craft will yield one additional product. Also applies to bonus crafts caused by productivity. */ readonly extra_count_fraction?: float readonly percent_spoiled?: float } /** * @example * -- Products of the "advanced-oil-processing" recipe * {{type="fluid", name="heavy-oil", amount=1}, * {type="fluid", name="light-oil", amount=4.5}, * {type="fluid", name="petroleum-gas", amount=5.5}} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/FluidProduct.html Online documentation} */ export interface FluidProduct { readonly type: "fluid" /** * Prototype name of the result. */ readonly name: string /** * Amount of the fluid to give. If not returned, `amount_min` and `amount_max` will be present instead. */ readonly amount?: double /** * Minimal amount of the fluid to give. Not returned if `amount` is returned. */ readonly amount_min?: double /** * Maximum amount of the fluid to give. Not returned if `amount` is returned. */ readonly amount_max?: double /** * A value in range `[0, 1]`. Fluid is only given with this probability; otherwise no product is produced. */ readonly probability: double /** * How much of this product is ignored by statistics. */ readonly ignored_by_stats?: double /** * How much of this product is ignored by productivity. */ readonly ignored_by_productivity?: double /** * The fluid temperature of this product. */ readonly temperature?: float readonly fluidbox_index?: uint } export interface ResearchProgressProduct { readonly type: "research-progress" /** * Prototype name of the research item. */ readonly research_item: string readonly amount: double } /** * @see BlueprintScheduleRecordWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintScheduleRecord.html Online documentation} */ export interface BlueprintScheduleRecord { /** * Name of the station. */ readonly station?: string readonly wait_conditions?: WaitCondition[] readonly temporary?: boolean readonly created_by_interrupt?: boolean readonly allows_unloading?: boolean } /** * Write form of {@link BlueprintScheduleRecord}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintScheduleRecord.html Online documentation} */ export interface BlueprintScheduleRecordWrite { /** * Name of the station. */ readonly station?: string readonly wait_conditions?: readonly WaitConditionWrite[] readonly temporary?: boolean readonly created_by_interrupt?: boolean readonly allows_unloading?: boolean } /** * @see ScheduleRecordWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScheduleRecord.html Online documentation} */ export interface ScheduleRecord { /** * Name of the station. */ readonly station?: string readonly rail?: LuaEntity /** * When a train is allowed to reach rail target from any direction it will be `nil`. If rail has to be reached from specific direction, this value allows to choose the direction. This value corresponds to {@link LuaEntity#connected_rail_direction LuaEntity::connected_rail_direction} of a TrainStop. */ readonly rail_direction?: defines.rail_direction readonly wait_conditions?: WaitCondition[] readonly temporary?: boolean readonly created_by_interrupt?: boolean readonly allows_unloading?: boolean } /** * Write form of {@link ScheduleRecord}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScheduleRecord.html Online documentation} */ export interface ScheduleRecordWrite { /** * Name of the station. */ readonly station?: string readonly rail?: LuaEntity /** * When a train is allowed to reach rail target from any direction it will be `nil`. If rail has to be reached from specific direction, this value allows to choose the direction. This value corresponds to {@link LuaEntity#connected_rail_direction LuaEntity::connected_rail_direction} of a TrainStop. */ readonly rail_direction?: defines.rail_direction readonly wait_conditions?: readonly WaitConditionWrite[] readonly temporary?: boolean readonly created_by_interrupt?: boolean readonly allows_unloading?: boolean } /** * @see BlueprintScheduleInterruptWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintScheduleInterrupt.html Online documentation} */ export interface BlueprintScheduleInterrupt { readonly name?: string readonly conditions?: WaitCondition[] readonly targets?: BlueprintScheduleRecord[] readonly inside_interrupt: boolean } /** * Write form of {@link BlueprintScheduleInterrupt}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintScheduleInterrupt.html Online documentation} */ export interface BlueprintScheduleInterruptWrite { readonly name?: string readonly conditions?: readonly WaitConditionWrite[] readonly targets?: readonly BlueprintScheduleRecordWrite[] readonly inside_interrupt: boolean } /** * @see ScheduleInterruptWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScheduleInterrupt.html Online documentation} */ export interface ScheduleInterrupt { readonly name?: string readonly conditions?: WaitCondition[] readonly targets?: ScheduleRecord[] readonly inside_interrupt: boolean } /** * Write form of {@link ScheduleInterrupt}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScheduleInterrupt.html Online documentation} */ export interface ScheduleInterruptWrite { readonly name?: string readonly conditions?: readonly WaitConditionWrite[] readonly targets?: readonly ScheduleRecordWrite[] readonly inside_interrupt: boolean } /** * @see WaitConditionWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/WaitCondition.html Online documentation} */ export interface WaitCondition { readonly type: WaitConditionType /** * Specifies how this condition is to be compared with the preceding conditions in the corresponding `wait_conditions` array. Always present when reading, defaults to `"and"` when writing. */ readonly compare_type?: "and" | "or" /** * Number of ticks to wait when `type` is `"time"`, or number of ticks of inactivity when `type` is `"inactivity"`. */ readonly ticks?: uint /** * This is a CircuitCondition and only present when `type` is `"item_count"`, `"circuit"`, `"fluid_count"`, `"fuel_item_count_all"`, or `"fuel_item_count_any"`, and a circuit condition is configured. This is a ItemIDAndQualityIDPair and only present when `type` is `"request_satisfied"` or `"request_not_satisfied"` */ readonly condition?: CircuitCondition | ItemIDAndQualityIDPair /** * Name of the space location. Only present when `type` is "`any_planet_import_zero`" and a planet is configured. */ readonly planet?: string /** * Name of the station. Only present when `type` is "`specific_destination_full`", "`specific_destination_not_full`", "`at_station`", or "`not_at_station`", and a station is configured. */ readonly station?: string /** * Amount of damage to take when `type` is `"damage_taken"`. */ readonly damage?: uint } /** * Write form of {@link WaitCondition}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/WaitCondition.html Online documentation} */ export interface WaitConditionWrite { readonly type: WaitConditionType /** * Specifies how this condition is to be compared with the preceding conditions in the corresponding `wait_conditions` array. Always present when reading, defaults to `"and"` when writing. */ readonly compare_type?: "and" | "or" /** * Number of ticks to wait when `type` is `"time"`, or number of ticks of inactivity when `type` is `"inactivity"`. */ readonly ticks?: uint /** * This is a CircuitCondition and only present when `type` is `"item_count"`, `"circuit"`, `"fluid_count"`, `"fuel_item_count_all"`, or `"fuel_item_count_any"`, and a circuit condition is configured. This is a ItemIDAndQualityIDPair and only present when `type` is `"request_satisfied"` or `"request_not_satisfied"` */ readonly condition?: CircuitConditionWrite | ItemIDAndQualityIDPairWrite /** * Name of the space location. Only present when `type` is "`any_planet_import_zero`" and a planet is configured. */ readonly planet?: string /** * Name of the station. Only present when `type` is "`specific_destination_full`", "`specific_destination_not_full`", "`at_station`", or "`not_at_station`", and a station is configured. */ readonly station?: string /** * Amount of damage to take when `type` is `"damage_taken"`. */ readonly damage?: uint } /** * Type of a {@link WaitCondition}. * * ## Union members * - `"time"` * - `"full"` * - `"empty"` * - `"not_empty"` * - `"item_count"` * - `"circuit"` * - `"inactivity"` * - `"robots_inactive"` * - `"fluid_count"` * - `"passenger_present"` * - `"passenger_not_present"` * - `"fuel_item_count_all"` * - `"fuel_item_count_any"` * - `"fuel_full"` * - `"destination_full_or_no_path"` * - `"request_satisfied"` * - `"request_not_satisfied"` * - `"all_requests_satisfied"` * - `"any_request_not_satisfied"` * - `"any_request_zero"` * - `"any_planet_import_zero"` * - `"specific_destination_full"` * - `"specific_destination_not_full"` * - `"at_station"` * - `"not_at_station"` * - `"damage_taken"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/WaitConditionType.html Online documentation} */ export type WaitConditionType = | "time" | "full" | "empty" | "not_empty" | "item_count" | "circuit" | "inactivity" | "robots_inactive" | "fluid_count" | "passenger_present" | "passenger_not_present" | "fuel_item_count_all" | "fuel_item_count_any" | "fuel_full" | "destination_full_or_no_path" | "request_satisfied" | "request_not_satisfied" | "all_requests_satisfied" | "any_request_not_satisfied" | "any_request_zero" | "any_planet_import_zero" | "specific_destination_full" | "specific_destination_not_full" | "at_station" | "not_at_station" | "damage_taken" /** * @see BlueprintScheduleWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintSchedule.html Online documentation} */ export interface BlueprintSchedule { readonly records?: BlueprintScheduleRecord[] readonly group?: string readonly interrupts?: BlueprintScheduleInterrupt[] } /** * Write form of {@link BlueprintSchedule}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintSchedule.html Online documentation} */ export interface BlueprintScheduleWrite { readonly records?: readonly BlueprintScheduleRecordWrite[] readonly group?: string readonly interrupts?: readonly BlueprintScheduleInterruptWrite[] } export interface ResearchIngredient { /** * Prototype name of the required item. */ readonly name: string /** * Amount of items required to research one unit of technology. */ readonly amount: uint16 } /** * Used by {@link TechnologyModifier}. * * ## Union members * - `"inserter-stack-size-bonus"` * - `"bulk-inserter-capacity-bonus"` * - `"laboratory-speed"` * - `"character-logistic-trash-slots"` * - `"maximum-following-robots-count"` * - `"worker-robot-speed"` * - `"worker-robot-storage"` * - `"turret-attack"` * - `"ammo-damage"` * - `"give-item"` * - `"gun-speed"` * - `"unlock-recipe"` * - `"character-crafting-speed"` * - `"character-mining-speed"` * - `"character-running-speed"` * - `"character-build-distance"` * - `"character-item-drop-distance"` * - `"character-reach-distance"` * - `"character-resource-reach-distance"` * - `"character-item-pickup-distance"` * - `"character-loot-pickup-distance"` * - `"character-inventory-slots-bonus"` * - `"deconstruction-time-to-live"` * - `"max-failed-attempts-per-tick-per-construction-queue"` * - `"max-successful-attempts-per-tick-per-construction-queue"` * - `"character-health-bonus"` * - `"mining-drill-productivity-bonus"` * - `"train-braking-force-bonus"` * - `"worker-robot-battery"` * - `"laboratory-productivity"` * - `"follower-robot-lifetime"` * - `"artillery-range"` * - `"nothing"` * - `"character-logistic-requests"` * - `"unlock-space-location"` * - `"unlock-quality"` * - `"unlock-space-platforms"` * - `"unlock-circuit-network"` * - `"cargo-landing-pad-count"` * - `"change-recipe-productivity"` * - `"cliff-deconstruction-enabled"` * - `"mining-with-fluid"` * - `"rail-support-on-deep-oil-ocean"` * - `"rail-planner-allow-elevated-rails"` * - `"beacon-distribution"` * - `"create-ghost-on-entity-death"` * - `"belt-stack-size-bonus"` * - `"vehicle-logistics"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ModifierType.html Online documentation} */ export type ModifierType = | "inserter-stack-size-bonus" | "bulk-inserter-capacity-bonus" | "laboratory-speed" | "character-logistic-trash-slots" | "maximum-following-robots-count" | "worker-robot-speed" | "worker-robot-storage" | "turret-attack" | "ammo-damage" | "give-item" | "gun-speed" | "unlock-recipe" | "character-crafting-speed" | "character-mining-speed" | "character-running-speed" | "character-build-distance" | "character-item-drop-distance" | "character-reach-distance" | "character-resource-reach-distance" | "character-item-pickup-distance" | "character-loot-pickup-distance" | "character-inventory-slots-bonus" | "deconstruction-time-to-live" | "max-failed-attempts-per-tick-per-construction-queue" | "max-successful-attempts-per-tick-per-construction-queue" | "character-health-bonus" | "mining-drill-productivity-bonus" | "train-braking-force-bonus" | "worker-robot-battery" | "laboratory-productivity" | "follower-robot-lifetime" | "artillery-range" | "nothing" | "character-logistic-requests" | "unlock-space-location" | "unlock-quality" | "unlock-space-platforms" | "unlock-circuit-network" | "cargo-landing-pad-count" | "change-recipe-productivity" | "cliff-deconstruction-enabled" | "mining-with-fluid" | "rail-support-on-deep-oil-ocean" | "rail-planner-allow-elevated-rails" | "beacon-distribution" | "create-ghost-on-entity-death" | "belt-stack-size-bonus" | "vehicle-logistics" export interface BaseResearchTrigger { readonly type: | "craft-item" | "mine-entity" | "craft-fluid" | "send-item-to-orbit" | "capture-spawner" | "build-entity" | "create-space-platform" } /** * `"craft-item"` variant of {@link ResearchTrigger}. */ export interface CraftItemResearchTrigger extends BaseResearchTrigger { readonly type: "craft-item" readonly item: string readonly item_quality?: string } /** * `"mine-entity"` variant of {@link ResearchTrigger}. */ export interface MineEntityResearchTrigger extends BaseResearchTrigger { readonly type: "mine-entity" readonly entity: string } /** * `"craft-fluid"` variant of {@link ResearchTrigger}. */ export interface CraftFluidResearchTrigger extends BaseResearchTrigger { readonly type: "craft-fluid" readonly fluid: string readonly amount: double } /** * `"capture-spawner"` variant of {@link ResearchTrigger}. */ export interface CaptureSpawnerResearchTrigger extends BaseResearchTrigger { readonly type: "capture-spawner" readonly entity?: string } /** * `"build-entity"` variant of {@link ResearchTrigger}. */ export interface BuildEntityResearchTrigger extends BaseResearchTrigger { readonly type: "build-entity" readonly entity: EntityIDFilter } /** * `"send-item-to-orbit"` variant of {@link ResearchTrigger}. */ export interface SendItemToOrbitResearchTrigger extends BaseResearchTrigger { readonly type: "send-item-to-orbit" readonly item: ItemIDFilter } /** * Variants of {@link ResearchTrigger} with no additional attributes. */ export interface OtherResearchTrigger extends BaseResearchTrigger { readonly type: "create-space-platform" } /** * Other attributes may be specified depending on `type`: * - `"craft-item"`: {@link CraftItemResearchTrigger} * - `"mine-entity"`: {@link MineEntityResearchTrigger} * - `"craft-fluid"`: {@link CraftFluidResearchTrigger} * - `"capture-spawner"`: {@link CaptureSpawnerResearchTrigger} * - `"build-entity"`: {@link BuildEntityResearchTrigger} * - `"send-item-to-orbit"`: {@link SendItemToOrbitResearchTrigger} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ResearchTrigger.html Online documentation} */ export type ResearchTrigger = | CraftItemResearchTrigger | MineEntityResearchTrigger | CraftFluidResearchTrigger | CaptureSpawnerResearchTrigger | BuildEntityResearchTrigger | SendItemToOrbitResearchTrigger | OtherResearchTrigger /** * Candidate chunks are given scores to determine which one of them should be expanded into. This score takes into account various settings noted below. The iteration is over a square region centered around the chunk for which the calculation is done, and includes the central chunk as well. Distances are calculated as {@linkplain https://en.wikipedia.org/wiki/Taxicab_geometry Manhattan distance}. * * The pseudocode algorithm to determine a chunk's score is as follows: * * ``` * player = 0 * for neighbour in all chunks within enemy_building_influence_radius from chunk: * player += number of player buildings on neighbour * * building_coefficient * * neighbouring_chunk_coefficient^distance(chunk, neighbour) * base = 0 * for neighbour in all chunk within friendly_base_influence_radius from chunk: * base += num of enemy bases on neighbour * * other_base_coefficient * * neighbouring_base_chunk_coefficient^distance(chunk, neighbour) * score(chunk) = 1 / (1 + player + base) * ``` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EnemyExpansionMapSettings.html Online documentation} */ export interface EnemyExpansionMapSettings { /** * Whether enemy expansion is enabled at all. */ readonly enabled: boolean /** * Distance in chunks from the furthest base around to prevent expansions from reaching too far into the player's territory. Defaults to `7`. */ readonly max_expansion_distance: uint /** * Defaults to `2`. */ readonly friendly_base_influence_radius: uint /** * Defaults to `2`. */ readonly enemy_building_influence_radius: uint /** * Defaults to `0.1`. */ readonly building_coefficient: double /** * Defaults to `2.0`. */ readonly other_base_coefficient: double /** * Defaults to `0.5`. */ readonly neighbouring_chunk_coefficient: double /** * Defaults to `0.4`. */ readonly neighbouring_base_chunk_coefficient: double /** * A chunk has to have at most this high of a percentage of unbuildable tiles for it to be considered a candidate to avoid chunks full of water as candidates. Defaults to `0.9`, or 90%. */ readonly max_colliding_tiles_coefficient: double /** * The minimum size of a biter group that goes to build a new base. This is multiplied by the evolution factor. Defaults to `5`. */ readonly settler_group_min_size: uint /** * The maximum size of a biter group that goes to build a new base. This is multiplied by the evolution factor. Defaults to `20`. */ readonly settler_group_max_size: uint /** * The minimum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to `4*3 600=14 400` ticks. */ readonly min_expansion_cooldown: uint /** * The maximum time between expansions in ticks. The actual cooldown is adjusted to the current evolution levels. Defaults to `60*3 600=216 000` ticks. */ readonly max_expansion_cooldown: uint } /** * Used by {@link MapSettings} and {@link MapAndDifficultySettings}. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AsteroidMapSettings.html Online documentation} */ export interface AsteroidMapSettings { readonly spawning_rate: double readonly max_ray_portals_expanded_per_tick: uint } export interface SteeringMapSetting { /** * Does not include the radius of the unit. */ readonly radius: double readonly separation_factor: double readonly separation_force: double /** * Used to make steering look better for aesthetic purposes. */ readonly force_unit_fuzzy_goto_behavior: boolean } export interface SteeringMapSettings { readonly default: SteeringMapSetting readonly moving: SteeringMapSetting } export interface UnitGroupMapSettings { /** * The minimum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to `3 600` ticks. */ readonly min_group_gathering_time: uint /** * The maximum amount of time in ticks a group will spend gathering before setting off. The actual time is a random time between the minimum and maximum times. Defaults to `10*3 600=36 000` ticks. */ readonly max_group_gathering_time: uint /** * After gathering has finished, the group is allowed to wait this long in ticks for delayed members. New members are not accepted anymore however. Defaults to `2*3 600=7 200` ticks. */ readonly max_wait_time_for_late_members: uint /** * The minimum group radius in tiles. The actual radius is adjusted based on the number of members. Defaults to `5.0`. */ readonly min_group_radius: double /** * The maximum group radius in tiles. The actual radius is adjusted based on the number of members. Defaults to `30.0`. */ readonly max_group_radius: double /** * The maximum speed a percentage of its regular speed that a group member can speed up to when catching up with the group. Defaults to `1.4`, or 140%. */ readonly max_member_speedup_when_behind: double /** * The minimum speed a percentage of its regular speed that a group member can slow down to when ahead of the group. Defaults to `0.6`, or 60%. */ readonly max_member_slowdown_when_ahead: double /** * The minimum speed as a percentage of its maximum speed that a group will slow down to so members that fell behind can catch up. Defaults to `0.3`, or 30%. */ readonly max_group_slowdown_factor: double /** * When a member of a group falls back more than this factor times the group radius, the group will slow down to its `max_group_slowdown_factor` speed to let them catch up. Defaults to `3`. */ readonly max_group_member_fallback_factor: double /** * When a member of a group falls back more than this factor times the group radius, it will be dropped from the group. Defaults to `10`. */ readonly member_disown_distance: double readonly tick_tolerance_when_member_arrives: uint /** * The maximum number of automatically created unit groups gathering for attack at any time. Defaults to `30`. */ readonly max_gathering_unit_groups: uint /** * The maximum number of members for an attack unit group. This only affects automatically created unit groups, manual groups created through the API are unaffected. Defaults to `200`. */ readonly max_unit_group_size: uint } export interface PathFinderMapSettings { /** * The pathfinder performs a step of the backward search every `fwd2bwd_ratio`'th step. The minimum allowed value is `2`, which means symmetric search. The default value is `5`. */ readonly fwd2bwd_ratio: uint /** * When looking at which node to check next, their heuristic value is multiplied by this ratio. The higher it is, the more the search is directed straight at the goal. Defaults to `2`. */ readonly goal_pressure_ratio: double /** * Whether to cache paths at all. Defaults to `true`. */ readonly use_path_cache: boolean /** * The maximum number of nodes that are expanded per tick. Defaults to `1 000`. */ readonly max_steps_worked_per_tick: double /** * The maximum amount of work each pathfinding job is allowed to do per tick. Defaults to `8 000`. */ readonly max_work_done_per_tick: uint /** * Number of elements in the short cache. Defaults to `5`. */ readonly short_cache_size: uint /** * Number of elements in the long cache. Defaults to `25`. */ readonly long_cache_size: uint /** * The minimal distance to the goal in tiles required to be searched in the short path cache. Defaults to `10`. */ readonly short_cache_min_cacheable_distance: double /** * The minimal number of nodes required to be searched in the short path cache. Defaults to `50`. */ readonly short_cache_min_algo_steps_to_cache: uint /** * The minimal distance to the goal in tiles required to be searched in the long path cache. Defaults to `30`. */ readonly long_cache_min_cacheable_distance: double /** * When looking for a connection to a cached path, search at most for this number of steps times the original estimate. Defaults to `100`. */ readonly cache_max_connect_to_cache_steps_multiplier: uint /** * When looking for a path from cache, make sure it doesn't start too far from the requested start in relative terms. Defaults to `0.2`. */ readonly cache_accept_path_start_distance_ratio: double /** * When looking for a path from cache, make sure it doesn't end too far from the requested end in relative terms. This is typically more lenient than the start ratio since the end target could be moving. Defaults to `0.15`. */ readonly cache_accept_path_end_distance_ratio: double /** * Same principle as `cache_accept_path_start_distance_ratio`, but used for negative cache queries. Defaults to `0.3`. */ readonly negative_cache_accept_path_start_distance_ratio: double /** * Same principle as `cache_accept_path_end_distance_ratio`, but used for negative cache queries. Defaults to `0.3`. */ readonly negative_cache_accept_path_end_distance_ratio: double /** * When assigning a rating to the best path, this multiplier times start distances is considered. Defaults to `10`. */ readonly cache_path_start_distance_rating_multiplier: double /** * When assigning a rating to the best path, this multiplier times end distances is considered. This value is typically higher than the start multiplier as this results in better end path quality. Defaults to `20`. */ readonly cache_path_end_distance_rating_multiplier: double /** * A penalty that is applied for another unit that is on the way to the goal. This is mainly relevant for situations where a group of units has arrived at the target they are supposed to attack, making units further back circle around to reach the target. Defaults to `30`. */ readonly stale_enemy_with_same_destination_collision_penalty: double /** * The distance in tiles after which other moving units are not considered for pathfinding. Defaults to `5`. */ readonly ignore_moving_enemy_collision_distance: double /** * A penalty that is applied for another unit that is too close and either not moving or has a different goal. Defaults to `30`. */ readonly enemy_with_different_destination_collision_penalty: double /** * The general collision penalty with other units. Defaults to `10`. */ readonly general_entity_collision_penalty: double /** * The collision penalty for positions that require the destruction of an entity to get to. Defaults to `3`. */ readonly general_entity_subsequent_collision_penalty: double /** * The collision penalty for collisions in the extended bounding box but outside the entity's actual bounding box. Defaults to `3`. */ readonly extended_collision_penalty: double /** * The amount of path finder requests accepted per tick regardless of the requested path's length. Defaults to `10`. */ readonly max_clients_to_accept_any_new_request: uint /** * When the `max_clients_to_accept_any_new_request` amount is exhausted, only path finder requests with a short estimate will be accepted until this amount (per tick) is reached. Defaults to `100`. */ readonly max_clients_to_accept_short_new_request: uint /** * The maximum direct distance in tiles before a request is no longer considered short. Defaults to `100`. */ readonly direct_distance_to_consider_short_request: uint /** * The maximum amount of nodes a short request will traverse before being rescheduled as a long request. Defaults to `1000`. */ readonly short_request_max_steps: uint /** * The amount of steps that are allocated to short requests each tick, as a percentage of all available steps. Defaults to `0.5`, or 50%. */ readonly short_request_ratio: double /** * The minimum amount of steps that are guaranteed to be performed for every request. Defaults to `2000`. */ readonly min_steps_to_check_path_find_termination: uint /** * If the actual amount of steps is higher than the initial estimate by this factor, pathfinding is terminated. Defaults to `2000.0`. */ readonly start_to_goal_cost_multiplier_to_terminate_path_find: double /** * The thresholds of waiting clients after each of which the per-tick work limit will be increased by the corresponding value in `overload_multipliers`. This is to avoid clients having to wait too long. Must have the same number of elements as `overload_multipliers`. Defaults to `{0, 100, 500}`. */ readonly overload_levels: uint[] /** * The multipliers to the amount of per-tick work applied after the corresponding thresholds in `overload_levels` have been reached. Must have the same number of elements as `overload_multipliers`. Defaults to `{2, 3, 4}`. */ readonly overload_multipliers: double[] /** * The delay in ticks between decrementing the score of all paths in the negative cache by one. Defaults to `20`. */ readonly negative_path_cache_delay_interval: uint } /** * Technology difficulty settings. Updating any of the attributes will immediately take effect in the game engine. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/DifficultySettings.html Online documentation} */ export interface DifficultySettings { /** * A value in range [0.001, 1000]. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/DifficultySettings.technology_price_multiplier.html Online documentation} */ technology_price_multiplier: double /** * A value in range [0.01, 100]. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/DifficultySettings.spoil_time_modifier.html Online documentation} */ spoil_time_modifier: double } export interface MapDifficultySettings { /** * A value in range [0.001, 1000]. */ readonly technology_price_multiplier: double /** * A value in range [0.01, 100]. */ readonly spoil_time_modifier: double } /** * A standard table containing all {@link MapSettings} attributes plus an additional table that contains all {@link DifficultySettings} properties. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapAndDifficultySettings.html Online documentation} */ export interface MapAndDifficultySettings { readonly pollution: PollutionMapSettings readonly enemy_evolution: EnemyEvolutionMapSettings readonly enemy_expansion: EnemyExpansionMapSettings readonly unit_group: UnitGroupMapSettings readonly steering: SteeringMapSettings readonly path_finder: PathFinderMapSettings readonly asteroids: AsteroidMapSettings /** * If a behavior fails this many times, the enemy (or enemy group) is destroyed. This solves biters getting stuck within their own base. */ readonly max_failed_behavior_count: uint readonly difficulty_settings: MapDifficultySettings } /** * Various game-related settings. Updating any of the attributes will immediately take effect in the game engine. * @example * -- Increase the number of short paths the pathfinder can cache. * game.map_settings.path_finder.short_cache_size = 15 * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapSettings.html Online documentation} */ export interface MapSettings { pollution: PollutionMapSettings enemy_evolution: EnemyEvolutionMapSettings enemy_expansion: EnemyExpansionMapSettings unit_group: UnitGroupMapSettings steering: SteeringMapSetting path_finder: PathFinderMapSettings asteroids: AsteroidMapSettings /** * If a behavior fails this many times, the enemy (or enemy group) is destroyed. This solves biters getting stuck within their own base. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapSettings.max_failed_behavior_count.html Online documentation} */ max_failed_behavior_count: uint } /** * These values are for the time frame of one second (60 ticks). * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PollutionMapSettings.html Online documentation} */ export interface PollutionMapSettings { /** * Whether pollution is enabled at all. */ readonly enabled: boolean /** * The amount that is diffused to a neighboring chunk (possibly repeated for other directions as well). Defaults to `0.02`. */ readonly diffusion_ratio: double /** * The amount of PUs that need to be in a chunk for it to start diffusing. Defaults to `15`. */ readonly min_to_diffuse: double /** * The amount of pollution eaten by a chunk's tiles as a percentage of 1. Also known as absorption modifier. Defaults to `1`. */ readonly ageing: double /** * Any amount of pollution larger than this value is visualized as this value instead. Defaults to `150`. */ readonly expected_max_per_chunk: double /** * Any amount of pollution smaller than this value (but bigger than zero) is visualized as this value instead. Defaults to `50`. */ readonly min_to_show_per_chunk: double /** * Defaults to `60`. */ readonly min_pollution_to_damage_trees: double /** * Defaults to `150`. */ readonly pollution_with_max_forest_damage: double /** * Defaults to `50`. */ readonly pollution_per_tree_damage: double /** * Defaults to `10`. */ readonly pollution_restored_per_tree_damage: double /** * Defaults to `20`. */ readonly max_pollution_to_restore_trees: double /** * Defaults to `1`. */ readonly enemy_attack_pollution_consumption_modifier: double } /** * These values represent a percentual increase in evolution. This means a value of `0.1` would increase evolution by 10%. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EnemyEvolutionMapSettings.html Online documentation} */ export interface EnemyEvolutionMapSettings { /** * Whether enemy evolution is enabled at all. */ readonly enabled: boolean /** * The amount evolution naturally progresses by every second. Defaults to `0.000004`. */ readonly time_factor: double /** * The amount evolution progresses for every destroyed spawner. Defaults to `0.002`. */ readonly destroy_factor: double /** * The amount evolution progresses for every unit of pollution. Defaults to `0.0000009`. */ readonly pollution_factor: double } /** * @see CliffPlacementSettingsWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CliffPlacementSettings.html Online documentation} */ export interface CliffPlacementSettings { /** * Name of the cliff prototype. */ readonly name: string /** * Name of the autoplace control prototype. */ readonly control: string /** * Elevation at which the first row of cliffs is placed. The default is `10`, and this cannot be set from the map generation GUI. */ readonly cliff_elevation_0: float /** * Elevation difference between successive rows of cliffs. This is inversely proportional to 'frequency' in the map generation GUI. Specifically, when set from the GUI the value is `40 / frequency`. */ readonly cliff_elevation_interval: float /** * Smoothing makes cliffs straighter on rough elevation but makes placement inaccurate. 0 is no smoothing, 1 is full smoothing. Values outside of 0-1 are possible for specific effects but not recommended. */ readonly cliff_smoothing: float /** * Corresponds to 'continuity' in the GUI. This value is not used directly, but is used by the 'cliffiness' noise expression, which in combination with elevation and the two cliff elevation properties drives cliff placement (cliffs are placed when elevation crosses the elevation contours defined by `cliff_elevation_0` and `cliff_elevation_interval` when 'cliffiness' is greater than `0.5`). The default 'cliffiness' expression interprets this value such that larger values result in longer unbroken walls of cliffs, and smaller values (between `0` and `1`) result in larger gaps in cliff walls. */ readonly richness: float } /** * Write form of {@link CliffPlacementSettings}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CliffPlacementSettings.html Online documentation} */ export interface CliffPlacementSettingsWrite { /** * Name of the cliff prototype. */ readonly name: string /** * Name of the autoplace control prototype. */ readonly control: string /** * Elevation at which the first row of cliffs is placed. The default is `10`, and this cannot be set from the map generation GUI. */ readonly cliff_elevation_0: float /** * Elevation difference between successive rows of cliffs. This is inversely proportional to 'frequency' in the map generation GUI. Specifically, when set from the GUI the value is `40 / frequency`. */ readonly cliff_elevation_interval: float /** * Smoothing makes cliffs straighter on rough elevation but makes placement inaccurate. 0 is no smoothing, 1 is full smoothing. Values outside of 0-1 are possible for specific effects but not recommended. */ readonly cliff_smoothing: float /** * Corresponds to 'continuity' in the GUI. This value is not used directly, but is used by the 'cliffiness' noise expression, which in combination with elevation and the two cliff elevation properties drives cliff placement (cliffs are placed when elevation crosses the elevation contours defined by `cliff_elevation_0` and `cliff_elevation_interval` when 'cliffiness' is greater than `0.5`). The default 'cliffiness' expression interprets this value such that larger values result in longer unbroken walls of cliffs, and smaller values (between `0` and `1`) result in larger gaps in cliff walls. */ readonly richness: MapGenSize } /** * @see AutoplaceSettingsWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AutoplaceSettings.html Online documentation} */ export interface AutoplaceSettings { /** * Whether missing autoplace names for this type should be default enabled. Always defined when reading autoplace settings. */ readonly treat_missing_as_default?: boolean /** * Always defined when reading autoplace settings. */ readonly settings?: Record } /** * Write form of {@link AutoplaceSettings}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AutoplaceSettings.html Online documentation} */ export interface AutoplaceSettingsWrite { /** * Whether missing autoplace names for this type should be default enabled. Always defined when reading autoplace settings. */ readonly treat_missing_as_default?: boolean /** * Always defined when reading autoplace settings. */ readonly settings?: Record } export interface TerritorySettings { readonly units: string[] readonly territory_index_expression: string readonly territory_variation_expression: string readonly minimum_territory_size: uint } /** * @see MapGenSettingsWrite * @example * -- Assuming a NamedNoiseExpression with the name "my-alternate-grass1-probability" is defined... * local surface = game.player.surface * local mgs = surface.map_gen_settings * mgs.property_expression_names["tile:grass1:probability"] = "my-alternate-grass1-probability" * surface.map_gen_settings = mgs * -- ...would override the probability of grass1 being placed at any given point on the current surface. * @example * -- To make there be no deep water on (newly generated chunks) a surface * local surface = game.player.surface * local mgs = surface.map_gen_settings * mgs.property_expression_names["tile:deepwater:probability"] = -1000 * surface.map_gen_settings = mgs * -- This does not require a NamedNoiseExpression to be defined, since literal numbers (and strings naming literal * -- numbers, e.g. `"123"`) are understood to stand for constant value expressions. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapGenSettings.html Online documentation} */ export interface MapGenSettings { /** * Indexed by autoplace control prototype name. */ readonly autoplace_controls: Record /** * Whether undefined `autoplace_controls` should fall back to the default controls or not. Defaults to `true`. */ readonly default_enable_all_autoplace_controls: boolean /** * Each setting in this dictionary maps the string type to the settings for that type. */ readonly autoplace_settings: Record<"entity" | "tile" | "decorative", AutoplaceSettings> /** * The random seed used to generated this map. */ readonly seed: uint /** * Width in tiles. If `0`, the map has 'infinite' width, with the actual limitation being one million tiles in each direction from the center. */ readonly width: uint /** * Height in tiles. If `0`, the map has 'infinite' height, with the actual limitation being one million tiles in each direction from the center. */ readonly height: uint /** * Size of the starting area. */ readonly starting_area: float /** * Positions of the starting areas. */ readonly starting_points: MapPosition[] /** * Whether enemy creatures will not attack unless the player first attacks them. */ readonly peaceful_mode: boolean /** * Whether enemy creatures will not naturally spawn from spawners, map gen, or trigger effects. */ readonly no_enemies_mode: boolean /** * Overrides for tile property value generators. */ readonly property_expression_names: PropertyExpressionNames /** * Map generation settings for entities of the type "cliff". */ readonly cliff_settings: CliffPlacementSettings readonly territory_settings: TerritorySettings } /** * Write form of {@link MapGenSettings}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapGenSettings.html Online documentation} */ export interface MapGenSettingsWrite { /** * Indexed by autoplace control prototype name. */ readonly autoplace_controls: Record /** * Whether undefined `autoplace_controls` should fall back to the default controls or not. Defaults to `true`. */ readonly default_enable_all_autoplace_controls: boolean /** * Each setting in this dictionary maps the string type to the settings for that type. */ readonly autoplace_settings: Record<"entity" | "tile" | "decorative", AutoplaceSettingsWrite> /** * The random seed used to generated this map. */ readonly seed: uint /** * Width in tiles. If `0`, the map has 'infinite' width, with the actual limitation being one million tiles in each direction from the center. */ readonly width: uint /** * Height in tiles. If `0`, the map has 'infinite' height, with the actual limitation being one million tiles in each direction from the center. */ readonly height: uint /** * Size of the starting area. */ readonly starting_area: MapGenSize /** * Positions of the starting areas. */ readonly starting_points: readonly (MapPosition | MapPositionArray)[] /** * Whether enemy creatures will not attack unless the player first attacks them. */ readonly peaceful_mode: boolean /** * Whether enemy creatures will not naturally spawn from spawners, map gen, or trigger effects. */ readonly no_enemies_mode: boolean /** * Overrides for tile property value generators. */ readonly property_expression_names: PropertyExpressionNames /** * Map generation settings for entities of the type "cliff". */ readonly cliff_settings: CliffPlacementSettingsWrite readonly territory_settings: TerritorySettings } /** * Specifies how probability and richness are calculated when placing something on the map. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AutoplaceSpecification.html Online documentation} */ export interface AutoplaceSpecification { /** * Control prototype name. */ readonly control?: string readonly default_enabled: boolean readonly force: string readonly order: string readonly placement_density: uint readonly tile_restriction?: AutoplaceSpecificationRestriction[] readonly probability_expression: NoiseExpression readonly richness_expression?: NoiseExpression } export interface RailExtensionData { /** * Name of the entity prototype to be built */ readonly name: string /** * Position of the entity to be built */ readonly position: MapPosition /** * Direction of the entity to be built */ readonly direction: defines.direction /** * Goal where this rail extension will go to */ readonly goal: RailLocation } /** * A single pipe connection for a given fluidbox. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PipeConnection.html Online documentation} */ export interface PipeConnection { readonly flow_direction: "input" | "output" | "input-output" readonly connection_type: "normal" | "underground" | "linked" /** * 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 target fluidbox, if any. */ readonly target_fluidbox_index?: uint /** * The index of the target fluidbox pipe connection, if any. */ readonly target_pipe_connection_index?: uint } export interface FluidBoxConnectionRecord { readonly this_linked_connection_id: uint readonly other_entity: LuaEntity readonly other_linked_connection_id: uint } export interface DetailedItemOnLine { readonly stack: LuaItemStack /** * Linear position of this stack on this line. */ readonly position: float /** * Unique identifier of this item while it is on transport lines. */ readonly unique_id: uint } /** * ## Union members * - `"signal-id"` * - `"signal-id-base"` * - `"signal-or-number"` * - `"simple-slot"` * - `"simple-item-slot"` * - `"recipe-slot"` * - `"quickbar-slot"` * - `"logistics-button"` * - `"logistics-button-space"` * - `"text-button-localised-substring"` * - `"text-button"` * - `"text-button-substring"` * - `"inventory-limit-slot-button"` * - `"train-schedule-action-button"` * - `"choose-button"` * - `"textfield"` * - `"item-group-tab"` * - `"drop-down"` * - `"check-box"` * - `"switch"` * - `"label"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SimulationWidgetType.html Online documentation} */ export type SimulationWidgetType = | "signal-id" | "signal-id-base" | "signal-or-number" | "simple-slot" | "simple-item-slot" | "recipe-slot" | "quickbar-slot" | "logistics-button" | "logistics-button-space" | "text-button-localised-substring" | "text-button" | "text-button-substring" | "inventory-limit-slot-button" | "train-schedule-action-button" | "choose-button" | "textfield" | "item-group-tab" | "drop-down" | "check-box" | "switch" | "label" export interface AddRecordData { /** * One of station or rail must be given. */ readonly station?: string readonly rail?: LuaEntity /** * When `rail` is given, this can be provided to further narrow down direction from which that rail should be approached. */ readonly rail_direction?: defines.rail_direction readonly wait_conditions?: readonly WaitConditionWrite[] readonly temporary?: boolean readonly allows_unloading?: boolean /** * If index is not given, the record is appended. */ readonly index?: ScheduleRecordPosition } export interface EntitySearchFilters { readonly area?: BoundingBoxWrite | BoundingBoxArray /** * Has precedence over area field. */ readonly position?: MapPosition | MapPositionArray /** * If given with position, will return all entities within the radius of the position. */ readonly radius?: double /** * An empty array means nothing matches the name filter. */ readonly name?: EntityID | readonly EntityID[] /** * An empty array means nothing matches the type filter. */ readonly type?: string | readonly string[] /** * An empty array means nothing matches the ghost_name filter. */ readonly ghost_name?: EntityID | readonly EntityID[] /** * An empty array means nothing matches the ghost_type filter. */ readonly ghost_type?: string | readonly string[] readonly direction?: defines.direction | readonly defines.direction[] readonly collision_mask?: CollisionLayerID | readonly CollisionLayerID[] | Record readonly force?: ForceSetWrite readonly to_be_deconstructed?: boolean readonly to_be_upgraded?: boolean readonly limit?: uint readonly is_military_target?: boolean readonly has_item_inside?: ItemWithQualityID readonly quality?: QualityCondition /** * Whether the filters should be inverted. */ readonly invert?: boolean } export interface TileSearchFilters { readonly area?: BoundingBoxWrite | BoundingBoxArray /** * Ignored if not given with radius. */ readonly position?: MapPosition | MapPositionArray /** * If given with position, will return all tiles within the radius of the position. */ readonly radius?: double /** * An empty array means nothing matches the name filter. */ readonly name?: TileID | readonly TileID[] readonly limit?: uint readonly has_hidden_tile?: boolean /** * Can be further filtered by supplying a `force` filter. */ readonly has_double_hidden_tile?: boolean /** * Can be further filtered by supplying a `force` filter. */ readonly has_tile_ghost?: boolean /** * Can be further filtered by supplying a `force` filter. */ readonly to_be_deconstructed?: boolean readonly collision_mask?: CollisionLayerID | readonly CollisionLayerID[] | Record readonly force?: ForceSetWrite /** * If the filters should be inverted. */ readonly invert?: boolean } export interface TrainFilter { /** * Train ID filter */ readonly train_id?: uint /** * Surface the train must be on in order to pass */ readonly surface?: SurfaceIdentification /** * Train must contain at least one rolling stock of this force to pass */ readonly force?: ForceID /** * Train must contain a rolling stock of any of provided prototype to pass */ readonly stock?: EntityID | readonly EntityID[] /** * Train must have at least that many stocks to pass */ readonly min_stocks?: uint /** * Train must have at most that many stocks to pass */ readonly max_stocks?: uint /** * Checks if train is moving (has speed != 0) or not moving. */ readonly is_moving?: boolean /** * Checks if train has a passenger. */ readonly has_passenger?: boolean /** * Checks if train is in manual controller. */ readonly is_manual?: boolean /** * Train must belong to a group of a given name. */ readonly group?: string } export interface TrainStopFilter { /** * Surface the train stop must be on in order to pass */ readonly surface?: SurfaceIdentification /** * ForceID the train stop must have to pass */ readonly force?: ForceID /** * Checks if train stop is full (trains count >= trains limit or disabled) or not full. */ readonly is_full?: boolean /** * Checks if train stop has a rail next to it. */ readonly is_connected_to_rail?: boolean /** * If given, only train stops of this type will pass */ readonly type?: EntityID | readonly EntityID[] /** * Train stop must belong to given station name to pass */ readonly station_name?: string | readonly string[] /** * If train stop has limit set by control behavior */ readonly limit_set_by_control_behavior?: boolean /** * If train stop is disabled by a control behavior */ readonly is_disabled?: boolean } /** * A `string` specifying the type of request for {@link LuaTrainManager#request_train_path LuaTrainManager::request_train_path}. * * ## Union members * - `"path"`: The method will return {@link TrainPathFinderOneGoalResult}. * - `"any-goal-accessible"`: The method will return {@link TrainPathFinderOneGoalResult}. * - `"all-goals-accessible"`: The method will return {@link TrainPathAllGoalsResult}. * - `"all-goals-penalties"`: The method will return {@link TrainPathAllGoalsResult} with `penalties`. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TrainPathRequestType.html Online documentation} */ export type TrainPathRequestType = "path" | "any-goal-accessible" | "all-goals-accessible" | "all-goals-penalties" /** * ## Union members * - {@link TrainStopGoal} * - {@link RailEndGoal} * - {@link LuaRailEnd} * - {@link LuaEntity}: Only if it points at train-stop that is connected to a rail. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TrainPathFinderGoal.html Online documentation} */ export type TrainPathFinderGoal = TrainStopGoal | RailEndGoal | LuaRailEnd | LuaEntity export interface TrainStopGoal { /** * Train stop target. Must be connected to rail ({@link LuaEntity#connected_rail LuaEntity::connected_rail} returns valid LuaEntity). */ readonly train_stop: LuaEntity /** * Goal priority. If not provided, defaults to {@link LuaEntity#train_stop_priority LuaEntity::train_stop_priority} of provided train_stop. */ readonly priority?: uint8 } export interface RailEndGoal { /** * Rail target. */ readonly rail: LuaEntity readonly direction: defines.rail_direction /** * Goal priority. If not provided, defaults to 50. */ readonly priority?: uint8 } export interface RailEndStart { readonly rail: LuaEntity readonly direction: defines.rail_direction /** * Defaults to `true`. Providing false will cause the pathfinder to reject a path that starts here and ends in the same segment as the path would be too short to provide correct alignment with a goal. */ readonly allow_path_within_segment?: boolean /** * Defaults to `false`. */ readonly is_front?: boolean /** * Start priority. Defaults to `50`. */ readonly priority?: uint8 } export interface TrainPathFinderOneGoalResult { /** * True if found path. */ readonly found_path: boolean /** * If path was found, provides index of the specific goal to which the path goes to. */ readonly goal_index?: uint /** * If path was found, provides index of the specific start from which the path to target goes from */ readonly start_index?: uint /** * Penalty of the path to goal if path was found. */ readonly penalty?: double /** * If path was found, tells if the path was reached from the train's front end or from {@link RailEndStart} with {@link RailEndStart#is_front RailEndStart::is_front} set. */ readonly is_front?: boolean /** * If path was found and search was of type `"path"`, provides total length of all rails of the path. */ readonly total_length?: double /** * Only if search was of type `"path"`, `return_path` was set to true and path was found. Contains all rails in order that are part of the found path. */ readonly path?: LuaEntity[] /** * Amount of steps pathfinder performed. This is a measure of how expensive this search was. */ readonly steps_count: uint } export interface TrainPathAllGoalsResult { /** * Amount of goals that are accessible. */ readonly amount_accessible: uint /** * Array of the same length as requested goals: each field will tell if related goal is accessible for the train. */ readonly accessible: boolean[] /** * Array of the same length as requested goals. Only present if request type was `"all-goals-penalties"`. */ readonly penalties?: double[] /** * Amount of steps pathfinder performed. This is a measure of how expensive this search was. */ readonly steps_count: uint } export interface RollingStockDrawData { readonly position: MapPosition readonly orientation: RealOrientation readonly slope: float readonly height: float } /** * Used to filter out irrelevant event callbacks in a performant way. * * Filters are always used as an array of filters of a specific type. Every filter can only be used with its corresponding event, and different types of event filters can not be mixed. * * ## Union members * - {@link LuaScriptRaisedTeleportedEventFilter} * - {@link LuaPreRobotMinedEntityEventFilter} * - {@link LuaScriptRaisedBuiltEventFilter} * - {@link LuaPlatformMinedEntityEventFilter} * - {@link LuaRobotBuiltEntityEventFilter} * - {@link LuaPrePlayerMinedEntityEventFilter} * - {@link LuaEntityDeconstructionCancelledEventFilter} * - {@link LuaPreGhostUpgradedEventFilter} * - {@link LuaPlatformBuiltEntityEventFilter} * - {@link LuaPrePlatformMinedEntityEventFilter} * - {@link LuaEntityClonedEventFilter} * - {@link LuaPlayerRepairedEntityEventFilter} * - {@link LuaPostEntityDiedEventFilter} * - {@link LuaPreGhostDeconstructedEventFilter} * - {@link LuaPlayerMinedEntityEventFilter} * - {@link LuaSectorScannedEventFilter} * - {@link LuaRobotMinedEntityEventFilter} * - {@link LuaEntityMarkedForDeconstructionEventFilter} * - {@link LuaScriptRaisedReviveEventFilter} * - {@link LuaPlayerBuiltEntityEventFilter} * - {@link LuaUpgradeCancelledEventFilter} * - {@link LuaEntityDamagedEventFilter} * - {@link LuaEntityDiedEventFilter} * - {@link LuaEntityMarkedForUpgradeEventFilter} * - {@link LuaScriptRaisedDestroyEventFilter} * @see EventFilterWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EventFilter.html Online documentation} */ export type EventFilter = | LuaScriptRaisedTeleportedEventFilter[] | LuaPreRobotMinedEntityEventFilter[] | LuaScriptRaisedBuiltEventFilter[] | LuaPlatformMinedEntityEventFilter[] | LuaRobotBuiltEntityEventFilter[] | LuaPrePlayerMinedEntityEventFilter[] | LuaEntityDeconstructionCancelledEventFilter[] | LuaPreGhostUpgradedEventFilter[] | LuaPlatformBuiltEntityEventFilter[] | LuaPrePlatformMinedEntityEventFilter[] | LuaEntityClonedEventFilter[] | LuaPlayerRepairedEntityEventFilter[] | LuaPostEntityDiedEventFilter[] | LuaPreGhostDeconstructedEventFilter[] | LuaPlayerMinedEntityEventFilter[] | LuaSectorScannedEventFilter[] | LuaRobotMinedEntityEventFilter[] | LuaEntityMarkedForDeconstructionEventFilter[] | LuaScriptRaisedReviveEventFilter[] | LuaPlayerBuiltEntityEventFilter[] | LuaUpgradeCancelledEventFilter[] | LuaEntityDamagedEventFilter[] | LuaEntityDiedEventFilter[] | LuaEntityMarkedForUpgradeEventFilter[] | LuaScriptRaisedDestroyEventFilter[] /** * Write form of {@link EventFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EventFilter.html Online documentation} */ export type EventFilterWrite = | readonly LuaScriptRaisedTeleportedEventFilter[] | readonly LuaPreRobotMinedEntityEventFilter[] | readonly LuaScriptRaisedBuiltEventFilter[] | readonly LuaPlatformMinedEntityEventFilter[] | readonly LuaRobotBuiltEntityEventFilter[] | readonly LuaPrePlayerMinedEntityEventFilter[] | readonly LuaEntityDeconstructionCancelledEventFilter[] | readonly LuaPreGhostUpgradedEventFilter[] | readonly LuaPlatformBuiltEntityEventFilter[] | readonly LuaPrePlatformMinedEntityEventFilter[] | readonly LuaEntityClonedEventFilter[] | readonly LuaPlayerRepairedEntityEventFilter[] | readonly LuaPostEntityDiedEventFilter[] | readonly LuaPreGhostDeconstructedEventFilter[] | readonly LuaPlayerMinedEntityEventFilter[] | readonly LuaSectorScannedEventFilter[] | readonly LuaRobotMinedEntityEventFilter[] | readonly LuaEntityMarkedForDeconstructionEventFilter[] | readonly LuaScriptRaisedReviveEventFilter[] | readonly LuaPlayerBuiltEntityEventFilter[] | readonly LuaUpgradeCancelledEventFilter[] | readonly LuaEntityDamagedEventFilterWrite[] | readonly LuaEntityDiedEventFilter[] | readonly LuaEntityMarkedForUpgradeEventFilter[] | readonly LuaScriptRaisedDestroyEventFilter[] /** * Represents an object that can be {@link LuaBootstrap#register_on_object_destroyed registered} for the {@link OnObjectDestroyedEvent on_object_destroyed} event. Each target has an associated {@link defines.target_type} and some have a unique identifier. * * ## Union members * - {@link LuaEntity}: Target type {@link defines.target_type.entity entity}; `useful_id` {@link LuaEntity#unit_number LuaEntity::unit_number} * - {@link LuaEquipment}: Target type {@link defines.target_type.equipment equipment} * - {@link LuaEquipmentGrid}: Target type {@link defines.target_type.equipment_grid equipment_grid}; `useful_id` {@link LuaEquipmentGrid#unique_id LuaEquipmentGrid::unique_id} * - {@link LuaItem}: Target type {@link defines.target_type.item item}; `useful_id` {@link LuaItemCommon#item_number LuaItemCommon::item_number} * - {@link LuaLogisticCell}: Target type {@link defines.target_type.logistic_cell logistic_cell} * - {@link LuaLogisticNetwork}: Target type {@link defines.target_type.logistic_network logistic_network}; `useful_id` {@link LuaLogisticNetwork#network_id LuaLogisticNetwork::network_id} * - {@link LuaLogisticSection}: Target type {@link defines.target_type.logistic_section logistic_section} * - {@link LuaPermissionGroup}: Target type {@link defines.target_type.permission_group permission_group}; `useful_id` {@link LuaPermissionGroup#group_id LuaPermissionGroup::group_id} * - {@link LuaPlanet}: Target type {@link defines.target_type.planet planet} * - {@link LuaPlayer}: Target type {@link defines.target_type.player player}; `useful_id` {@link LuaPlayer#index LuaPlayer::index} * - {@link LuaRailPath}: Target type {@link defines.target_type.rail_path rail_path} * - {@link LuaRenderObject}: Target type {@link defines.target_type.render_object render_object}; `useful_id` {@link LuaRenderObject#id LuaRenderObject::id} * - {@link LuaSpacePlatform}: Target type {@link defines.target_type.space_platform space_platform}; `useful_id` {@link LuaSpacePlatform#index LuaSpacePlatform::index} * - {@link LuaSurface}: Target type {@link defines.target_type.surface surface}; `useful_id` {@link LuaSurface#index LuaSurface::index} * - {@link LuaTrain}: Target type {@link defines.target_type.train train}; `useful_id` {@link LuaTrain#id LuaTrain::id} * - {@link LuaCommandable}: Target type {@link defines.target_type.commandable commandable}; `useful_id` {@link LuaCommandable#unique_id LuaCommandable::unique_id} * - {@link LuaCustomChartTag}: Target type {@link defines.target_type.custom_chart_tag custom_chart_tag}; `useful_id` {@link LuaCustomChartTag#tag_number LuaCustomChartTag::tag_number} * - {@link LuaGuiElement}: Target type {@link defines.target_type.gui_element gui_element}; `useful_id` {@link LuaGuiElement#index LuaGuiElement::index} * - {@link LuaCargoHatch}: Target type {@link defines.target_type.cargo_hatch cargo_hatch} * - {@link LuaSchedule}: Target type {@link defines.target_type.schedule schedule} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/RegistrationTarget.html Online documentation} */ export type RegistrationTarget = | LuaEntity | LuaEquipment | LuaEquipmentGrid | LuaItem | LuaLogisticCell | LuaLogisticNetwork | LuaLogisticSection | LuaPermissionGroup | LuaPlanet | LuaPlayer | LuaRailPath | LuaRenderObject | LuaSpacePlatform | LuaSurface | LuaTrain | LuaCommandable | LuaCustomChartTag | LuaGuiElement | LuaCargoHatch | LuaSchedule export interface ItemIDFilter { /** * The item name. */ readonly name: string /** * The name of the quality. */ readonly quality?: string /** * The quality comparison type. */ readonly comparator?: ComparatorStringRead } export interface EntityIDFilter { /** * The entity name. */ readonly name: string /** * The name of the quality. */ readonly quality?: string /** * The quality comparison type. */ readonly comparator?: ComparatorStringRead } /** * Types `"signal"` and `"item-group"` do not support filters. * * Filters are always used as an array of filters of a specific type. Every filter can only be used with its corresponding event, and different types of event filters can not be mixed. * * ## Union members * - {@link ModSettingPrototypeFilter} * - {@link SpaceLocationPrototypeFilter} * - {@link DecorativePrototypeFilter} * - {@link TilePrototypeFilter} * - {@link AsteroidChunkPrototypeFilter} * - {@link ItemPrototypeFilter} * - {@link TechnologyPrototypeFilter} * - {@link RecipePrototypeFilter} * - {@link AchievementPrototypeFilter} * - {@link EquipmentPrototypeFilter} * - {@link FluidPrototypeFilter} * - {@link EntityPrototypeFilter} * @see PrototypeFilterWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PrototypeFilter.html Online documentation} */ export type PrototypeFilter = | ModSettingPrototypeFilter[] | SpaceLocationPrototypeFilter[] | DecorativePrototypeFilter[] | TilePrototypeFilter[] | AsteroidChunkPrototypeFilter[] | ItemPrototypeFilter[] | TechnologyPrototypeFilter[] | RecipePrototypeFilter[] | AchievementPrototypeFilter[] | EquipmentPrototypeFilter[] | FluidPrototypeFilter[] | EntityPrototypeFilter[] /** * Write form of {@link PrototypeFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PrototypeFilter.html Online documentation} */ export type PrototypeFilterWrite = | readonly ModSettingPrototypeFilter[] | readonly SpaceLocationPrototypeFilterWrite[] | readonly DecorativePrototypeFilter[] | readonly TilePrototypeFilterWrite[] | readonly AsteroidChunkPrototypeFilter[] | readonly ItemPrototypeFilterWrite[] | readonly TechnologyPrototypeFilterWrite[] | readonly RecipePrototypeFilterWrite[] | readonly AchievementPrototypeFilter[] | readonly EquipmentPrototypeFilter[] | readonly FluidPrototypeFilterWrite[] | readonly EntityPrototypeFilterWrite[] /** * 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. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EntityPrototypeFlags.html Online documentation} */ export type EntityPrototypeFlags = { readonly [T in EntityPrototypeFlag]?: true } /** * A `string` specifying an entity prototype flag. * * ## Union members * - `"not-rotatable"`: Prevents the entity from being rotated before or after placement. * - `"placeable-neutral"`: Determines the default force when placing entities in the map editor and using the "AUTO" option for the force. * - `"placeable-player"`: Determines the default force when placing entities in the map editor and using the "AUTO" option for the force. * - `"placeable-enemy"`: Determines the default force when placing entities in the map editor and using the "AUTO" option for the force. * - `"placeable-off-grid"`: Determines whether the entity needs to be aligned with the invisible grid within the world. Most entities are confined in this way, with a few exceptions such as trees and land mines. * - `"player-creation"`: Makes it possible to blueprint, deconstruct, and repair the entity (which can be turned off again using the specific flags). Makes it possible for the biter AI to target the entity as a distraction. Enables dust to automatically be created when building the entity. If the entity does not have a `map_color` set, this flag makes the entity appear on the map with the default color specified by the UtilityConstants. * - `"building-direction-8-way"`: Uses 45 degree angle increments when selecting direction. * - `"filter-directions"`: Used to automatically detect the proper direction of the entity if possible. Used by the pump, train stop, and train signal by default. * - `"get-by-unit-number"`: When set, entity will be possible to obtain by using {@link LuaGameScript#get_entity_by_unit_number LuaGameScript::get_entity_by_unit_number}. * - `"breaths-air"`: Used to specify that the entity breathes air, and is thus affected by poison. * - `"not-repairable"`: Used to specify that the entity can not be 'healed' by repair packs. * - `"not-on-map"`: Prevents the entity from being drawn on the map. * - `"not-deconstructable"`: Prevents the entity from being deconstructed. * - `"not-blueprintable"`: Prevents the entity from being part of a blueprint. * - `"hide-alt-info"`: Hides the alt-info of this entity when in alt-mode. * - `"no-gap-fill-while-building"` * - `"not-flammable"`: Does not apply fire stickers to the entity. * - `"no-automated-item-removal"`: Prevents inserters and loaders from taking items from this entity. * - `"no-automated-item-insertion"`: Prevents inserters and loaders from inserting items into this entity. * - `"no-copy-paste"`: Prevents the entity from being copy-pasted. * - `"not-selectable-in-game"`: Disallows selection of the entity even when a selection box is specified for other reasons. For example, selection boxes are used to determine the size of outlines to be shown when highlighting entities inside electric pole ranges. * - `"not-upgradable"`: Prevents the entity from being selected by the upgrade planner. * - `"not-in-kill-statistics"`: Prevents the entity from being shown in the kill statistics. * - `"building-direction-16-way"` * - `"snap-to-rail-support-spot"` * - `"not-in-made-in"`: Prevents the entity from being shown in the "made in" list in recipe tooltips. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EntityPrototypeFlag.html Online documentation} */ export type EntityPrototypeFlag = | "not-rotatable" | "placeable-neutral" | "placeable-player" | "placeable-enemy" | "placeable-off-grid" | "player-creation" | "building-direction-8-way" | "filter-directions" | "get-by-unit-number" | "breaths-air" | "not-repairable" | "not-on-map" | "not-deconstructable" | "not-blueprintable" | "hide-alt-info" | "no-gap-fill-while-building" | "not-flammable" | "no-automated-item-removal" | "no-automated-item-insertion" | "no-copy-paste" | "not-selectable-in-game" | "not-upgradable" | "not-in-kill-statistics" | "building-direction-16-way" | "snap-to-rail-support-spot" | "not-in-made-in" /** * Specifies from where the programmable speaker's sound will be heard. * * ## Union members * - `"local"`: The sound can be heard within the audible range around the speaker. * - `"surface"`: The sound can be heard anywhere on the speaker's surface. * - `"global"`: The sound can be heard everywhere. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ProgrammableSpeakerPlaybackMode.html Online documentation} */ export type ProgrammableSpeakerPlaybackMode = "local" | "surface" | "global" /** * ## Union members * - `"west-to-east"` * - `"north-to-south"` * - `"east-to-west"` * - `"south-to-north"` * - `"west-to-north"` * - `"north-to-east"` * - `"east-to-south"` * - `"south-to-west"` * - `"west-to-south"` * - `"north-to-west"` * - `"east-to-north"` * - `"south-to-east"` * - `"west-to-none"` * - `"none-to-east"` * - `"east-to-none"` * - `"none-to-west"` * - `"north-to-none"` * - `"none-to-south"` * - `"south-to-none"` * - `"none-to-north"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CliffOrientation.html Online documentation} */ export type CliffOrientation = | "west-to-east" | "north-to-south" | "east-to-west" | "south-to-north" | "west-to-north" | "north-to-east" | "east-to-south" | "south-to-west" | "west-to-south" | "north-to-west" | "east-to-north" | "south-to-east" | "west-to-none" | "none-to-east" | "east-to-none" | "none-to-west" | "north-to-none" | "none-to-south" | "south-to-none" | "none-to-north" export interface ItemInventoryPositions { /** * A list of stacks into which items should be inserted. */ readonly in_inventory?: InventoryPosition[] /** * Defaults to `0`. Number of items to request for the equipment grid. When the items arrive they will be used to revive the first matching ghost equipment. */ readonly grid_count?: ItemCountType } export interface InventoryPosition { /** * The ID of the inventory to insert into. */ readonly inventory: defines.inventory /** * The stack index of the inventory to insert into. */ readonly stack: ItemStackIndex /** * How many items to insert. Defaults to `1`. */ readonly count?: ItemCountType } /** * Defines an item type that a blueprint entity will request. * @see BlueprintInsertPlanWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintInsertPlan.html Online documentation} */ export interface BlueprintInsertPlan { /** * The prototype name and quality of the item to request. */ readonly id: ItemIDAndQualityIDPair /** * Describes the inventories to insert these items into. */ readonly items: ItemInventoryPositions } /** * Write form of {@link BlueprintInsertPlan}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintInsertPlan.html Online documentation} */ export interface BlueprintInsertPlanWrite { /** * The prototype name and quality of the item to request. */ readonly id: ItemIDAndQualityIDPairWrite /** * Describes the inventories to insert these items into. */ readonly items: ItemInventoryPositions } export interface MarketIngredient { /** * Prototype name of the required item. */ readonly name: string /** * Normal quality will be used if not specified. */ readonly quality?: string /** * Count of the item. Cannot be 0. */ readonly count: ItemCountType } /** * A single offer on a market entity. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Offer.html Online documentation} */ export interface Offer { /** * List of prices. */ readonly price?: MarketIngredient[] /** * The action that will take place when a player accepts the offer. Usually a `"give-item"` modifier. */ readonly offer: TechnologyModifier } export interface CustomEntityStatus { readonly diode: defines.entity_status_diode readonly label: LocalisedString } export interface RadiusVisualisationSpecification { readonly distance: double readonly offset: Vector readonly draw_in_cursor: boolean readonly draw_on_selection: boolean } /** * Defines which slider in the game's sound settings affects the volume of this sound. Furthermore, some sound types are mixed differently than others, e.g. zoom level effects are applied. * * ## Union members * - `"game-effect"` * - `"gui-effect"` * - `"ambient"` * - `"environment"` * - `"walking"` * - `"alert"` * - `"wind"` * - `"world-ambient"` * - `"weapon"` * - `"explosion"` * - `"enemy"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SoundType.html Online documentation} */ export type SoundType = | "game-effect" | "gui-effect" | "ambient" | "environment" | "walking" | "alert" | "wind" | "world-ambient" | "weapon" | "explosion" | "enemy" export interface CompiledLogisticFilter { readonly index: LogisticFilterIndex /** * The type of the logistic filter. */ readonly type?: SignalIDType /** * Name of the logistic filter. */ readonly name?: string /** * The prototype name of the quality. `nil` for any quality. */ readonly quality?: string /** * The comparator for quality. `nil` if any quality. */ readonly comparator?: ComparatorStringRead readonly count: int readonly max_count?: ItemCountType /** * Defaults to 0. */ readonly minimum_delivery_count?: ItemCountType } /** * @see BlueprintLogisticFilterWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintLogisticFilter.html Online documentation} */ export interface BlueprintLogisticFilter { readonly index: LogisticFilterIndex /** * The type of the logistic filter. */ readonly type?: SignalIDType /** * Name of the logistic filter. */ readonly name?: string /** * The prototype name of the quality. `nil` for any quality. */ readonly quality?: string /** * The comparator for quality. `nil` if any quality. */ readonly comparator?: ComparatorStringRead readonly count: int readonly max_count?: ItemCountType /** * Defaults to 0. */ readonly minimum_delivery_count?: ItemCountType readonly import_from?: string } /** * Write form of {@link BlueprintLogisticFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintLogisticFilter.html Online documentation} */ export interface BlueprintLogisticFilterWrite { readonly index: LogisticFilterIndex /** * The type of the logistic filter. */ readonly type?: SignalIDType /** * Name of the logistic filter. */ readonly name?: string /** * The prototype name of the quality. `nil` for any quality. */ readonly quality?: string /** * The comparator for quality. `nil` if any quality. */ readonly comparator?: ComparatorString readonly count: int readonly max_count?: ItemCountType /** * Defaults to 0. */ readonly minimum_delivery_count?: ItemCountType readonly import_from?: string } /** * @see LogisticSectionWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LogisticSection.html Online documentation} */ export interface LogisticSection { readonly index: uint8 readonly filters?: BlueprintLogisticFilter[] readonly group?: string /** * Defaults to 1. */ readonly multiplier?: float /** * Defaults to true. */ readonly active?: float } /** * Write form of {@link LogisticSection}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LogisticSection.html Online documentation} */ export interface LogisticSectionWrite { readonly index: uint8 readonly filters?: readonly BlueprintLogisticFilterWrite[] readonly group?: string /** * Defaults to 1. */ readonly multiplier?: float /** * Defaults to true. */ readonly active?: float } /** * @see LogisticSectionsWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LogisticSections.html Online documentation} */ export interface LogisticSections { readonly sections?: LogisticSection[] /** * Defaults to false. */ readonly trash_not_requested?: boolean } /** * Write form of {@link LogisticSections}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LogisticSections.html Online documentation} */ export interface LogisticSectionsWrite { readonly sections?: readonly LogisticSectionWrite[] /** * Defaults to false. */ readonly trash_not_requested?: boolean } /** * ## Union members * - {@link LuaItemPrototype} * - {@link LuaFluidPrototype} * - {@link LuaRecipePrototype} * - {@link LuaEntityPrototype} * - {@link LuaTilePrototype} * - {@link LuaSpaceLocationPrototype} * - {@link LuaTechnologyPrototype}: Does not actually have an entry in Factoriopedia. * - {@link LuaAmmoCategoryPrototype} * - {@link LuaSpaceConnectionPrototype} * - {@link LuaAsteroidChunkPrototype} * - {@link LuaVirtualSignalPrototype} * - {@link LuaSurfacePrototype} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/FactoriopediaID.html Online documentation} */ export type FactoriopediaID = | LuaItemPrototype | LuaFluidPrototype | LuaRecipePrototype | LuaEntityPrototype | LuaTilePrototype | LuaSpaceLocationPrototype | LuaTechnologyPrototype | LuaAmmoCategoryPrototype | LuaSpaceConnectionPrototype | LuaAsteroidChunkPrototype | LuaVirtualSignalPrototype | LuaSurfacePrototype export interface TriggerItem { readonly type: "direct" | "area" | "line" | "cluster" readonly action_delivery?: TriggerDelivery[] /** * The trigger will only affect entities that contain any of these flags. */ readonly entity_flags?: EntityPrototypeFlags readonly ignore_collision_condition: boolean /** * The trigger will only affect entities that would collide with given collision mask. */ readonly collision_mask: CollisionMask readonly trigger_target_mask: TriggerTargetMask /** * If `"enemy"`, the trigger will only affect entities whose force is different from the attacker's and for which there is no cease-fire set. `"ally"` is the opposite of `"enemy"`. */ readonly force: ForceCondition readonly repeat_count: uint readonly probability: float } /** * A set of trigger target masks. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TriggerTargetMask.html Online documentation} */ export type TriggerTargetMask = Record export interface TriggerDelivery { readonly type: "instant" | "projectile" | "beam" | "stream" | "artillery" | "chain" | "delayed" readonly source_effects: TriggerEffectItem[] readonly target_effects: TriggerEffectItem[] } export interface DamageTypeFilters { /** * Whether this is a whitelist or a blacklist of damage types. `true` means whitelist. */ readonly whitelist: boolean /** * The damage types to filter for. The value in the dictionary is meaningless and exists just to allow for easy lookup. */ readonly types: Record } /** * Used by {@link TriggerEffectItem}. * * ## Union members * - `"damage"` * - `"damage-tile"` * - `"create-entity"` * - `"create-explosion"` * - `"create-fire"` * - `"create-smoke"` * - `"create-trivial-smoke"` * - `"create-asteroid-chunk"` * - `"create-particle"` * - `"create-sticker"` * - `"create-decorative"` * - `"nested-result"` * - `"play-sound"` * - `"push-back"` * - `"destroy-cliffs"` * - `"show-explosion-on-chart"` * - `"insert-item"` * - `"script"` * - `"set-tile"` * - `"invoke-tile-trigger"` * - `"destroy-decoratives"` * - `"camera-effect"` * - `"activate-impact"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TriggerEffectItemType.html Online documentation} */ export type TriggerEffectItemType = | "damage" | "damage-tile" | "create-entity" | "create-explosion" | "create-fire" | "create-smoke" | "create-trivial-smoke" | "create-asteroid-chunk" | "create-particle" | "create-sticker" | "create-decorative" | "nested-result" | "play-sound" | "push-back" | "destroy-cliffs" | "show-explosion-on-chart" | "insert-item" | "script" | "set-tile" | "invoke-tile-trigger" | "destroy-decoratives" | "camera-effect" | "activate-impact" export interface TriggerEffectItem { readonly type: TriggerEffectItemType readonly repeat_count: uint16 readonly repeat_count_deviation: uint16 readonly probability: float readonly affects_target: boolean readonly show_in_tooltip: boolean readonly damage_type_filters?: DamageTypeFilters } /** * Localised strings are a way to support translation of in-game text. It is an array where the first element is the key and the remaining elements are parameters that will be substituted for placeholders in the template designated by the key. * * The key identifies the string template. For example, `"gui-alert-tooltip.attack"` (for the template `"__1__ objects are being damaged"`; see the file `data/core/locale/en.cfg`). * * The template can contain placeholders such as `__1__` or `__2__`. These will be replaced by the respective parameter in the LocalisedString. The parameters themselves can be other localised strings, which will be processed recursively in the same fashion. Localised strings can not be recursed deeper than 20 levels and can not have more than 20 parameters. * * There are two special flags for the localised string, indicated by the key being a particular string. First, if the key is the empty string (`""`), then all parameters will be concatenated (after processing, if any are localised strings themselves). Second, if the key is a question mark (`"?"`), then the first valid parameter will be used. A parameter can be invalid if its name doesn't match any string template. If no parameters are valid, the last one is returned. This is useful to implement a fallback for missing locale templates. * * Furthermore, when an API function expects a localised string, it will also accept a regular string (i.e. not a table) which will not be translated, as well as a number, boolean or `nil`, which will be converted to their textual representation. * @example * -- In the English translation, this will print "No ammo"; in the Czech translation, it will print "Bez munice": * game.player.print({"description.no-ammo"}) * -- The 'description.no-ammo' template contains no placeholders, so no further parameters are necessary. * @example * -- In the English translation, this will print "Durability: 5/9"; in the Japanese one, it will print "耐久度: 5/9": * game.player.print({"description.durability", 5, 9}) * @example * -- This will print "hello" in all translations: * game.player.print({"", "hello"}) * @example * -- This will print "Iron plate: 60" in the English translation and "Eisenplatte: 60" in the German translation. * game.print({"", {"item-name.iron-plate"}, ": ", 60}) * @example * -- As an example of a localised string with fallback, consider this: * {"?", {"", {"entity-description.furnace"}, "\n"}, {"item-description.furnace"}, "optional fallback"} * -- If 'entity-description.furnace' exists, it is concatenated with "\n" and returned. Otherwise, if 'item-description.furnace' * -- exists, it is returned as-is. Otherwise, "optional fallback" is returned. If this value wasn't specified, the * -- translation result would be "Unknown key: 'item-description.furnace'". * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LocalisedString.html Online documentation} */ export type LocalisedString = string | number | boolean | LuaObject | nil | [string, ...LocalisedString[]] export interface DisplayResolution { readonly width: uint readonly height: uint } /** * The smooth orientation. It is a {@link float} in the range `[0, 1)` that covers a full circle, starting at the top and going clockwise. This means a value of `0` indicates "north", a value of `0.5` indicates "south". * * For example then, a value of `0.625` would indicate "south-west", and a value of `0.875` would indicate "north-west". * @see {@link https://lua-api.factorio.com/2.0.45/concepts/RealOrientation.html Online documentation} */ export type RealOrientation = float /** * Coordinates on a surface, for example of an entity. MapPositions may be specified either as a dictionary with `x`, `y` as keys, or simply as an array with two elements. * * The coordinates are saved as a fixed-size 32 bit integer, with 8 bits reserved for decimal precision, meaning the smallest value step is `1/2^8 = 0.00390625` tiles. * @see MapPositionArray * @example * -- Explicit definition * {x = 5.5, y = 2} * {y = 2.25, x = 5.125} * @example * -- Shorthand * {1.625, 2.375} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapPosition.html Online documentation} */ export interface MapPosition { readonly x: double readonly y: double } /** * Array form of {@link MapPosition}. * @see MapPosition * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapPosition.html Online documentation} */ export type MapPositionArray = readonly [double, double] /** * Coordinates of a chunk in a {@link LuaSurface} where each integer `x`/`y` represents a different chunk. This uses the same format as {@link MapPosition}, meaning it can be specified either with or without explicit keys. A {@link MapPosition} can be translated to a ChunkPosition by dividing the `x`/`y` values by 32. * @see ChunkPositionArray * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ChunkPosition.html Online documentation} */ export interface ChunkPosition { readonly x: int readonly y: int } /** * Array form of {@link ChunkPosition}. * @see ChunkPosition * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ChunkPosition.html Online documentation} */ export type ChunkPositionArray = readonly [int, int] /** * Coordinates of a tile on a {@link LuaSurface} where each integer `x`/`y` represents a different tile. This uses the same format as {@link MapPosition}, except it rounds any non-integer `x`/`y` down to whole numbers. It can be specified either with or without explicit keys. * @see TilePositionArray * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TilePosition.html Online documentation} */ export interface TilePosition { readonly x: int readonly y: int } /** * Array form of {@link TilePosition}. * @see TilePosition * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TilePosition.html Online documentation} */ export type TilePositionArray = readonly [int, int] /** * Position inside an equipment grid. This uses the same format as {@link MapPosition}, meaning it can be specified either with or without explicit keys. * @see EquipmentPositionArray * @example * -- Explicit definition * {x = 5, y = 2} * {y = 2, x = 5} * @example * -- Shorthand * {1, 2} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EquipmentPosition.html Online documentation} */ export interface EquipmentPosition { readonly x: int readonly y: int } /** * Array form of {@link EquipmentPosition}. * @see EquipmentPosition * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EquipmentPosition.html Online documentation} */ export type EquipmentPositionArray = readonly [int, int] /** * Screen coordinates of a GUI element in a {@link LuaGui}. This uses the same format as {@link TilePosition}, meaning it can be specified either with or without explicit keys. * @see GuiLocationArray * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GuiLocation.html Online documentation} */ export interface GuiLocation { readonly x: int readonly y: int } /** * Array form of {@link GuiLocation}. * @see GuiLocation * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GuiLocation.html Online documentation} */ export type GuiLocationArray = readonly [int, int] /** * A {@link ChunkPosition} with an added bounding box for the area of the chunk. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ChunkPositionAndArea.html Online documentation} */ export interface ChunkPositionAndArea { readonly x: int readonly y: int readonly area: BoundingBox } /** * A table used to define a manual shape for a piece of equipment. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EquipmentPoint.html Online documentation} */ export interface EquipmentPoint { readonly x: uint readonly y: uint } export interface GuiAnchor { readonly gui: defines.relative_gui_type readonly position: defines.relative_gui_position /** * If provided, only anchors the GUI element when the opened things type matches the type. */ readonly type?: string /** * If provided, only anchors the GUI element when the opened thing matches the name. `name` takes precedence over `names`. */ readonly name?: string /** * If provided, only anchors the GUI element when the opened thing matches one of the names. When reading an anchor, `names` is always populated. */ readonly names?: string[] } export interface TabAndContent { readonly tab: LuaGuiElement readonly content: LuaGuiElement } export interface OldTileAndPosition { readonly old_tile: LuaTilePrototype readonly position: TilePosition } /** * A dictionary of string to the four basic Lua types: `string`, `boolean`, `number`, `table`. * * Note that the API returns tags as a simple table, meaning any modifications to it will not propagate back to the game. Thus, to modify a set of tags, the whole table needs to be written back to the respective property. * @example * {a = 1, b = true, c = "three", d = {e = "f"}} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Tags.html Online documentation} */ export type Tags = Record export interface SurfaceCondition { readonly property: string readonly min: double readonly max: double } export interface SmokeSource { readonly name: string readonly frequency: float readonly offset: float readonly position?: MapPosition readonly north_position?: MapPosition readonly north_east_position?: Vector readonly east_position?: MapPosition readonly south_east_position?: Vector readonly south_position?: MapPosition readonly south_west_position?: Vector readonly west_position?: MapPosition readonly north_west_position?: Vector readonly deviation?: MapPosition readonly starting_frame: uint16 readonly starting_frame_deviation: uint16 readonly height: float readonly height_deviation: float readonly starting_vertical_speed: float readonly starting_vertical_speed_deviation: float readonly vertical_speed_slowdown: float } /** * A vector is a two-element array or dictionary containing the `x` and `y` components. The game will always provide the array format. Positive x goes east, positive y goes south. * @example * right = {1.0, 0.0} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Vector.html Online documentation} */ export type Vector = MapPositionArray /** * An area defined using the map editor. * @see ScriptAreaWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScriptArea.html Online documentation} */ export interface ScriptArea { readonly area: BoundingBox readonly name: string readonly color: Color readonly id: uint } /** * Write form of {@link ScriptArea}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScriptArea.html Online documentation} */ export interface ScriptAreaWrite { readonly area: BoundingBoxWrite | BoundingBoxArray readonly name: string readonly color: Color | ColorArray readonly id: uint } /** * A position defined using the map editor. * @see ScriptPositionWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScriptPosition.html Online documentation} */ export interface ScriptPosition { readonly position: MapPosition readonly name: string readonly color: Color readonly id: uint } /** * Write form of {@link ScriptPosition}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScriptPosition.html Online documentation} */ export interface ScriptPositionWrite { readonly position: MapPosition | MapPositionArray readonly name: string readonly color: Color | ColorArray readonly id: uint } /** * Red, green, blue and alpha values, all in range [0, 1] or all in range [0, 255] if any value is > 1. All values here are optional. Color channels default to `0`, the alpha channel defaults to `1`. * * Similar to {@link MapPosition}, Color allows the short-hand notation of passing an array of exactly 3 or 4 numbers. The game usually expects colors to be in pre-multiplied form (color channels are pre-multiplied by alpha). * @see ColorArray * @example * red1 = {r = 0.5, g = 0, b = 0, a = 0.5} -- Half-opacity red * red2 = {r = 0.5, a = 0.5} -- Same color as red1 * black = {} -- All channels omitted: black * red1_short = {0.5, 0, 0, 0.5} -- Same color as red1 in short-hand notation * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Color.html Online documentation} */ export interface Color { readonly r?: float readonly g?: float readonly b?: float readonly a?: float } /** * Array form of {@link Color}. * @see Color * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Color.html Online documentation} */ export type ColorArray = readonly [r: double, g: double, b: double, a?: double] /** * Same as {@link Color}, but red, green, blue and alpha values can be any floating point number, without any special handling of the range [1, 255]. * @see ColorModifierArray * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ColorModifier.html Online documentation} */ export interface ColorModifier { readonly r?: float readonly g?: float readonly b?: float readonly a?: float } /** * Array form of {@link ColorModifier}. * @see ColorModifier * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ColorModifier.html Online documentation} */ export type ColorModifierArray = readonly [r: double, g: double, b: double, a?: double] export interface CraftingQueueItem { /** * The index of the item in the crafting queue. */ readonly index: uint /** * The recipe being crafted. */ readonly recipe: string /** * The amount of items being crafted. */ readonly count: uint /** * The item is a prerequisite for another item in the queue. */ readonly prerequisite: boolean } export interface Alert { /** * The tick this alert was created. */ readonly tick: uint readonly target?: LuaEntity readonly prototype?: LuaEntityPrototype readonly position?: MapPosition /** * The SignalID used for a custom alert. Only present for custom alerts. */ readonly icon?: SignalID /** * The message for a custom alert. Only present for custom alerts. */ readonly message?: LocalisedString } export interface PathfinderWaypoint { /** * The position of the waypoint on its surface. */ readonly position: MapPosition /** * `true` if the path from the previous waypoint to this one goes through an entity that must be destroyed. */ readonly needs_destroy_to_reach: boolean } export interface CutsceneWaypoint { /** * Position to pan the camera to. */ readonly position?: MapPosition | MapPositionArray /** * Entity or unit group to pan the camera to. */ readonly target?: LuaEntity | LuaCommandable /** * How many ticks it will take to reach this waypoint from the previous one. */ readonly transition_time: uint /** * Time in ticks to wait before moving to the next waypoint. */ readonly time_to_wait: uint /** * Zoom level to be set when the waypoint is reached. When not specified, the previous waypoint's zoom is used. */ readonly zoom?: double } export interface Decorative { /** * The name of the decorative prototype. */ readonly name: string readonly position: TilePosition | TilePositionArray readonly amount: uint8 } export interface DecorativeResult { readonly position: TilePosition readonly decorative: LuaDecorativePrototype readonly amount: uint } export interface MineableProperties { /** * Is this entity mineable at all? */ readonly minable: boolean /** * Energy required to mine an entity. */ readonly mining_time: double /** * Prototype name of the particle produced when mining this entity. Will only be present if this entity produces any particle during mining. */ readonly mining_particle?: string /** * Products obtained by mining this entity. */ readonly products?: Product[] /** * The required fluid amount if any. */ readonly fluid_amount?: double /** * The prototype name of the required fluid if any. */ readonly required_fluid?: string /** * The mining trigger if any. */ readonly mining_trigger?: TriggerItem[] } export interface SpaceLocationAsteroidSpawnDefinition { /** * `asteroid-chunk` or `entity` */ type: "asteroid-chunk" | "entity" /** * The asteroid chunk or entity name. */ readonly asteroid: string readonly probability: double readonly speed: double } export interface SpaceConnectionAsteroidSpawnPoint { readonly probability: double readonly speed: double readonly distance: double } export interface SpaceConnectionAsteroidSpawnDefinition { /** * `asteroid-chunk` or `entity` */ type: "asteroid-chunk" | "entity" /** * The asteroid chunk or entity name. */ readonly asteroid: string readonly spawn_points: SpaceConnectionAsteroidSpawnPoint[] } /** * @see AsteroidChunkWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AsteroidChunk.html Online documentation} */ export interface AsteroidChunk { /** * The name of the asteroid chunk prototype. */ readonly name: string readonly position: MapPosition readonly movement: Vector } /** * Write form of {@link AsteroidChunk}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AsteroidChunk.html Online documentation} */ export interface AsteroidChunkWrite { /** * The name of the asteroid chunk prototype. */ readonly name: string readonly position: MapPosition | MapPositionArray readonly movement: Vector } export interface PrototypeHistory { /** * The mod that created this prototype. */ readonly created: string /** * The mods that changed this prototype in the order they changed it. */ readonly changed: string[] } /** * Either `icon`, `text`, or both must be provided. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ChartTagSpec.html Online documentation} */ export interface ChartTagSpec { readonly position: MapPosition | MapPositionArray readonly icon?: SignalIDWrite readonly text?: string readonly last_user?: PlayerIdentification } /** * Parameters that affect the look and control of the game. Updating any of the member attributes here will immediately take effect in the game engine. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.html Online documentation} */ export interface GameViewSettings { /** * Show the controller GUI elements. This includes the toolbar, the selected tool slot, the armour slot, and the gun and ammunition slots. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_controller_gui.html Online documentation} */ show_controller_gui: boolean /** * Show the chart in the upper right-hand corner of the screen. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_minimap.html Online documentation} */ show_minimap: boolean /** * Show research progress and name in the upper right-hand corner of the screen. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_research_info.html Online documentation} */ show_research_info: boolean /** * Show overlay icons on entities. Also known as "alt-mode". * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_entity_info.html Online documentation} */ show_entity_info: boolean /** * Show the flashing alert icons next to the player's toolbar. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_alert_gui.html Online documentation} */ show_alert_gui: boolean /** * When `true` (the default), mousing over an entity will select it. Otherwise, moving the mouse won't update entity selection. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.update_entity_selection.html Online documentation} */ update_entity_selection: boolean /** * When `true` (`false` is default), the rails will always show the rail block visualisation. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_rail_block_visualisation.html Online documentation} */ show_rail_block_visualisation: boolean /** * Shows or hides the buttons row. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_side_menu.html Online documentation} */ show_side_menu: boolean /** * Shows or hides the view options when map is opened. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_map_view_options.html 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/2.0.45/concepts/GameViewSettings.show_entity_tooltip.html Online documentation} */ show_entity_tooltip: boolean /** * Shows or hides quickbar of shortcuts. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_quickbar.html Online documentation} */ show_quickbar: boolean /** * Shows or hides the shortcut bar. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_shortcut_bar.html Online documentation} */ show_shortcut_bar: boolean /** * Shows or hides the crafting queue. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_crafting_queue.html Online documentation} */ show_crafting_queue: boolean /** * Shows or hides the tool window with the weapons and armor. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_tool_bar.html 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/2.0.45/concepts/GameViewSettings.show_hotkey_suggestions.html Online documentation} */ show_hotkey_suggestions: boolean /** * Shows or hides the surface list while in Remote View. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GameViewSettings.show_surface_list.html Online documentation} */ show_surface_list: boolean } /** * The data that can be extracted from a map exchange string, as a plain table. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapExchangeStringData.html Online documentation} */ export interface MapExchangeStringData { readonly map_settings: MapAndDifficultySettings readonly map_gen_settings: MapGenSettings } /** * @see BlueprintSignalIconWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintSignalIcon.html Online documentation} */ export interface BlueprintSignalIcon { /** * The icon to use. */ readonly signal: SignalID /** * Index of the icon in the blueprint icons slots. An integer in the range [1, 4]. */ readonly index: uint } /** * Write form of {@link BlueprintSignalIcon}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintSignalIcon.html Online documentation} */ export interface BlueprintSignalIconWrite { /** * The icon to use. */ readonly signal: SignalIDWrite /** * Index of the icon in the blueprint icons slots. An integer in the range [1, 4]. */ readonly index: uint } export interface ItemLocationData { readonly surface: LuaSurface readonly entity?: LuaEntity readonly player?: LuaPlayer readonly position: MapPosition readonly force: LuaForce } /** * Describes a single wire in the blueprint. The members of the tuple are, in order: * * - `source_entity_number` * * - `source_wire_connector_id` * * - `target_entity_number` * * - `target_wire_connector_id` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/BlueprintWire.html Online documentation} */ export type BlueprintWire = readonly [uint, defines.wire_connector_id, uint, defines.wire_connector_id] /** * @see TileWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Tile.html Online documentation} */ export interface Tile { /** * The position of the tile. */ readonly position: TilePosition /** * The prototype name of the tile. */ readonly name: string } /** * Write form of {@link Tile}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Tile.html Online documentation} */ export interface TileWrite { /** * The position of the tile. */ readonly position: TilePosition | TilePositionArray /** * The prototype name of the tile. */ readonly name: string } /** * Common attributes to all variants of {@link Ingredient}. */ export interface BaseIngredient { readonly type: "item" | "fluid" /** * Prototype name of the required item or fluid. */ readonly name: string /** * Amount of the item or fluid. */ readonly amount: double /** * How much of this ingredient is ignored by statistics. */ readonly ignored_by_stats?: uint | double } /** * `"fluid"` variant of {@link Ingredient}. */ export interface FluidIngredient extends BaseIngredient { readonly type: "fluid" /** * The minimum fluid temperature required. */ readonly minimum_temperature?: float /** * The maximum fluid temperature allowed. */ readonly maximum_temperature?: float } /** * Variants of {@link Ingredient} with no additional attributes. */ export interface OtherIngredient extends BaseIngredient { readonly type: "item" } /** * Base attributes: {@link BaseIngredient} * * Other attributes may be specified depending on `type`: * - `"fluid"`: {@link FluidIngredient} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Ingredient.html Online documentation} */ export type Ingredient = FluidIngredient | OtherIngredient export interface Loot { /** * Item prototype name of the result. */ readonly item: string /** * Probability that any loot at all will drop, as a number in range [0, 1]. */ readonly probability: double /** * Minimum amount of loot to drop. */ readonly count_min: double /** * Maximum amount of loot to drop. */ readonly count_max: double } export interface BaseTechnologyModifier { /** * Modifier type. Specifies which of the other fields will be available. */ readonly type: ModifierType } /** * `"gun-speed"` variant of {@link TechnologyModifier}. */ export interface GunSpeedTechnologyModifier extends BaseTechnologyModifier { readonly type: "gun-speed" /** * Prototype name of the ammunition category that is affected */ readonly ammo_category: string /** * Modification value. This will be added to the current gun speed modifier upon researching. */ readonly modifier: double } /** * `"ammo-damage"` variant of {@link TechnologyModifier}. */ export interface AmmoDamageTechnologyModifier extends BaseTechnologyModifier { readonly type: "ammo-damage" /** * Prototype name of the ammunition category that is affected */ readonly ammo_category: string /** * Modification value. This will be added to the current ammo damage modifier upon researching. */ readonly modifier: double } /** * `"give-item"` variant of {@link TechnologyModifier}. */ export interface GiveItemTechnologyModifier extends BaseTechnologyModifier { readonly type: "give-item" /** * Item prototype name to give. */ readonly item: string /** * Number of items to give. Defaults to `1`. */ readonly count?: uint } /** * `"turret-attack"` variant of {@link TechnologyModifier}. */ export interface TurretAttackTechnologyModifier extends BaseTechnologyModifier { readonly type: "turret-attack" /** * Turret prototype name this modifier will affect. */ readonly turret_id: string /** * Modification value. This will be added to the current turret damage modifier upon researching. */ readonly modifier: double } /** * `"unlock-recipe"` variant of {@link TechnologyModifier}. */ export interface UnlockRecipeTechnologyModifier extends BaseTechnologyModifier { readonly type: "unlock-recipe" /** * Recipe prototype name to unlock. */ readonly recipe: string } /** * `"nothing"` variant of {@link TechnologyModifier}. */ export interface NothingTechnologyModifier extends BaseTechnologyModifier { readonly type: "nothing" /** * Description of this nothing modifier. */ readonly effect_description: LocalisedString } /** * Variants of {@link TechnologyModifier} with no additional attributes. */ export interface OtherTechnologyModifier extends BaseTechnologyModifier { readonly type: | "inserter-stack-size-bonus" | "bulk-inserter-capacity-bonus" | "laboratory-speed" | "character-logistic-trash-slots" | "maximum-following-robots-count" | "worker-robot-speed" | "worker-robot-storage" | "character-crafting-speed" | "character-mining-speed" | "character-running-speed" | "character-build-distance" | "character-item-drop-distance" | "character-reach-distance" | "character-resource-reach-distance" | "character-item-pickup-distance" | "character-loot-pickup-distance" | "character-inventory-slots-bonus" | "deconstruction-time-to-live" | "max-failed-attempts-per-tick-per-construction-queue" | "max-successful-attempts-per-tick-per-construction-queue" | "character-health-bonus" | "mining-drill-productivity-bonus" | "train-braking-force-bonus" | "worker-robot-battery" | "laboratory-productivity" | "follower-robot-lifetime" | "artillery-range" | "character-logistic-requests" | "unlock-space-location" | "unlock-quality" | "unlock-space-platforms" | "unlock-circuit-network" | "cargo-landing-pad-count" | "change-recipe-productivity" | "cliff-deconstruction-enabled" | "mining-with-fluid" | "rail-support-on-deep-oil-ocean" | "rail-planner-allow-elevated-rails" | "beacon-distribution" | "create-ghost-on-entity-death" | "belt-stack-size-bonus" | "vehicle-logistics" /** * Modification value. This value will be added to the variable it modifies. */ readonly modifier: double } /** * The effect that is applied when a technology is researched. It is a table that contains at least the field `type`. * * Other attributes may be specified depending on `type`: * - `"gun-speed"`: {@link GunSpeedTechnologyModifier} * - `"ammo-damage"`: {@link AmmoDamageTechnologyModifier} * - `"give-item"`: {@link GiveItemTechnologyModifier} * - `"turret-attack"`: {@link TurretAttackTechnologyModifier} * - `"unlock-recipe"`: {@link UnlockRecipeTechnologyModifier} * - `"nothing"`: {@link NothingTechnologyModifier} * - Other types: {@link OtherTechnologyModifier} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TechnologyModifier.html Online documentation} */ export type TechnologyModifier = | GunSpeedTechnologyModifier | AmmoDamageTechnologyModifier | GiveItemTechnologyModifier | TurretAttackTechnologyModifier | UnlockRecipeTechnologyModifier | NothingTechnologyModifier | OtherTechnologyModifier /** * A fragment of a functional program used to generate coherent noise, probably for purposes related to terrain generation. These can only be meaningfully written/modified during the data load phase. More detailed information is found on the {@link import("factorio:prototype").NamedNoiseExpression prototype docs}. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/NoiseExpression.html Online documentation} */ export interface NoiseExpression { /** * Names the type of the expression and determines what other fields are required. */ readonly type: string } export interface AutoplaceSpecificationRestriction { /** * Tile prototype name */ readonly first?: string /** * Second prototype name */ readonly second?: string } export interface Resistance { /** * Absolute damage decrease */ readonly decrease: float /** * Percentual damage decrease */ readonly percent: float } /** * A floating point number specifying an amount. * * For backwards compatibility, MapGenSizes can also be specified as a string, which will be converted to a number (when queried, a number will always be returned). * * The map generation algorithm officially supports the range of values the in-game map generation screen shows (specifically `0` and values from `1/6` to `6`). Values outside this range are not guaranteed to work as expected. * * ## Union members * - {@link float}: Specifying a map gen dimension. * - `"none"`: equivalent to `0`. * - `"very-low"`: equivalent to `1/2`. * - `"very-small"`: equivalent to `1/2`. * - `"very-poor"`: equivalent to `1/2`. * - `"low"`: equivalent to `1/sqrt(2)`. * - `"small"`: equivalent to `1/sqrt(2)`. * - `"poor"`: equivalent to `1/sqrt(2)`. * - `"normal"`: equivalent to `1`. * - `"medium"`: equivalent to `1`. * - `"regular"`: equivalent to `1`. * - `"high"`: equivalent to `sqrt(2)`. * - `"big"`: equivalent to `sqrt(2)`. * - `"good"`: equivalent to `sqrt(2)`. * - `"very-high"`: equivalent to `2`. * - `"very-big"`: equivalent to `2`. * - `"very-good"`: equivalent to `2`. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MapGenSize.html Online documentation} */ export type MapGenSize = | float | "none" | "very-low" | "very-small" | "very-poor" | "low" | "small" | "poor" | "normal" | "medium" | "regular" | "high" | "big" | "good" | "very-high" | "very-big" | "very-good" /** * @see AutoplaceControlWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AutoplaceControl.html Online documentation} */ export interface AutoplaceControl { /** * For things that are placed as spots such as ores and enemy bases, frequency is generally proportional to number of spots placed per unit area. For continuous features such as forests, frequency is how compressed the probability function is over distance, i.e. the inverse of 'scale'. When the {@link LuaAutoplaceControlPrototype} is of the category `"terrain"`, then scale is shown in the map generator GUI instead of frequency. */ readonly frequency: float /** * For things that are placed as spots, size is proportional to the area of each spot. For continuous features, size affects how much of the map is covered with the thing, and is called 'coverage' in the GUI. */ readonly size: float /** * Has different effects for different things, but generally affects the 'health' or density of a thing that is placed without affecting where it is placed. For trees, richness affects tree health. For ores, richness multiplies the amount of ore at any given tile in a patch. Metadata about autoplace controls (such as whether or not 'richness' does anything for them) can be found in the {@link LuaAutoplaceControlPrototype} by looking up `prototypes.autoplace_control[(control prototype name)]`, e.g. `prototypes.autoplace_control["enemy-base"].richness` is false, because enemy base autoplacement doesn't use richness. */ readonly richness: float } /** * Write form of {@link AutoplaceControl}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AutoplaceControl.html Online documentation} */ export interface AutoplaceControlWrite { /** * For things that are placed as spots such as ores and enemy bases, frequency is generally proportional to number of spots placed per unit area. For continuous features such as forests, frequency is how compressed the probability function is over distance, i.e. the inverse of 'scale'. When the {@link LuaAutoplaceControlPrototype} is of the category `"terrain"`, then scale is shown in the map generator GUI instead of frequency. */ readonly frequency: MapGenSize /** * For things that are placed as spots, size is proportional to the area of each spot. For continuous features, size affects how much of the map is covered with the thing, and is called 'coverage' in the GUI. */ readonly size: MapGenSize /** * Has different effects for different things, but generally affects the 'health' or density of a thing that is placed without affecting where it is placed. For trees, richness affects tree health. For ores, richness multiplies the amount of ore at any given tile in a patch. Metadata about autoplace controls (such as whether or not 'richness' does anything for them) can be found in the {@link LuaAutoplaceControlPrototype} by looking up `prototypes.autoplace_control[(control prototype name)]`, e.g. `prototypes.autoplace_control["enemy-base"].richness` is false, because enemy base autoplacement doesn't use richness. */ readonly richness: MapGenSize } /** * All other MapGenSettings feed into named noise expressions, and therefore placement can be overridden by including the name of a property in this dictionary. The probability and richness functions for placing specific tiles, entities, and decoratives can be overridden by including an entry named `{tile|entity|decorative}:(prototype name):{probability|richness}`. * * {@link https://lua-api.factorio.com/2.0.45/concepts/PropertyExpressionNames.html > Values either name a NamedNoiseExpression or can be literal numbers, stored as strings (e.g. `5`). All other controls can be overridden by a property expression names. Notable properties:} * * {@link https://lua-api.factorio.com/2.0.45/concepts/PropertyExpressionNames.html > Climate controls ('Moisture' and 'Terrain type' at the bottom of the Terrain tab in the map generator GUI) don't have their own dedicated structures in MapGenSettings. Instead, their values are stored as property expression overrides with long names:} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PropertyExpressionNames.html Online documentation} */ export type PropertyExpressionNames = Record export interface AdvancedMapGenSettings { readonly pollution: PollutionMapSettings readonly enemy_evolution: EnemyEvolutionMapSettings readonly enemy_expansion: EnemyExpansionMapSettings readonly difficulty_settings: DifficultySettings } export interface MapGenPreset { /** * The string used to alphabetically sort the presets. It is a simple string that has no additional semantic meaning. */ readonly order: string /** * Whether this is the preset that is selected by default. */ readonly default?: boolean readonly basic_settings?: MapGenSettings readonly advanced_settings?: AdvancedMapGenSettings } /** * An actual signal transmitted by the network. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Signal.html Online documentation} */ export interface Signal { /** * ID of the signal. */ readonly signal: SignalID /** * Value of the signal. */ readonly count: int } /** * A single filter used by an infinity-filters instance. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/InfinityInventoryFilter.html Online documentation} */ export interface InfinityInventoryFilter { /** * Name of the item. */ readonly name: string /** * The count of the filter. */ readonly count?: uint /** * Defaults to `"at-least"`. */ readonly mode?: "at-least" | "at-most" | "exactly" /** * The index of this filter in the filters list. Not required when writing a filter. */ readonly index: uint } /** * A single filter used by an infinity-pipe type entity. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/InfinityPipeFilter.html Online documentation} */ export interface InfinityPipeFilter { /** * Name of the fluid. */ readonly name: string /** * The fill percentage the pipe (for example `0.5` for 50%). Can't be negative. */ readonly percentage?: double /** * The temperature of the fluid. Defaults to the default/minimum temperature of the fluid. */ readonly temperature?: double /** * Defaults to `"at-least"`. */ readonly mode?: "at-least" | "at-most" | "exactly" | "add" | "remove" } export interface FluidBoxFilter { /** * Fluid prototype name of the filtered fluid. */ readonly name: string /** * The minimum temperature allowed into the fluidbox. */ readonly minimum_temperature: float /** * The maximum temperature allowed into the fluidbox. */ readonly maximum_temperature: float } export interface FluidBoxFilterSpec { /** * Fluid prototype name of the filtered fluid. */ readonly name: string /** * The minimum temperature allowed into the fluidbox. */ readonly minimum_temperature?: float /** * The maximum temperature allowed into the fluidbox. */ readonly maximum_temperature?: float /** * Force the filter to be set, regardless of current fluid content. */ readonly force?: boolean } /** * The settings used by a heat-interface type entity. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/HeatSetting.html Online documentation} */ export interface HeatSetting { /** * The target temperature. Defaults to the minimum temperature of the heat buffer. */ readonly temperature?: double /** * Defaults to `"at-least"`. */ readonly mode?: "at-least" | "at-most" | "exactly" | "add" | "remove" } export interface HeatConnection { readonly position: Vector readonly direction: defines.direction } /** * @see ArithmeticCombinatorParametersWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ArithmeticCombinatorParameters.html Online documentation} */ export interface ArithmeticCombinatorParameters { /** * First signal to use in an operation. If not specified, the second argument will be the value of `first_constant`. */ readonly first_signal?: SignalID /** * Second signal to use in an operation. If not specified, the second argument will be the value of `second_constant`. */ readonly second_signal?: SignalID /** * Constant to use as the first argument of the operation. Has no effect when `first_signal` is set. Defaults to `0`. */ readonly first_constant?: int /** * Constant to use as the second argument of the operation. Has no effect when `second_signal` is set. Defaults to `0`. */ readonly second_constant?: int /** * When not specified, defaults to `"*"`. */ readonly operation?: "*" | "/" | "+" | "-" | "%" | "^" | "<<" | ">>" | "AND" | "OR" | "XOR" /** * Specifies the signal to output. */ readonly output_signal?: SignalID } /** * Write form of {@link ArithmeticCombinatorParameters}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ArithmeticCombinatorParameters.html Online documentation} */ export interface ArithmeticCombinatorParametersWrite { /** * First signal to use in an operation. If not specified, the second argument will be the value of `first_constant`. */ readonly first_signal?: SignalIDWrite /** * Second signal to use in an operation. If not specified, the second argument will be the value of `second_constant`. */ readonly second_signal?: SignalIDWrite /** * Constant to use as the first argument of the operation. Has no effect when `first_signal` is set. Defaults to `0`. */ readonly first_constant?: int /** * Constant to use as the second argument of the operation. Has no effect when `second_signal` is set. Defaults to `0`. */ readonly second_constant?: int /** * When not specified, defaults to `"*"`. */ readonly operation?: "*" | "/" | "+" | "-" | "%" | "^" | "<<" | ">>" | "AND" | "OR" | "XOR" /** * Specifies the signal to output. */ readonly output_signal?: SignalIDWrite } /** * @see SelectorCombinatorParametersWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SelectorCombinatorParameters.html Online documentation} */ export interface SelectorCombinatorParameters { /** * The signal to use. */ readonly index_signal: SignalID /** * The signal index to use if not using a specific signal. */ readonly index_constant: uint /** * The signal to emit. */ readonly count_signal: SignalID /** * Must be one of `"select"`, `"count"`, `"random"`. When not specified, defaults to `"select"`. */ readonly operation?: "select" | "count" | "random" /** * If the maximum value is used. */ readonly select_max: boolean } /** * Write form of {@link SelectorCombinatorParameters}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SelectorCombinatorParameters.html Online documentation} */ export interface SelectorCombinatorParametersWrite { /** * The signal to use. */ readonly index_signal: SignalIDWrite /** * The signal index to use if not using a specific signal. */ readonly index_constant: uint /** * The signal to emit. */ readonly count_signal: SignalIDWrite /** * Must be one of `"select"`, `"count"`, `"random"`. When not specified, defaults to `"select"`. */ readonly operation?: "select" | "count" | "random" /** * If the maximum value is used. */ readonly select_max: boolean } export interface DeciderCombinatorParameters { /** * List of conditions. */ readonly conditions: DeciderCombinatorCondition[] /** * List of outputs. */ readonly outputs: DeciderCombinatorOutput[] } export type DeciderCombinatorCondition = table export type DeciderCombinatorOutput = table export interface InserterCircuitConditions { readonly circuit?: CircuitConditionWrite readonly logistics?: CircuitConditionWrite } /** * @see CircuitConditionWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CircuitCondition.html Online documentation} */ export interface CircuitCondition { /** * Specifies how the inputs should be compared. If not specified, defaults to `"<"`. */ readonly comparator?: ComparatorStringRead /** * Defaults to blank */ readonly first_signal?: SignalID /** * What to compare `first_signal` to. If not specified, `first_signal` will be compared to `constant`. */ readonly second_signal?: SignalID /** * Constant to compare `first_signal` to. Has no effect when `second_signal` is set. When neither `second_signal` nor `constant` are specified, the effect is as though `constant` were specified with the value `0`. */ readonly constant?: int } /** * Write form of {@link CircuitCondition}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CircuitCondition.html Online documentation} */ export interface CircuitConditionWrite { /** * Specifies how the inputs should be compared. If not specified, defaults to `"<"`. */ readonly comparator?: ComparatorString /** * Defaults to blank */ readonly first_signal?: SignalIDWrite /** * What to compare `first_signal` to. If not specified, `first_signal` will be compared to `constant`. */ readonly second_signal?: SignalIDWrite /** * Constant to compare `first_signal` to. Has no effect when `second_signal` is set. When neither `second_signal` nor `constant` are specified, the effect is as though `constant` were specified with the value `0`. */ readonly constant?: int } /** * @see CircuitConditionDefinitionWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CircuitConditionDefinition.html Online documentation} */ export interface CircuitConditionDefinition { /** * TODOC CircuitConditionDefinition now extends CircuitCondition, all fields of CircuitCondition should be pasted here directly */ readonly condition: CircuitCondition /** * Whether the condition is currently fulfilled */ readonly fulfilled?: boolean } /** * Write form of {@link CircuitConditionDefinition}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/CircuitConditionDefinition.html Online documentation} */ export interface CircuitConditionDefinitionWrite { /** * TODOC CircuitConditionDefinition now extends CircuitCondition, all fields of CircuitCondition should be pasted here directly */ readonly condition: CircuitConditionWrite /** * Whether the condition is currently fulfilled */ readonly fulfilled?: boolean } export interface DragTarget { readonly target_entity: LuaEntity /** * Identifier of the wire connector from which the wire is being dragged. */ readonly wire_connector_id: defines.wire_connector_id } export interface InventoryFilter { /** * Position of the corresponding filter slot. */ readonly index: uint /** * Item prototype name of the item to filter. */ readonly name: string } export interface PlaceAsTileResult { /** * The tile prototype. */ readonly result: LuaTilePrototype readonly condition_size: uint readonly condition: CollisionMask } export interface BaseCommand { /** * Type of command. The remaining fields depend on the value of this field. */ readonly type: defines.command } /** * {@link defines.command.attack} variant of {@link Command}. */ export interface AttackCommand extends BaseCommand { readonly type: defines.command.attack readonly target: LuaEntity /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction } /** * {@link defines.command.go_to_location} variant of {@link Command}. */ export interface GoToLocationCommand extends BaseCommand { readonly type: defines.command.go_to_location /** * The position to path to. Either this or `destination_entity` need to be specified. If both are, `destination_entity` is used. */ readonly destination?: MapPosition /** * The entity to path to. Either this or `destination` need to be specified. If both are, `destination_entity` is used. */ readonly destination_entity?: LuaEntity /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction /** * Flags that affect pathfinder behavior. */ readonly pathfind_flags?: PathfinderFlags /** * How close the pathfinder needs to get to its destination (in tiles). Defaults to `3`. */ readonly radius?: double } export interface GoToLocationCommandWrite extends BaseCommand { readonly type: defines.command.go_to_location /** * The position to path to. Either this or `destination_entity` need to be specified. If both are, `destination_entity` is used. */ readonly destination?: MapPosition | MapPositionArray /** * The entity to path to. Either this or `destination` need to be specified. If both are, `destination_entity` is used. */ readonly destination_entity?: LuaEntity /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction /** * Flags that affect pathfinder behavior. */ readonly pathfind_flags?: PathfinderFlags /** * How close the pathfinder needs to get to its destination (in tiles). Defaults to `3`. */ readonly radius?: double } /** * {@link defines.command.compound} variant of {@link Command}. */ export interface CompoundCommand extends BaseCommand { readonly type: defines.command.compound /** * How the commands should be chained together. */ readonly structure_type: defines.compound_command /** * The sub-commands. */ readonly commands: Command[] } export interface CompoundCommandWrite extends BaseCommand { readonly type: defines.command.compound /** * How the commands should be chained together. */ readonly structure_type: defines.compound_command /** * The sub-commands. */ readonly commands: readonly CommandWrite[] } /** * {@link defines.command.group} variant of {@link Command}. */ export interface GroupCommand extends BaseCommand { readonly type: defines.command.group /** * The group whose command to follow. */ readonly group: LuaCommandable /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction /** * Whether the unit will use the group distraction or the commands distraction. Defaults to true. */ readonly use_group_distraction?: boolean } /** * {@link defines.command.attack_area} variant of {@link Command}. */ export interface AttackAreaCommand extends BaseCommand { readonly type: defines.command.attack_area /** * Center of the attack area. */ readonly destination: MapPosition /** * Radius of the attack area. */ readonly radius: double /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction } export interface AttackAreaCommandWrite extends BaseCommand { readonly type: defines.command.attack_area /** * Center of the attack area. */ readonly destination: MapPosition | MapPositionArray /** * Radius of the attack area. */ readonly radius: double /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction } /** * {@link defines.command.wander} variant of {@link Command}. */ export interface WanderCommand extends BaseCommand { readonly type: defines.command.wander /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction /** * Defaults to 10. Does not apply when `wander_in_group` is `true`. */ readonly radius?: double /** * When commanding a group, defines how the group will wander. When `true`, the units in the group will wander around inside the group's radius, just like gathering biters. When `false`, the units will wander as a group, ie they will all walk together in the same random direction. Default is true for groups. Passing true for a single unit is an error. */ readonly wander_in_group?: boolean /** * Ticks to wander before successfully completing the command. Default is max uint, which means wander forever. */ readonly ticks_to_wait?: uint } /** * {@link defines.command.stop} variant of {@link Command}. */ export interface StopCommand extends BaseCommand { readonly type: defines.command.stop /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction /** * Ticks to wander before successfully completing the command. Default is max uint, which means stop forever. */ readonly ticks_to_wait?: uint } /** * {@link defines.command.flee} variant of {@link Command}. */ export interface FleeCommand extends BaseCommand { readonly type: defines.command.flee /** * The entity to flee from */ readonly from: LuaEntity /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction } /** * {@link defines.command.build_base} variant of {@link Command}. */ export interface BuildBaseCommand extends BaseCommand { readonly type: defines.command.build_base /** * Where to build the base. */ readonly destination: MapPosition /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction /** * Whether the units should ignore expansion candidate chunks. When `false`, they will obey and not build a base in a non-candidate chunk. Defaults to `false`. */ readonly ignore_planner?: boolean } export interface BuildBaseCommandWrite extends BaseCommand { readonly type: defines.command.build_base /** * Where to build the base. */ readonly destination: MapPosition | MapPositionArray /** * Defaults to `defines.distraction.by_enemy`. */ readonly distraction?: defines.distraction /** * Whether the units should ignore expansion candidate chunks. When `false`, they will obey and not build a base in a non-candidate chunk. Defaults to `false`. */ readonly ignore_planner?: boolean } /** * Commands can be given to enemies and unit groups. * * Other attributes may be specified depending on `type`: * - {@link defines.command.attack}: {@link AttackCommand} * - {@link defines.command.go_to_location}: {@link GoToLocationCommand} * - {@link defines.command.compound}: {@link CompoundCommand} * - {@link defines.command.group}: {@link GroupCommand} * - {@link defines.command.attack_area}: {@link AttackAreaCommand} * - {@link defines.command.wander}: {@link WanderCommand} * - {@link defines.command.stop}: {@link StopCommand} * - {@link defines.command.flee}: {@link FleeCommand} * - {@link defines.command.build_base}: {@link BuildBaseCommand} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Command.html Online documentation} */ export type Command = | AttackCommand | GoToLocationCommand | CompoundCommand | GroupCommand | AttackAreaCommand | WanderCommand | StopCommand | FleeCommand | BuildBaseCommand /** * Write form of {@link Command}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Command.html Online documentation} */ export type CommandWrite = | AttackCommand | GoToLocationCommandWrite | CompoundCommandWrite | GroupCommand | AttackAreaCommandWrite | WanderCommand | StopCommand | FleeCommand | BuildBaseCommandWrite export interface PathfinderFlags { /** * Allows pathing through friendly entities. Defaults to `false`. */ readonly allow_destroy_friendly_entities?: boolean /** * Allows the pathfinder to path through entities of the same force. Defaults to `false`. */ readonly allow_paths_through_own_entities?: boolean /** * Enables path caching. This can be more efficient, but might fail to respond to changes in the environment. Defaults to `true`. */ readonly cache?: boolean /** * Makes the pathfinder try to path in straight lines. Defaults to `false`. */ readonly prefer_straight_paths?: boolean /** * Sets lower priority on the path request, meaning it might take longer to find a path at the expense of speeding up others. Defaults to `false`. */ readonly low_priority?: boolean /** * Makes the pathfinder not break in the middle of processing this pathfind, no matter how much work is needed. Defaults to `false`. */ readonly no_break?: boolean } export interface UnitSpawnDefinition { /** * Prototype name of the unit that would be spawned. */ readonly unit: string /** * The points at which to spawn the unit. */ readonly spawn_points: SpawnPointDefinition[] } export interface SpawnPointDefinition { /** * Evolution factor for which this weight applies. */ readonly evolution_factor: double /** * Probability of spawning this unit at this evolution factor. */ readonly weight: double } export interface SpoilToTriggerResult { /** * The trigger runs (count-in-stack / items_per_trigger) times; rounded up. */ readonly items_per_trigger: uint /** * The trigger items that are run. */ readonly trigger: TriggerItem[] } /** * An item stack may be specified in one of two ways. * * ## Union members * - `string`: The name of the item, which represents a full stack of that item. * - {@link ItemStackDefinition}: The detailed definition of an item stack. * @example * -- Both of these lines specify an item stack of one iron plate * {name="iron-plate"} * {name="iron-plate", count=1} * @example * -- This is a stack of 47 copper plates * {name="copper-plate", count=47} * @example * These are both full stacks of iron plates (for iron-plate, a full stack is 100 plates) * "iron-plate" * {name="iron-plate", count=100} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SimpleItemStack.html Online documentation} */ export type SimpleItemStack = string | ItemStackDefinition /** * A surface may be specified in one of three ways. * * ## Union members * - SurfaceIndex: It will be the index of the surface. `nauvis` has index `1`, the first surface-created surface will have index `2` and so on. * - `string`: It will be the surface name. E.g. `"nauvis"`. * - {@link LuaSurface}: A reference to {@link LuaSurface} may be passed directly. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SurfaceIdentification.html Online documentation} */ export type SurfaceIdentification = SurfaceIndex | string | LuaSurface /** * A player may be specified in one of three ways. * * ## Union members * - PlayerIndex: The player index. * - `string`: The player name. * - {@link LuaPlayer}: A reference to {@link LuaPlayer} may be passed directly. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/PlayerIdentification.html Online documentation} */ export type PlayerIdentification = PlayerIndex | string | LuaPlayer /** * An item may be specified in one of two ways. * * ## Union members * - {@link SimpleItemStack} * - {@link LuaItemStack} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemStackIdentification.html Online documentation} */ export type ItemStackIdentification = SimpleItemStack | LuaItemStack /** * Target type of an {@link AmmoType}. * * ## Union members * - `"entity"`: Fires at an entity. * - `"position"`: Fires directly at a position. * - `"direction"`: Fires in a direction. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TargetType.html Online documentation} */ export type TargetType = "entity" | "position" | "direction" export interface BeamTarget { /** * The target entity. */ readonly entity?: LuaEntity /** * The target position. */ readonly position?: MapPosition } export interface RidingState { readonly acceleration: defines.riding.acceleration readonly direction: defines.riding.direction } export type SoundCategory = | "utility" | "ambient" | "tile-walking" | "tile-mined" | "tile-build-small" | "tile-build-medium" | "tile-build-large" | "entity-build" | "entity-mined" | "entity-mining" | "entity-vehicle_impact" | "entity-rotated" | "entity-open" | "entity-close" /** * It can be either the name of a {@link import("factorio:prototype").SoundPrototype SoundPrototype} defined in the data stage, or a path in the form `"type/name"`. The latter option can be sorted into three categories. * * The validity of a SoundPath can be verified at runtime using {@link LuaHelpers#is_valid_sound_path LuaHelpers::is_valid_sound_path}. * * {@link https://lua-api.factorio.com/2.0.45/concepts/SoundPath.html > The utility and ambient types each contain general use sound prototypes defined by the game itself.} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SoundPath.html Online documentation} */ export type SoundPath = (string & { _?: never }) | `${SoundCategory}/${string}` export interface CircularParticleCreationSpecification { /** * Name of the {@link LuaEntityPrototype}. */ readonly name: string readonly direction: float readonly direction_deviation: float readonly speed: float readonly speed_deviation: float readonly starting_frame_speed: float readonly starting_frame_speed_deviation: float readonly height: float readonly height_deviation: float readonly vertical_speed: float readonly vertical_speed_deviation: float readonly center: Vector readonly creation_distance: double readonly creation_distance_orientation: double readonly use_source_position: boolean } export type CircularProjectileCreationSpecification = readonly [RealOrientation, Vector] export interface AttackParameterFluid { /** * Name of the {@link LuaFluidPrototype}. */ readonly type: string /** * Multiplier applied to the damage of an attack. */ readonly damage_modifier: double } /** * Common attributes to all variants of {@link AttackParameters}. */ export interface BaseAttackParameters { /** * The type of AttackParameter. */ readonly type: "projectile" | "stream" | "beam" /** * Maximum range of attack. */ readonly range: float /** * Minimum range of attack. Used with flamethrower turrets to prevent self-immolation. */ readonly min_range: float /** * Defines how the range is determined. */ readonly range_mode: RangeMode /** * When searching for the nearest enemy to attack, `fire_penalty` is added to the enemy's distance if they are on fire. */ readonly fire_penalty: float /** * When searching for an enemy to attack, a higher `rotate_penalty` will discourage targeting enemies that would take longer to turn to face. */ readonly rotate_penalty: float /** * When searching for an enemy to attack, a higher `health_penalty` will discourage targeting enemies with high health. A negative penalty will do the opposite. */ readonly health_penalty: float /** * If less than `range`, the entity will choose a random distance between `range` and `min_attack_distance` and attack from that distance. Used for spitters. */ readonly min_attack_distance: float /** * The arc that the entity can attack in as a fraction of a circle. A value of `1` means the full 360 degrees. */ readonly turn_range: float /** * Multiplier applied to the damage of an attack. */ readonly damage_modifier: float /** * Multiplier applied to the ammo consumption of an attack. */ readonly ammo_consumption_modifier: float /** * Minimum amount of ticks between shots. If this is less than `1`, multiple shots can be performed per tick. */ readonly cooldown: float /** * Number of ticks it takes for the weapon to actually shoot after it has been ordered to do so. */ readonly warmup: uint readonly movement_slow_down_factor: double readonly movement_slow_down_cooldown: float readonly ammo_type?: AmmoType /** * List of the names of compatible {@link LuaAmmoCategoryPrototype LuaAmmoCategoryPrototypes}. */ readonly ammo_categories?: string[] } /** * `"projectile"` variant of {@link AttackParameters}. */ export interface ProjectileAttackParameters extends BaseAttackParameters { readonly type: "projectile" readonly projectile_center: Vector readonly projectile_creation_distance: float readonly projectile_orientation_offset: float readonly shell_particle?: CircularParticleCreationSpecification readonly projectile_creation_parameters?: CircularProjectileCreationSpecification[] } /** * `"stream"` variant of {@link AttackParameters}. */ export interface StreamAttackParameters extends BaseAttackParameters { readonly type: "stream" readonly gun_barrel_length: float readonly gun_center_shift: GunShift4Way readonly fluid_consumption: float readonly fluids?: AttackParameterFluid[] readonly projectile_creation_parameters?: CircularProjectileCreationSpecification[] } /** * Variants of {@link AttackParameters} with no additional attributes. */ export interface OtherAttackParameters extends BaseAttackParameters { readonly type: "beam" } /** * Base attributes: {@link BaseAttackParameters} * * Other attributes may be specified depending on `type`: * - `"projectile"`: {@link ProjectileAttackParameters} * - `"stream"`: {@link StreamAttackParameters} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AttackParameters.html Online documentation} */ export type AttackParameters = ProjectileAttackParameters | StreamAttackParameters | OtherAttackParameters export interface GunShift4Way { readonly north: Vector readonly east: Vector readonly south: Vector readonly west: Vector } export interface BaseCapsuleAction { readonly type: "throw" | "equipment-remote" | "use-on-self" | "artillery-remote" | "destroy-cliffs" } /** * `"throw"` variant of {@link CapsuleAction}. */ export 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}. */ export interface EquipmentRemoteCapsuleAction extends BaseCapsuleAction { readonly type: "equipment-remote" /** * Name of the {@link LuaEquipmentPrototype}. */ readonly equipment: string } /** * `"use-on-self"` variant of {@link CapsuleAction}. */ export interface UseOnSelfCapsuleAction extends BaseCapsuleAction { readonly type: "use-on-self" readonly attack_parameters: AttackParameters } /** * `"artillery-remote"` variant of {@link CapsuleAction}. */ export interface ArtilleryRemoteCapsuleAction extends BaseCapsuleAction { readonly type: "artillery-remote" /** * Name of the {@link LuaEntityPrototype flare prototype}. */ readonly flare: string } /** * `"destroy-cliffs"` variant of {@link CapsuleAction}. */ export interface DestroyCliffsCapsuleAction extends BaseCapsuleAction { readonly type: "destroy-cliffs" readonly attack_parameters: AttackParameters readonly radius: float readonly timeout: uint } /** * 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/2.0.45/concepts/CapsuleAction.html Online documentation} */ export type CapsuleAction = | ThrowCapsuleAction | EquipmentRemoteCapsuleAction | UseOnSelfCapsuleAction | ArtilleryRemoteCapsuleAction | DestroyCliffsCapsuleAction export interface LogisticsNetworkSupplyCounts { /** * Number of available items in the storage members. */ readonly storage: uint /** * Number of available items in the passive provider members. */ readonly "passive-provider": uint /** * Number of available items in the buffer members. */ readonly buffer: uint /** * Number of available items in the active provider members. */ readonly "active-provider": uint } export interface LogisticsNetworkSupplyPoints { readonly storage: LuaLogisticPoint[] readonly "passive-provider": LuaLogisticPoint[] readonly buffer: LuaLogisticPoint[] readonly "active-provider": LuaLogisticPoint[] } export interface ModSetting { /** * The value of the mod setting. The type depends on the kind of setting. */ readonly value: int | double | boolean | string | Color | ColorArray } /** * Any basic type (string, number, boolean) or table. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AnyBasic.html Online documentation} */ export type AnyBasic = string | boolean | number | table /** * Any basic type (string, number, boolean), table, or LuaObject. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Any.html Online documentation} */ export type Any = string | boolean | number | table | LuaObject export interface ProgrammableSpeakerParameters { readonly playback_volume: float readonly playback_mode: ProgrammableSpeakerPlaybackMode readonly allow_polyphony: boolean } /** * @see ProgrammableSpeakerAlertParametersWrite * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ProgrammableSpeakerAlertParameters.html Online documentation} */ export interface ProgrammableSpeakerAlertParameters { readonly show_alert: boolean readonly show_on_map: boolean readonly icon_signal_id: SignalID readonly alert_message: string } /** * Write form of {@link ProgrammableSpeakerAlertParameters}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ProgrammableSpeakerAlertParameters.html Online documentation} */ export interface ProgrammableSpeakerAlertParametersWrite { readonly show_alert: boolean readonly show_on_map: boolean readonly icon_signal_id: SignalIDWrite readonly alert_message: string } export interface ProgrammableSpeakerCircuitParameters { readonly signal_value_is_pitch: boolean readonly instrument_id: uint readonly note_id: uint } export interface ProgrammableSpeakerInstrument { readonly name: string readonly notes: string[] } /** * A `string` that specifies where a GUI element should be. * * ## Union members * - `"top-left"` * - `"middle-left"` * - `"left"`: The same as `"middle-left"` * - `"bottom-left"` * - `"top-center"` * - `"middle-center"` * - `"center"`: The same as `"middle-center"` * - `"bottom-center"` * - `"top-right"` * - `"right"`: The same as `"middle-right"` * - `"bottom-right"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/Alignment.html Online documentation} */ export type Alignment = | "top-left" | "middle-left" | "left" | "bottom-left" | "top-center" | "middle-center" | "center" | "bottom-center" | "top-right" | "right" | "bottom-right" export type RaiseableEvents = | typeof defines.events.on_console_chat | typeof defines.events.on_player_crafted_item | typeof defines.events.on_player_fast_transferred | typeof defines.events.on_biter_base_built | typeof defines.events.on_market_item_purchased | typeof defines.events.script_raised_built | typeof defines.events.script_raised_destroy | typeof defines.events.script_raised_revive | typeof defines.events.script_raised_teleported | typeof defines.events.script_raised_set_tiles export type EventId = uint & { readonly _eventData: T & EventData readonly _filter: F } export type CustomEventId = EventId & { _customEventIdBrand: any } /** * Information about the event that has been raised. The table can also contain other fields depending on the type of event. See {@linkplain https://lua-api.factorio.com/2.0.45/events.html the list of Factorio events} for more information on these. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EventData.html Online documentation} */ export interface EventData { /** * The identifier of the event this handler was registered to. */ readonly name: EventId | string /** * The tick during which the event happened. */ readonly tick: uint /** * The name of the mod that raised the event if it was raised using {@link LuaBootstrap#raise_event LuaBootstrap::raise_event}. */ readonly mod_name?: string } export interface NthTickEventData { /** * The tick during which the event happened. */ readonly tick: uint /** * The nth tick this handler was registered to. */ readonly nth_tick: uint } export interface ModChangeData { /** * Old version of the mod. May be `nil` if the mod wasn't previously present (i.e. it was just added). */ readonly old_version: VersionString | nil /** * New version of the mod. May be `nil` if the mod is no longer present (i.e. it was just removed). */ readonly new_version: VersionString | nil } export interface ConfigurationChangedData { /** * Old version of the map. Present only when loading map version other than the current version. */ readonly old_version?: VersionString /** * New version of the map. Present only when loading map version other than the current version. */ readonly new_version?: VersionString /** * Dictionary of mod changes. It is indexed by mod name. */ readonly mod_changes: Record /** * `true` when mod startup settings have changed since the last time this save was loaded. */ readonly mod_startup_settings_changed: boolean /** * `true` when mod prototype migrations have been applied since the last time this save was loaded. */ readonly migration_applied: boolean } export interface CustomCommandData { /** * The name of the command. */ readonly name: string /** * The tick the command was used in. */ readonly tick: uint /** * The player who issued the command, or `nil` if it was issued from the server console. */ readonly player_index?: PlayerIndex /** * The parameter passed after the command, if there is one. */ readonly parameter?: string } export interface SelectedPrototypeData { /** * E.g. `"entity"`. */ readonly base_type: string /** * The `type` of the prototype. E.g. `"tree"`. */ readonly derived_type: string /** * The `name` of the prototype. E.g. `"tree-05"`. */ readonly name: string /** * The `name` of the quality prototype if any. E.g. `"normal"`. */ readonly quality?: string } /** * 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`. * * ## Union members * - `"left"` * - `"right"` * - `"middle"` * - `"button-4"` * - `"button-5"` * - `"button-6"` * - `"button-7"` * - `"button-8"` * - `"button-9"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/MouseButtonFlags.html Online documentation} */ export interface MouseButtonFlags { readonly left?: true readonly right?: true readonly middle?: true readonly "button-4"?: true readonly "button-5"?: true readonly "button-6"?: true readonly "button-7"?: true readonly "button-8"?: true readonly "button-9"?: true } export type MouseButtonFlagsWrite = MouseButtonFlags | ReadonlyArray /** * ## Union members * - `"all"`: All forces pass. * - `"enemy"`: Forces which will attack pass. * - `"ally"`: Forces which won't attack pass. * - `"friend"`: Forces which are friends pass. * - `"not-friend"`: Forces which are not friends pass. * - `"same"`: The same force pass. * - `"not-same"`: The non-same forces pass. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ForceCondition.html Online documentation} */ export type ForceCondition = "all" | "enemy" | "ally" | "friend" | "not-friend" | "same" | "not-same" export interface ItemStackLocation { readonly inventory: defines.inventory readonly slot: uint } export interface VehicleAutomaticTargetingParameters { readonly auto_target_without_gunner: boolean readonly auto_target_with_gunner: boolean } /** * ## Union members * - `"button"`: A clickable element. Relevant event: {@link OnGuiClickEvent on_gui_click} * - `"sprite-button"`: A `button` that displays a sprite rather than text. Relevant event: {@link OnGuiClickEvent on_gui_click} * - `"checkbox"`: A clickable element with a check mark that can be turned off or on. Relevant event: {@link OnGuiCheckedStateChangedEvent on_gui_checked_state_changed} * - `"flow"`: An invisible container that lays out its children either horizontally or vertically. * - `"frame"`: A non-transparent box that contains other elements. It can have a title (set via the `caption` attribute). Just like a `flow`, it lays out its children either horizontally or vertically. Relevant event: {@link OnGuiLocationChangedEvent on_gui_location_changed} * - `"label"`: A piece of text. * - `"line"`: A horizontal or vertical separation line. * - `"progressbar"`: A partially filled bar that can be used to indicate progress. * - `"table"`: An invisible container that lays out its children in a specific number of columns. The width of each column is determined by the widest element it contains. * - `"textfield"`: A single-line box the user can type into. Relevant events: {@link OnGuiTextChangedEvent on_gui_text_changed}, {@link OnGuiConfirmedEvent on_gui_confirmed} * - `"radiobutton"`: An element that is similar to a `checkbox`, but with a circular appearance. Clicking a selected radio button will not unselect it. Radio buttons are not linked to each other in any way. Relevant event: {@link OnGuiCheckedStateChangedEvent on_gui_checked_state_changed} * - `"sprite"`: An element that shows an image. * - `"scroll-pane"`: An invisible element that is similar to a `flow`, but has the ability to show and use scroll bars. * - `"drop-down"`: A drop-down containing strings of text. Relevant event: {@link OnGuiSelectionStateChangedEvent on_gui_selection_state_changed} * - `"list-box"`: A list of strings, only one of which can be selected at a time. Shows a scroll bar if necessary. Relevant event: {@link OnGuiSelectionStateChangedEvent on_gui_selection_state_changed} * - `"camera"`: A camera that shows the game at the given position on the given surface. It can visually track an {@link LuaGuiElement#entity entity} that is set after the element has been created. * - `"choose-elem-button"`: A button that lets the player pick from a certain kind of prototype, with optional filtering. Relevant event: {@link OnGuiElemChangedEvent on_gui_elem_changed} * - `"text-box"`: A multi-line `textfield`. Relevant event: {@link OnGuiTextChangedEvent on_gui_text_changed} * - `"slider"`: A horizontal number line which can be used to choose a number. Relevant event: {@link OnGuiValueChangedEvent on_gui_value_changed} * - `"minimap"`: A minimap preview, similar to the normal player minimap. It can visually track an {@link LuaGuiElement#entity entity} that is set after the element has been created. * - `"entity-preview"`: A preview of an entity. The {@link LuaGuiElement#entity entity} has to be set after the element has been created. * - `"empty-widget"`: An empty element that just exists. The root GUI elements `screen` and `relative` are `empty-widget`s. * - `"tabbed-pane"`: A collection of `tab`s and their contents. Relevant event: {@link OnGuiSelectedTabChangedEvent on_gui_selected_tab_changed} * - `"tab"`: A tab for use in a `tabbed-pane`. * - `"switch"`: A switch with three possible states. Can have labels attached to either side. Relevant event: {@link OnGuiSwitchStateChangedEvent on_gui_switch_state_changed} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GuiElementType.html Online documentation} */ export type GuiElementType = | "button" | "sprite-button" | "checkbox" | "flow" | "frame" | "label" | "line" | "progressbar" | "table" | "textfield" | "radiobutton" | "sprite" | "scroll-pane" | "drop-down" | "list-box" | "camera" | "choose-elem-button" | "text-box" | "slider" | "minimap" | "entity-preview" | "empty-widget" | "tabbed-pane" | "tab" | "switch" /** * Used by {@link GuiArrowSpecification}. * * ## Union members * - `"nowhere"`: Will remove the arrow entirely. * - `"goal"`: Will point to the current goal. * - `"entity_info"` * - `"active_window"` * - `"entity"` * - `"position"` * - `"crafting_queue"` * - `"item_stack"`: Will point to a given item stack in an inventory. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GuiArrowType.html Online documentation} */ export type GuiArrowType = | "nowhere" | "goal" | "entity_info" | "active_window" | "entity" | "position" | "crafting_queue" | "item_stack" /** * Direction of a {@link LuaGuiElement#direction LuaGuiElement's} layout. * * ## Union members * - `"horizontal"` * - `"vertical"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/GuiDirection.html Online documentation} */ export type GuiDirection = "horizontal" | "vertical" /** * Scroll policy of a {@link LuaGuiElement scroll pane}. * * ## Union members * - `"never"` * - `"dont-show-but-allow-scrolling"` * - `"always"` * - `"auto"` * - `"auto-and-reserve-space"` * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ScrollPolicy.html Online documentation} */ export type ScrollPolicy = "never" | "dont-show-but-allow-scrolling" | "always" | "auto" | "auto-and-reserve-space" export interface RailLocation { readonly position: MapPosition readonly direction: defines.direction readonly rail_layer: defines.rail_layer } export interface WireConnection { readonly target: LuaWireConnector /** * Defaults to defines.wire_origin.player */ readonly origin?: defines.wire_origin } /** * A floating-point number. This is a single-precision floating point number. Whilst Lua only uses double-precision numbers, when a function takes a float, the game engine will immediately convert the double-precision number to single-precision. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/float.html Online documentation} */ export type float = number /** * A double-precision floating-point number. This is the same data type as all Lua numbers use. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/double.html Online documentation} */ export type double = number /** * 32-bit signed integer. Possible values are `-2 147 483 648` to `2 147 483 647`. * * Since Lua 5.2 only uses doubles, any API that asks for `int` will floor the given double. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/int.html Online documentation} */ export type int = number /** * 8-bit signed integer. Possible values are `-128` to `127`. * * Since Lua 5.2 only uses doubles, any API that asks for `int8` will floor the given double. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/int8.html Online documentation} */ export type int8 = number /** * 32-bit unsigned integer. Possible values are `0` to `4 294 967 295`. * * Since Lua 5.2 only uses doubles, any API that asks for `uint` will floor the given double. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/uint.html Online documentation} */ export type uint = number /** * 8-bit unsigned integer. Possible values are `0` to `255`. * * Since Lua 5.2 only uses doubles, any API that asks for `uint8` will floor the given double. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/uint8.html Online documentation} */ export type uint8 = number /** * 16-bit unsigned integer. Possible values are `0` to `65 535`. * * Since Lua 5.2 only uses doubles, any API that asks for `uint16` will floor the given double. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/uint16.html Online documentation} */ export type uint16 = number /** * 64-bit unsigned integer. Possible values are `0` to `18 446 744 073 709 551 615`. * * Since Lua 5.2 only uses doubles, any API that asks for `uint64` will floor the given double. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/uint64.html Online documentation} */ export type uint64 = number /** * Nil is the type of the value `nil`, whose main property is to be different from any other value. It usually represents the absence of a useful value. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/nil.html Online documentation} */ export type nil = undefined /** * Tables are enclosed in curly brackets, like this `{}`. * * Throughout the API docs, the terms "array" and "dictionary" are used. These are fundamentally just {@linkplain http://www.lua.org/pil/2.5.html Lua tables}, but have a limitation on which kind of table keys can be used. An array is a table that uses continuous integer keys starting at `1`, while a dictionary can use numeric or string keys in any order or combination. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/table.html Online documentation} */ export type table = object /** * Any LuaObject listed on the {@linkplain https://lua-api.factorio.com/2.0.45/classes.html Classes} page. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaObject.html Online documentation} */ export interface LuaObject { readonly object_name: string } /** * Common attributes to all variants of {@link ModSettingPrototypeFilter}. */ export interface BaseModSettingPrototypeFilter { /** * The condition to filter on. */ readonly filter: "type" | "mod" | "setting-type" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link ModSettingPrototypeFilter}. */ export interface TypeModSettingPrototypeFilter extends BaseModSettingPrototypeFilter { readonly filter: "type" /** * The prototype type, or a list of acceptable types. */ readonly type: string | string[] } /** * `"mod"` variant of {@link ModSettingPrototypeFilter}. */ export interface ModModSettingPrototypeFilter extends BaseModSettingPrototypeFilter { readonly filter: "mod" /** * The mod name */ readonly mod: string } /** * `"setting-type"` variant of {@link ModSettingPrototypeFilter}. */ export interface SettingTypeModSettingPrototypeFilter extends BaseModSettingPrototypeFilter { readonly filter: "setting-type" /** * The setting scope type. */ readonly type: "startup" | "runtime-global" | "runtime-per-user" } /** * Base attributes: {@link BaseModSettingPrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeModSettingPrototypeFilter} * - `"mod"`: {@link ModModSettingPrototypeFilter} * - `"setting-type"`: {@link SettingTypeModSettingPrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ModSettingPrototypeFilter.html Online documentation} */ export type ModSettingPrototypeFilter = | TypeModSettingPrototypeFilter | ModModSettingPrototypeFilter | SettingTypeModSettingPrototypeFilter /** * Common attributes to all variants of {@link SpaceLocationPrototypeFilter}. */ export interface BaseSpaceLocationPrototypeFilter { /** * The condition to filter on. */ readonly filter: "fly-condition" | "type" | "solar-power-in-space" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link SpaceLocationPrototypeFilter}. */ export interface TypeSpaceLocationPrototypeFilter extends BaseSpaceLocationPrototypeFilter { readonly filter: "type" /** * The prototype type, or a list of acceptable types. */ readonly type: string | string[] } /** * `"solar-power-in-space"` variant of {@link SpaceLocationPrototypeFilter}. */ export interface SolarPowerInSpaceSpaceLocationPrototypeFilter extends BaseSpaceLocationPrototypeFilter { readonly filter: "solar-power-in-space" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface SolarPowerInSpaceSpaceLocationPrototypeFilterWrite extends BaseSpaceLocationPrototypeFilter { readonly filter: "solar-power-in-space" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * Variants of {@link SpaceLocationPrototypeFilter} with no additional attributes. */ export interface OtherSpaceLocationPrototypeFilter extends BaseSpaceLocationPrototypeFilter { readonly filter: "fly-condition" } /** * Base attributes: {@link BaseSpaceLocationPrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeSpaceLocationPrototypeFilter} * - `"solar-power-in-space"`: {@link SolarPowerInSpaceSpaceLocationPrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SpaceLocationPrototypeFilter.html Online documentation} */ export type SpaceLocationPrototypeFilter = | TypeSpaceLocationPrototypeFilter | SolarPowerInSpaceSpaceLocationPrototypeFilter | OtherSpaceLocationPrototypeFilter /** * Write form of {@link SpaceLocationPrototypeFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/SpaceLocationPrototypeFilter.html Online documentation} */ export type SpaceLocationPrototypeFilterWrite = | TypeSpaceLocationPrototypeFilter | SolarPowerInSpaceSpaceLocationPrototypeFilterWrite | OtherSpaceLocationPrototypeFilter /** * Common attributes to all variants of {@link DecorativePrototypeFilter}. */ export interface BaseDecorativePrototypeFilter { /** * The condition to filter on. */ readonly filter: "decal" | "autoplace" | "collision-mask" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"collision-mask"` variant of {@link DecorativePrototypeFilter}. */ export interface CollisionMaskDecorativePrototypeFilter extends BaseDecorativePrototypeFilter { readonly filter: "collision-mask" /** * Name of one {@link LuaCollisionLayerPrototype layer} or a full collision mask. */ readonly mask: CollisionLayerID | CollisionMask /** * How to filter. */ readonly mask_mode: "collides" | "layers-equals" | "contains-any" | "contains-all" } /** * Variants of {@link DecorativePrototypeFilter} with no additional attributes. */ export interface OtherDecorativePrototypeFilter extends BaseDecorativePrototypeFilter { readonly filter: "decal" | "autoplace" } /** * Base attributes: {@link BaseDecorativePrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"collision-mask"`: {@link CollisionMaskDecorativePrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/DecorativePrototypeFilter.html Online documentation} */ export type DecorativePrototypeFilter = CollisionMaskDecorativePrototypeFilter | OtherDecorativePrototypeFilter /** * Common attributes to all variants of {@link TilePrototypeFilter}. */ export interface BaseTilePrototypeFilter { /** * The condition to filter on. */ readonly filter: | "minable" | "autoplace" | "blueprintable" | "item-to-place" | "collision-mask" | "walking-speed-modifier" | "vehicle-friction-modifier" | "decorative-removal-probability" | "absorptions-per-second" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"collision-mask"` variant of {@link TilePrototypeFilter}. */ export interface CollisionMaskTilePrototypeFilter extends BaseTilePrototypeFilter { readonly filter: "collision-mask" /** * Name of one {@link LuaCollisionLayerPrototype layer} or a full collision mask. */ readonly mask: CollisionLayerID | CollisionMask /** * How to filter. */ readonly mask_mode: "collides" | "layers-equals" | "contains-any" | "contains-all" } /** * `"walking-speed-modifier"` variant of {@link TilePrototypeFilter}. */ export interface WalkingSpeedModifierTilePrototypeFilter extends BaseTilePrototypeFilter { readonly filter: "walking-speed-modifier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface WalkingSpeedModifierTilePrototypeFilterWrite extends BaseTilePrototypeFilter { readonly filter: "walking-speed-modifier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"vehicle-friction-modifier"` variant of {@link TilePrototypeFilter}. */ export interface VehicleFrictionModifierTilePrototypeFilter extends BaseTilePrototypeFilter { readonly filter: "vehicle-friction-modifier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface VehicleFrictionModifierTilePrototypeFilterWrite extends BaseTilePrototypeFilter { readonly filter: "vehicle-friction-modifier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"decorative-removal-probability"` variant of {@link TilePrototypeFilter}. */ export interface DecorativeRemovalProbabilityTilePrototypeFilter extends BaseTilePrototypeFilter { readonly filter: "decorative-removal-probability" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: float } export interface DecorativeRemovalProbabilityTilePrototypeFilterWrite extends BaseTilePrototypeFilter { readonly filter: "decorative-removal-probability" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: float } /** * `"absorptions-per-second"` variant of {@link TilePrototypeFilter}. */ export interface AbsorptionsPerSecondTilePrototypeFilter extends BaseTilePrototypeFilter { readonly filter: "absorptions-per-second" /** * The name of a pollutant type to check. */ readonly pollutant: string readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface AbsorptionsPerSecondTilePrototypeFilterWrite extends BaseTilePrototypeFilter { readonly filter: "absorptions-per-second" /** * The name of a pollutant type to check. */ readonly pollutant: string readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * Variants of {@link TilePrototypeFilter} with no additional attributes. */ export interface OtherTilePrototypeFilter extends BaseTilePrototypeFilter { readonly filter: "minable" | "autoplace" | "blueprintable" | "item-to-place" } /** * Base attributes: {@link BaseTilePrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"collision-mask"`: {@link CollisionMaskTilePrototypeFilter} * - `"walking-speed-modifier"`: {@link WalkingSpeedModifierTilePrototypeFilter} * - `"vehicle-friction-modifier"`: {@link VehicleFrictionModifierTilePrototypeFilter} * - `"decorative-removal-probability"`: {@link DecorativeRemovalProbabilityTilePrototypeFilter} * - `"absorptions-per-second"`: {@link AbsorptionsPerSecondTilePrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TilePrototypeFilter.html Online documentation} */ export type TilePrototypeFilter = | CollisionMaskTilePrototypeFilter | WalkingSpeedModifierTilePrototypeFilter | VehicleFrictionModifierTilePrototypeFilter | DecorativeRemovalProbabilityTilePrototypeFilter | AbsorptionsPerSecondTilePrototypeFilter | OtherTilePrototypeFilter /** * Write form of {@link TilePrototypeFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TilePrototypeFilter.html Online documentation} */ export type TilePrototypeFilterWrite = | CollisionMaskTilePrototypeFilter | WalkingSpeedModifierTilePrototypeFilterWrite | VehicleFrictionModifierTilePrototypeFilterWrite | DecorativeRemovalProbabilityTilePrototypeFilterWrite | AbsorptionsPerSecondTilePrototypeFilterWrite | OtherTilePrototypeFilter export interface AsteroidChunkPrototypeFilter { /** * The condition to filter on. */ readonly filter: "minable" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * Common attributes to all variants of {@link ItemPrototypeFilter}. */ export interface BaseItemPrototypeFilter { /** * The condition to filter on. */ readonly filter: | "tool" | "mergeable" | "hidden" | "hidden-in-factoriopedia" | "is-parameter" | "item-with-inventory" | "selection-tool" | "item-with-label" | "has-rocket-launch-products" | "fuel" | "place-result" | "burnt-result" | "place-as-tile" | "placed-as-equipment-result" | "plant-result" | "spoil-result" | "name" | "type" | "flag" | "subgroup" | "fuel-category" | "stack-size" | "fuel-value" | "fuel-acceleration-multiplier" | "fuel-top-speed-multiplier" | "fuel-emissions-multiplier" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"place-result"` variant of {@link ItemPrototypeFilter}. */ export interface PlaceResultItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "place-result" /** * Filters for the place result. */ readonly elem_filters?: EntityPrototypeFilter[] } export interface PlaceResultItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "place-result" /** * Filters for the place result. */ readonly elem_filters?: readonly EntityPrototypeFilterWrite[] } /** * `"burnt-result"` variant of {@link ItemPrototypeFilter}. */ export interface BurntResultItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "burnt-result" /** * Filters for the burnt result. */ readonly elem_filters?: ItemPrototypeFilter[] } export interface BurntResultItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "burnt-result" /** * Filters for the burnt result. */ readonly elem_filters?: readonly ItemPrototypeFilterWrite[] } /** * `"place-as-tile"` variant of {@link ItemPrototypeFilter}. */ export interface PlaceAsTileItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "place-as-tile" /** * Filters for the placed tile. */ readonly elem_filters?: TilePrototypeFilter[] } export interface PlaceAsTileItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "place-as-tile" /** * Filters for the placed tile. */ readonly elem_filters?: readonly TilePrototypeFilterWrite[] } /** * `"placed-as-equipment-result"` variant of {@link ItemPrototypeFilter}. */ export interface PlacedAsEquipmentResultItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "placed-as-equipment-result" /** * Filters for the placed equipment. */ readonly elem_filters?: EquipmentPrototypeFilter[] } /** * `"plant-result"` variant of {@link ItemPrototypeFilter}. */ export interface PlantResultItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "plant-result" /** * Filters for the plant result. */ readonly elem_filters?: EntityPrototypeFilter[] } export interface PlantResultItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "plant-result" /** * Filters for the plant result. */ readonly elem_filters?: readonly EntityPrototypeFilterWrite[] } /** * `"spoil-result"` variant of {@link ItemPrototypeFilter}. */ export interface SpoilResultItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "spoil-result" /** * Filters for the spoil result. */ readonly elem_filters?: ItemPrototypeFilter[] } export interface SpoilResultItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "spoil-result" /** * Filters for the spoil result. */ readonly elem_filters?: readonly ItemPrototypeFilterWrite[] } /** * `"name"` variant of {@link ItemPrototypeFilter}. * * For use within nested filters such as the `has-product-item` filter of array[{@link RecipePrototypeFilter}]. * * To get a specific prototype by name, see {@link LuaPrototypes#item LuaPrototypes::item}. */ export interface NameItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "name" /** * The prototype name, or list of acceptable names. */ readonly name: string | string[] } /** * `"type"` variant of {@link ItemPrototypeFilter}. * * Usage example: * * ``` * prototypes.get_item_filtered({{filter = "type", type = "armor"}}) * ``` */ export interface TypeItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "type" /** * The prototype type, or a list of acceptable types. */ readonly type: string | string[] } /** * `"flag"` variant of {@link ItemPrototypeFilter}. */ export interface FlagItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "flag" readonly flag: ItemPrototypeFlag } /** * `"subgroup"` variant of {@link ItemPrototypeFilter}. */ export interface SubgroupItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "subgroup" /** * A {@link LuaGroup} (subgroup) name */ readonly subgroup: string } /** * `"fuel-category"` variant of {@link ItemPrototypeFilter}. */ export interface FuelCategoryItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "fuel-category" /** * A {@link LuaFuelCategoryPrototype} name */ readonly "fuel-category": string } /** * `"stack-size"` variant of {@link ItemPrototypeFilter}. * * Usage example: * * ``` * prototypes.get_item_filtered({{filter = "stack-size", comparison = ">", value = 20}, {filter = "stack-size", comparison = "<", value = 100, mode = "and"}}) * ``` */ export interface StackSizeItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "stack-size" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: uint } export interface StackSizeItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "stack-size" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: uint } /** * `"fuel-value"` variant of {@link ItemPrototypeFilter}. */ export interface FuelValueItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "fuel-value" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface FuelValueItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "fuel-value" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"fuel-acceleration-multiplier"` variant of {@link ItemPrototypeFilter}. */ export interface FuelAccelerationMultiplierItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "fuel-acceleration-multiplier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface FuelAccelerationMultiplierItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "fuel-acceleration-multiplier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"fuel-top-speed-multiplier"` variant of {@link ItemPrototypeFilter}. */ export interface FuelTopSpeedMultiplierItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "fuel-top-speed-multiplier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface FuelTopSpeedMultiplierItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "fuel-top-speed-multiplier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"fuel-emissions-multiplier"` variant of {@link ItemPrototypeFilter}. */ export interface FuelEmissionsMultiplierItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: "fuel-emissions-multiplier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface FuelEmissionsMultiplierItemPrototypeFilterWrite extends BaseItemPrototypeFilter { readonly filter: "fuel-emissions-multiplier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * Variants of {@link ItemPrototypeFilter} with no additional attributes. */ export interface OtherItemPrototypeFilter extends BaseItemPrototypeFilter { readonly filter: | "tool" | "mergeable" | "hidden" | "hidden-in-factoriopedia" | "is-parameter" | "item-with-inventory" | "selection-tool" | "item-with-label" | "has-rocket-launch-products" | "fuel" } /** * Base attributes: {@link BaseItemPrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"place-result"`: {@link PlaceResultItemPrototypeFilter} * - `"burnt-result"`: {@link BurntResultItemPrototypeFilter} * - `"place-as-tile"`: {@link PlaceAsTileItemPrototypeFilter} * - `"placed-as-equipment-result"`: {@link PlacedAsEquipmentResultItemPrototypeFilter} * - `"plant-result"`: {@link PlantResultItemPrototypeFilter} * - `"spoil-result"`: {@link SpoilResultItemPrototypeFilter} * - `"name"`: {@link NameItemPrototypeFilter} * - `"type"`: {@link TypeItemPrototypeFilter} * - `"flag"`: {@link FlagItemPrototypeFilter} * - `"subgroup"`: {@link SubgroupItemPrototypeFilter} * - `"fuel-category"`: {@link FuelCategoryItemPrototypeFilter} * - `"stack-size"`: {@link StackSizeItemPrototypeFilter} * - `"fuel-value"`: {@link FuelValueItemPrototypeFilter} * - `"fuel-acceleration-multiplier"`: {@link FuelAccelerationMultiplierItemPrototypeFilter} * - `"fuel-top-speed-multiplier"`: {@link FuelTopSpeedMultiplierItemPrototypeFilter} * - `"fuel-emissions-multiplier"`: {@link FuelEmissionsMultiplierItemPrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemPrototypeFilter.html Online documentation} */ export type ItemPrototypeFilter = | PlaceResultItemPrototypeFilter | BurntResultItemPrototypeFilter | PlaceAsTileItemPrototypeFilter | PlacedAsEquipmentResultItemPrototypeFilter | PlantResultItemPrototypeFilter | SpoilResultItemPrototypeFilter | NameItemPrototypeFilter | TypeItemPrototypeFilter | FlagItemPrototypeFilter | SubgroupItemPrototypeFilter | FuelCategoryItemPrototypeFilter | StackSizeItemPrototypeFilter | FuelValueItemPrototypeFilter | FuelAccelerationMultiplierItemPrototypeFilter | FuelTopSpeedMultiplierItemPrototypeFilter | FuelEmissionsMultiplierItemPrototypeFilter | OtherItemPrototypeFilter /** * Write form of {@link ItemPrototypeFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/ItemPrototypeFilter.html Online documentation} */ export type ItemPrototypeFilterWrite = | PlaceResultItemPrototypeFilterWrite | BurntResultItemPrototypeFilterWrite | PlaceAsTileItemPrototypeFilterWrite | PlacedAsEquipmentResultItemPrototypeFilter | PlantResultItemPrototypeFilterWrite | SpoilResultItemPrototypeFilterWrite | NameItemPrototypeFilter | TypeItemPrototypeFilter | FlagItemPrototypeFilter | SubgroupItemPrototypeFilter | FuelCategoryItemPrototypeFilter | StackSizeItemPrototypeFilterWrite | FuelValueItemPrototypeFilterWrite | FuelAccelerationMultiplierItemPrototypeFilterWrite | FuelTopSpeedMultiplierItemPrototypeFilterWrite | FuelEmissionsMultiplierItemPrototypeFilterWrite | OtherItemPrototypeFilter /** * Common attributes to all variants of {@link TechnologyPrototypeFilter}. */ export interface BaseTechnologyPrototypeFilter { /** * The condition to filter on. */ readonly filter: | "enabled" | "hidden" | "upgrade" | "visible-when-disabled" | "has-effects" | "has-prerequisites" | "research-unit-ingredient" | "unlocks-recipe" | "level" | "max-level" | "time" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"research-unit-ingredient"` variant of {@link TechnologyPrototypeFilter}. */ export interface ResearchUnitIngredientTechnologyPrototypeFilter extends BaseTechnologyPrototypeFilter { readonly filter: "research-unit-ingredient" /** * The research ingredient to check. */ readonly ingredient: string } /** * `"unlocks-recipe"` variant of {@link TechnologyPrototypeFilter}. */ export interface UnlocksRecipeTechnologyPrototypeFilter extends BaseTechnologyPrototypeFilter { readonly filter: "unlocks-recipe" /** * The recipe to check. */ readonly recipe: string } /** * `"level"` variant of {@link TechnologyPrototypeFilter}. */ export interface LevelTechnologyPrototypeFilter extends BaseTechnologyPrototypeFilter { readonly filter: "level" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: uint } export interface LevelTechnologyPrototypeFilterWrite extends BaseTechnologyPrototypeFilter { readonly filter: "level" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: uint } /** * `"max-level"` variant of {@link TechnologyPrototypeFilter}. */ export interface MaxLevelTechnologyPrototypeFilter extends BaseTechnologyPrototypeFilter { readonly filter: "max-level" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: uint } export interface MaxLevelTechnologyPrototypeFilterWrite extends BaseTechnologyPrototypeFilter { readonly filter: "max-level" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: uint } /** * `"time"` variant of {@link TechnologyPrototypeFilter}. */ export interface TimeTechnologyPrototypeFilter extends BaseTechnologyPrototypeFilter { readonly filter: "time" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: uint } export interface TimeTechnologyPrototypeFilterWrite extends BaseTechnologyPrototypeFilter { readonly filter: "time" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: uint } /** * Variants of {@link TechnologyPrototypeFilter} with no additional attributes. */ export interface OtherTechnologyPrototypeFilter extends BaseTechnologyPrototypeFilter { readonly filter: "enabled" | "hidden" | "upgrade" | "visible-when-disabled" | "has-effects" | "has-prerequisites" } /** * Base attributes: {@link BaseTechnologyPrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"research-unit-ingredient"`: {@link ResearchUnitIngredientTechnologyPrototypeFilter} * - `"unlocks-recipe"`: {@link UnlocksRecipeTechnologyPrototypeFilter} * - `"level"`: {@link LevelTechnologyPrototypeFilter} * - `"max-level"`: {@link MaxLevelTechnologyPrototypeFilter} * - `"time"`: {@link TimeTechnologyPrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TechnologyPrototypeFilter.html Online documentation} */ export type TechnologyPrototypeFilter = | ResearchUnitIngredientTechnologyPrototypeFilter | UnlocksRecipeTechnologyPrototypeFilter | LevelTechnologyPrototypeFilter | MaxLevelTechnologyPrototypeFilter | TimeTechnologyPrototypeFilter | OtherTechnologyPrototypeFilter /** * Write form of {@link TechnologyPrototypeFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/TechnologyPrototypeFilter.html Online documentation} */ export type TechnologyPrototypeFilterWrite = | ResearchUnitIngredientTechnologyPrototypeFilter | UnlocksRecipeTechnologyPrototypeFilter | LevelTechnologyPrototypeFilterWrite | MaxLevelTechnologyPrototypeFilterWrite | TimeTechnologyPrototypeFilterWrite | OtherTechnologyPrototypeFilter /** * Common attributes to all variants of {@link RecipePrototypeFilter}. */ export interface BaseRecipePrototypeFilter { /** * The condition to filter on. */ readonly filter: | "enabled" | "hidden" | "hidden-from-flow-stats" | "hidden-from-player-crafting" | "allow-as-intermediate" | "allow-intermediates" | "allow-decomposition" | "always-show-made-in" | "always-show-products" | "show-amount-in-title" | "has-ingredients" | "has-products" | "has-ingredient-item" | "has-ingredient-fluid" | "has-product-item" | "has-product-fluid" | "subgroup" | "category" | "energy" | "emissions-multiplier" | "request-paste-multiplier" | "overload-multiplier" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"has-ingredient-item"` variant of {@link RecipePrototypeFilter}. */ export interface HasIngredientItemRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "has-ingredient-item" /** * Matches if at least 1 ingredient is an item that matches these filters. */ readonly elem_filters?: ItemPrototypeFilter[] } export interface HasIngredientItemRecipePrototypeFilterWrite extends BaseRecipePrototypeFilter { readonly filter: "has-ingredient-item" /** * Matches if at least 1 ingredient is an item that matches these filters. */ readonly elem_filters?: readonly ItemPrototypeFilterWrite[] } /** * `"has-ingredient-fluid"` variant of {@link RecipePrototypeFilter}. * * ``` * -- selects recipes that consume sulfuric acid * {{filter = "has-ingredient-fluid", elem_filters = {{filter = "name", name = "sulfuric-acid"}}}} * ``` */ export interface HasIngredientFluidRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "has-ingredient-fluid" /** * Matches if at least 1 ingredient is a fluid that matches these filters. */ readonly elem_filters?: FluidPrototypeFilter[] } export interface HasIngredientFluidRecipePrototypeFilterWrite extends BaseRecipePrototypeFilter { readonly filter: "has-ingredient-fluid" /** * Matches if at least 1 ingredient is a fluid that matches these filters. */ readonly elem_filters?: readonly FluidPrototypeFilterWrite[] } /** * `"has-product-item"` variant of {@link RecipePrototypeFilter}. * * Usage example: * * ``` * -- selects recipes that produce an item * {{filter = "has-product-item"}} * -- selects recipes that produce iron plates * {{filter = "has-product-item", elem_filters = {{filter = "name", name = "iron-plate"}}}} * -- selects recipes that produce items that place furnaces * {{filter = "has-product-item", elem_filters = {{filter = "place-result", elem_filters = {{filter = "type", type = "furnace"}}}}}} * ``` */ export interface HasProductItemRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "has-product-item" /** * Matches if at least 1 product is an item that matches these filters. */ readonly elem_filters?: ItemPrototypeFilter[] } export interface HasProductItemRecipePrototypeFilterWrite extends BaseRecipePrototypeFilter { readonly filter: "has-product-item" /** * Matches if at least 1 product is an item that matches these filters. */ readonly elem_filters?: readonly ItemPrototypeFilterWrite[] } /** * `"has-product-fluid"` variant of {@link RecipePrototypeFilter}. */ export interface HasProductFluidRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "has-product-fluid" /** * Matches if at least 1 product is a fluid that matches */ readonly elem_filters?: FluidPrototypeFilter[] } export interface HasProductFluidRecipePrototypeFilterWrite extends BaseRecipePrototypeFilter { readonly filter: "has-product-fluid" /** * Matches if at least 1 product is a fluid that matches */ readonly elem_filters?: readonly FluidPrototypeFilterWrite[] } /** * `"subgroup"` variant of {@link RecipePrototypeFilter}. */ export interface SubgroupRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "subgroup" /** * A {@link LuaGroup} (subgroup) name */ readonly subgroup: string } /** * `"category"` variant of {@link RecipePrototypeFilter}. */ export interface CategoryRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "category" /** * A {@link LuaRecipeCategoryPrototype} name */ readonly category: string } /** * `"energy"` variant of {@link RecipePrototypeFilter}. */ export interface EnergyRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "energy" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface EnergyRecipePrototypeFilterWrite extends BaseRecipePrototypeFilter { readonly filter: "energy" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"emissions-multiplier"` variant of {@link RecipePrototypeFilter}. */ export interface EmissionsMultiplierRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "emissions-multiplier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface EmissionsMultiplierRecipePrototypeFilterWrite extends BaseRecipePrototypeFilter { readonly filter: "emissions-multiplier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"request-paste-multiplier"` variant of {@link RecipePrototypeFilter}. */ export interface RequestPasteMultiplierRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "request-paste-multiplier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: uint } export interface RequestPasteMultiplierRecipePrototypeFilterWrite extends BaseRecipePrototypeFilter { readonly filter: "request-paste-multiplier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: uint } /** * `"overload-multiplier"` variant of {@link RecipePrototypeFilter}. */ export interface OverloadMultiplierRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: "overload-multiplier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: uint } export interface OverloadMultiplierRecipePrototypeFilterWrite extends BaseRecipePrototypeFilter { readonly filter: "overload-multiplier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: uint } /** * Variants of {@link RecipePrototypeFilter} with no additional attributes. */ export interface OtherRecipePrototypeFilter extends BaseRecipePrototypeFilter { readonly filter: | "enabled" | "hidden" | "hidden-from-flow-stats" | "hidden-from-player-crafting" | "allow-as-intermediate" | "allow-intermediates" | "allow-decomposition" | "always-show-made-in" | "always-show-products" | "show-amount-in-title" | "has-ingredients" | "has-products" } /** * Base attributes: {@link BaseRecipePrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"has-ingredient-item"`: {@link HasIngredientItemRecipePrototypeFilter} * - `"has-ingredient-fluid"`: {@link HasIngredientFluidRecipePrototypeFilter} * - `"has-product-item"`: {@link HasProductItemRecipePrototypeFilter} * - `"has-product-fluid"`: {@link HasProductFluidRecipePrototypeFilter} * - `"subgroup"`: {@link SubgroupRecipePrototypeFilter} * - `"category"`: {@link CategoryRecipePrototypeFilter} * - `"energy"`: {@link EnergyRecipePrototypeFilter} * - `"emissions-multiplier"`: {@link EmissionsMultiplierRecipePrototypeFilter} * - `"request-paste-multiplier"`: {@link RequestPasteMultiplierRecipePrototypeFilter} * - `"overload-multiplier"`: {@link OverloadMultiplierRecipePrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/RecipePrototypeFilter.html Online documentation} */ export type RecipePrototypeFilter = | HasIngredientItemRecipePrototypeFilter | HasIngredientFluidRecipePrototypeFilter | HasProductItemRecipePrototypeFilter | HasProductFluidRecipePrototypeFilter | SubgroupRecipePrototypeFilter | CategoryRecipePrototypeFilter | EnergyRecipePrototypeFilter | EmissionsMultiplierRecipePrototypeFilter | RequestPasteMultiplierRecipePrototypeFilter | OverloadMultiplierRecipePrototypeFilter | OtherRecipePrototypeFilter /** * Write form of {@link RecipePrototypeFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/RecipePrototypeFilter.html Online documentation} */ export type RecipePrototypeFilterWrite = | HasIngredientItemRecipePrototypeFilterWrite | HasIngredientFluidRecipePrototypeFilterWrite | HasProductItemRecipePrototypeFilterWrite | HasProductFluidRecipePrototypeFilterWrite | SubgroupRecipePrototypeFilter | CategoryRecipePrototypeFilter | EnergyRecipePrototypeFilterWrite | EmissionsMultiplierRecipePrototypeFilterWrite | RequestPasteMultiplierRecipePrototypeFilterWrite | OverloadMultiplierRecipePrototypeFilterWrite | OtherRecipePrototypeFilter /** * Common attributes to all variants of {@link AchievementPrototypeFilter}. */ export interface BaseAchievementPrototypeFilter { /** * The condition to filter on. */ readonly filter: "allowed-without-fight" | "type" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link AchievementPrototypeFilter}. */ export interface TypeAchievementPrototypeFilter extends BaseAchievementPrototypeFilter { readonly filter: "type" /** * The prototype type, or a list of acceptable types. */ readonly type: string | string[] } /** * Variants of {@link AchievementPrototypeFilter} with no additional attributes. */ export interface OtherAchievementPrototypeFilter extends BaseAchievementPrototypeFilter { readonly filter: "allowed-without-fight" } /** * Base attributes: {@link BaseAchievementPrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeAchievementPrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/AchievementPrototypeFilter.html Online documentation} */ export type AchievementPrototypeFilter = TypeAchievementPrototypeFilter | OtherAchievementPrototypeFilter /** * Common attributes to all variants of {@link EquipmentPrototypeFilter}. */ export interface BaseEquipmentPrototypeFilter { /** * The condition to filter on. */ readonly filter: "item-to-place" | "type" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link EquipmentPrototypeFilter}. */ export interface TypeEquipmentPrototypeFilter extends BaseEquipmentPrototypeFilter { readonly filter: "type" /** * The prototype type, or a list of acceptable types. */ readonly type: string | string[] } /** * Variants of {@link EquipmentPrototypeFilter} with no additional attributes. */ export interface OtherEquipmentPrototypeFilter extends BaseEquipmentPrototypeFilter { readonly filter: "item-to-place" } /** * Base attributes: {@link BaseEquipmentPrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeEquipmentPrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EquipmentPrototypeFilter.html Online documentation} */ export type EquipmentPrototypeFilter = TypeEquipmentPrototypeFilter | OtherEquipmentPrototypeFilter /** * Common attributes to all variants of {@link FluidPrototypeFilter}. */ export interface BaseFluidPrototypeFilter { /** * The condition to filter on. */ readonly filter: | "hidden" | "name" | "subgroup" | "default-temperature" | "max-temperature" | "heat-capacity" | "fuel-value" | "emissions-multiplier" | "gas-temperature" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"name"` variant of {@link FluidPrototypeFilter}. * * For use within nested filters such as the `has-product-fluid` filter of array[{@link RecipePrototypeFilter}]. * * To get a specific prototype by name, see {@link LuaPrototypes#fluid LuaPrototypes::fluid}. */ export interface NameFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "name" /** * The prototype name, or list of acceptable names. */ readonly name: string | string[] } /** * `"subgroup"` variant of {@link FluidPrototypeFilter}. */ export interface SubgroupFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "subgroup" /** * A {@link LuaGroup} (subgroup) name */ readonly subgroup: string } /** * `"default-temperature"` variant of {@link FluidPrototypeFilter}. */ export interface DefaultTemperatureFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "default-temperature" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface DefaultTemperatureFluidPrototypeFilterWrite extends BaseFluidPrototypeFilter { readonly filter: "default-temperature" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"max-temperature"` variant of {@link FluidPrototypeFilter}. */ export interface MaxTemperatureFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "max-temperature" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface MaxTemperatureFluidPrototypeFilterWrite extends BaseFluidPrototypeFilter { readonly filter: "max-temperature" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"heat-capacity"` variant of {@link FluidPrototypeFilter}. */ export interface HeatCapacityFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "heat-capacity" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface HeatCapacityFluidPrototypeFilterWrite extends BaseFluidPrototypeFilter { readonly filter: "heat-capacity" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"fuel-value"` variant of {@link FluidPrototypeFilter}. */ export interface FuelValueFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "fuel-value" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface FuelValueFluidPrototypeFilterWrite extends BaseFluidPrototypeFilter { readonly filter: "fuel-value" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"emissions-multiplier"` variant of {@link FluidPrototypeFilter}. */ export interface EmissionsMultiplierFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "emissions-multiplier" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface EmissionsMultiplierFluidPrototypeFilterWrite extends BaseFluidPrototypeFilter { readonly filter: "emissions-multiplier" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"gas-temperature"` variant of {@link FluidPrototypeFilter}. */ export interface GasTemperatureFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "gas-temperature" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface GasTemperatureFluidPrototypeFilterWrite extends BaseFluidPrototypeFilter { readonly filter: "gas-temperature" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * Variants of {@link FluidPrototypeFilter} with no additional attributes. */ export interface OtherFluidPrototypeFilter extends BaseFluidPrototypeFilter { readonly filter: "hidden" } /** * Base attributes: {@link BaseFluidPrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"name"`: {@link NameFluidPrototypeFilter} * - `"subgroup"`: {@link SubgroupFluidPrototypeFilter} * - `"default-temperature"`: {@link DefaultTemperatureFluidPrototypeFilter} * - `"max-temperature"`: {@link MaxTemperatureFluidPrototypeFilter} * - `"heat-capacity"`: {@link HeatCapacityFluidPrototypeFilter} * - `"fuel-value"`: {@link FuelValueFluidPrototypeFilter} * - `"emissions-multiplier"`: {@link EmissionsMultiplierFluidPrototypeFilter} * - `"gas-temperature"`: {@link GasTemperatureFluidPrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/FluidPrototypeFilter.html Online documentation} */ export type FluidPrototypeFilter = | NameFluidPrototypeFilter | SubgroupFluidPrototypeFilter | DefaultTemperatureFluidPrototypeFilter | MaxTemperatureFluidPrototypeFilter | HeatCapacityFluidPrototypeFilter | FuelValueFluidPrototypeFilter | EmissionsMultiplierFluidPrototypeFilter | GasTemperatureFluidPrototypeFilter | OtherFluidPrototypeFilter /** * Write form of {@link FluidPrototypeFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/FluidPrototypeFilter.html Online documentation} */ export type FluidPrototypeFilterWrite = | NameFluidPrototypeFilter | SubgroupFluidPrototypeFilter | DefaultTemperatureFluidPrototypeFilterWrite | MaxTemperatureFluidPrototypeFilterWrite | HeatCapacityFluidPrototypeFilterWrite | FuelValueFluidPrototypeFilterWrite | EmissionsMultiplierFluidPrototypeFilterWrite | GasTemperatureFluidPrototypeFilterWrite | OtherFluidPrototypeFilter /** * Common attributes to all variants of {@link EntityPrototypeFilter}. */ export interface BaseEntityPrototypeFilter { /** * The condition to filter on. */ readonly filter: | "flying-robot" | "robot-with-logistics-interface" | "rail" | "ghost" | "explosion" | "vehicle" | "crafting-machine" | "rolling-stock" | "turret" | "transport-belt-connectable" | "wall-connectable" | "buildable" | "placable-in-editor" | "clonable" | "selectable" | "hidden" | "entity-with-health" | "building" | "fast-replaceable" | "uses-direction" | "minable" | "circuit-connectable" | "autoplace" | "blueprintable" | "item-to-place" | "name" | "type" | "collision-mask" | "flag" | "build-base-evolution-requirement" | "selection-priority" | "emissions-per-second" | "crafting-category" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"name"` variant of {@link EntityPrototypeFilter}. * * For use within nested filters such as the `place-result` filter of array[{@link ItemPrototypeFilter}]. * * To get a specific prototype by name, see {@link LuaPrototypes#entity LuaPrototypes::entity}. */ export interface NameEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: "name" /** * The prototype name, or list of acceptable names. */ readonly name: string | string[] } /** * `"type"` variant of {@link EntityPrototypeFilter}. * * Usage example: * * ``` * prototypes.get_entity_filtered({{filter = "type", type = "unit"}}) * ``` */ export interface TypeEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: "type" /** * The prototype type, or a list of acceptable types. */ readonly type: string | string[] } /** * `"collision-mask"` variant of {@link EntityPrototypeFilter}. * * Usage example: * * ``` * prototypes.get_entity_filtered({{filter = "collision-mask", mask = "player", mask_mode = "collides"}}) * ``` */ export interface CollisionMaskEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: "collision-mask" /** * Name of one {@link LuaCollisionLayerPrototype layer} or a full collision mask. */ readonly mask: CollisionLayerID | CollisionMask readonly mask_mode: "collides" | "layers-equals" | "contains-any" | "contains-all" } /** * `"flag"` variant of {@link EntityPrototypeFilter}. * * Usage example: * * ``` * prototypes.get_entity_filtered({{filter = "flag", flag = "placeable-player"}, {filter = "flag", flag = "placeable-enemy", mode = "and"}}) * ``` */ export interface FlagEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: "flag" readonly flag: EntityPrototypeFlag } /** * `"build-base-evolution-requirement"` variant of {@link EntityPrototypeFilter}. */ export interface BuildBaseEvolutionRequirementEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: "build-base-evolution-requirement" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface BuildBaseEvolutionRequirementEntityPrototypeFilterWrite extends BaseEntityPrototypeFilter { readonly filter: "build-base-evolution-requirement" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"selection-priority"` variant of {@link EntityPrototypeFilter}. */ export interface SelectionPriorityEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: "selection-priority" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: uint8 } export interface SelectionPriorityEntityPrototypeFilterWrite extends BaseEntityPrototypeFilter { readonly filter: "selection-priority" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: uint8 } /** * `"emissions-per-second"` variant of {@link EntityPrototypeFilter}. */ export interface EmissionsPerSecondEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: "emissions-per-second" /** * The name of a pollutant type to check. */ readonly pollutant: string readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: double } export interface EmissionsPerSecondEntityPrototypeFilterWrite extends BaseEntityPrototypeFilter { readonly filter: "emissions-per-second" /** * The name of a pollutant type to check. */ readonly pollutant: string readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: double } /** * `"crafting-category"` variant of {@link EntityPrototypeFilter}. */ export interface CraftingCategoryEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: "crafting-category" /** * Matches if the prototype is for a crafting machine with this {@link LuaEntityPrototype#crafting_categories crafting category}. */ readonly crafting_category: string } /** * Variants of {@link EntityPrototypeFilter} with no additional attributes. */ export interface OtherEntityPrototypeFilter extends BaseEntityPrototypeFilter { readonly filter: | "flying-robot" | "robot-with-logistics-interface" | "rail" | "ghost" | "explosion" | "vehicle" | "crafting-machine" | "rolling-stock" | "turret" | "transport-belt-connectable" | "wall-connectable" | "buildable" | "placable-in-editor" | "clonable" | "selectable" | "hidden" | "entity-with-health" | "building" | "fast-replaceable" | "uses-direction" | "minable" | "circuit-connectable" | "autoplace" | "blueprintable" | "item-to-place" } /** * Base attributes: {@link BaseEntityPrototypeFilter} * * Other attributes may be specified depending on `filter`: * - `"name"`: {@link NameEntityPrototypeFilter} * - `"type"`: {@link TypeEntityPrototypeFilter} * - `"collision-mask"`: {@link CollisionMaskEntityPrototypeFilter} * - `"flag"`: {@link FlagEntityPrototypeFilter} * - `"build-base-evolution-requirement"`: {@link BuildBaseEvolutionRequirementEntityPrototypeFilter} * - `"selection-priority"`: {@link SelectionPriorityEntityPrototypeFilter} * - `"emissions-per-second"`: {@link EmissionsPerSecondEntityPrototypeFilter} * - `"crafting-category"`: {@link CraftingCategoryEntityPrototypeFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EntityPrototypeFilter.html Online documentation} */ export type EntityPrototypeFilter = | NameEntityPrototypeFilter | TypeEntityPrototypeFilter | CollisionMaskEntityPrototypeFilter | FlagEntityPrototypeFilter | BuildBaseEvolutionRequirementEntityPrototypeFilter | SelectionPriorityEntityPrototypeFilter | EmissionsPerSecondEntityPrototypeFilter | CraftingCategoryEntityPrototypeFilter | OtherEntityPrototypeFilter /** * Write form of {@link EntityPrototypeFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/EntityPrototypeFilter.html Online documentation} */ export type EntityPrototypeFilterWrite = | NameEntityPrototypeFilter | TypeEntityPrototypeFilter | CollisionMaskEntityPrototypeFilter | FlagEntityPrototypeFilter | BuildBaseEvolutionRequirementEntityPrototypeFilterWrite | SelectionPriorityEntityPrototypeFilterWrite | EmissionsPerSecondEntityPrototypeFilterWrite | CraftingCategoryEntityPrototypeFilter | OtherEntityPrototypeFilter /** * Common attributes to all variants of {@link LuaScriptRaisedTeleportedEventFilter}. */ export interface BaseScriptRaisedTeleportedEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaScriptRaisedTeleportedEventFilter}. */ export interface TypeScriptRaisedTeleportedEventFilter extends BaseScriptRaisedTeleportedEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaScriptRaisedTeleportedEventFilter}. */ export interface NameScriptRaisedTeleportedEventFilter extends BaseScriptRaisedTeleportedEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaScriptRaisedTeleportedEventFilter}. */ export interface GhostTypeScriptRaisedTeleportedEventFilter extends BaseScriptRaisedTeleportedEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaScriptRaisedTeleportedEventFilter}. */ export interface GhostNameScriptRaisedTeleportedEventFilter extends BaseScriptRaisedTeleportedEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaScriptRaisedTeleportedEventFilter} with no additional attributes. */ export interface OtherScriptRaisedTeleportedEventFilter extends BaseScriptRaisedTeleportedEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseScriptRaisedTeleportedEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeScriptRaisedTeleportedEventFilter} * - `"name"`: {@link NameScriptRaisedTeleportedEventFilter} * - `"ghost_type"`: {@link GhostTypeScriptRaisedTeleportedEventFilter} * - `"ghost_name"`: {@link GhostNameScriptRaisedTeleportedEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaScriptRaisedTeleportedEventFilter.html Online documentation} */ export type LuaScriptRaisedTeleportedEventFilter = | TypeScriptRaisedTeleportedEventFilter | NameScriptRaisedTeleportedEventFilter | GhostTypeScriptRaisedTeleportedEventFilter | GhostNameScriptRaisedTeleportedEventFilter | OtherScriptRaisedTeleportedEventFilter /** * Common attributes to all variants of {@link LuaPreRobotMinedEntityEventFilter}. */ export interface BasePreRobotMinedEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPreRobotMinedEntityEventFilter}. */ export interface TypePreRobotMinedEntityEventFilter extends BasePreRobotMinedEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPreRobotMinedEntityEventFilter}. */ export interface NamePreRobotMinedEntityEventFilter extends BasePreRobotMinedEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPreRobotMinedEntityEventFilter}. */ export interface GhostTypePreRobotMinedEntityEventFilter extends BasePreRobotMinedEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPreRobotMinedEntityEventFilter}. */ export interface GhostNamePreRobotMinedEntityEventFilter extends BasePreRobotMinedEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaPreRobotMinedEntityEventFilter} with no additional attributes. */ export interface OtherPreRobotMinedEntityEventFilter extends BasePreRobotMinedEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePreRobotMinedEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePreRobotMinedEntityEventFilter} * - `"name"`: {@link NamePreRobotMinedEntityEventFilter} * - `"ghost_type"`: {@link GhostTypePreRobotMinedEntityEventFilter} * - `"ghost_name"`: {@link GhostNamePreRobotMinedEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPreRobotMinedEntityEventFilter.html Online documentation} */ export type LuaPreRobotMinedEntityEventFilter = | TypePreRobotMinedEntityEventFilter | NamePreRobotMinedEntityEventFilter | GhostTypePreRobotMinedEntityEventFilter | GhostNamePreRobotMinedEntityEventFilter | OtherPreRobotMinedEntityEventFilter /** * Common attributes to all variants of {@link LuaScriptRaisedBuiltEventFilter}. */ export interface BaseScriptRaisedBuiltEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaScriptRaisedBuiltEventFilter}. */ export interface TypeScriptRaisedBuiltEventFilter extends BaseScriptRaisedBuiltEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaScriptRaisedBuiltEventFilter}. */ export interface NameScriptRaisedBuiltEventFilter extends BaseScriptRaisedBuiltEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaScriptRaisedBuiltEventFilter}. */ export interface GhostTypeScriptRaisedBuiltEventFilter extends BaseScriptRaisedBuiltEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaScriptRaisedBuiltEventFilter}. */ export interface GhostNameScriptRaisedBuiltEventFilter extends BaseScriptRaisedBuiltEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaScriptRaisedBuiltEventFilter} with no additional attributes. */ export interface OtherScriptRaisedBuiltEventFilter extends BaseScriptRaisedBuiltEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseScriptRaisedBuiltEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeScriptRaisedBuiltEventFilter} * - `"name"`: {@link NameScriptRaisedBuiltEventFilter} * - `"ghost_type"`: {@link GhostTypeScriptRaisedBuiltEventFilter} * - `"ghost_name"`: {@link GhostNameScriptRaisedBuiltEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaScriptRaisedBuiltEventFilter.html Online documentation} */ export type LuaScriptRaisedBuiltEventFilter = | TypeScriptRaisedBuiltEventFilter | NameScriptRaisedBuiltEventFilter | GhostTypeScriptRaisedBuiltEventFilter | GhostNameScriptRaisedBuiltEventFilter | OtherScriptRaisedBuiltEventFilter /** * Common attributes to all variants of {@link LuaPlatformMinedEntityEventFilter}. */ export interface BasePlatformMinedEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPlatformMinedEntityEventFilter}. */ export interface TypePlatformMinedEntityEventFilter extends BasePlatformMinedEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPlatformMinedEntityEventFilter}. */ export interface NamePlatformMinedEntityEventFilter extends BasePlatformMinedEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPlatformMinedEntityEventFilter}. */ export interface GhostTypePlatformMinedEntityEventFilter extends BasePlatformMinedEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPlatformMinedEntityEventFilter}. */ export interface GhostNamePlatformMinedEntityEventFilter extends BasePlatformMinedEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaPlatformMinedEntityEventFilter} with no additional attributes. */ export interface OtherPlatformMinedEntityEventFilter extends BasePlatformMinedEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePlatformMinedEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePlatformMinedEntityEventFilter} * - `"name"`: {@link NamePlatformMinedEntityEventFilter} * - `"ghost_type"`: {@link GhostTypePlatformMinedEntityEventFilter} * - `"ghost_name"`: {@link GhostNamePlatformMinedEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPlatformMinedEntityEventFilter.html Online documentation} */ export type LuaPlatformMinedEntityEventFilter = | TypePlatformMinedEntityEventFilter | NamePlatformMinedEntityEventFilter | GhostTypePlatformMinedEntityEventFilter | GhostNamePlatformMinedEntityEventFilter | OtherPlatformMinedEntityEventFilter /** * Common attributes to all variants of {@link LuaRobotBuiltEntityEventFilter}. */ export interface BaseRobotBuiltEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" | "force" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaRobotBuiltEntityEventFilter}. */ export interface TypeRobotBuiltEntityEventFilter extends BaseRobotBuiltEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaRobotBuiltEntityEventFilter}. */ export interface NameRobotBuiltEntityEventFilter extends BaseRobotBuiltEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaRobotBuiltEntityEventFilter}. */ export interface GhostTypeRobotBuiltEntityEventFilter extends BaseRobotBuiltEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaRobotBuiltEntityEventFilter}. */ export interface GhostNameRobotBuiltEntityEventFilter extends BaseRobotBuiltEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * `"force"` variant of {@link LuaRobotBuiltEntityEventFilter}. */ export interface ForceRobotBuiltEntityEventFilter extends BaseRobotBuiltEntityEventFilter { readonly filter: "force" /** * The entity force */ readonly force: string } /** * Variants of {@link LuaRobotBuiltEntityEventFilter} with no additional attributes. */ export interface OtherRobotBuiltEntityEventFilter extends BaseRobotBuiltEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseRobotBuiltEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeRobotBuiltEntityEventFilter} * - `"name"`: {@link NameRobotBuiltEntityEventFilter} * - `"ghost_type"`: {@link GhostTypeRobotBuiltEntityEventFilter} * - `"ghost_name"`: {@link GhostNameRobotBuiltEntityEventFilter} * - `"force"`: {@link ForceRobotBuiltEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaRobotBuiltEntityEventFilter.html Online documentation} */ export type LuaRobotBuiltEntityEventFilter = | TypeRobotBuiltEntityEventFilter | NameRobotBuiltEntityEventFilter | GhostTypeRobotBuiltEntityEventFilter | GhostNameRobotBuiltEntityEventFilter | ForceRobotBuiltEntityEventFilter | OtherRobotBuiltEntityEventFilter /** * Common attributes to all variants of {@link LuaPrePlayerMinedEntityEventFilter}. */ export interface BasePrePlayerMinedEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPrePlayerMinedEntityEventFilter}. */ export interface TypePrePlayerMinedEntityEventFilter extends BasePrePlayerMinedEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPrePlayerMinedEntityEventFilter}. */ export interface NamePrePlayerMinedEntityEventFilter extends BasePrePlayerMinedEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPrePlayerMinedEntityEventFilter}. */ export interface GhostTypePrePlayerMinedEntityEventFilter extends BasePrePlayerMinedEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPrePlayerMinedEntityEventFilter}. */ export interface GhostNamePrePlayerMinedEntityEventFilter extends BasePrePlayerMinedEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaPrePlayerMinedEntityEventFilter} with no additional attributes. */ export interface OtherPrePlayerMinedEntityEventFilter extends BasePrePlayerMinedEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePrePlayerMinedEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePrePlayerMinedEntityEventFilter} * - `"name"`: {@link NamePrePlayerMinedEntityEventFilter} * - `"ghost_type"`: {@link GhostTypePrePlayerMinedEntityEventFilter} * - `"ghost_name"`: {@link GhostNamePrePlayerMinedEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPrePlayerMinedEntityEventFilter.html Online documentation} */ export type LuaPrePlayerMinedEntityEventFilter = | TypePrePlayerMinedEntityEventFilter | NamePrePlayerMinedEntityEventFilter | GhostTypePrePlayerMinedEntityEventFilter | GhostNamePrePlayerMinedEntityEventFilter | OtherPrePlayerMinedEntityEventFilter /** * Common attributes to all variants of {@link LuaEntityDeconstructionCancelledEventFilter}. */ export interface BaseEntityDeconstructionCancelledEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaEntityDeconstructionCancelledEventFilter}. */ export interface TypeEntityDeconstructionCancelledEventFilter extends BaseEntityDeconstructionCancelledEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaEntityDeconstructionCancelledEventFilter}. */ export interface NameEntityDeconstructionCancelledEventFilter extends BaseEntityDeconstructionCancelledEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaEntityDeconstructionCancelledEventFilter}. */ export interface GhostTypeEntityDeconstructionCancelledEventFilter extends BaseEntityDeconstructionCancelledEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaEntityDeconstructionCancelledEventFilter}. */ export interface GhostNameEntityDeconstructionCancelledEventFilter extends BaseEntityDeconstructionCancelledEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaEntityDeconstructionCancelledEventFilter} with no additional attributes. */ export interface OtherEntityDeconstructionCancelledEventFilter extends BaseEntityDeconstructionCancelledEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseEntityDeconstructionCancelledEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeEntityDeconstructionCancelledEventFilter} * - `"name"`: {@link NameEntityDeconstructionCancelledEventFilter} * - `"ghost_type"`: {@link GhostTypeEntityDeconstructionCancelledEventFilter} * - `"ghost_name"`: {@link GhostNameEntityDeconstructionCancelledEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaEntityDeconstructionCancelledEventFilter.html Online documentation} */ export type LuaEntityDeconstructionCancelledEventFilter = | TypeEntityDeconstructionCancelledEventFilter | NameEntityDeconstructionCancelledEventFilter | GhostTypeEntityDeconstructionCancelledEventFilter | GhostNameEntityDeconstructionCancelledEventFilter | OtherEntityDeconstructionCancelledEventFilter /** * Common attributes to all variants of {@link LuaPreGhostUpgradedEventFilter}. */ export interface BasePreGhostUpgradedEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPreGhostUpgradedEventFilter}. */ export interface TypePreGhostUpgradedEventFilter extends BasePreGhostUpgradedEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPreGhostUpgradedEventFilter}. */ export interface NamePreGhostUpgradedEventFilter extends BasePreGhostUpgradedEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPreGhostUpgradedEventFilter}. */ export interface GhostTypePreGhostUpgradedEventFilter extends BasePreGhostUpgradedEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPreGhostUpgradedEventFilter}. */ export interface GhostNamePreGhostUpgradedEventFilter extends BasePreGhostUpgradedEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaPreGhostUpgradedEventFilter} with no additional attributes. */ export interface OtherPreGhostUpgradedEventFilter extends BasePreGhostUpgradedEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePreGhostUpgradedEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePreGhostUpgradedEventFilter} * - `"name"`: {@link NamePreGhostUpgradedEventFilter} * - `"ghost_type"`: {@link GhostTypePreGhostUpgradedEventFilter} * - `"ghost_name"`: {@link GhostNamePreGhostUpgradedEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPreGhostUpgradedEventFilter.html Online documentation} */ export type LuaPreGhostUpgradedEventFilter = | TypePreGhostUpgradedEventFilter | NamePreGhostUpgradedEventFilter | GhostTypePreGhostUpgradedEventFilter | GhostNamePreGhostUpgradedEventFilter | OtherPreGhostUpgradedEventFilter /** * Common attributes to all variants of {@link LuaPlatformBuiltEntityEventFilter}. */ export interface BasePlatformBuiltEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" | "force" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPlatformBuiltEntityEventFilter}. */ export interface TypePlatformBuiltEntityEventFilter extends BasePlatformBuiltEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPlatformBuiltEntityEventFilter}. */ export interface NamePlatformBuiltEntityEventFilter extends BasePlatformBuiltEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPlatformBuiltEntityEventFilter}. */ export interface GhostTypePlatformBuiltEntityEventFilter extends BasePlatformBuiltEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPlatformBuiltEntityEventFilter}. */ export interface GhostNamePlatformBuiltEntityEventFilter extends BasePlatformBuiltEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * `"force"` variant of {@link LuaPlatformBuiltEntityEventFilter}. */ export interface ForcePlatformBuiltEntityEventFilter extends BasePlatformBuiltEntityEventFilter { readonly filter: "force" /** * The entity force */ readonly force: string } /** * Variants of {@link LuaPlatformBuiltEntityEventFilter} with no additional attributes. */ export interface OtherPlatformBuiltEntityEventFilter extends BasePlatformBuiltEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePlatformBuiltEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePlatformBuiltEntityEventFilter} * - `"name"`: {@link NamePlatformBuiltEntityEventFilter} * - `"ghost_type"`: {@link GhostTypePlatformBuiltEntityEventFilter} * - `"ghost_name"`: {@link GhostNamePlatformBuiltEntityEventFilter} * - `"force"`: {@link ForcePlatformBuiltEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPlatformBuiltEntityEventFilter.html Online documentation} */ export type LuaPlatformBuiltEntityEventFilter = | TypePlatformBuiltEntityEventFilter | NamePlatformBuiltEntityEventFilter | GhostTypePlatformBuiltEntityEventFilter | GhostNamePlatformBuiltEntityEventFilter | ForcePlatformBuiltEntityEventFilter | OtherPlatformBuiltEntityEventFilter /** * Common attributes to all variants of {@link LuaPrePlatformMinedEntityEventFilter}. */ export interface BasePrePlatformMinedEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPrePlatformMinedEntityEventFilter}. */ export interface TypePrePlatformMinedEntityEventFilter extends BasePrePlatformMinedEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPrePlatformMinedEntityEventFilter}. */ export interface NamePrePlatformMinedEntityEventFilter extends BasePrePlatformMinedEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPrePlatformMinedEntityEventFilter}. */ export interface GhostTypePrePlatformMinedEntityEventFilter extends BasePrePlatformMinedEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPrePlatformMinedEntityEventFilter}. */ export interface GhostNamePrePlatformMinedEntityEventFilter extends BasePrePlatformMinedEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaPrePlatformMinedEntityEventFilter} with no additional attributes. */ export interface OtherPrePlatformMinedEntityEventFilter extends BasePrePlatformMinedEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePrePlatformMinedEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePrePlatformMinedEntityEventFilter} * - `"name"`: {@link NamePrePlatformMinedEntityEventFilter} * - `"ghost_type"`: {@link GhostTypePrePlatformMinedEntityEventFilter} * - `"ghost_name"`: {@link GhostNamePrePlatformMinedEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPrePlatformMinedEntityEventFilter.html Online documentation} */ export type LuaPrePlatformMinedEntityEventFilter = | TypePrePlatformMinedEntityEventFilter | NamePrePlatformMinedEntityEventFilter | GhostTypePrePlatformMinedEntityEventFilter | GhostNamePrePlatformMinedEntityEventFilter | OtherPrePlatformMinedEntityEventFilter /** * Common attributes to all variants of {@link LuaEntityClonedEventFilter}. */ export interface BaseEntityClonedEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaEntityClonedEventFilter}. */ export interface TypeEntityClonedEventFilter extends BaseEntityClonedEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaEntityClonedEventFilter}. */ export interface NameEntityClonedEventFilter extends BaseEntityClonedEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaEntityClonedEventFilter}. */ export interface GhostTypeEntityClonedEventFilter extends BaseEntityClonedEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaEntityClonedEventFilter}. */ export interface GhostNameEntityClonedEventFilter extends BaseEntityClonedEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaEntityClonedEventFilter} with no additional attributes. */ export interface OtherEntityClonedEventFilter extends BaseEntityClonedEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseEntityClonedEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeEntityClonedEventFilter} * - `"name"`: {@link NameEntityClonedEventFilter} * - `"ghost_type"`: {@link GhostTypeEntityClonedEventFilter} * - `"ghost_name"`: {@link GhostNameEntityClonedEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaEntityClonedEventFilter.html Online documentation} */ export type LuaEntityClonedEventFilter = | TypeEntityClonedEventFilter | NameEntityClonedEventFilter | GhostTypeEntityClonedEventFilter | GhostNameEntityClonedEventFilter | OtherEntityClonedEventFilter /** * Common attributes to all variants of {@link LuaPlayerRepairedEntityEventFilter}. */ export interface BasePlayerRepairedEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPlayerRepairedEntityEventFilter}. */ export interface TypePlayerRepairedEntityEventFilter extends BasePlayerRepairedEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPlayerRepairedEntityEventFilter}. */ export interface NamePlayerRepairedEntityEventFilter extends BasePlayerRepairedEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPlayerRepairedEntityEventFilter}. */ export interface GhostTypePlayerRepairedEntityEventFilter extends BasePlayerRepairedEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPlayerRepairedEntityEventFilter}. */ export interface GhostNamePlayerRepairedEntityEventFilter extends BasePlayerRepairedEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaPlayerRepairedEntityEventFilter} with no additional attributes. */ export interface OtherPlayerRepairedEntityEventFilter extends BasePlayerRepairedEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePlayerRepairedEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePlayerRepairedEntityEventFilter} * - `"name"`: {@link NamePlayerRepairedEntityEventFilter} * - `"ghost_type"`: {@link GhostTypePlayerRepairedEntityEventFilter} * - `"ghost_name"`: {@link GhostNamePlayerRepairedEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPlayerRepairedEntityEventFilter.html Online documentation} */ export type LuaPlayerRepairedEntityEventFilter = | TypePlayerRepairedEntityEventFilter | NamePlayerRepairedEntityEventFilter | GhostTypePlayerRepairedEntityEventFilter | GhostNamePlayerRepairedEntityEventFilter | OtherPlayerRepairedEntityEventFilter /** * Common attributes to all variants of {@link LuaPostEntityDiedEventFilter}. */ export interface BasePostEntityDiedEventFilter { /** * The condition to filter on. */ filter: "ghost" | "type" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPostEntityDiedEventFilter}. */ export interface TypePostEntityDiedEventFilter extends BasePostEntityDiedEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * Variants of {@link LuaPostEntityDiedEventFilter} with no additional attributes. */ export interface OtherPostEntityDiedEventFilter extends BasePostEntityDiedEventFilter { readonly filter: "ghost" } /** * Base attributes: {@link BasePostEntityDiedEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePostEntityDiedEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPostEntityDiedEventFilter.html Online documentation} */ export type LuaPostEntityDiedEventFilter = TypePostEntityDiedEventFilter | OtherPostEntityDiedEventFilter /** * Common attributes to all variants of {@link LuaPreGhostDeconstructedEventFilter}. */ export interface BasePreGhostDeconstructedEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPreGhostDeconstructedEventFilter}. */ export interface TypePreGhostDeconstructedEventFilter extends BasePreGhostDeconstructedEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPreGhostDeconstructedEventFilter}. */ export interface NamePreGhostDeconstructedEventFilter extends BasePreGhostDeconstructedEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPreGhostDeconstructedEventFilter}. */ export interface GhostTypePreGhostDeconstructedEventFilter extends BasePreGhostDeconstructedEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPreGhostDeconstructedEventFilter}. */ export interface GhostNamePreGhostDeconstructedEventFilter extends BasePreGhostDeconstructedEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaPreGhostDeconstructedEventFilter} with no additional attributes. */ export interface OtherPreGhostDeconstructedEventFilter extends BasePreGhostDeconstructedEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePreGhostDeconstructedEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePreGhostDeconstructedEventFilter} * - `"name"`: {@link NamePreGhostDeconstructedEventFilter} * - `"ghost_type"`: {@link GhostTypePreGhostDeconstructedEventFilter} * - `"ghost_name"`: {@link GhostNamePreGhostDeconstructedEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPreGhostDeconstructedEventFilter.html Online documentation} */ export type LuaPreGhostDeconstructedEventFilter = | TypePreGhostDeconstructedEventFilter | NamePreGhostDeconstructedEventFilter | GhostTypePreGhostDeconstructedEventFilter | GhostNamePreGhostDeconstructedEventFilter | OtherPreGhostDeconstructedEventFilter /** * Common attributes to all variants of {@link LuaPlayerMinedEntityEventFilter}. */ export interface BasePlayerMinedEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPlayerMinedEntityEventFilter}. */ export interface TypePlayerMinedEntityEventFilter extends BasePlayerMinedEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPlayerMinedEntityEventFilter}. */ export interface NamePlayerMinedEntityEventFilter extends BasePlayerMinedEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPlayerMinedEntityEventFilter}. */ export interface GhostTypePlayerMinedEntityEventFilter extends BasePlayerMinedEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPlayerMinedEntityEventFilter}. */ export interface GhostNamePlayerMinedEntityEventFilter extends BasePlayerMinedEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaPlayerMinedEntityEventFilter} with no additional attributes. */ export interface OtherPlayerMinedEntityEventFilter extends BasePlayerMinedEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePlayerMinedEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePlayerMinedEntityEventFilter} * - `"name"`: {@link NamePlayerMinedEntityEventFilter} * - `"ghost_type"`: {@link GhostTypePlayerMinedEntityEventFilter} * - `"ghost_name"`: {@link GhostNamePlayerMinedEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPlayerMinedEntityEventFilter.html Online documentation} */ export type LuaPlayerMinedEntityEventFilter = | TypePlayerMinedEntityEventFilter | NamePlayerMinedEntityEventFilter | GhostTypePlayerMinedEntityEventFilter | GhostNamePlayerMinedEntityEventFilter | OtherPlayerMinedEntityEventFilter /** * Common attributes to all variants of {@link LuaSectorScannedEventFilter}. */ export interface BaseSectorScannedEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaSectorScannedEventFilter}. */ export interface TypeSectorScannedEventFilter extends BaseSectorScannedEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaSectorScannedEventFilter}. */ export interface NameSectorScannedEventFilter extends BaseSectorScannedEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaSectorScannedEventFilter}. */ export interface GhostTypeSectorScannedEventFilter extends BaseSectorScannedEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaSectorScannedEventFilter}. */ export interface GhostNameSectorScannedEventFilter extends BaseSectorScannedEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaSectorScannedEventFilter} with no additional attributes. */ export interface OtherSectorScannedEventFilter extends BaseSectorScannedEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseSectorScannedEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeSectorScannedEventFilter} * - `"name"`: {@link NameSectorScannedEventFilter} * - `"ghost_type"`: {@link GhostTypeSectorScannedEventFilter} * - `"ghost_name"`: {@link GhostNameSectorScannedEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaSectorScannedEventFilter.html Online documentation} */ export type LuaSectorScannedEventFilter = | TypeSectorScannedEventFilter | NameSectorScannedEventFilter | GhostTypeSectorScannedEventFilter | GhostNameSectorScannedEventFilter | OtherSectorScannedEventFilter /** * Common attributes to all variants of {@link LuaRobotMinedEntityEventFilter}. */ export interface BaseRobotMinedEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaRobotMinedEntityEventFilter}. */ export interface TypeRobotMinedEntityEventFilter extends BaseRobotMinedEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaRobotMinedEntityEventFilter}. */ export interface NameRobotMinedEntityEventFilter extends BaseRobotMinedEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaRobotMinedEntityEventFilter}. */ export interface GhostTypeRobotMinedEntityEventFilter extends BaseRobotMinedEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaRobotMinedEntityEventFilter}. */ export interface GhostNameRobotMinedEntityEventFilter extends BaseRobotMinedEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaRobotMinedEntityEventFilter} with no additional attributes. */ export interface OtherRobotMinedEntityEventFilter extends BaseRobotMinedEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseRobotMinedEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeRobotMinedEntityEventFilter} * - `"name"`: {@link NameRobotMinedEntityEventFilter} * - `"ghost_type"`: {@link GhostTypeRobotMinedEntityEventFilter} * - `"ghost_name"`: {@link GhostNameRobotMinedEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaRobotMinedEntityEventFilter.html Online documentation} */ export type LuaRobotMinedEntityEventFilter = | TypeRobotMinedEntityEventFilter | NameRobotMinedEntityEventFilter | GhostTypeRobotMinedEntityEventFilter | GhostNameRobotMinedEntityEventFilter | OtherRobotMinedEntityEventFilter /** * Common attributes to all variants of {@link LuaEntityMarkedForDeconstructionEventFilter}. */ export interface BaseEntityMarkedForDeconstructionEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaEntityMarkedForDeconstructionEventFilter}. */ export interface TypeEntityMarkedForDeconstructionEventFilter extends BaseEntityMarkedForDeconstructionEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaEntityMarkedForDeconstructionEventFilter}. */ export interface NameEntityMarkedForDeconstructionEventFilter extends BaseEntityMarkedForDeconstructionEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaEntityMarkedForDeconstructionEventFilter}. */ export interface GhostTypeEntityMarkedForDeconstructionEventFilter extends BaseEntityMarkedForDeconstructionEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaEntityMarkedForDeconstructionEventFilter}. */ export interface GhostNameEntityMarkedForDeconstructionEventFilter extends BaseEntityMarkedForDeconstructionEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaEntityMarkedForDeconstructionEventFilter} with no additional attributes. */ export interface OtherEntityMarkedForDeconstructionEventFilter extends BaseEntityMarkedForDeconstructionEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseEntityMarkedForDeconstructionEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeEntityMarkedForDeconstructionEventFilter} * - `"name"`: {@link NameEntityMarkedForDeconstructionEventFilter} * - `"ghost_type"`: {@link GhostTypeEntityMarkedForDeconstructionEventFilter} * - `"ghost_name"`: {@link GhostNameEntityMarkedForDeconstructionEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaEntityMarkedForDeconstructionEventFilter.html Online documentation} */ export type LuaEntityMarkedForDeconstructionEventFilter = | TypeEntityMarkedForDeconstructionEventFilter | NameEntityMarkedForDeconstructionEventFilter | GhostTypeEntityMarkedForDeconstructionEventFilter | GhostNameEntityMarkedForDeconstructionEventFilter | OtherEntityMarkedForDeconstructionEventFilter /** * Common attributes to all variants of {@link LuaScriptRaisedReviveEventFilter}. */ export interface BaseScriptRaisedReviveEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaScriptRaisedReviveEventFilter}. */ export interface TypeScriptRaisedReviveEventFilter extends BaseScriptRaisedReviveEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaScriptRaisedReviveEventFilter}. */ export interface NameScriptRaisedReviveEventFilter extends BaseScriptRaisedReviveEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaScriptRaisedReviveEventFilter}. */ export interface GhostTypeScriptRaisedReviveEventFilter extends BaseScriptRaisedReviveEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaScriptRaisedReviveEventFilter}. */ export interface GhostNameScriptRaisedReviveEventFilter extends BaseScriptRaisedReviveEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaScriptRaisedReviveEventFilter} with no additional attributes. */ export interface OtherScriptRaisedReviveEventFilter extends BaseScriptRaisedReviveEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseScriptRaisedReviveEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeScriptRaisedReviveEventFilter} * - `"name"`: {@link NameScriptRaisedReviveEventFilter} * - `"ghost_type"`: {@link GhostTypeScriptRaisedReviveEventFilter} * - `"ghost_name"`: {@link GhostNameScriptRaisedReviveEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaScriptRaisedReviveEventFilter.html Online documentation} */ export type LuaScriptRaisedReviveEventFilter = | TypeScriptRaisedReviveEventFilter | NameScriptRaisedReviveEventFilter | GhostTypeScriptRaisedReviveEventFilter | GhostNameScriptRaisedReviveEventFilter | OtherScriptRaisedReviveEventFilter /** * Common attributes to all variants of {@link LuaPlayerBuiltEntityEventFilter}. */ export interface BasePlayerBuiltEntityEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" | "force" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaPlayerBuiltEntityEventFilter}. */ export interface TypePlayerBuiltEntityEventFilter extends BasePlayerBuiltEntityEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaPlayerBuiltEntityEventFilter}. */ export interface NamePlayerBuiltEntityEventFilter extends BasePlayerBuiltEntityEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaPlayerBuiltEntityEventFilter}. */ export interface GhostTypePlayerBuiltEntityEventFilter extends BasePlayerBuiltEntityEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaPlayerBuiltEntityEventFilter}. */ export interface GhostNamePlayerBuiltEntityEventFilter extends BasePlayerBuiltEntityEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * `"force"` variant of {@link LuaPlayerBuiltEntityEventFilter}. */ export interface ForcePlayerBuiltEntityEventFilter extends BasePlayerBuiltEntityEventFilter { readonly filter: "force" /** * The entity force */ readonly force: string } /** * Variants of {@link LuaPlayerBuiltEntityEventFilter} with no additional attributes. */ export interface OtherPlayerBuiltEntityEventFilter extends BasePlayerBuiltEntityEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BasePlayerBuiltEntityEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypePlayerBuiltEntityEventFilter} * - `"name"`: {@link NamePlayerBuiltEntityEventFilter} * - `"ghost_type"`: {@link GhostTypePlayerBuiltEntityEventFilter} * - `"ghost_name"`: {@link GhostNamePlayerBuiltEntityEventFilter} * - `"force"`: {@link ForcePlayerBuiltEntityEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaPlayerBuiltEntityEventFilter.html Online documentation} */ export type LuaPlayerBuiltEntityEventFilter = | TypePlayerBuiltEntityEventFilter | NamePlayerBuiltEntityEventFilter | GhostTypePlayerBuiltEntityEventFilter | GhostNamePlayerBuiltEntityEventFilter | ForcePlayerBuiltEntityEventFilter | OtherPlayerBuiltEntityEventFilter /** * Common attributes to all variants of {@link LuaUpgradeCancelledEventFilter}. */ export interface BaseUpgradeCancelledEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaUpgradeCancelledEventFilter}. */ export interface TypeUpgradeCancelledEventFilter extends BaseUpgradeCancelledEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaUpgradeCancelledEventFilter}. */ export interface NameUpgradeCancelledEventFilter extends BaseUpgradeCancelledEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaUpgradeCancelledEventFilter}. */ export interface GhostTypeUpgradeCancelledEventFilter extends BaseUpgradeCancelledEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaUpgradeCancelledEventFilter}. */ export interface GhostNameUpgradeCancelledEventFilter extends BaseUpgradeCancelledEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaUpgradeCancelledEventFilter} with no additional attributes. */ export interface OtherUpgradeCancelledEventFilter extends BaseUpgradeCancelledEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseUpgradeCancelledEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeUpgradeCancelledEventFilter} * - `"name"`: {@link NameUpgradeCancelledEventFilter} * - `"ghost_type"`: {@link GhostTypeUpgradeCancelledEventFilter} * - `"ghost_name"`: {@link GhostNameUpgradeCancelledEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaUpgradeCancelledEventFilter.html Online documentation} */ export type LuaUpgradeCancelledEventFilter = | TypeUpgradeCancelledEventFilter | NameUpgradeCancelledEventFilter | GhostTypeUpgradeCancelledEventFilter | GhostNameUpgradeCancelledEventFilter | OtherUpgradeCancelledEventFilter /** * Common attributes to all variants of {@link LuaEntityDamagedEventFilter}. */ export interface BaseEntityDamagedEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" | "original-damage-amount" | "final-damage-amount" | "damage-type" | "final-health" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaEntityDamagedEventFilter}. */ export interface TypeEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaEntityDamagedEventFilter}. */ export interface NameEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaEntityDamagedEventFilter}. */ export interface GhostTypeEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaEntityDamagedEventFilter}. */ export interface GhostNameEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * `"original-damage-amount"` variant of {@link LuaEntityDamagedEventFilter}. */ export interface OriginalDamageAmountEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: "original-damage-amount" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: float } export interface OriginalDamageAmountEntityDamagedEventFilterWrite extends BaseEntityDamagedEventFilter { readonly filter: "original-damage-amount" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: float } /** * `"final-damage-amount"` variant of {@link LuaEntityDamagedEventFilter}. */ export interface FinalDamageAmountEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: "final-damage-amount" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: float } export interface FinalDamageAmountEntityDamagedEventFilterWrite extends BaseEntityDamagedEventFilter { readonly filter: "final-damage-amount" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: float } /** * `"damage-type"` variant of {@link LuaEntityDamagedEventFilter}. */ export interface DamageTypeEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: "damage-type" /** * A {@link LuaDamagePrototype} name. */ readonly type: EntityType } /** * `"final-health"` variant of {@link LuaEntityDamagedEventFilter}. */ export interface FinalHealthEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: "final-health" readonly comparison: ComparatorStringRead /** * The value to compare against. */ readonly value: float } export interface FinalHealthEntityDamagedEventFilterWrite extends BaseEntityDamagedEventFilter { readonly filter: "final-health" readonly comparison: ComparatorString /** * The value to compare against. */ readonly value: float } /** * Variants of {@link LuaEntityDamagedEventFilter} with no additional attributes. */ export interface OtherEntityDamagedEventFilter extends BaseEntityDamagedEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseEntityDamagedEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeEntityDamagedEventFilter} * - `"name"`: {@link NameEntityDamagedEventFilter} * - `"ghost_type"`: {@link GhostTypeEntityDamagedEventFilter} * - `"ghost_name"`: {@link GhostNameEntityDamagedEventFilter} * - `"original-damage-amount"`: {@link OriginalDamageAmountEntityDamagedEventFilter} * - `"final-damage-amount"`: {@link FinalDamageAmountEntityDamagedEventFilter} * - `"damage-type"`: {@link DamageTypeEntityDamagedEventFilter} * - `"final-health"`: {@link FinalHealthEntityDamagedEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaEntityDamagedEventFilter.html Online documentation} */ export type LuaEntityDamagedEventFilter = | TypeEntityDamagedEventFilter | NameEntityDamagedEventFilter | GhostTypeEntityDamagedEventFilter | GhostNameEntityDamagedEventFilter | OriginalDamageAmountEntityDamagedEventFilter | FinalDamageAmountEntityDamagedEventFilter | DamageTypeEntityDamagedEventFilter | FinalHealthEntityDamagedEventFilter | OtherEntityDamagedEventFilter /** * Write form of {@link LuaEntityDamagedEventFilter}, where some properties allow additional values as input compared to the read form. * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaEntityDamagedEventFilter.html Online documentation} */ export type LuaEntityDamagedEventFilterWrite = | TypeEntityDamagedEventFilter | NameEntityDamagedEventFilter | GhostTypeEntityDamagedEventFilter | GhostNameEntityDamagedEventFilter | OriginalDamageAmountEntityDamagedEventFilterWrite | FinalDamageAmountEntityDamagedEventFilterWrite | DamageTypeEntityDamagedEventFilter | FinalHealthEntityDamagedEventFilterWrite | OtherEntityDamagedEventFilter /** * Common attributes to all variants of {@link LuaEntityDiedEventFilter}. */ export interface BaseEntityDiedEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaEntityDiedEventFilter}. */ export interface TypeEntityDiedEventFilter extends BaseEntityDiedEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaEntityDiedEventFilter}. */ export interface NameEntityDiedEventFilter extends BaseEntityDiedEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaEntityDiedEventFilter}. */ export interface GhostTypeEntityDiedEventFilter extends BaseEntityDiedEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaEntityDiedEventFilter}. */ export interface GhostNameEntityDiedEventFilter extends BaseEntityDiedEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaEntityDiedEventFilter} with no additional attributes. */ export interface OtherEntityDiedEventFilter extends BaseEntityDiedEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseEntityDiedEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeEntityDiedEventFilter} * - `"name"`: {@link NameEntityDiedEventFilter} * - `"ghost_type"`: {@link GhostTypeEntityDiedEventFilter} * - `"ghost_name"`: {@link GhostNameEntityDiedEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaEntityDiedEventFilter.html Online documentation} */ export type LuaEntityDiedEventFilter = | TypeEntityDiedEventFilter | NameEntityDiedEventFilter | GhostTypeEntityDiedEventFilter | GhostNameEntityDiedEventFilter | OtherEntityDiedEventFilter /** * Common attributes to all variants of {@link LuaEntityMarkedForUpgradeEventFilter}. */ export interface BaseEntityMarkedForUpgradeEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaEntityMarkedForUpgradeEventFilter}. */ export interface TypeEntityMarkedForUpgradeEventFilter extends BaseEntityMarkedForUpgradeEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaEntityMarkedForUpgradeEventFilter}. */ export interface NameEntityMarkedForUpgradeEventFilter extends BaseEntityMarkedForUpgradeEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaEntityMarkedForUpgradeEventFilter}. */ export interface GhostTypeEntityMarkedForUpgradeEventFilter extends BaseEntityMarkedForUpgradeEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaEntityMarkedForUpgradeEventFilter}. */ export interface GhostNameEntityMarkedForUpgradeEventFilter extends BaseEntityMarkedForUpgradeEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaEntityMarkedForUpgradeEventFilter} with no additional attributes. */ export interface OtherEntityMarkedForUpgradeEventFilter extends BaseEntityMarkedForUpgradeEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseEntityMarkedForUpgradeEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeEntityMarkedForUpgradeEventFilter} * - `"name"`: {@link NameEntityMarkedForUpgradeEventFilter} * - `"ghost_type"`: {@link GhostTypeEntityMarkedForUpgradeEventFilter} * - `"ghost_name"`: {@link GhostNameEntityMarkedForUpgradeEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaEntityMarkedForUpgradeEventFilter.html Online documentation} */ export type LuaEntityMarkedForUpgradeEventFilter = | TypeEntityMarkedForUpgradeEventFilter | NameEntityMarkedForUpgradeEventFilter | GhostTypeEntityMarkedForUpgradeEventFilter | GhostNameEntityMarkedForUpgradeEventFilter | OtherEntityMarkedForUpgradeEventFilter /** * Common attributes to all variants of {@link LuaScriptRaisedDestroyEventFilter}. */ export interface BaseScriptRaisedDestroyEventFilter { /** * The condition to filter on. */ readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" | "type" | "name" | "ghost_type" | "ghost_name" /** * How to combine this with the previous filter. Defaults to `"or"`. When evaluating the filters, `"and"` has higher precedence than `"or"`. */ readonly mode?: "or" | "and" /** * Inverts the condition. Default is `false`. */ readonly invert?: boolean } /** * `"type"` variant of {@link LuaScriptRaisedDestroyEventFilter}. */ export interface TypeScriptRaisedDestroyEventFilter extends BaseScriptRaisedDestroyEventFilter { readonly filter: "type" /** * The prototype type. */ readonly type: EntityType } /** * `"name"` variant of {@link LuaScriptRaisedDestroyEventFilter}. */ export interface NameScriptRaisedDestroyEventFilter extends BaseScriptRaisedDestroyEventFilter { readonly filter: "name" /** * The prototype name. */ readonly name: string } /** * `"ghost_type"` variant of {@link LuaScriptRaisedDestroyEventFilter}. */ export interface GhostTypeScriptRaisedDestroyEventFilter extends BaseScriptRaisedDestroyEventFilter { readonly filter: "ghost_type" /** * The ghost prototype type. */ readonly type: EntityType } /** * `"ghost_name"` variant of {@link LuaScriptRaisedDestroyEventFilter}. */ export interface GhostNameScriptRaisedDestroyEventFilter extends BaseScriptRaisedDestroyEventFilter { readonly filter: "ghost_name" /** * The ghost prototype name. */ readonly name: string } /** * Variants of {@link LuaScriptRaisedDestroyEventFilter} with no additional attributes. */ export interface OtherScriptRaisedDestroyEventFilter extends BaseScriptRaisedDestroyEventFilter { readonly filter: | "ghost" | "rail" | "rail-signal" | "rolling-stock" | "robot-with-logistics-interface" | "vehicle" | "turret" | "crafting-machine" | "wall-connectable" | "transport-belt-connectable" | "circuit-network-connectable" } /** * Base attributes: {@link BaseScriptRaisedDestroyEventFilter} * * Other attributes may be specified depending on `filter`: * - `"type"`: {@link TypeScriptRaisedDestroyEventFilter} * - `"name"`: {@link NameScriptRaisedDestroyEventFilter} * - `"ghost_type"`: {@link GhostTypeScriptRaisedDestroyEventFilter} * - `"ghost_name"`: {@link GhostNameScriptRaisedDestroyEventFilter} * @see {@link https://lua-api.factorio.com/2.0.45/concepts/LuaScriptRaisedDestroyEventFilter.html Online documentation} */ export type LuaScriptRaisedDestroyEventFilter = | TypeScriptRaisedDestroyEventFilter | NameScriptRaisedDestroyEventFilter | GhostTypeScriptRaisedDestroyEventFilter | GhostNameScriptRaisedDestroyEventFilter | OtherScriptRaisedDestroyEventFilter export type StyleValuesArray = [topBottom: int, leftRight: int] | [top: int, right: int, bottom: int, left: int] export type SizeArray = [width: int, height: int] export type EventTypeOf = T extends string | LuaCustomInputPrototype ? CustomInputEvent : T extends EventId ? E : T extends LuaCustomEventPrototype ? EventData : never }