factorio-types 1.2.59 → 1.2.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/classes.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.7
5
+ // Factorio version 2.1.8
6
6
  // API version 6
7
7
 
8
8
  declare namespace runtime {
@@ -12427,12 +12427,12 @@ interface LuaGuiElement {
12427
12427
  * The GUI this element is a child of.
12428
12428
  */
12429
12429
  readonly gui: LuaGui;
12430
- hand_send_stacks_to_trash: boolean;
12431
12430
  handle_cursor_split: boolean;
12432
12431
  handle_cursor_transfer: boolean;
12433
12432
  handle_open_item: boolean;
12434
12433
  handle_open_mod_item: boolean;
12435
12434
  handle_send_stack_to_trash: boolean;
12435
+ handle_send_stacks_to_trash: boolean;
12436
12436
  /**
12437
12437
  * Policy of the horizontal scroll bar.
12438
12438
  */
@@ -12922,12 +12922,12 @@ interface LuaGuiElementAddParamsInventory extends BaseLuaGuiElementAddParams {
12922
12922
  */
12923
12923
  'type': 'inventory';
12924
12924
  'empty_slot_info'?: EmptySlotInfo;
12925
- 'hand_send_stacks_to_trash'?: boolean;
12926
12925
  'handle_cursor_split'?: boolean;
12927
12926
  'handle_cursor_transfer'?: boolean;
12928
12927
  'handle_open_item'?: boolean;
12929
12928
  'handle_open_mod_item'?: boolean;
12930
12929
  'handle_send_stack_to_trash'?: boolean;
12930
+ 'handle_send_stacks_to_trash'?: boolean;
12931
12931
  'slots_per_row'?: uint8;
12932
12932
  }
12933
12933
  /**
@@ -19105,9 +19105,11 @@ interface LuaSpacePlatform {
19105
19105
  */
19106
19106
  hidden: boolean;
19107
19107
  /**
19108
- * The hub on this platform. `nil` if the platform has not had the starter pack applied or hub was destroyed but the platform not yet deleted.
19108
+ * The hub on this platform, if it exists. It does not exist if the platform has not had the starter pack applied.
19109
19109
  *
19110
- * If the hub is destroyed the platform will be deleted at the end of the tick but is otherwise valid to use until that point.
19110
+ * If the hub {@link dies | runtime:LuaEntity::die} the platform will be deleted at the end of the tick but is otherwise valid to use until that point.
19111
+ *
19112
+ * If the hub is {@link destroyed | runtime:LuaEntity::destroy} the platform is not affected.
19111
19113
  */
19112
19114
  readonly hub?: LuaEntity;
19113
19115
  /**
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.7
5
+ // Factorio version 2.1.8
6
6
  // API version 6
7
7
 
8
8
  declare namespace runtime {
@@ -3129,7 +3129,7 @@ interface EventData {
3129
3129
  *
3130
3130
  * 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.
3131
3131
  */
3132
- type EventFilter = (LuaEntityClonedEventFilter | LuaEntityDamagedEventFilter | LuaEntityDeconstructionCancelledEventFilter | LuaEntityDiedEventFilter | LuaEntityMarkedForDeconstructionEventFilter | LuaEntityMarkedForUpgradeEventFilter | LuaPlatformBuiltEntityEventFilter | LuaPlatformMinedEntityEventFilter | LuaPlayerBuiltEntityEventFilter | LuaPlayerMinedEntityEventFilter | LuaPlayerRepairedEntityEventFilter | LuaPostEntityDiedEventFilter | LuaPostSegmentedUnitDiedEventFilter | LuaPreGhostDeconstructedEventFilter | LuaPreGhostUpgradedEventFilter | LuaPrePlatformMinedEntityEventFilter | LuaPrePlayerMinedEntityEventFilter | LuaPreRobotMinedEntityEventFilter | LuaRobotBuiltEntityEventFilter | LuaRobotMinedEntityEventFilter | LuaScriptRaisedBuiltEventFilter | LuaScriptRaisedDestroyEventFilter | LuaScriptRaisedDestroySegmentedUnitEventFilter | LuaScriptRaisedReviveEventFilter | LuaScriptRaisedTeleportedEventFilter | LuaSectorScannedEventFilter | LuaSegmentedUnitCreatedEventFilter | LuaSegmentedUnitDamagedEventFilter | LuaSegmentedUnitDiedEventFilter | LuaUpgradeCancelledEventFilter)[];
3132
+ type EventFilter = (LuaSegmentedUnitDiedEventFilter | LuaScriptRaisedTeleportedEventFilter | LuaPreRobotMinedEntityEventFilter | LuaScriptRaisedBuiltEventFilter | LuaPlatformMinedEntityEventFilter | LuaRobotBuiltEntityEventFilter | LuaPrePlayerMinedEntityEventFilter | LuaEntityDeconstructionCancelledEventFilter | LuaPreGhostUpgradedEventFilter | LuaPlatformBuiltEntityEventFilter | LuaPrePlatformMinedEntityEventFilter | LuaEntityClonedEventFilter | LuaPlayerRepairedEntityEventFilter | LuaPostEntityDiedEventFilter | LuaScriptRaisedDestroySegmentedUnitEventFilter | LuaSegmentedUnitDamagedEventFilter | LuaPreGhostDeconstructedEventFilter | LuaPlayerMinedEntityEventFilter | LuaSectorScannedEventFilter | LuaRobotMinedEntityEventFilter | LuaEntityMarkedForDeconstructionEventFilter | LuaPostSegmentedUnitDiedEventFilter | LuaScriptRaisedReviveEventFilter | LuaPlayerBuiltEntityEventFilter | LuaUpgradeCancelledEventFilter | LuaEntityDamagedEventFilter | LuaEntityDiedEventFilter | LuaEntityMarkedForUpgradeEventFilter | LuaSegmentedUnitCreatedEventFilter | LuaScriptRaisedDestroyEventFilter)[];
3133
3133
  interface ExplosionDefinition {
3134
3134
  name: LuaEntityPrototype;
3135
3135
  offset: Vector;
@@ -4700,6 +4700,10 @@ interface LogisticFilter {
4700
4700
  * The space location to import from.
4701
4701
  */
4702
4702
  import_from?: SpaceLocationID;
4703
+ /**
4704
+ * From which sources items should be requested for space platforms. Defaults to `"planet"`.
4705
+ */
4706
+ request_from?: RequestFromLocation;
4703
4707
  }
4704
4708
  type LogisticFilterIndex = uint16;
4705
4709
  interface LogisticGroup {
@@ -6840,7 +6844,7 @@ interface MapAndDifficultySettings {
6840
6844
  }
6841
6845
  interface MapDifficultySettings {
6842
6846
  /**
6843
- * A value in range [0.001, 1000].
6847
+ * A value in range [0.001, 100000].
6844
6848
  */
6845
6849
  technology_price_multiplier: double;
6846
6850
  /**
@@ -7920,7 +7924,7 @@ type PropertyExpressionNames = Record<string, string>;
7920
7924
  *
7921
7925
  * Filters are always used as an array of filters of a specific type. Every filter can only be used with its corresponding prototype type, and different types of prototype filters can not be mixed.
7922
7926
  */
7923
- type PrototypeFilter = (AchievementPrototypeFilter | AsteroidChunkPrototypeFilter | DecorativePrototypeFilter | EquipmentPrototypeFilter | FluidPrototypeFilter | ModSettingPrototypeFilter | RecipePrototypeFilter | SpaceLocationPrototypeFilter | TechnologyPrototypeFilter | TilePrototypeFilter | VirtualSignalPrototypeFilter | EntityPrototypeFilter | ItemPrototypeFilter)[];
7927
+ type PrototypeFilter = (ModSettingPrototypeFilter | SpaceLocationPrototypeFilter | DecorativePrototypeFilter | TilePrototypeFilter | AsteroidChunkPrototypeFilter | ItemPrototypeFilter | TechnologyPrototypeFilter | RecipePrototypeFilter | AchievementPrototypeFilter | VirtualSignalPrototypeFilter | EquipmentPrototypeFilter | FluidPrototypeFilter | EntityPrototypeFilter)[];
7924
7928
  type PrototypeFilterMode = 'none' | 'whitelist' | 'blacklist';
7925
7929
  interface PrototypeHistory {
7926
7930
  /**
@@ -8752,10 +8756,10 @@ interface SavedLogisticFilters {
8752
8756
  sections: SavedLogisticSection[];
8753
8757
  }
8754
8758
  interface SavedLogisticSection {
8755
- group: string;
8756
- filters: LogisticFilter[];
8757
- multiplier: float;
8758
- active: boolean;
8759
+ group?: string;
8760
+ filters?: LogisticFilter[];
8761
+ multiplier?: float;
8762
+ active?: boolean;
8759
8763
  }
8760
8764
  interface ScheduleInterrupt {
8761
8765
  /**
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.7
5
+ // Factorio version 2.1.8
6
6
  // API version 6
7
7
 
8
8
  declare namespace prototype {
package/dist/defines.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.7
5
+ // Factorio version 2.1.8
6
6
  // API version 6
7
7
 
8
8
  declare namespace defines {
package/dist/events.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.7
5
+ // Factorio version 2.1.8
6
6
  // API version 6
7
7
 
8
8
  declare namespace runtime {
package/dist/global.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.7
5
+ // Factorio version 2.1.8
6
6
  // API version 6
7
7
 
8
8
  /**
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.7
5
+ // Factorio version 2.1.8
6
6
  // API version 6
7
7
 
8
8
  declare namespace prototype {
@@ -3583,6 +3583,8 @@ interface EntityPrototype extends Prototype {
3583
3583
  surface_conditions?: SurfaceCondition[];
3584
3584
  /**
3585
3585
  * When this is true, this entity prototype will be translucent and unselectable when "Hide tall entities" mode is active.
3586
+ *
3587
+ * Rail signals are always treated as 'tall' when built attached to elevated rails.
3586
3588
  */
3587
3589
  tall?: boolean;
3588
3590
  tile_buildability_rules?: TileBuildabilityRule[];
package/dist/types.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  // Factorio API reference https://lua-api.factorio.com/latest/index.html
3
3
  // Generated from JSON source https://lua-api.factorio.com/latest/prototype-api.json
4
4
  // Definition source https://github.com/sguest/factorio-types
5
- // Factorio version 2.1.7
5
+ // Factorio version 2.1.8
6
6
  // API version 6
7
7
 
8
8
  declare namespace prototype {
@@ -215,6 +215,9 @@ type Alignment = 'top-left' | 'middle-left' | /**
215
215
  * The same as `"middle-right"`
216
216
  */
217
217
  'right' | 'bottom-right';
218
+ /**
219
+ * Triggered when using the "build ghost" hotkey to build something.
220
+ */
218
221
  interface AlternativeBuildTipTrigger extends CountBasedTipTrigger {
219
222
  type: 'alternative-build';
220
223
  }
@@ -1403,6 +1406,9 @@ VirtualSignalPrototype | /**
1403
1406
  * `'wall'`
1404
1407
  */
1405
1408
  WallPrototype;
1409
+ /**
1410
+ * Triggered when a {@link space platform starter pack | prototype:SpacePlatformStarterPackPrototype} is used to create a space platform.
1411
+ */
1406
1412
  interface ApplyStarterPackTipTrigger extends CountBasedTipTrigger {
1407
1413
  type: 'apply-starter-pack';
1408
1414
  }
@@ -3871,7 +3877,7 @@ interface DifficultySettings {
3871
3877
  */
3872
3878
  spoil_time_modifier?: double;
3873
3879
  /**
3874
- * Must be >= 0.001 and <= 1000.
3880
+ * Must be >= 0.001 and <= 100000.
3875
3881
  */
3876
3882
  technology_price_multiplier?: double;
3877
3883
  }
@@ -4643,7 +4649,13 @@ interface EntityRendererSearchBoxLimits {
4643
4649
  top: uint8;
4644
4650
  }
4645
4651
  type EntityStatus = 'working' | 'normal' | 'ghost' | 'not-plugged-in-electric-network' | 'networks-connected' | 'networks-disconnected' | 'no-ammo' | 'waiting-for-target-to-be-built' | 'waiting-for-train' | 'no-power' | 'low-temperature' | 'charging' | 'discharging' | 'fully-charged' | 'no-fuel' | 'no-food' | 'out-of-logistic-network' | 'no-recipe' | 'no-ingredients' | 'no-input-fluid' | 'no-research-in-progress' | 'no-minable-resources' | 'low-input-fluid' | 'low-power' | 'not-connected-to-rail' | 'cant-divide-segments' | 'recharging-after-power-outage' | 'no-modules-to-transmit' | 'disabled-by-control-behavior' | 'opened-by-circuit-network' | 'closed-by-circuit-network' | 'disabled-by-script' | 'disabled' | 'turned-off-during-daytime' | 'fluid-ingredient-shortage' | 'item-ingredient-shortage' | 'full-output' | 'not-enough-space-in-output' | 'full-burnt-result-output' | 'marked-for-deconstruction' | 'missing-required-fluid' | 'missing-science-packs' | 'waiting-for-source-items' | 'waiting-for-space-in-destination' | 'preparing-rocket-for-launch' | 'waiting-to-launch-rocket' | 'waiting-for-space-in-platform-hub' | 'launching-rocket' | 'thrust-not-required' | 'not-enough-thrust' | 'on-the-way' | 'waiting-in-orbit' | 'waiting-for-rocket-to-arrive' | 'waiting-to-clear-drop-slots' | 'no-path' | 'broken' | 'none' | 'frozen' | 'paused' | 'not-connected-to-hub-or-pad' | 'too-far-from-pad-to-unload' | 'computing-navigation' | 'no-filter' | 'waiting-at-stop' | 'waiting-for-upgrade' | 'destination-stop-full' | 'pipeline-overextended' | 'no-spot-seedable-by-inputs' | 'waiting-for-plants-to-grow' | 'recipe-not-researched' | 'armed';
4652
+ /**
4653
+ * Triggered when a player fast-transfers something to or from an entity, similar to the {@link on_player_fast_transferred | runtime:on_player_fast_transferred} event.
4654
+ */
4646
4655
  interface EntityTransferTipTrigger extends CountBasedTipTrigger {
4656
+ /**
4657
+ * Whether the transfer should be into or out of the player.
4658
+ */
4647
4659
  transfer?: 'in' | 'out';
4648
4660
  type: 'entity-transfer';
4649
4661
  }
@@ -6572,6 +6584,9 @@ interface MainSound {
6572
6584
  */
6573
6585
  volume_smoothing_window_size?: uint32;
6574
6586
  }
6587
+ /**
6588
+ * Triggered when the player manually moves item with the cursor, *without* using shortcuts such as entity transfer or stack split.
6589
+ */
6575
6590
  interface ManualTransferTipTrigger extends CountBasedTipTrigger {
6576
6591
  type: 'manual-transfer';
6577
6592
  }
@@ -9728,6 +9743,9 @@ interface SendSpidertronTipTrigger extends CountBasedTipTrigger {
9728
9743
  type: 'send-spidertron';
9729
9744
  }
9730
9745
  type SendToOrbitMode = 'not-sendable' | 'manual' | 'automated';
9746
+ /**
9747
+ * Triggered when the triggers listed in `triggers` are triggered in order.
9748
+ */
9731
9749
  interface SequenceTipTrigger {
9732
9750
  /**
9733
9751
  * List of triggers to fulfill.
@@ -12697,6 +12715,9 @@ KillTipTrigger;
12697
12715
  interface ToggleRailLayerTipTrigger extends CountBasedTipTrigger {
12698
12716
  type: 'toggle-rail-layer';
12699
12717
  }
12718
+ /**
12719
+ * Triggered when the player turns "alt-mode" on or off.
12720
+ */
12700
12721
  interface ToggleShowEntityInfoTipTrigger extends CountBasedTipTrigger {
12701
12722
  type: 'toggle-show-entity-info';
12702
12723
  }
@@ -13568,6 +13589,9 @@ interface UnlockSpaceLocationModifier extends BaseModifier {
13568
13589
  */
13569
13590
  use_icon_overlay_constant?: boolean;
13570
13591
  }
13592
+ /**
13593
+ * Triggered when using E to confirm a GUI that allows to pick from a certain kind of prototype.
13594
+ */
13571
13595
  interface UseConfirmTipTrigger extends CountBasedTipTrigger {
13572
13596
  type: 'use-confirm';
13573
13597
  }
@@ -14229,6 +14253,9 @@ interface WorkingVisualisation {
14229
14253
  frame_based_on_shift_animation_progress?: boolean;
14230
14254
  light?: LightDefinition;
14231
14255
  mining_drill_scorch_mark?: boolean;
14256
+ /**
14257
+ * Used by {@link MainSound::play_for_working_visualisations | prototype:MainSound::play_for_working_visualisations}, {@link SoundAccent::play_for_working_visualisation | prototype:SoundAccent::play_for_working_visualisation}, {@link FluidBox::enable_working_visualisations | prototype:FluidBox::enable_working_visualisations}, and {@link PipeConnectionDefinition::enable_working_visualisations | prototype:PipeConnectionDefinition::enable_working_visualisations}.
14258
+ */
14232
14259
  name?: string;
14233
14260
  north_animation?: Animation;
14234
14261
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "factorio-types",
3
- "version": "1.2.59",
3
+ "version": "1.2.60",
4
4
  "description": "Typescript declarations for the Factorio mod API",
5
5
  "main": "index.d.ts",
6
6
  "repository": "https://github.com/sguest/factorio-types.git",
@@ -23,7 +23,7 @@
23
23
  "src/**/*.d.ts",
24
24
  "dist/**/*.d.ts"
25
25
  ],
26
- "factorioVersion": "2.1.7",
26
+ "factorioVersion": "2.1.8",
27
27
  "dependencies": {
28
28
  "lua-types": "^2.13.1"
29
29
  },