factorio-types 0.0.37 → 0.0.39

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/defines.d.ts CHANGED
@@ -2,8 +2,8 @@
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 1.1.86
6
- // API version 3
5
+ // Factorio version 1.1.89
6
+ // API version 4
7
7
 
8
8
  declare namespace defines {
9
9
  enum alert_type {
@@ -18,7 +18,7 @@ declare namespace defines {
18
18
  turret_fire,
19
19
  }
20
20
  /**
21
- * AI command exit status. See {@link LuaEntity::set_command | LuaEntity::set_command}
21
+ * AI command exit status. See {@link LuaEntity::set_command | runtime:LuaEntity::set_command}
22
22
  */
23
23
  enum behavior_result {
24
24
  deleted,
@@ -97,7 +97,7 @@ declare namespace defines {
97
97
  */
98
98
  build_base,
99
99
  /**
100
- * Chain commands together, see {@link defines.compound_command | defines.compound_command}.
100
+ * Chain commands together, see {@link defines.compound_command | runtime:defines.compound_command}.
101
101
  */
102
102
  compound,
103
103
  /**
@@ -122,7 +122,7 @@ declare namespace defines {
122
122
  wander,
123
123
  }
124
124
  /**
125
- * How commands are joined together in a compound command (see {@link defines.command.compound | defines.command.compound}).
125
+ * How commands are joined together in a compound command (see {@link defines.command.compound | runtime:defines.command.compound}).
126
126
  */
127
127
  enum compound_command {
128
128
  /**
@@ -177,75 +177,75 @@ declare namespace defines {
177
177
  }
178
178
  enum type {
179
179
  /**
180
- * {@link LuaAccumulatorControlBehavior | LuaAccumulatorControlBehavior}
180
+ * {@link LuaAccumulatorControlBehavior | runtime:LuaAccumulatorControlBehavior}
181
181
  */
182
182
  accumulator,
183
183
  /**
184
- * {@link LuaArithmeticCombinatorControlBehavior | LuaArithmeticCombinatorControlBehavior}
184
+ * {@link LuaArithmeticCombinatorControlBehavior | runtime:LuaArithmeticCombinatorControlBehavior}
185
185
  */
186
186
  arithmetic_combinator,
187
187
  /**
188
- * {@link LuaConstantCombinatorControlBehavior | LuaConstantCombinatorControlBehavior}
188
+ * {@link LuaConstantCombinatorControlBehavior | runtime:LuaConstantCombinatorControlBehavior}
189
189
  */
190
190
  constant_combinator,
191
191
  /**
192
- * {@link LuaContainerControlBehavior | LuaContainerControlBehavior}
192
+ * {@link LuaContainerControlBehavior | runtime:LuaContainerControlBehavior}
193
193
  */
194
194
  container,
195
195
  /**
196
- * {@link LuaDeciderCombinatorControlBehavior | LuaDeciderCombinatorControlBehavior}
196
+ * {@link LuaDeciderCombinatorControlBehavior | runtime:LuaDeciderCombinatorControlBehavior}
197
197
  */
198
198
  decider_combinator,
199
199
  /**
200
- * {@link LuaGenericOnOffControlBehavior | LuaGenericOnOffControlBehavior}
200
+ * {@link LuaGenericOnOffControlBehavior | runtime:LuaGenericOnOffControlBehavior}
201
201
  */
202
202
  generic_on_off,
203
203
  /**
204
- * {@link LuaInserterControlBehavior | LuaInserterControlBehavior}
204
+ * {@link LuaInserterControlBehavior | runtime:LuaInserterControlBehavior}
205
205
  */
206
206
  inserter,
207
207
  /**
208
- * {@link LuaLampControlBehavior | LuaLampControlBehavior}
208
+ * {@link LuaLampControlBehavior | runtime:LuaLampControlBehavior}
209
209
  */
210
210
  lamp,
211
211
  /**
212
- * {@link LuaLogisticContainerControlBehavior | LuaLogisticContainerControlBehavior}
212
+ * {@link LuaLogisticContainerControlBehavior | runtime:LuaLogisticContainerControlBehavior}
213
213
  */
214
214
  logistic_container,
215
215
  /**
216
- * {@link LuaMiningDrillControlBehavior | LuaMiningDrillControlBehavior}
216
+ * {@link LuaMiningDrillControlBehavior | runtime:LuaMiningDrillControlBehavior}
217
217
  */
218
218
  mining_drill,
219
219
  /**
220
- * {@link LuaProgrammableSpeakerControlBehavior | LuaProgrammableSpeakerControlBehavior}
220
+ * {@link LuaProgrammableSpeakerControlBehavior | runtime:LuaProgrammableSpeakerControlBehavior}
221
221
  */
222
222
  programmable_speaker,
223
223
  /**
224
- * {@link LuaRailChainSignalControlBehavior | LuaRailChainSignalControlBehavior}
224
+ * {@link LuaRailChainSignalControlBehavior | runtime:LuaRailChainSignalControlBehavior}
225
225
  */
226
226
  rail_chain_signal,
227
227
  /**
228
- * {@link LuaRailSignalControlBehavior | LuaRailSignalControlBehavior}
228
+ * {@link LuaRailSignalControlBehavior | runtime:LuaRailSignalControlBehavior}
229
229
  */
230
230
  rail_signal,
231
231
  /**
232
- * {@link LuaRoboportControlBehavior | LuaRoboportControlBehavior}
232
+ * {@link LuaRoboportControlBehavior | runtime:LuaRoboportControlBehavior}
233
233
  */
234
234
  roboport,
235
235
  /**
236
- * {@link LuaStorageTankControlBehavior | LuaStorageTankControlBehavior}
236
+ * {@link LuaStorageTankControlBehavior | runtime:LuaStorageTankControlBehavior}
237
237
  */
238
238
  storage_tank,
239
239
  /**
240
- * {@link LuaTrainStopControlBehavior | LuaTrainStopControlBehavior}
240
+ * {@link LuaTrainStopControlBehavior | runtime:LuaTrainStopControlBehavior}
241
241
  */
242
242
  train_stop,
243
243
  /**
244
- * {@link LuaTransportBeltControlBehavior | LuaTransportBeltControlBehavior}
244
+ * {@link LuaTransportBeltControlBehavior | runtime:LuaTransportBeltControlBehavior}
245
245
  */
246
246
  transport_belt,
247
247
  /**
248
- * {@link LuaWallControlBehavior | LuaWallControlBehavior}
248
+ * {@link LuaWallControlBehavior | runtime:LuaWallControlBehavior}
249
249
  */
250
250
  wall,
251
251
  }
@@ -493,7 +493,7 @@ declare namespace defines {
493
493
  working,
494
494
  }
495
495
  /**
496
- * See the {@link events page | events.html} for more info on what events contain and when they get raised.
496
+ * See the {@link events page | runtime:events} for more info on what events contain and when they get raised.
497
497
  */
498
498
  enum events {
499
499
  on_ai_command_completed,
package/dist/events.d.ts CHANGED
@@ -2,8 +2,8 @@
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 1.1.86
6
- // API version 3
5
+ // Factorio version 1.1.89
6
+ // API version 4
7
7
 
8
8
  /**
9
9
  * Base type for all events
@@ -22,7 +22,7 @@ interface event {
22
22
  tick: number
23
23
  }
24
24
  /**
25
- * Called when a {@link CustomInput | https://wiki.factorio.com/Prototype/CustomInput} is activated.
25
+ * Called when a {@link CustomInputPrototype | prototype:CustomInputPrototype} is activated.
26
26
  */
27
27
  interface CustomInputEvent extends event {
28
28
  /**
@@ -104,7 +104,7 @@ interface on_brush_cloned extends event {
104
104
  source_surface: LuaSurface
105
105
  }
106
106
  /**
107
- * Called when a {@link defines.command.build_base | defines.command.build_base} command reaches its destination, and before building starts.
107
+ * Called when a {@link defines.command.build_base | runtime:defines.command.build_base} command reaches its destination, and before building starts.
108
108
  */
109
109
  interface on_build_base_arrived extends event {
110
110
  /**
@@ -117,7 +117,7 @@ interface on_build_base_arrived extends event {
117
117
  unit?: LuaEntity
118
118
  }
119
119
  /**
120
- * Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter | LuaPlayerBuiltEntityEventFilter}.
120
+ * Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter | runtime:LuaPlayerBuiltEntityEventFilter}.
121
121
  */
122
122
  interface on_built_entity extends event {
123
123
  created_entity: LuaEntity
@@ -133,14 +133,14 @@ interface on_built_entity extends event {
133
133
  tags?: Tags
134
134
  }
135
135
  /**
136
- * Called when the deconstruction of an entity is canceled. Can be filtered using {@link LuaEntityDeconstructionCancelledEventFilter | LuaEntityDeconstructionCancelledEventFilter}.
136
+ * Called when the deconstruction of an entity is canceled. Can be filtered using {@link LuaEntityDeconstructionCancelledEventFilter | runtime:LuaEntityDeconstructionCancelledEventFilter}.
137
137
  */
138
138
  interface on_cancelled_deconstruction extends event {
139
139
  entity: LuaEntity
140
140
  player_index?: number
141
141
  }
142
142
  /**
143
- * Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter | LuaUpgradeCancelledEventFilter}.
143
+ * Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter | runtime:LuaUpgradeCancelledEventFilter}.
144
144
  */
145
145
  interface on_cancelled_upgrade extends event {
146
146
  direction?: defines.direction
@@ -151,7 +151,7 @@ interface on_cancelled_upgrade extends event {
151
151
  /**
152
152
  * Called when a character corpse expires due to timeout or all of the items being removed from it.
153
153
  * @remarks
154
- * this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item | defines.events.on_pre_player_mined_item} to detect that.
154
+ * this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item | runtime:defines.events.on_pre_player_mined_item} to detect that.
155
155
  *
156
156
  */
157
157
  interface on_character_corpse_expired extends event {
@@ -200,7 +200,7 @@ interface on_chunk_charted extends event {
200
200
  surface_index: number
201
201
  }
202
202
  /**
203
- * Called when one or more chunks are deleted using {@link LuaSurface::delete_chunk | LuaSurface::delete_chunk}.
203
+ * Called when one or more chunks are deleted using {@link LuaSurface::delete_chunk | runtime:LuaSurface::delete_chunk}.
204
204
  */
205
205
  interface on_chunk_deleted extends event {
206
206
  /**
@@ -325,7 +325,7 @@ interface on_difficulty_settings_changed extends event {
325
325
  old_technology_difficulty: number
326
326
  }
327
327
  /**
328
- * Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter | LuaEntityClonedEventFilter}.
328
+ * Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter | runtime:LuaEntityClonedEventFilter}.
329
329
  */
330
330
  interface on_entity_cloned extends event {
331
331
  destination: LuaEntity
@@ -334,7 +334,7 @@ interface on_entity_cloned extends event {
334
334
  /**
335
335
  * Called after an entity has been recolored either by the player or through script.
336
336
  * @remarks
337
- * Automatic recoloring due to {@link LuaPlayer::color | LuaPlayer::color} will not raise events, as that is a separate mechanism.
337
+ * Automatic recoloring due to {@link LuaPlayer::color | runtime:LuaPlayer::color} will not raise events, as that is a separate mechanism.
338
338
  *
339
339
  */
340
340
  interface on_entity_color_changed extends event {
@@ -344,7 +344,7 @@ interface on_entity_color_changed extends event {
344
344
  entity: LuaEntity
345
345
  }
346
346
  /**
347
- * Called when an entity is damaged. Can be filtered using {@link LuaEntityDamagedEventFilter | LuaEntityDamagedEventFilter}.
347
+ * Called when an entity is damaged. Can be filtered using {@link LuaEntityDamagedEventFilter | runtime:LuaEntityDamagedEventFilter}.
348
348
  * @remarks
349
349
  * This is not called when an entities health is set directly by another mod.
350
350
  *
@@ -374,23 +374,23 @@ interface on_entity_damaged extends event {
374
374
  original_damage_amount: number
375
375
  }
376
376
  /**
377
- * Called after an entity is destroyed that has been registered with {@link LuaBootstrap::register_on_entity_destroyed | LuaBootstrap::register_on_entity_destroyed}.
377
+ * Called after an entity is destroyed that has been registered with {@link LuaBootstrap::register_on_entity_destroyed | runtime:LuaBootstrap::register_on_entity_destroyed}.
378
378
  * @remarks
379
379
  * Depending on when a given entity is destroyed, this event will be fired at the end of the current tick or at the end of the next tick.
380
380
  *
381
381
  */
382
382
  interface on_entity_destroyed extends event {
383
383
  /**
384
- * The number returned by {@link register_on_entity_destroyed | LuaBootstrap::register_on_entity_destroyed} to uniquely identify this entity during this event.
384
+ * The number returned by {@link register_on_entity_destroyed | runtime:LuaBootstrap::register_on_entity_destroyed} to uniquely identify this entity during this event.
385
385
  */
386
386
  registration_number: number
387
387
  /**
388
- * The {@link LuaEntity::unit_number | LuaEntity::unit_number} of the destroyed entity, if it had one.
388
+ * The {@link LuaEntity::unit_number | runtime:LuaEntity::unit_number} of the destroyed entity, if it had one.
389
389
  */
390
390
  unit_number?: number
391
391
  }
392
392
  /**
393
- * Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter | LuaEntityDiedEventFilter}.
393
+ * Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter | runtime:LuaEntityDiedEventFilter}.
394
394
  */
395
395
  interface on_entity_died extends event {
396
396
  /**
@@ -544,7 +544,7 @@ interface on_force_friends_changed extends event {
544
544
  other_force: LuaForce
545
545
  }
546
546
  /**
547
- * Called when {@link LuaForce::reset | LuaForce::reset} is finished.
547
+ * Called when {@link LuaForce::reset | runtime:LuaForce::reset} is finished.
548
548
  */
549
549
  interface on_force_reset extends event {
550
550
  force: LuaForce
@@ -583,7 +583,7 @@ interface on_forces_merging extends event {
583
583
  source: LuaForce
584
584
  }
585
585
  /**
586
- * Called when a game is created from a scenario. This is fired for every mod, even when the scenario's save data already includes it. In those cases however, {@link LuaBootstrap::on_init | LuaBootstrap::on_init} is not fired.
586
+ * Called when a game is created from a scenario. This is fired for every mod, even when the scenario's save data already includes it. In those cases however, {@link LuaBootstrap::on_init | runtime:LuaBootstrap::on_init} is not fired.
587
587
  * @remarks
588
588
  * This event is not fired when the scenario is loaded via the map editor.
589
589
  *
@@ -591,7 +591,7 @@ interface on_forces_merging extends event {
591
591
  interface on_game_created_from_scenario extends event {
592
592
  }
593
593
  /**
594
- * Called when {@link LuaGuiElement | LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
594
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
595
595
  */
596
596
  interface on_gui_checked_state_changed extends event {
597
597
  /**
@@ -604,7 +604,7 @@ interface on_gui_checked_state_changed extends event {
604
604
  player_index: number
605
605
  }
606
606
  /**
607
- * Called when {@link LuaGuiElement | LuaGuiElement} is clicked.
607
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} is clicked.
608
608
  */
609
609
  interface on_gui_click extends event {
610
610
  /**
@@ -687,7 +687,7 @@ interface on_gui_closed extends event {
687
687
  tile_position?: TilePosition
688
688
  }
689
689
  /**
690
- * Called when a {@link LuaGuiElement | LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
690
+ * Called when a {@link LuaGuiElement | runtime:LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
691
691
  */
692
692
  interface on_gui_confirmed extends event {
693
693
  /**
@@ -712,7 +712,7 @@ interface on_gui_confirmed extends event {
712
712
  shift: boolean
713
713
  }
714
714
  /**
715
- * Called when {@link LuaGuiElement | LuaGuiElement} element value is changed (related to choose element buttons).
715
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} element value is changed (related to choose element buttons).
716
716
  */
717
717
  interface on_gui_elem_changed extends event {
718
718
  /**
@@ -725,7 +725,7 @@ interface on_gui_elem_changed extends event {
725
725
  player_index: number
726
726
  }
727
727
  /**
728
- * Called when {@link LuaGuiElement | LuaGuiElement} is hovered by the mouse.
728
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} is hovered by the mouse.
729
729
  */
730
730
  interface on_gui_hover extends event {
731
731
  /**
@@ -738,7 +738,7 @@ interface on_gui_hover extends event {
738
738
  player_index: number
739
739
  }
740
740
  /**
741
- * Called when the player's cursor leaves a {@link LuaGuiElement | LuaGuiElement} that was previously hovered.
741
+ * Called when the player's cursor leaves a {@link LuaGuiElement | runtime:LuaGuiElement} that was previously hovered.
742
742
  */
743
743
  interface on_gui_leave extends event {
744
744
  /**
@@ -751,7 +751,7 @@ interface on_gui_leave extends event {
751
751
  player_index: number
752
752
  }
753
753
  /**
754
- * Called when {@link LuaGuiElement | LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
754
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
755
755
  */
756
756
  interface on_gui_location_changed extends event {
757
757
  /**
@@ -801,7 +801,7 @@ interface on_gui_opened extends event {
801
801
  player_index: number
802
802
  }
803
803
  /**
804
- * Called when {@link LuaGuiElement | LuaGuiElement} selected tab is changed (related to tabbed-panes).
804
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} selected tab is changed (related to tabbed-panes).
805
805
  */
806
806
  interface on_gui_selected_tab_changed extends event {
807
807
  /**
@@ -814,7 +814,7 @@ interface on_gui_selected_tab_changed extends event {
814
814
  player_index: number
815
815
  }
816
816
  /**
817
- * Called when {@link LuaGuiElement | LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
817
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
818
818
  */
819
819
  interface on_gui_selection_state_changed extends event {
820
820
  /**
@@ -827,7 +827,7 @@ interface on_gui_selection_state_changed extends event {
827
827
  player_index: number
828
828
  }
829
829
  /**
830
- * Called when {@link LuaGuiElement | LuaGuiElement} switch state is changed (related to switches).
830
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} switch state is changed (related to switches).
831
831
  */
832
832
  interface on_gui_switch_state_changed extends event {
833
833
  /**
@@ -840,7 +840,7 @@ interface on_gui_switch_state_changed extends event {
840
840
  player_index: number
841
841
  }
842
842
  /**
843
- * Called when {@link LuaGuiElement | LuaGuiElement} text is changed by the player.
843
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} text is changed by the player.
844
844
  */
845
845
  interface on_gui_text_changed extends event {
846
846
  /**
@@ -857,7 +857,7 @@ interface on_gui_text_changed extends event {
857
857
  text: string
858
858
  }
859
859
  /**
860
- * Called when {@link LuaGuiElement | LuaGuiElement} slider value is changed (related to the slider element).
860
+ * Called when {@link LuaGuiElement | runtime:LuaGuiElement} slider value is changed (related to the slider element).
861
861
  */
862
862
  interface on_gui_value_changed extends event {
863
863
  /**
@@ -886,14 +886,14 @@ interface on_lua_shortcut extends event {
886
886
  prototype_name: string
887
887
  }
888
888
  /**
889
- * Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using {@link LuaEntityMarkedForDeconstructionEventFilter | LuaEntityMarkedForDeconstructionEventFilter}.
889
+ * Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using {@link LuaEntityMarkedForDeconstructionEventFilter | runtime:LuaEntityMarkedForDeconstructionEventFilter}.
890
890
  */
891
891
  interface on_marked_for_deconstruction extends event {
892
892
  entity: LuaEntity
893
893
  player_index?: number
894
894
  }
895
895
  /**
896
- * Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using {@link LuaEntityMarkedForUpgradeEventFilter | LuaEntityMarkedForUpgradeEventFilter}.
896
+ * Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using {@link LuaEntityMarkedForUpgradeEventFilter | runtime:LuaEntityMarkedForUpgradeEventFilter}.
897
897
  */
898
898
  interface on_marked_for_upgrade extends event {
899
899
  /**
@@ -1251,7 +1251,7 @@ interface on_player_configured_spider_remote extends event {
1251
1251
  vehicle: LuaEntity
1252
1252
  }
1253
1253
  /**
1254
- * Called when the player finishes crafting an item. This event fires just before the results are inserted into the player's inventory, not when the crafting is queued (see {@link on_pre_player_crafted_item | on_pre_player_crafted_item}).
1254
+ * Called when the player finishes crafting an item. This event fires just before the results are inserted into the player's inventory, not when the crafting is queued (see {@link on_pre_player_crafted_item | runtime:on_pre_player_crafted_item}).
1255
1255
  */
1256
1256
  interface on_player_crafted_item extends event {
1257
1257
  /**
@@ -1274,7 +1274,7 @@ interface on_player_created extends event {
1274
1274
  player_index: number
1275
1275
  }
1276
1276
  /**
1277
- * Called after a player's {@link cursor stack | LuaControl::cursor_stack} changed in some way.
1277
+ * Called after a player's {@link cursor stack | runtime:LuaControl::cursor_stack} changed in some way.
1278
1278
  */
1279
1279
  interface on_player_cursor_stack_changed extends event {
1280
1280
  player_index: number
@@ -1424,7 +1424,7 @@ interface on_player_gun_inventory_changed extends event {
1424
1424
  /**
1425
1425
  * Called when a player's input method changes.
1426
1426
  * @remarks
1427
- * See {@link LuaPlayer::input_method | LuaPlayer::input_method}.
1427
+ * See {@link LuaPlayer::input_method | runtime:LuaPlayer::input_method}.
1428
1428
  *
1429
1429
  */
1430
1430
  interface on_player_input_method_changed extends event {
@@ -1470,7 +1470,7 @@ interface on_player_main_inventory_changed extends event {
1470
1470
  player_index: number
1471
1471
  }
1472
1472
  /**
1473
- * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the player as if they came from mining the entity. Can be filtered using {@link LuaPlayerMinedEntityEventFilter | LuaPlayerMinedEntityEventFilter}.
1473
+ * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the player as if they came from mining the entity. Can be filtered using {@link LuaPlayerMinedEntityEventFilter | runtime:LuaPlayerMinedEntityEventFilter}.
1474
1474
  * @remarks
1475
1475
  * The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding as more items are transferred into it.
1476
1476
  *
@@ -1563,7 +1563,7 @@ interface on_player_promoted extends event {
1563
1563
  player_index: number
1564
1564
  }
1565
1565
  /**
1566
- * Called when a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | on_player_left_game} the game, and instead behaves like the player never existed in the save file.
1566
+ * Called when a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | runtime:on_player_left_game} the game, and instead behaves like the player never existed in the save file.
1567
1567
  */
1568
1568
  interface on_player_removed extends event {
1569
1569
  /**
@@ -1590,7 +1590,7 @@ interface on_player_removed_equipment extends event {
1590
1590
  player_index: number
1591
1591
  }
1592
1592
  /**
1593
- * Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter | LuaPlayerRepairedEntityEventFilter}.
1593
+ * Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter | runtime:LuaPlayerRepairedEntityEventFilter}.
1594
1594
  */
1595
1595
  interface on_player_repaired_entity extends event {
1596
1596
  entity: LuaEntity
@@ -1718,7 +1718,7 @@ interface on_player_setup_blueprint extends event {
1718
1718
  */
1719
1719
  interface on_player_toggled_alt_mode extends event {
1720
1720
  /**
1721
- * The new alt mode value. This value is a shortcut for accessing {@link GameViewSettings::show_entity_info | GameViewSettings::show_entity_info} on the player.
1721
+ * The new alt mode value. This value is a shortcut for accessing {@link GameViewSettings::show_entity_info | runtime:GameViewSettings::show_entity_info} on the player.
1722
1722
  */
1723
1723
  alt_mode: boolean
1724
1724
  player_index: number
@@ -1804,7 +1804,7 @@ interface on_player_used_spider_remote extends event {
1804
1804
  vehicle: LuaEntity
1805
1805
  }
1806
1806
  /**
1807
- * Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter | LuaPostEntityDiedEventFilter}.
1807
+ * Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter | runtime:LuaPostEntityDiedEventFilter}.
1808
1808
  */
1809
1809
  interface on_post_entity_died extends event {
1810
1810
  /**
@@ -1841,7 +1841,7 @@ interface on_post_entity_died extends event {
1841
1841
  unit_number?: number
1842
1842
  }
1843
1843
  /**
1844
- * Called when players uses an item to build something. Called before {@link on_built_entity | on_built_entity}.
1844
+ * Called when players uses an item to build something. Called before {@link on_built_entity | runtime:on_built_entity}.
1845
1845
  */
1846
1846
  interface on_pre_build extends event {
1847
1847
  /**
@@ -1874,7 +1874,7 @@ interface on_pre_build extends event {
1874
1874
  shift_build: boolean
1875
1875
  }
1876
1876
  /**
1877
- * Called before one or more chunks are deleted using {@link LuaSurface::delete_chunk | LuaSurface::delete_chunk}.
1877
+ * Called before one or more chunks are deleted using {@link LuaSurface::delete_chunk | runtime:LuaSurface::delete_chunk}.
1878
1878
  */
1879
1879
  interface on_pre_chunk_deleted extends event {
1880
1880
  /**
@@ -1898,7 +1898,7 @@ interface on_pre_entity_settings_pasted extends event {
1898
1898
  source: LuaEntity
1899
1899
  }
1900
1900
  /**
1901
- * Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using {@link LuaPreGhostDeconstructedEventFilter | LuaPreGhostDeconstructedEventFilter}.
1901
+ * Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using {@link LuaPreGhostDeconstructedEventFilter | runtime:LuaPreGhostDeconstructedEventFilter}.
1902
1902
  */
1903
1903
  interface on_pre_ghost_deconstructed extends event {
1904
1904
  ghost: LuaEntity
@@ -1908,7 +1908,7 @@ interface on_pre_ghost_deconstructed extends event {
1908
1908
  player_index?: number
1909
1909
  }
1910
1910
  /**
1911
- * Called before a ghost entity is upgraded. Can be filtered using {@link LuaPreGhostUpgradedEventFilter | LuaPreGhostUpgradedEventFilter}.
1911
+ * Called before a ghost entity is upgraded. Can be filtered using {@link LuaPreGhostUpgradedEventFilter | runtime:LuaPreGhostUpgradedEventFilter}.
1912
1912
  */
1913
1913
  interface on_pre_ghost_upgraded extends event {
1914
1914
  ghost: LuaEntity
@@ -1976,7 +1976,7 @@ interface on_pre_player_left_game extends event {
1976
1976
  reason: defines.disconnect_reason
1977
1977
  }
1978
1978
  /**
1979
- * Called when the player completes a mining action, but before the entity is potentially removed from the map. This is called even if the entity does not end up being removed. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter | LuaPrePlayerMinedEntityEventFilter}.
1979
+ * Called when the player completes a mining action, but before the entity is potentially removed from the map. This is called even if the entity does not end up being removed. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter | runtime:LuaPrePlayerMinedEntityEventFilter}.
1980
1980
  */
1981
1981
  interface on_pre_player_mined_item extends event {
1982
1982
  /**
@@ -1986,7 +1986,7 @@ interface on_pre_player_mined_item extends event {
1986
1986
  player_index: number
1987
1987
  }
1988
1988
  /**
1989
- * Called before a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | on_player_left_game} the game, and instead behaves like the player never existed in the save file.
1989
+ * Called before a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link leaving | runtime:on_player_left_game} the game, and instead behaves like the player never existed in the save file.
1990
1990
  */
1991
1991
  interface on_pre_player_removed extends event {
1992
1992
  /**
@@ -2101,7 +2101,7 @@ interface on_resource_depleted extends event {
2101
2101
  entity: LuaEntity
2102
2102
  }
2103
2103
  /**
2104
- * Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter | LuaRobotBuiltEntityEventFilter}.
2104
+ * Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter | runtime:LuaRobotBuiltEntityEventFilter}.
2105
2105
  */
2106
2106
  interface on_robot_built_entity extends event {
2107
2107
  /**
@@ -2174,7 +2174,7 @@ interface on_robot_mined extends event {
2174
2174
  robot: LuaEntity
2175
2175
  }
2176
2176
  /**
2177
- * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the robot as if they came from mining the entity. Can be filtered using {@link LuaRobotMinedEntityEventFilter | LuaRobotMinedEntityEventFilter}.
2177
+ * Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the robot as if they came from mining the entity. Can be filtered using {@link LuaRobotMinedEntityEventFilter | runtime:LuaRobotMinedEntityEventFilter}.
2178
2178
  * @remarks
2179
2179
  * The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding as more items are transferred into it.
2180
2180
  *
@@ -2211,7 +2211,7 @@ interface on_robot_mined_tile extends event {
2211
2211
  tiles: OldTileAndPosition[]
2212
2212
  }
2213
2213
  /**
2214
- * Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter | LuaPreRobotMinedEntityEventFilter}.
2214
+ * Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter | runtime:LuaPreRobotMinedEntityEventFilter}.
2215
2215
  */
2216
2216
  interface on_robot_pre_mined extends event {
2217
2217
  /**
@@ -2289,11 +2289,11 @@ interface on_script_inventory_resized extends event {
2289
2289
  player_index?: number
2290
2290
  }
2291
2291
  /**
2292
- * Called when a {@link LuaSurface::request_path | LuaSurface::request_path} call completes.
2292
+ * Called when a {@link LuaSurface::request_path | runtime:LuaSurface::request_path} call completes.
2293
2293
  */
2294
2294
  interface on_script_path_request_finished extends event {
2295
2295
  /**
2296
- * Handle to associate the callback with a particular call to {@link LuaSurface::request_path | LuaSurface::request_path}.
2296
+ * Handle to associate the callback with a particular call to {@link LuaSurface::request_path | runtime:LuaSurface::request_path}.
2297
2297
  */
2298
2298
  id: number
2299
2299
  /**
@@ -2323,7 +2323,7 @@ interface on_script_trigger_effect extends event {
2323
2323
  target_position?: MapPosition
2324
2324
  }
2325
2325
  /**
2326
- * Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using {@link LuaSectorScannedEventFilter | LuaSectorScannedEventFilter}.
2326
+ * Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using {@link LuaSectorScannedEventFilter | runtime:LuaSectorScannedEventFilter}.
2327
2327
  */
2328
2328
  interface on_sector_scanned extends event {
2329
2329
  /**
@@ -2362,7 +2362,7 @@ interface on_spider_command_completed extends event {
2362
2362
  vehicle: LuaEntity
2363
2363
  }
2364
2364
  /**
2365
- * Called when a translation request generated through {@link LuaPlayer::request_translation | LuaPlayer::request_translation} or {@link LuaPlayer::request_translations | LuaPlayer::request_translations} has been completed.
2365
+ * Called when a translation request generated through {@link LuaPlayer::request_translation | runtime:LuaPlayer::request_translation} or {@link LuaPlayer::request_translations | runtime:LuaPlayer::request_translations} has been completed.
2366
2366
  */
2367
2367
  interface on_string_translated extends event {
2368
2368
  /**
@@ -2426,7 +2426,7 @@ interface on_surface_renamed extends event {
2426
2426
  surface_index: number
2427
2427
  }
2428
2428
  /**
2429
- * Called when {@link LuaForce::reset_technology_effects | LuaForce::reset_technology_effects} is finished.
2429
+ * Called when {@link LuaForce::reset_technology_effects | runtime:LuaForce::reset_technology_effects} is finished.
2430
2430
  */
2431
2431
  interface on_technology_effects_reset extends event {
2432
2432
  force: LuaForce
@@ -2514,7 +2514,7 @@ interface on_worker_robot_expired extends event {
2514
2514
  robot: LuaEntity
2515
2515
  }
2516
2516
  /**
2517
- * A static event mods can use to tell other mods they built something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_built | LuaBootstrap::raise_script_built}, or when `raise_built` is passed to {@link LuaSurface::create_entity | LuaSurface::create_entity}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter | LuaScriptRaisedBuiltEventFilter}.
2517
+ * A static event mods can use to tell other mods they built something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_built | runtime:LuaBootstrap::raise_script_built}, or when `raise_built` is passed to {@link LuaSurface::create_entity | runtime:LuaSurface::create_entity}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter | runtime:LuaScriptRaisedBuiltEventFilter}.
2518
2518
  */
2519
2519
  interface script_raised_built extends event {
2520
2520
  /**
@@ -2523,7 +2523,7 @@ interface script_raised_built extends event {
2523
2523
  entity: LuaEntity
2524
2524
  }
2525
2525
  /**
2526
- * A static event mods can use to tell other mods they destroyed something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_destroy | LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to {@link LuaEntity::destroy | LuaEntity::destroy}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter | LuaScriptRaisedDestroyEventFilter}.
2526
+ * A static event mods can use to tell other mods they destroyed something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_destroy | runtime:LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to {@link LuaEntity::destroy | runtime:LuaEntity::destroy}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter | runtime:LuaScriptRaisedDestroyEventFilter}.
2527
2527
  */
2528
2528
  interface script_raised_destroy extends event {
2529
2529
  /**
@@ -2532,7 +2532,7 @@ interface script_raised_destroy extends event {
2532
2532
  entity: LuaEntity
2533
2533
  }
2534
2534
  /**
2535
- * A static event mods can use to tell other mods they revived something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_revive | LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to {@link LuaEntity::revive | LuaEntity::revive}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter | LuaScriptRaisedReviveEventFilter}.
2535
+ * A static event mods can use to tell other mods they revived something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_revive | runtime:LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to {@link LuaEntity::revive | runtime:LuaEntity::revive}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter | runtime:LuaScriptRaisedReviveEventFilter}.
2536
2536
  */
2537
2537
  interface script_raised_revive extends event {
2538
2538
  /**
@@ -2545,7 +2545,7 @@ interface script_raised_revive extends event {
2545
2545
  tags?: Tags
2546
2546
  }
2547
2547
  /**
2548
- * A static event mods can use to tell other mods they changed tiles on a surface by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_set_tiles | LuaBootstrap::raise_script_set_tiles}, or when `raise_event` is passed to {@link LuaSurface::set_tiles | LuaSurface::set_tiles}.
2548
+ * A static event mods can use to tell other mods they changed tiles on a surface by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_set_tiles | runtime:LuaBootstrap::raise_script_set_tiles}, or when `raise_event` is passed to {@link LuaSurface::set_tiles | runtime:LuaSurface::set_tiles}.
2549
2549
  */
2550
2550
  interface script_raised_set_tiles extends event {
2551
2551
  /**
@@ -2558,7 +2558,7 @@ interface script_raised_set_tiles extends event {
2558
2558
  tiles: Tile[]
2559
2559
  }
2560
2560
  /**
2561
- * A static event mods can use to tell other mods they teleported something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_teleported | LuaBootstrap::raise_script_teleported}, or when `raise_teleported` is passed to {@link LuaControl::teleport | LuaControl::teleport}. Can be filtered using {@link LuaScriptRaisedTeleportedEventFilter | LuaScriptRaisedTeleportedEventFilter}.
2561
+ * A static event mods can use to tell other mods they teleported something by script. This event is only raised if a mod does so with {@link LuaBootstrap::raise_event | runtime:LuaBootstrap::raise_event} or {@link LuaBootstrap::raise_script_teleported | runtime:LuaBootstrap::raise_script_teleported}, or when `raise_teleported` is passed to {@link LuaControl::teleport | runtime:LuaControl::teleport}. Can be filtered using {@link LuaScriptRaisedTeleportedEventFilter | runtime:LuaScriptRaisedTeleportedEventFilter}.
2562
2562
  */
2563
2563
  interface script_raised_teleported extends event {
2564
2564
  /**