typed-factorio 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
package/Changelog.md CHANGED
@@ -1,3 +1,7 @@
1
+ # v1.1.0
2
+
3
+ - Updated to factorio version 1.1.59
4
+
1
5
  # v1.0.0
2
6
 
3
7
  - This project now has all the features that was originally planned, and can now guarantee reasonable backwards compatibility for future releases. As such, it now deserves the v1.0.0. Goodbye to [Zer0Ver](http://0ver.org)!
@@ -83,7 +83,7 @@ interface LuaAchievementPrototype {
83
83
  */
84
84
  readonly name: string
85
85
  /**
86
- * Order string of this prototype.
86
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
87
87
  *
88
88
  * {@link https://lua-api.factorio.com/latest/LuaAchievementPrototype.html#LuaAchievementPrototype.order View documentation}
89
89
  */
@@ -120,7 +120,7 @@ interface LuaAmmoCategoryPrototype {
120
120
  */
121
121
  readonly name: string
122
122
  /**
123
- * Order string of this prototype.
123
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
124
124
  *
125
125
  * {@link https://lua-api.factorio.com/latest/LuaAmmoCategoryPrototype.html#LuaAmmoCategoryPrototype.order View documentation}
126
126
  */
@@ -150,10 +150,10 @@ interface LuaAmmoCategoryPrototype {
150
150
  */
151
151
  interface LuaArithmeticCombinatorControlBehavior extends LuaCombinatorControlBehavior {
152
152
  /**
153
- * The arithmetic combinator parameters.
153
+ * This arithmetic combinator's parameters.
154
154
  *
155
155
  * {@link https://lua-api.factorio.com/latest/LuaArithmeticCombinatorControlBehavior.html#LuaArithmeticCombinatorControlBehavior.parameters View documentation}
156
- * @remarks `parameters` may be `nil` in order to clear the parameters.
156
+ * @remarks Writing `nil` clears the combinator's parameters.
157
157
  */
158
158
  parameters: ArithmeticCombinatorParameters
159
159
  /**
@@ -184,7 +184,7 @@ interface LuaAutoplaceControlPrototype {
184
184
  */
185
185
  readonly name: string
186
186
  /**
187
- * Order string of this prototype.
187
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
188
188
  *
189
189
  * {@link https://lua-api.factorio.com/latest/LuaAutoplaceControlPrototype.html#LuaAutoplaceControlPrototype.order View documentation}
190
190
  */
@@ -222,10 +222,11 @@ interface LuaAutoplaceControlPrototype {
222
222
  */
223
223
  interface LuaBootstrap {
224
224
  /**
225
- * Register a callback to be run on mod initialization. This is only called when a new save game is created or when a save file is loaded that previously didn't contain the mod. During it, the mod gets the chance to set up initial values that it will use for its lifetime. It has full access to {@link LuaGameScript} and the `global` table and can change anything about them that it deems appropriate. No other events will be raised for the mod until it has finished this step.
225
+ * Register a function to be run on mod initialization. This is only called when a new save game is created or when a save file is loaded that previously didn't contain the mod. During it, the mod gets the chance to set up initial values that it will use for its lifetime. It has full access to {@link LuaGameScript} and the {@link https://lua-api.factorio.com/latest/Global.html global} table and can change anything about them that it deems appropriate. No other events will be raised for the mod until it has finished this step.
226
226
  *
227
227
  * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_init View documentation}
228
228
  * @param f The handler for this event. Passing `nil` will unregister it.
229
+ * @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
229
230
  * @example Initialize a `players` table in `global` for later use.
230
231
  *
231
232
  * ```
@@ -236,24 +237,26 @@ interface LuaBootstrap {
236
237
  */
237
238
  on_init(f: (() => void) | undefined): void
238
239
  /**
239
- * Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session. It gives the mod the opportunity to do some very specific actions, should it need to. Doing anything other than these three will lead to desyncs, which breaks multiplayer and replay functionality. Access to {@link LuaGameScript} and {@link LuaRendering} is not available. The `global` table can be accessed and is safe to read from, but not write to.
240
+ * Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session. It gives the mod the opportunity to do some very specific actions, should it need to. Doing anything other than these three will lead to desyncs, which breaks multiplayer and replay functionality. Access to {@link LuaGameScript} is not available. The {@link https://lua-api.factorio.com/latest/Global.html global} table can be accessed and is safe to read from, but not write to, as doing so will lead to an error.
240
241
  *
241
- * The only legitimate uses of this event are these three:
242
- * - Re-setup {@link https://www.lua.org/pil/13.html metatables} as they are not persisted through save-load.
243
- * - Re-setup conditional event handlers.
242
+ * The only legitimate uses of this event are the following:
243
+ * - Re-setup {@link https://www.lua.org/pil/13.html metatables} as they are not persisted through the save/load cycle.
244
+ * - Re-setup conditional event handlers, meaning subscribing to an event only when some condition is met to save processing time.
244
245
  * - Create local references to data stored in the {@link https://lua-api.factorio.com/latest/Global.html global} table.
245
246
  *
246
- * For all other purposes, {@link LuaBootstrap#on_init LuaBootstrap::on_init}, {@link LuaBootstrap#on_configuration_changed LuaBootstrap::on_configuration_changed} or migration scripts should be used instead.
247
+ * For all other purposes, {@link LuaBootstrap#on_init LuaBootstrap::on_init}, {@link LuaBootstrap#on_configuration_changed LuaBootstrap::on_configuration_changed} or {@link https://lua-api.factorio.com/latest/Migrations.html migrations} should be used instead.
247
248
  *
248
249
  * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_load View documentation}
249
250
  * @param f The handler for this event. Passing `nil` will unregister it.
251
+ * @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
250
252
  */
251
253
  on_load(f: (() => void) | undefined): void
252
254
  /**
253
- * Register a function to be run when mod configuration changes. This is called when the game version or any mod version changes; when any mod is added or removed; or when prototypes or startup mod settings have changed. It allows the mod to make any changes it deems appropriate to both the data structures in its `global` table or to the game state through {@link LuaGameScript}.
255
+ * Register a function to be run when mod configuration changes. This is called when the major game version or any mod version changed, when any mod was added or removed, when a startup setting has changed, or when any prototypes have been added or removed. It allows the mod to make any changes it deems appropriate to both the data structures in its {@link https://lua-api.factorio.com/latest/Global.html global} table or to the game state through {@link LuaGameScript}.
254
256
  *
255
257
  * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_configuration_changed View documentation}
256
258
  * @param f The handler for this event. Passing `nil` will unregister it.
259
+ * @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
257
260
  */
258
261
  on_configuration_changed(f: ((param1: ConfigurationChangedData) => void) | undefined): void
259
262
  /**
@@ -915,12 +918,12 @@ interface LuaConstantCombinatorControlBehavior extends LuaControlBehavior {
915
918
  */
916
919
  get_signal(index: uint): Signal
917
920
  /**
918
- * The constant combinator parameters
921
+ * This constant combinator's parameters, or `nil` if the {@link LuaEntityPrototype#item_slot_count item_slot_count} of the combinator's prototype is `0`.
919
922
  *
920
923
  * {@link https://lua-api.factorio.com/latest/LuaConstantCombinatorControlBehavior.html#LuaConstantCombinatorControlBehavior.parameters View documentation}
921
- * @remarks Setting to `nil` clears the parameters.
924
+ * @remarks Writing `nil` clears the combinator's parameters.
922
925
  */
923
- parameters: ConstantCombinatorParameters[]
926
+ parameters: ConstantCombinatorParameters[] | undefined
924
927
  /**
925
928
  * Turns this constant combinator on and off.
926
929
  *
@@ -1281,7 +1284,7 @@ interface LuaControl {
1281
1284
  */
1282
1285
  set_personal_logistic_slot(slot_index: uint, value: LogisticParameters): boolean
1283
1286
  /**
1284
- * Sets a vehicle logistic request and auto-trash slot to the given value. Only used on `spider-vehicule`s.
1287
+ * Sets a vehicle logistic request and auto-trash slot to the given value. Only used on `spider-vehicle`.
1285
1288
  *
1286
1289
  * **Raised events:**
1287
1290
  * - {@link OnEntityLogisticSlotChangedEvent on_entity_logistic_slot_changed}? _instantly_ Raised if setting of logistic slot was successful.
@@ -1294,7 +1297,7 @@ interface LuaControl {
1294
1297
  */
1295
1298
  set_vehicle_logistic_slot(slot_index: uint, value: LogisticParameters): boolean
1296
1299
  /**
1297
- * Gets the parameters of a personal logistic request and auto-trash slot.
1300
+ * Gets the parameters of a personal logistic request and auto-trash slot. Only used on `spider-vehicle`.
1298
1301
  *
1299
1302
  * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.get_personal_logistic_slot View documentation}
1300
1303
  * @param slot_index The slot to get.
@@ -1857,7 +1860,7 @@ interface LuaCustomInputPrototype {
1857
1860
  */
1858
1861
  readonly name: string
1859
1862
  /**
1860
- * Order string of this prototype.
1863
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
1861
1864
  *
1862
1865
  * {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.order View documentation}
1863
1866
  */
@@ -2021,7 +2024,7 @@ interface LuaDamagePrototype {
2021
2024
  */
2022
2025
  readonly name: string
2023
2026
  /**
2024
- * Order string of this prototype.
2027
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
2025
2028
  *
2026
2029
  * {@link https://lua-api.factorio.com/latest/LuaDamagePrototype.html#LuaDamagePrototype.order View documentation}
2027
2030
  */
@@ -2056,10 +2059,10 @@ interface LuaDamagePrototype {
2056
2059
  */
2057
2060
  interface LuaDeciderCombinatorControlBehavior extends LuaCombinatorControlBehavior {
2058
2061
  /**
2059
- * The decider combinator parameters
2062
+ * This decider combinator's parameters.
2060
2063
  *
2061
2064
  * {@link https://lua-api.factorio.com/latest/LuaDeciderCombinatorControlBehavior.html#LuaDeciderCombinatorControlBehavior.parameters View documentation}
2062
- * @remarks Setting to `nil` clears the parameters.
2065
+ * @remarks Writing `nil` clears the combinator's parameters.
2063
2066
  */
2064
2067
  parameters: DeciderCombinatorParameters
2065
2068
  /**
@@ -2090,7 +2093,7 @@ interface LuaDecorativePrototype {
2090
2093
  */
2091
2094
  readonly name: string
2092
2095
  /**
2093
- * Order string of this prototype.
2096
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
2094
2097
  *
2095
2098
  * {@link https://lua-api.factorio.com/latest/LuaDecorativePrototype.html#LuaDecorativePrototype.order View documentation}
2096
2099
  */
@@ -2169,7 +2172,7 @@ interface LuaElectricEnergySourcePrototype {
2169
2172
  */
2170
2173
  interface LuaEntity extends LuaControl {
2171
2174
  /**
2172
- * Gets the entities output inventory if it has one.
2175
+ * Gets the entity's output inventory if it has one.
2173
2176
  *
2174
2177
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_output_inventory View documentation}
2175
2178
  * @returns A reference to the entity's output inventory.
@@ -2909,7 +2912,7 @@ interface LuaEntity extends LuaControl {
2909
2912
  */
2910
2913
  set_passenger(passenger: LuaEntity | PlayerIdentification): void
2911
2914
  /**
2912
- * Returns true if this entity is connected to an electric network.
2915
+ * Returns `true` if this entity produces or consumes electricity and is connected to an electric network that has at least one entity that can produce power.
2913
2916
  *
2914
2917
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_connected_to_electric_network View documentation}
2915
2918
  */
@@ -3755,13 +3758,16 @@ interface LuaEntity extends LuaControl {
3755
3758
  */
3756
3759
  kills: uint
3757
3760
  /**
3758
- * The last player that changed any setting on this entity. This includes building the entity, changing its color, or configuring its circuit network. Can be `nil` if the last user is not part of the save anymore. Mods can overwrite it if desired.
3761
+ * The last player that changed any setting on this entity. This includes building the entity, changing its color, or configuring its circuit network. Can be `nil` if the last user is not part of the save anymore.
3762
+ *
3763
+ * Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
3759
3764
  *
3760
3765
  * _Can only be used if this is EntityWithOwner_
3761
3766
  *
3762
3767
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.last_user View documentation}
3763
3768
  */
3764
- last_user: LuaPlayer | undefined
3769
+ get last_user(): LuaPlayer | LuaPlayer | undefined
3770
+ set last_user(value: LuaPlayer | PlayerIdentification | undefined)
3765
3771
  /**
3766
3772
  * The buffer size for the electric energy source or nil if the entity doesn't have an electric energy source.
3767
3773
  *
@@ -4087,14 +4093,19 @@ interface LuaEntity extends LuaControl {
4087
4093
  */
4088
4094
  character_corpse_death_cause: LocalisedString
4089
4095
  /**
4090
- * The player this character is associated with or `nil` if none. When the player logs off in multiplayer all of the associated characters will be logged off with him.
4096
+ * The player this character is associated with, or `nil` if there isn't one. Set to `nil` to clear.
4097
+ *
4098
+ * The player will be automatically disassociated when a controller is set on the character. Also, all characters associated to a player will be logged off when the player logs off in multiplayer.
4099
+ *
4100
+ * Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
4091
4101
  *
4092
4102
  * _Can only be used if this is Character_
4093
4103
  *
4094
4104
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.associated_player View documentation}
4095
- * @remarks A character associated with a player is not directly controlled by any player.<br>Set to `nil` to clear. The player will be automatically disassociated when a controller is set on the character.
4105
+ * @remarks A character associated with a player is not directly controlled by any player.
4096
4106
  */
4097
- associated_player: LuaPlayer | undefined
4107
+ get associated_player(): LuaPlayer | LuaPlayer | undefined
4108
+ set associated_player(value: LuaPlayer | PlayerIdentification | undefined)
4098
4109
  /**
4099
4110
  * The last tick this character entity was attacked.
4100
4111
  *
@@ -4240,9 +4251,12 @@ interface LuaEntity extends LuaControl {
4240
4251
  /**
4241
4252
  * The player that this `simple-entity-with-owner`, `simple-entity-with-force`, `flying-text`, or `highlight-box` is visible to. `nil` means it is rendered for every player.
4242
4253
  *
4254
+ * Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
4255
+ *
4243
4256
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_player View documentation}
4244
4257
  */
4245
- render_player: LuaPlayer | undefined
4258
+ get render_player(): LuaPlayer | LuaPlayer | undefined
4259
+ set render_player(value: LuaPlayer | PlayerIdentification | undefined)
4246
4260
  /**
4247
4261
  * The forces that this `simple-entity-with-owner`, `simple-entity-with-force`, or `flying-text` is visible to. `nil` or an empty array means it is rendered for every force.
4248
4262
  *
@@ -4486,7 +4500,7 @@ interface LuaEntity extends LuaControl {
4486
4500
  */
4487
4501
  interface BaseEntity extends LuaControl {
4488
4502
  /**
4489
- * Gets the entities output inventory if it has one.
4503
+ * Gets the entity's output inventory if it has one.
4490
4504
  *
4491
4505
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_output_inventory View documentation}
4492
4506
  * @returns A reference to the entity's output inventory.
@@ -4876,7 +4890,7 @@ interface BaseEntity extends LuaControl {
4876
4890
  readonly force?: LuaForce | string
4877
4891
  }): LuaMultiReturn<[boolean, Record<string, uint> | undefined]>
4878
4892
  /**
4879
- * Returns true if this entity is connected to an electric network.
4893
+ * Returns `true` if this entity produces or consumes electricity and is connected to an electric network that has at least one entity that can produce power.
4880
4894
  *
4881
4895
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_connected_to_electric_network View documentation}
4882
4896
  */
@@ -5556,9 +5570,12 @@ interface BaseEntity extends LuaControl {
5556
5570
  /**
5557
5571
  * The player that this `simple-entity-with-owner`, `simple-entity-with-force`, `flying-text`, or `highlight-box` is visible to. `nil` means it is rendered for every player.
5558
5572
  *
5573
+ * Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
5574
+ *
5559
5575
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_player View documentation}
5560
5576
  */
5561
- render_player: LuaPlayer | undefined
5577
+ get render_player(): LuaPlayer | LuaPlayer | undefined
5578
+ set render_player(value: LuaPlayer | PlayerIdentification | undefined)
5562
5579
  /**
5563
5580
  * The forces that this `simple-entity-with-owner`, `simple-entity-with-force`, or `flying-text` is visible to. `nil` or an empty array means it is rendered for every force.
5564
5581
  *
@@ -6718,14 +6735,19 @@ interface CharacterEntity extends BaseEntity {
6718
6735
  */
6719
6736
  readonly player: LuaPlayer | undefined
6720
6737
  /**
6721
- * The player this character is associated with or `nil` if none. When the player logs off in multiplayer all of the associated characters will be logged off with him.
6738
+ * The player this character is associated with, or `nil` if there isn't one. Set to `nil` to clear.
6739
+ *
6740
+ * The player will be automatically disassociated when a controller is set on the character. Also, all characters associated to a player will be logged off when the player logs off in multiplayer.
6741
+ *
6742
+ * Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
6722
6743
  *
6723
6744
  * _Can only be used if this is Character_
6724
6745
  *
6725
6746
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.associated_player View documentation}
6726
- * @remarks A character associated with a player is not directly controlled by any player.<br>Set to `nil` to clear. The player will be automatically disassociated when a controller is set on the character.
6747
+ * @remarks A character associated with a player is not directly controlled by any player.
6727
6748
  */
6728
- associated_player: LuaPlayer | undefined
6749
+ get associated_player(): LuaPlayer | LuaPlayer | undefined
6750
+ set associated_player(value: LuaPlayer | PlayerIdentification | undefined)
6729
6751
  /**
6730
6752
  * The last tick this character entity was attacked.
6731
6753
  *
@@ -6825,13 +6847,16 @@ interface TurretEntity extends BaseEntity {
6825
6847
 
6826
6848
  interface EntityWithOwnerEntity extends BaseEntity {
6827
6849
  /**
6828
- * The last player that changed any setting on this entity. This includes building the entity, changing its color, or configuring its circuit network. Can be `nil` if the last user is not part of the save anymore. Mods can overwrite it if desired.
6850
+ * The last player that changed any setting on this entity. This includes building the entity, changing its color, or configuring its circuit network. Can be `nil` if the last user is not part of the save anymore.
6851
+ *
6852
+ * Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
6829
6853
  *
6830
6854
  * _Can only be used if this is EntityWithOwner_
6831
6855
  *
6832
6856
  * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.last_user View documentation}
6833
6857
  */
6834
- last_user: LuaPlayer | undefined
6858
+ get last_user(): LuaPlayer | LuaPlayer | undefined
6859
+ set last_user(value: LuaPlayer | PlayerIdentification | undefined)
6835
6860
  }
6836
6861
 
6837
6862
  interface ElectricEnergyInterfaceEntity extends BaseEntity {
@@ -7186,7 +7211,7 @@ interface LuaEntityPrototype {
7186
7211
  */
7187
7212
  readonly default_collision_mask_with_flags: CollisionMaskWithFlags
7188
7213
  /**
7189
- * Order string of this prototype.
7214
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
7190
7215
  *
7191
7216
  * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.order View documentation}
7192
7217
  */
@@ -8575,7 +8600,7 @@ interface BaseEntityPrototype {
8575
8600
  */
8576
8601
  readonly default_collision_mask_with_flags: CollisionMaskWithFlags
8577
8602
  /**
8578
- * Order string of this prototype.
8603
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
8579
8604
  *
8580
8605
  * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.order View documentation}
8581
8606
  */
@@ -9936,7 +9961,7 @@ interface LuaEquipmentCategoryPrototype {
9936
9961
  */
9937
9962
  readonly name: string
9938
9963
  /**
9939
- * Order string of this prototype.
9964
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
9940
9965
  *
9941
9966
  * {@link https://lua-api.factorio.com/latest/LuaEquipmentCategoryPrototype.html#LuaEquipmentCategoryPrototype.order View documentation}
9942
9967
  */
@@ -10154,7 +10179,7 @@ interface LuaEquipmentGridPrototype {
10154
10179
  */
10155
10180
  readonly name: string
10156
10181
  /**
10157
- * Order string of this prototype.
10182
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
10158
10183
  *
10159
10184
  * {@link https://lua-api.factorio.com/latest/LuaEquipmentGridPrototype.html#LuaEquipmentGridPrototype.order View documentation}
10160
10185
  */
@@ -10209,7 +10234,7 @@ interface LuaEquipmentPrototype {
10209
10234
  */
10210
10235
  readonly type: string
10211
10236
  /**
10212
- * Order string of this prototype.
10237
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
10213
10238
  *
10214
10239
  * {@link https://lua-api.factorio.com/latest/LuaEquipmentPrototype.html#LuaEquipmentPrototype.order View documentation}
10215
10240
  */
@@ -10719,7 +10744,7 @@ interface LuaFluidPrototype {
10719
10744
  */
10720
10745
  readonly heat_capacity: double
10721
10746
  /**
10722
- * Order string for this prototype.
10747
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
10723
10748
  *
10724
10749
  * {@link https://lua-api.factorio.com/latest/LuaFluidPrototype.html#LuaFluidPrototype.order View documentation}
10725
10750
  */
@@ -11546,7 +11571,7 @@ interface LuaFuelCategoryPrototype {
11546
11571
  */
11547
11572
  readonly name: string
11548
11573
  /**
11549
- * Order string of this prototype.
11574
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
11550
11575
  *
11551
11576
  * {@link https://lua-api.factorio.com/latest/LuaFuelCategoryPrototype.html#LuaFuelCategoryPrototype.order View documentation}
11552
11577
  */
@@ -12279,7 +12304,9 @@ interface LuaGameScript {
12279
12304
  */
12280
12305
  decode_string(string: string): string | undefined
12281
12306
  /**
12282
- * The player typing at the console - `nil` in all other instances. See {@link LuaGameScript#players LuaGameScript::players} for accessing all players.
12307
+ * This property is only populated inside {@link LuaCommandProcessor custom command} handlers and when writing {@link https://wiki.factorio.com/Console#Scripting_and_cheat_commands Lua console commands}. Returns the player that is typing the command, `nil` in all other instances.
12308
+ *
12309
+ * See {@link LuaGameScript#players LuaGameScript::players} for accessing all players.
12283
12310
  *
12284
12311
  * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.player View documentation}
12285
12312
  */
@@ -12727,6 +12754,11 @@ interface LuaGroup {
12727
12754
  * @remarks Can only be used on groups, not on subgroups.
12728
12755
  */
12729
12756
  readonly order_in_recipe: string
12757
+ /**
12758
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
12759
+ *
12760
+ * {@link https://lua-api.factorio.com/latest/LuaGroup.html#LuaGroup.order View documentation}
12761
+ */
12730
12762
  readonly order: string
12731
12763
  /**
12732
12764
  * Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
@@ -13585,20 +13617,7 @@ interface ChooseElemButtonGuiElementMembers extends BaseGuiElement {
13585
13617
  */
13586
13618
  elem_value: (this["elem_type"] extends "signal" ? SignalID : string) | undefined
13587
13619
  /**
13588
- * The elem filters of this choose-elem-button or `nil` if there are no filters.
13589
- *
13590
- * The compatible type of filter is determined by elem_type:
13591
- * - Type `"item"` - {@link ItemPrototypeFilter}
13592
- * - Type `"tile"` - {@link TilePrototypeFilter}
13593
- * - Type `"entity"` - {@link EntityPrototypeFilter}
13594
- * - Type `"signal"` - Does not support filters
13595
- * - Type `"fluid"` - {@link FluidPrototypeFilter}
13596
- * - Type `"recipe"` - {@link RecipePrototypeFilter}
13597
- * - Type `"decorative"` - {@link DecorativePrototypeFilter}
13598
- * - Type `"item-group"` - Does not support filters
13599
- * - Type `"achievement"` - {@link AchievementPrototypeFilter}
13600
- * - Type `"equipment"` - {@link EquipmentPrototypeFilter}
13601
- * - Type `"technology"` - {@link TechnologyPrototypeFilter}
13620
+ * The elem filters of this choose-elem-button, or `nil` if there are no filters. The compatible type of filter is determined by `elem_type`.
13602
13621
  *
13603
13622
  * _Can only be used if this is choose-elem-button_
13604
13623
  *
@@ -15223,7 +15242,7 @@ interface LuaItemPrototype {
15223
15242
  readonly localised_name: LocalisedString
15224
15243
  readonly localised_description: LocalisedString
15225
15244
  /**
15226
- * Order string.
15245
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
15227
15246
  *
15228
15247
  * {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.order View documentation}
15229
15248
  */
@@ -15461,13 +15480,13 @@ interface LuaItemPrototype {
15461
15480
  */
15462
15481
  readonly speed: float | undefined
15463
15482
  /**
15464
- * Effects of this module; `nil` if this is not a module.
15483
+ * Effects of this module.
15465
15484
  *
15466
15485
  * _Can only be used if this is ModuleItem_
15467
15486
  *
15468
15487
  * {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.module_effects View documentation}
15469
15488
  */
15470
- readonly module_effects: ModuleEffects | undefined
15489
+ readonly module_effects: ModuleEffects
15471
15490
  /**
15472
15491
  * The name of a {@link LuaModuleCategoryPrototype}. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.
15473
15492
  *
@@ -15816,7 +15835,7 @@ interface BaseItemPrototype {
15816
15835
  readonly localised_name: LocalisedString
15817
15836
  readonly localised_description: LocalisedString
15818
15837
  /**
15819
- * Order string.
15838
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
15820
15839
  *
15821
15840
  * {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.order View documentation}
15822
15841
  */
@@ -16078,13 +16097,13 @@ interface ItemWithLabelItemPrototype extends BaseItemPrototype {
16078
16097
 
16079
16098
  interface ModuleItemPrototype extends BaseItemPrototype {
16080
16099
  /**
16081
- * Effects of this module; `nil` if this is not a module.
16100
+ * Effects of this module.
16082
16101
  *
16083
16102
  * _Can only be used if this is ModuleItem_
16084
16103
  *
16085
16104
  * {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.module_effects View documentation}
16086
16105
  */
16087
- readonly module_effects: ModuleEffects | undefined
16106
+ readonly module_effects: ModuleEffects
16088
16107
  /**
16089
16108
  * The name of a {@link LuaModuleCategoryPrototype}. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.
16090
16109
  *
@@ -16484,8 +16503,8 @@ interface LuaItemStack {
16484
16503
  * Set this item stack to another item stack.
16485
16504
  *
16486
16505
  * {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.set_stack View documentation}
16487
- * @param stack Item stack to set this one to. Omitting this parameter or passing `nil` will clear this item stack, as if by calling {@link LuaItemStack#clear LuaItemStack::clear}.
16488
- * @returns Was the stack set successfully?
16506
+ * @param stack Item stack to set it to. Omitting this parameter or passing `nil` will clear this item stack, as if {@link LuaItemStack#clear LuaItemStack::clear} was called.
16507
+ * @returns Whether the stack was set successfully. Returns `false` if this stack was not {@link LuaItemStack#can_set_stack valid for write}.
16489
16508
  */
16490
16509
  set_stack(stack?: ItemStackIdentification): boolean
16491
16510
  /**
@@ -17219,8 +17238,8 @@ interface BaseItemStack {
17219
17238
  * Set this item stack to another item stack.
17220
17239
  *
17221
17240
  * {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.set_stack View documentation}
17222
- * @param stack Item stack to set this one to. Omitting this parameter or passing `nil` will clear this item stack, as if by calling {@link LuaItemStack#clear LuaItemStack::clear}.
17223
- * @returns Was the stack set successfully?
17241
+ * @param stack Item stack to set it to. Omitting this parameter or passing `nil` will clear this item stack, as if {@link LuaItemStack#clear LuaItemStack::clear} was called.
17242
+ * @returns Whether the stack was set successfully. Returns `false` if this stack was not {@link LuaItemStack#can_set_stack valid for write}.
17224
17243
  */
17225
17244
  set_stack(stack?: ItemStackIdentification): boolean
17226
17245
  /**
@@ -18619,7 +18638,7 @@ interface LuaModSettingPrototype {
18619
18638
  */
18620
18639
  readonly name: string
18621
18640
  /**
18622
- * Order string of this prototype.
18641
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
18623
18642
  *
18624
18643
  * {@link https://lua-api.factorio.com/latest/LuaModSettingPrototype.html#LuaModSettingPrototype.order View documentation}
18625
18644
  */
@@ -18703,7 +18722,7 @@ interface LuaModuleCategoryPrototype {
18703
18722
  */
18704
18723
  readonly name: string
18705
18724
  /**
18706
- * Order string of this prototype.
18725
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
18707
18726
  *
18708
18727
  * {@link https://lua-api.factorio.com/latest/LuaModuleCategoryPrototype.html#LuaModuleCategoryPrototype.order View documentation}
18709
18728
  */
@@ -18738,7 +18757,7 @@ interface LuaNamedNoiseExpression {
18738
18757
  */
18739
18758
  readonly name: string
18740
18759
  /**
18741
- * Order string of this prototype.
18760
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
18742
18761
  *
18743
18762
  * {@link https://lua-api.factorio.com/latest/LuaNamedNoiseExpression.html#LuaNamedNoiseExpression.order View documentation}
18744
18763
  */
@@ -18785,7 +18804,7 @@ interface LuaNoiseLayerPrototype {
18785
18804
  */
18786
18805
  readonly name: string
18787
18806
  /**
18788
- * Order string of this prototype.
18807
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
18789
18808
  *
18790
18809
  * {@link https://lua-api.factorio.com/latest/LuaNoiseLayerPrototype.html#LuaNoiseLayerPrototype.order View documentation}
18791
18810
  */
@@ -18820,7 +18839,7 @@ interface LuaParticlePrototype {
18820
18839
  */
18821
18840
  readonly name: string
18822
18841
  /**
18823
- * Order string of this prototype.
18842
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
18824
18843
  *
18825
18844
  * {@link https://lua-api.factorio.com/latest/LuaParticlePrototype.html#LuaParticlePrototype.order View documentation}
18826
18845
  */
@@ -19595,7 +19614,7 @@ interface LuaPlayer extends LuaControl {
19595
19614
  */
19596
19615
  readonly cutscene_character: LuaEntity | undefined
19597
19616
  /**
19598
- * This player's index in {@link LuaGameScript#players LuaGameScript::players}.
19617
+ * This player's unique index in {@link LuaGameScript#players LuaGameScript::players}. It is given to them when they are {@link OnPlayerCreatedEvent created} and remains assigned to them until they are {@link OnPlayerRemovedEvent removed}.
19599
19618
  *
19600
19619
  * {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.index View documentation}
19601
19620
  */
@@ -20143,7 +20162,7 @@ interface LuaRecipe {
20143
20162
  */
20144
20163
  readonly energy: double
20145
20164
  /**
20146
- * Order string. This is used to sort the crafting menu.
20165
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
20147
20166
  *
20148
20167
  * {@link https://lua-api.factorio.com/latest/LuaRecipe.html#LuaRecipe.order View documentation}
20149
20168
  */
@@ -20194,7 +20213,7 @@ interface LuaRecipeCategoryPrototype {
20194
20213
  */
20195
20214
  readonly name: string
20196
20215
  /**
20197
- * Order string of this prototype.
20216
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
20198
20217
  *
20199
20218
  * {@link https://lua-api.factorio.com/latest/LuaRecipeCategoryPrototype.html#LuaRecipeCategoryPrototype.order View documentation}
20200
20219
  */
@@ -20296,7 +20315,7 @@ interface LuaRecipePrototype {
20296
20315
  */
20297
20316
  readonly energy: double
20298
20317
  /**
20299
- * Order string. This is used to sort the crafting menu.
20318
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
20300
20319
  *
20301
20320
  * {@link https://lua-api.factorio.com/latest/LuaRecipePrototype.html#LuaRecipePrototype.order View documentation}
20302
20321
  */
@@ -21793,7 +21812,7 @@ interface LuaResourceCategoryPrototype {
21793
21812
  */
21794
21813
  readonly name: string
21795
21814
  /**
21796
- * Order string of this prototype.
21815
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
21797
21816
  *
21798
21817
  * {@link https://lua-api.factorio.com/latest/LuaResourceCategoryPrototype.html#LuaResourceCategoryPrototype.order View documentation}
21799
21818
  */
@@ -21907,7 +21926,7 @@ interface LuaShortcutPrototype {
21907
21926
  */
21908
21927
  readonly name: string
21909
21928
  /**
21910
- * Order string of this prototype.
21929
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
21911
21930
  *
21912
21931
  * {@link https://lua-api.factorio.com/latest/LuaShortcutPrototype.html#LuaShortcutPrototype.order View documentation}
21913
21932
  */
@@ -22161,7 +22180,7 @@ interface LuaStyle {
22161
22180
  /**
22162
22181
  * Horizontal space between individual cells.
22163
22182
  *
22164
- * _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlow_
22183
+ * _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
22165
22184
  *
22166
22185
  * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
22167
22186
  */
@@ -22336,13 +22355,13 @@ interface LuaStyle {
22336
22355
  */
22337
22356
  set cell_padding(value: int)
22338
22357
  /**
22339
- * Sets extra_top/right/bottom/left_padding_when_actived to this value. An array with two values sets top/bottom padding to the first value and left/right padding to the second value. An array with four values sets top, right, bottom, left padding respectively.
22358
+ * Sets `extra_top/right/bottom/left_padding_when_activated` to this value. An array with two values sets top/bottom padding to the first value and left/right padding to the second value. An array with four values sets top, right, bottom, left padding respectively.
22340
22359
  *
22341
22360
  * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_padding_when_activated View documentation}
22342
22361
  */
22343
22362
  set extra_padding_when_activated(value: int | StyleValuesArray)
22344
22363
  /**
22345
- * Sets extra_top/right/bottom/left_margin_when_activated to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
22364
+ * Sets `extra_top/right/bottom/left_margin_when_activated` to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
22346
22365
  *
22347
22366
  * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_margin_when_activated View documentation}
22348
22367
  */
@@ -22551,7 +22570,7 @@ interface TableStyle extends BaseStyle {
22551
22570
  /**
22552
22571
  * Horizontal space between individual cells.
22553
22572
  *
22554
- * _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlow_
22573
+ * _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
22555
22574
  *
22556
22575
  * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
22557
22576
  */
@@ -22725,7 +22744,7 @@ interface FlowStyle extends BaseStyle {
22725
22744
  /**
22726
22745
  * Horizontal space between individual cells.
22727
22746
  *
22728
- * _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlow_
22747
+ * _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
22729
22748
  *
22730
22749
  * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
22731
22750
  */
@@ -22744,7 +22763,7 @@ interface HorizontalFlowStyle extends BaseStyle {
22744
22763
  /**
22745
22764
  * Horizontal space between individual cells.
22746
22765
  *
22747
- * _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlow_
22766
+ * _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
22748
22767
  *
22749
22768
  * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
22750
22769
  */
@@ -22848,13 +22867,13 @@ interface ScrollPaneStyle extends BaseStyle {
22848
22867
  */
22849
22868
  extra_right_margin_when_activated: int
22850
22869
  /**
22851
- * Sets extra_top/right/bottom/left_padding_when_actived to this value. An array with two values sets top/bottom padding to the first value and left/right padding to the second value. An array with four values sets top, right, bottom, left padding respectively.
22870
+ * Sets `extra_top/right/bottom/left_padding_when_activated` to this value. An array with two values sets top/bottom padding to the first value and left/right padding to the second value. An array with four values sets top, right, bottom, left padding respectively.
22852
22871
  *
22853
22872
  * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_padding_when_activated View documentation}
22854
22873
  */
22855
22874
  set extra_padding_when_activated(value: int | StyleValuesArray)
22856
22875
  /**
22857
- * Sets extra_top/right/bottom/left_margin_when_activated to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
22876
+ * Sets `extra_top/right/bottom/left_margin_when_activated` to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
22858
22877
  *
22859
22878
  * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_margin_when_activated View documentation}
22860
22879
  */
@@ -22890,11 +22909,11 @@ interface BaseSurfaceCreateEntity {
22890
22909
  /**
22891
22910
  * Entity with health for the new entity to target.
22892
22911
  */
22893
- readonly target?: LuaEntity
22912
+ readonly target?: LuaEntity | MapPosition
22894
22913
  /**
22895
22914
  * Source entity. Used for beams and highlight-boxes.
22896
22915
  */
22897
- readonly source?: LuaEntity
22916
+ readonly source?: LuaEntity | MapPosition
22898
22917
  /**
22899
22918
  * If true, building will attempt to simulate fast-replace building.
22900
22919
  */
@@ -23268,7 +23287,10 @@ interface LuaSurface {
23268
23287
  *
23269
23288
  * If no filters (`name`, `type`, `force`, etc.) are given, this returns all entities in the search area. If multiple filters are specified, only entities matching all given filters are returned.
23270
23289
  *
23271
- * If no `area` or `position` are given, the entire surface is searched. If `position` is given, this returns the entities colliding with that position (i.e the given position is within the entity's collision box). If `position` and `radius` are given, this returns the entities within the radius of the position. If `area` is specified, this returns the entities colliding with that area.
23290
+ * - If no `area` or `position` are given, the entire surface is searched.
23291
+ * - If `position` is given, this returns the entities colliding with that position (i.e the given position is within the entity's collision box).
23292
+ * - If `position` and `radius` are given, this returns the entities within the radius of the position. Looks for the center of entities.
23293
+ * - If `area` is specified, this returns the entities colliding with that area.
23272
23294
  *
23273
23295
  * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entities_filtered View documentation}
23274
23296
  * @example
@@ -23288,9 +23310,6 @@ interface LuaSurface {
23288
23310
  * Has precedence over area field.
23289
23311
  */
23290
23312
  readonly position?: MapPosition
23291
- /**
23292
- * If given with position, will return all entities within the radius of the position.
23293
- */
23294
23313
  readonly radius?: double
23295
23314
  readonly name?: string | readonly string[]
23296
23315
  readonly type?: string | readonly string[]
@@ -23304,7 +23323,7 @@ interface LuaSurface {
23304
23323
  readonly limit?: uint
23305
23324
  readonly is_military_target?: boolean
23306
23325
  /**
23307
- * If the filters should be inverted.
23326
+ * Whether the filters should be inverted.
23308
23327
  */
23309
23328
  readonly invert?: boolean
23310
23329
  }): LuaEntity[]
@@ -24597,7 +24616,7 @@ interface LuaTechnology {
24597
24616
  */
24598
24617
  readonly research_unit_energy: double
24599
24618
  /**
24600
- * Order string for this prototype.
24619
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
24601
24620
  *
24602
24621
  * {@link https://lua-api.factorio.com/latest/LuaTechnology.html#LuaTechnology.order View documentation}
24603
24622
  */
@@ -24711,7 +24730,7 @@ interface LuaTechnologyPrototype {
24711
24730
  */
24712
24731
  readonly research_unit_energy: double
24713
24732
  /**
24714
- * Order string for this prototype.
24733
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
24715
24734
  *
24716
24735
  * {@link https://lua-api.factorio.com/latest/LuaTechnologyPrototype.html#LuaTechnologyPrototype.order View documentation}
24717
24736
  */
@@ -24850,7 +24869,7 @@ interface LuaTilePrototype {
24850
24869
  */
24851
24870
  readonly name: string
24852
24871
  /**
24853
- * Order string of this prototype.
24872
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
24854
24873
  *
24855
24874
  * {@link https://lua-api.factorio.com/latest/LuaTilePrototype.html#LuaTilePrototype.order View documentation}
24856
24875
  */
@@ -25465,7 +25484,7 @@ interface LuaTrivialSmokePrototype {
25465
25484
  */
25466
25485
  readonly name: string
25467
25486
  /**
25468
- * Order string of this prototype.
25487
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
25469
25488
  *
25470
25489
  * {@link https://lua-api.factorio.com/latest/LuaTrivialSmokePrototype.html#LuaTrivialSmokePrototype.order View documentation}
25471
25490
  */
@@ -25626,7 +25645,7 @@ interface LuaVirtualSignalPrototype {
25626
25645
  */
25627
25646
  readonly name: string
25628
25647
  /**
25629
- * Order string of this prototype.
25648
+ * The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
25630
25649
  *
25631
25650
  * {@link https://lua-api.factorio.com/latest/LuaVirtualSignalPrototype.html#LuaVirtualSignalPrototype.order View documentation}
25632
25651
  */
@@ -11,7 +11,7 @@
11
11
  *
12
12
  * As a special case, when the key is just the empty string, all the parameters will be concatenated (after processing, if any are localised strings). If there is only one parameter, it will be used as is.
13
13
  *
14
- * 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 or boolean, which will be converted to their textual representation.
14
+ * 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.
15
15
  *
16
16
  * {@link https://lua-api.factorio.com/latest/Concepts.html#LocalisedString View documentation}
17
17
  * @example In the English translation, this will print `"No ammo"`; in the Czech translation, it will print `"Bez munice"`:
@@ -280,7 +280,7 @@ type BoundingBoxArray = readonly [left_top: MapPosition, right_bottom: MapPositi
280
280
  * @example Explicit definition:
281
281
  *
282
282
  * ```
283
- * {left_top = {-2, -3}, right_bottom = {5, 8}}
283
+ * {left_top = {x = -2, y = -3}, right_bottom = {x = 5, y = 8}}
284
284
  * ```
285
285
  * @example Shorthand:
286
286
  *
@@ -1611,20 +1611,6 @@ type MapGenSize =
1611
1611
  | "very-big"
1612
1612
  | "very-good"
1613
1613
 
1614
- interface AutoplaceSetting {
1615
- readonly frequency: MapGenSize
1616
- readonly size: MapGenSize
1617
- readonly richness: MapGenSize
1618
- }
1619
-
1620
- interface AutoplaceSettings {
1621
- /**
1622
- * Whether missing autoplace names for this type should be default enabled.
1623
- */
1624
- readonly treat_missing_as_default: boolean
1625
- readonly settings: Record<string, AutoplaceSetting>
1626
- }
1627
-
1628
1614
  interface AutoplaceControl {
1629
1615
  /**
1630
1616
  * 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' (similar to terrain_segmentation). When the {@link LuaAutoplaceControlPrototype} is of the category `"terrain"`, then scale is shown in the map generator GUI instead of frequency.
@@ -1640,6 +1626,14 @@ interface AutoplaceControl {
1640
1626
  readonly richness: MapGenSize
1641
1627
  }
1642
1628
 
1629
+ interface AutoplaceSettings {
1630
+ /**
1631
+ * Whether missing autoplace names for this type should be default enabled.
1632
+ */
1633
+ readonly treat_missing_as_default: boolean
1634
+ readonly settings: Record<string, AutoplaceControl>
1635
+ }
1636
+
1643
1637
  interface CliffPlacementSettings {
1644
1638
  /**
1645
1639
  * Name of the cliff prototype.
@@ -1758,6 +1752,26 @@ interface MapGenSettingsRead extends MapGenSettings {
1758
1752
  readonly starting_points: MapPositionTable[]
1759
1753
  }
1760
1754
 
1755
+ interface AdvancedMapGenSettings {
1756
+ readonly pollution: PollutionMapSettings
1757
+ readonly enemy_evolution: EnemyEvolutionMapSettings
1758
+ readonly enemy_expansion: EnemyExpansionMapSettings
1759
+ readonly difficulty_settings: DifficultySettings
1760
+ }
1761
+
1762
+ interface MapGenPreset {
1763
+ /**
1764
+ * The string used to alphabetically sort the presets. It is a simple string that has no additional semantic meaning.
1765
+ */
1766
+ readonly order: string
1767
+ /**
1768
+ * Whether this is the preset that is selected by default.
1769
+ */
1770
+ readonly default?: boolean
1771
+ readonly basic_settings?: MapGenSettingsRead
1772
+ readonly advanced_settings?: AdvancedMapGenSettings
1773
+ }
1774
+
1761
1775
  interface SignalID {
1762
1776
  /**
1763
1777
  * `"item"`, `"fluid"`, or `"virtual"`.
@@ -2787,32 +2801,105 @@ interface ModuleEffects {
2787
2801
  * This is a set of flags given as a dictionary[{@link string} &rarr; {@link boolean}]. When a flag is set, it is present in the dictionary with the value `true`. Unset flags aren't present in the dictionary at all. So, the boolean value is meaningless and exists just for easy table lookup if a flag is set.
2788
2802
  *
2789
2803
  * {@link https://lua-api.factorio.com/latest/Concepts.html#EntityPrototypeFlags View documentation}
2804
+ * @remarks By default, none of these flags are set.
2790
2805
  */
2791
2806
  interface EntityPrototypeFlags {
2807
+ /**
2808
+ * Prevents the entity from being rotated before or after placement.
2809
+ */
2792
2810
  readonly "not-rotatable"?: boolean
2811
+ /**
2812
+ * Determines the default force when placing entities in the map editor and using the "AUTO" option for the force.
2813
+ */
2793
2814
  readonly "placeable-neutral"?: boolean
2815
+ /**
2816
+ * Determines the default force when placing entities in the map editor and using the "AUTO" option for the force.
2817
+ */
2794
2818
  readonly "placeable-player"?: boolean
2819
+ /**
2820
+ * Determines the default force when placing entities in the map editor and using the "AUTO" option for the force.
2821
+ */
2795
2822
  readonly "placeable-enemy"?: boolean
2823
+ /**
2824
+ * 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.
2825
+ */
2796
2826
  readonly "placeable-off-grid"?: boolean
2827
+ /**
2828
+ * 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.
2829
+ */
2797
2830
  readonly "player-creation"?: boolean
2831
+ /**
2832
+ * Uses 45 degree angle increments when selecting direction.
2833
+ */
2798
2834
  readonly "building-direction-8-way"?: boolean
2835
+ /**
2836
+ * Used to automatically detect the proper direction of the entity if possible. Used by the pump, train stop, and train signal by default.
2837
+ */
2799
2838
  readonly "filter-directions"?: boolean
2839
+ /**
2840
+ * Fast replace will not apply when building while moving.
2841
+ */
2800
2842
  readonly "fast-replaceable-no-build-while-moving"?: boolean
2843
+ /**
2844
+ * Used to specify that the entity breathes air, and is thus affected by poison.
2845
+ */
2801
2846
  readonly "breaths-air"?: boolean
2847
+ /**
2848
+ * Used to specify that the entity can not be 'healed' by repair packs.
2849
+ */
2802
2850
  readonly "not-repairable"?: boolean
2851
+ /**
2852
+ * Prevents the entity from being drawn on the map.
2853
+ */
2803
2854
  readonly "not-on-map"?: boolean
2855
+ /**
2856
+ * Prevents the entity from being deconstructed.
2857
+ */
2804
2858
  readonly "not-deconstructable"?: boolean
2859
+ /**
2860
+ * Prevents the entity from being part of a blueprint.
2861
+ */
2805
2862
  readonly "not-blueprintable"?: boolean
2863
+ /**
2864
+ * Hides the entity from the bonus GUI and from the "made in"-property of recipe tooltips.
2865
+ */
2806
2866
  readonly hidden?: boolean
2867
+ /**
2868
+ * Hides the alt-info of this entity when in alt-mode.
2869
+ */
2807
2870
  readonly "hide-alt-info"?: boolean
2871
+ /**
2872
+ * Does not fast replace this entity over other entity types when building while moving.
2873
+ */
2808
2874
  readonly "fast-replaceable-no-cross-type-while-moving"?: boolean
2809
2875
  readonly "no-gap-fill-while-building"?: boolean
2876
+ /**
2877
+ * Does not apply fire stickers to the entity.
2878
+ */
2810
2879
  readonly "not-flammable"?: boolean
2880
+ /**
2881
+ * Prevents inserters and loaders from taking items from this entity.
2882
+ */
2811
2883
  readonly "no-automated-item-removal"?: boolean
2884
+ /**
2885
+ * Prevents inserters and loaders from inserting items into this entity.
2886
+ */
2812
2887
  readonly "no-automated-item-insertion"?: boolean
2888
+ /**
2889
+ * Prevents the entity from being copy-pasted.
2890
+ */
2813
2891
  readonly "no-copy-paste"?: boolean
2892
+ /**
2893
+ * 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.
2894
+ */
2814
2895
  readonly "not-selectable-in-game"?: boolean
2896
+ /**
2897
+ * Prevents the entity from being selected by the upgrade planner.
2898
+ */
2815
2899
  readonly "not-upgradable"?: boolean
2900
+ /**
2901
+ * Prevents the entity from being shown in the kill statistics.
2902
+ */
2816
2903
  readonly "not-in-kill-statistics"?: boolean
2817
2904
  }
2818
2905
 
@@ -2820,18 +2907,52 @@ interface EntityPrototypeFlags {
2820
2907
  * This is a set of flags given as dictionary[{@link string} &rarr; {@link boolean}]. When a flag is set, it is present in the dictionary with the value `true`. Unset flags aren't present in the dictionary at all. So, the boolean value is meaningless and exists just for easy table lookup if a flag is set.
2821
2908
  *
2822
2909
  * {@link https://lua-api.factorio.com/latest/Concepts.html#ItemPrototypeFlags View documentation}
2910
+ * @remarks By default, none of these flags are set.
2823
2911
  */
2824
2912
  interface ItemPrototypeFlags {
2913
+ /**
2914
+ * Determines whether the logistics areas of roboports should be drawn when holding this item. Used by the deconstruction planner by default.
2915
+ */
2825
2916
  readonly "draw-logistic-overlay"?: boolean
2917
+ /**
2918
+ * Hides the item in the logistic requests and filters GUIs (among others).
2919
+ */
2826
2920
  readonly hidden?: boolean
2921
+ /**
2922
+ * Always shows the item in the logistic requests and filters GUIs (among others) even when the recipe for that item is locked.
2923
+ */
2827
2924
  readonly "always-show"?: boolean
2925
+ /**
2926
+ * Hides the item from the bonus GUI.
2927
+ */
2828
2928
  readonly "hide-from-bonus-gui"?: boolean
2929
+ /**
2930
+ * Hides the item from the tooltip that's shown when hovering over a burner inventory.
2931
+ */
2829
2932
  readonly "hide-from-fuel-tooltip"?: boolean
2933
+ /**
2934
+ * 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.
2935
+ */
2830
2936
  readonly "not-stackable"?: boolean
2937
+ /**
2938
+ * Makes the item act as an extension to the inventory that it is placed in. Only has an effect for items with inventory.
2939
+ */
2831
2940
  readonly "can-extend-inventory"?: boolean
2941
+ /**
2942
+ * Makes construction bots prefer this item when building the entity specified by its `place_result`.
2943
+ */
2832
2944
  readonly "primary-place-result"?: boolean
2945
+ /**
2946
+ * Allows the item to be opened by the player, firing the `on_mod_item_opened` event. Only has an effect for selection tool items.
2947
+ */
2833
2948
  readonly "mod-openable"?: boolean
2949
+ /**
2950
+ * 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.
2951
+ */
2834
2952
  readonly "only-in-cursor"?: boolean
2953
+ /**
2954
+ * Allows the item to be spawned by a quickbar shortcut or custom input.
2955
+ */
2835
2956
  readonly spawnable?: boolean
2836
2957
  }
2837
2958
 
@@ -3231,7 +3352,7 @@ interface ProgrammableSpeakerInstrument {
3231
3352
  }
3232
3353
 
3233
3354
  /**
3234
- * A {@link string} that specifies where a gui element should be.
3355
+ * A {@link string} that specifies where a GUI element should be.
3235
3356
  *
3236
3357
  * {@link https://lua-api.factorio.com/latest/Concepts.html#Alignment View documentation}
3237
3358
  */
@@ -3599,6 +3720,34 @@ interface VehicleAutomaticTargetingParameters {
3599
3720
  */
3600
3721
  type SoundType = "game-effect" | "gui-effect" | "ambient" | "environment" | "walking" | "alert" | "wind"
3601
3722
 
3723
+ /**
3724
+ * Types `"signal"` and `"item-group"` do not support filters.
3725
+ *
3726
+ * Available filters:
3727
+ * - {@link ItemPrototypeFilter} for type `"item"`
3728
+ * - {@link TilePrototypeFilter} for type `"tile"`
3729
+ * - {@link EntityPrototypeFilter} for type `"entity"`
3730
+ * - {@link FluidPrototypeFilter} for type `"fluid"`
3731
+ * - {@link RecipePrototypeFilter} for type `"recipe"`
3732
+ * - {@link DecorativePrototypeFilter} for type `"decorative"`
3733
+ * - {@link AchievementPrototypeFilter} for type `"achievement"`
3734
+ * - {@link EquipmentPrototypeFilter} for type `"equipment"`
3735
+ * - {@link TechnologyPrototypeFilter} for type `"technology"`
3736
+ *
3737
+ * {@link https://lua-api.factorio.com/latest/Concepts.html#PrototypeFilter View documentation}
3738
+ * @remarks 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.
3739
+ */
3740
+ type PrototypeFilter =
3741
+ | ItemPrototypeFilter
3742
+ | TilePrototypeFilter
3743
+ | EntityPrototypeFilter
3744
+ | FluidPrototypeFilter
3745
+ | RecipePrototypeFilter
3746
+ | DecorativePrototypeFilter
3747
+ | AchievementPrototypeFilter
3748
+ | EquipmentPrototypeFilter
3749
+ | TechnologyPrototypeFilter
3750
+
3602
3751
  interface BaseItemPrototypeFilter {
3603
3752
  /**
3604
3753
  * The condition to filter on. One of `"tool"`, `"mergeable"`, `"item-with-inventory"`, `"selection-tool"`, `"item-with-label"`, `"has-rocket-launch-products"`, `"fuel"`, `"place-result"`, `"burnt-result"`, `"place-as-tile"`, `"placed-as-equipment-result"`, `"name"`, `"type"`, `"flag"`, `"subgroup"`, `"fuel-category"`, `"stack-size"`, `"default-request-amount"`, `"wire-count"`, `"fuel-value"`, `"fuel-acceleration-multiplier"`, `"fuel-top-speed-multiplier"`, `"fuel-emissions-multiplier"`.
@@ -3690,9 +3839,9 @@ interface NameItemPrototypeFilter extends BaseItemPrototypeFilter {
3690
3839
  interface TypeItemPrototypeFilter extends BaseItemPrototypeFilter {
3691
3840
  readonly filter: "type"
3692
3841
  /**
3693
- * The prototype type
3842
+ * The prototype type, or a list of acceptable types.
3694
3843
  */
3695
- readonly type: string
3844
+ readonly type: string | string[]
3696
3845
  }
3697
3846
 
3698
3847
  interface FlagItemPrototypeFilter extends BaseItemPrototypeFilter {
@@ -3865,9 +4014,9 @@ interface BaseModSettingPrototypeFilter {
3865
4014
  interface TypeModSettingPrototypeFilter extends BaseModSettingPrototypeFilter {
3866
4015
  readonly filter: "type"
3867
4016
  /**
3868
- * The prototype type
4017
+ * The prototype type, or a list of acceptable types.
3869
4018
  */
3870
- readonly type: string
4019
+ readonly type: string | string[]
3871
4020
  }
3872
4021
 
3873
4022
  interface ModModSettingPrototypeFilter extends BaseModSettingPrototypeFilter {
@@ -3881,9 +4030,9 @@ interface ModModSettingPrototypeFilter extends BaseModSettingPrototypeFilter {
3881
4030
  interface SettingTypeModSettingPrototypeFilter extends BaseModSettingPrototypeFilter {
3882
4031
  readonly filter: "setting-type"
3883
4032
  /**
3884
- * The setting scope type (startup, runtime-global, or runtime-per-user)
4033
+ * The setting scope type (`"startup"`, `"runtime-global"`, or `"runtime-per-user"`)
3885
4034
  */
3886
- readonly type: string
4035
+ readonly type: "startup" | "runtime-global" | "runtime-per-user"
3887
4036
  }
3888
4037
 
3889
4038
  /**
@@ -4057,9 +4206,9 @@ interface BaseAchievementPrototypeFilter {
4057
4206
  interface TypeAchievementPrototypeFilter extends BaseAchievementPrototypeFilter {
4058
4207
  readonly filter: "type"
4059
4208
  /**
4060
- * The prototype type
4209
+ * The prototype type, or a list of acceptable types.
4061
4210
  */
4062
- readonly type: string
4211
+ readonly type: string | string[]
4063
4212
  }
4064
4213
 
4065
4214
  interface AllowedWithoutFightAchievementPrototypeFilter extends BaseAchievementPrototypeFilter {
@@ -4208,9 +4357,9 @@ interface BaseEquipmentPrototypeFilter {
4208
4357
  interface TypeEquipmentPrototypeFilter extends BaseEquipmentPrototypeFilter {
4209
4358
  readonly filter: "type"
4210
4359
  /**
4211
- * The prototype type
4360
+ * The prototype type, or a list of acceptable types.
4212
4361
  */
4213
- readonly type: string
4362
+ readonly type: string | string[]
4214
4363
  }
4215
4364
 
4216
4365
  interface ItemToPlaceEquipmentPrototypeFilter extends BaseEquipmentPrototypeFilter {
@@ -4612,9 +4761,9 @@ interface NameEntityPrototypeFilter extends BaseEntityPrototypeFilter {
4612
4761
  interface TypeEntityPrototypeFilter extends BaseEntityPrototypeFilter {
4613
4762
  readonly filter: "type"
4614
4763
  /**
4615
- * The prototype type
4764
+ * The prototype type, or a list of acceptable types.
4616
4765
  */
4617
- readonly type: string
4766
+ readonly type: string | string[]
4618
4767
  }
4619
4768
 
4620
4769
  /**
@@ -7371,61 +7520,6 @@ type RaiseableEvents =
7371
7520
  | typeof defines.events.script_raised_revive
7372
7521
  | typeof defines.events.script_raised_set_tiles
7373
7522
 
7374
- /**
7375
- * A map gen preset. Used in {@link https://wiki.factorio.com/Prototype/MapGenPresets Prototype/MapGenPresets}.
7376
- *
7377
- * {@link https://wiki.factorio.com/Types/MapGenPreset View Documentation}
7378
- */
7379
- interface MapGenPreset {
7380
- /** Specifies the ordering the map generator gui. */
7381
- order: string
7382
- /** Whether this is the default preset. If set to boolean, this preset may not have any other properties besides this and order. */
7383
- default?: boolean
7384
- /**
7385
- * This is a table with the below key/value pairs. All key/value pairs are optional. If not set they will just use the
7386
- * default values.
7387
- */
7388
- basic_settings: Partial<MapGenSettings>
7389
- /**
7390
- * This is a table with the below key/value pairs. All key/value pairs are optional, if not set they will just use the
7391
- * existing values.
7392
- */
7393
- readonly advanced_settings: {
7394
- readonly pollution?: {
7395
- enabled?: boolean
7396
- /** Must be <= 0.25. */
7397
- diffusion_ratio?: double
7398
- /** Also known as dissipation rate. Must be >= 0.5. */
7399
- ageing?: double
7400
- enemy_attack_pollution_consumption_modifier?: double
7401
- min_pollution_to_damage_trees?: double
7402
- pollution_restored_per_tree_damage?: double
7403
- }
7404
- readonly enemy_evolution?: {
7405
- enabled?: boolean
7406
- time_factor?: double
7407
- destroy_factor?: double
7408
- pollution_factor?: double
7409
- }
7410
- readonly enemy_expansion?: {
7411
- enabled?: boolean
7412
- max_expansion_distance?: double
7413
- settler_group_min_size?: double
7414
- settler_group_max_size?: double
7415
- /** In ticks. */
7416
- min_expansion_cooldown?: double
7417
- /** In ticks. */
7418
- max_expansion_cooldown?: double
7419
- }
7420
- readonly difficulty_settings?: {
7421
- recipe_difficulty?: defines.difficulty_settings.recipe_difficulty
7422
- technology_difficulty?: defines.difficulty_settings.technology_difficulty
7423
- technology_price_multiplier?: double
7424
- research_queue_setting?: "after-victory" | "always" | "never"
7425
- }
7426
- }
7427
- }
7428
-
7429
7523
  interface BlueprintControlBehavior {
7430
7524
  readonly condition?: CircuitCondition
7431
7525
  readonly circuit_condition?: CircuitCondition
@@ -756,6 +756,10 @@ declare namespace defines {
756
756
  * Event type: {@link OnResearchReversedEvent}
757
757
  */
758
758
  const on_research_reversed: EventId<OnResearchReversedEvent>
759
+ /**
760
+ * Event type: {@link OnResearchCancelledEvent}
761
+ */
762
+ const on_research_cancelled: EventId<OnResearchCancelledEvent>
759
763
  /**
760
764
  * Event type: {@link OnPlayerRotatedEntityEvent}
761
765
  */
@@ -1386,6 +1390,10 @@ declare namespace defines {
1386
1390
  * Event type: {@link OnEquipmentRemovedEvent}
1387
1391
  */
1388
1392
  const on_equipment_removed: EventId<OnEquipmentRemovedEvent>
1393
+ /**
1394
+ * Event type: {@link OnPlayerReverseSelectedAreaEvent}
1395
+ */
1396
+ const on_player_reverse_selected_area: EventId<OnPlayerReverseSelectedAreaEvent>
1389
1397
  }
1390
1398
  /**
1391
1399
  * See the {@link https://lua-api.factorio.com/latest/events.html events page} for more info on what events contain and when they get raised.
@@ -1555,6 +1563,7 @@ declare namespace defines {
1555
1563
  remove_train_station,
1556
1564
  reset_assembling_machine,
1557
1565
  reset_item,
1566
+ reverse_select_area,
1558
1567
  rotate_entity,
1559
1568
  select_area,
1560
1569
  select_blueprint_entities,
@@ -2588,6 +2588,46 @@ interface OnPlayerRespawnedEvent extends EventData {
2588
2588
  readonly tick: uint
2589
2589
  }
2590
2590
 
2591
+ /**
2592
+ * Called after a player reverse-selects an area with a selection-tool item.
2593
+ *
2594
+ * {@link https://lua-api.factorio.com/latest/events.html#on_player_reverse_selected_area View documentation}
2595
+ */
2596
+ interface OnPlayerReverseSelectedAreaEvent extends EventData {
2597
+ /**
2598
+ * The player doing the selection.
2599
+ */
2600
+ readonly player_index: PlayerIndex
2601
+ /**
2602
+ * The surface selected.
2603
+ */
2604
+ readonly surface: LuaSurface
2605
+ /**
2606
+ * The area selected.
2607
+ */
2608
+ readonly area: BoundingBoxRead
2609
+ /**
2610
+ * The item used to select the area.
2611
+ */
2612
+ readonly item: string
2613
+ /**
2614
+ * The entities selected.
2615
+ */
2616
+ readonly entities: LuaEntity[]
2617
+ /**
2618
+ * The tiles selected.
2619
+ */
2620
+ readonly tiles: LuaTile[]
2621
+ /**
2622
+ * Identifier of the event
2623
+ */
2624
+ readonly name: typeof defines.events.on_player_reverse_selected_area
2625
+ /**
2626
+ * Tick the event was generated.
2627
+ */
2628
+ readonly tick: uint
2629
+ }
2630
+
2591
2631
  /**
2592
2632
  * Called when the player rotates an entity. This event is only fired when the entity actually changes its orientation -- pressing the rotate key on an entity that can't be rotated won't fire this event.
2593
2633
  *
@@ -3295,6 +3335,30 @@ interface OnPreSurfaceDeletedEvent extends EventData {
3295
3335
  readonly tick: uint
3296
3336
  }
3297
3337
 
3338
+ /**
3339
+ * Called when research is cancelled.
3340
+ *
3341
+ * {@link https://lua-api.factorio.com/latest/events.html#on_research_cancelled View documentation}
3342
+ */
3343
+ interface OnResearchCancelledEvent extends EventData {
3344
+ /**
3345
+ * A mapping of technology name to how many times it was cancelled.
3346
+ */
3347
+ readonly research: Record<string, uint>
3348
+ /**
3349
+ * The force whose research was cancelled.
3350
+ */
3351
+ readonly force: LuaForce
3352
+ /**
3353
+ * Identifier of the event
3354
+ */
3355
+ readonly name: typeof defines.events.on_research_cancelled
3356
+ /**
3357
+ * Tick the event was generated.
3358
+ */
3359
+ readonly tick: uint
3360
+ }
3361
+
3298
3362
  /**
3299
3363
  * Called when a research finishes.
3300
3364
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "typed-factorio",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "Featureful typescript definitions for the the Factorio modding lua api.",
5
5
  "keywords": [
6
6
  "factorio",