typed-factorio 3.31.0 → 3.32.0
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/package.json +2 -2
- package/prototype/generated/prototypes.d.ts +2274 -2228
- package/prototype/generated/types.d.ts +2212 -2161
- package/runtime/generated/classes.d.ts +4281 -4168
- package/runtime/generated/concepts.d.ts +417 -405
- package/runtime/generated/defines.d.ts +221 -216
- package/runtime/generated/events.d.ts +237 -218
- package/runtime/generated/global-functions.d.ts +3 -3
- package/runtime/generated/global-objects.d.ts +7 -7
|
@@ -13,7 +13,7 @@ declare module "factorio:runtime" {
|
|
|
13
13
|
* script.on_event("my-potato-control", function(event)
|
|
14
14
|
* game.print("Keyboard shortcut pressed on tick: " ..tostring(event.tick))
|
|
15
15
|
* end)
|
|
16
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
16
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#CustomInputEvent Online documentation}
|
|
17
17
|
*/
|
|
18
18
|
interface CustomInputEvent extends EventData {
|
|
19
19
|
/**
|
|
@@ -59,7 +59,7 @@ declare module "factorio:runtime" {
|
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
61
|
* Called when an achievement is gained.
|
|
62
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
62
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_achievement_gained Online documentation}
|
|
63
63
|
*/
|
|
64
64
|
interface OnAchievementGainedEvent extends EventData {
|
|
65
65
|
/**
|
|
@@ -78,7 +78,7 @@ declare module "factorio:runtime" {
|
|
|
78
78
|
}
|
|
79
79
|
/**
|
|
80
80
|
* Called when a unit/group completes a command.
|
|
81
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
81
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_ai_command_completed Online documentation}
|
|
82
82
|
*/
|
|
83
83
|
interface OnAiCommandCompletedEvent extends EventData {
|
|
84
84
|
/**
|
|
@@ -101,7 +101,7 @@ declare module "factorio:runtime" {
|
|
|
101
101
|
}
|
|
102
102
|
/**
|
|
103
103
|
* Called when an area of the map is cloned.
|
|
104
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
104
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_area_cloned Online documentation}
|
|
105
105
|
*/
|
|
106
106
|
interface OnAreaClonedEvent extends EventData {
|
|
107
107
|
readonly source_surface: LuaSurface
|
|
@@ -127,7 +127,7 @@ declare module "factorio:runtime" {
|
|
|
127
127
|
* Called when a biter migration builds a base.
|
|
128
128
|
*
|
|
129
129
|
* This will be called multiple times for each migration, once for every biter that is sacrificed to build part of the new base.
|
|
130
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
130
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_biter_base_built Online documentation}
|
|
131
131
|
*/
|
|
132
132
|
interface OnBiterBaseBuiltEvent extends EventData {
|
|
133
133
|
/**
|
|
@@ -145,7 +145,7 @@ declare module "factorio:runtime" {
|
|
|
145
145
|
}
|
|
146
146
|
/**
|
|
147
147
|
* Called when a set of positions on the map is cloned.
|
|
148
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
148
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_brush_cloned Online documentation}
|
|
149
149
|
*/
|
|
150
150
|
interface OnBrushClonedEvent extends EventData {
|
|
151
151
|
readonly source_offset: TilePosition
|
|
@@ -170,7 +170,7 @@ declare module "factorio:runtime" {
|
|
|
170
170
|
}
|
|
171
171
|
/**
|
|
172
172
|
* Called when a {@link defines.command.build_base} command reaches its destination, and before building starts.
|
|
173
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
173
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_build_base_arrived Online documentation}
|
|
174
174
|
*/
|
|
175
175
|
interface OnBuildBaseArrivedEvent extends EventData {
|
|
176
176
|
/**
|
|
@@ -194,7 +194,7 @@ declare module "factorio:runtime" {
|
|
|
194
194
|
* Called when player builds something.
|
|
195
195
|
*
|
|
196
196
|
* Event filter: [LuaPlayerBuiltEntityEventFilter](LuaPlayerBuiltEntityEventFilter]
|
|
197
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
197
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_built_entity Online documentation}
|
|
198
198
|
*/
|
|
199
199
|
interface OnBuiltEntityEvent extends EventData {
|
|
200
200
|
/**
|
|
@@ -226,7 +226,7 @@ declare module "factorio:runtime" {
|
|
|
226
226
|
* Called when the deconstruction of an entity is canceled.
|
|
227
227
|
*
|
|
228
228
|
* Event filter: [LuaEntityDeconstructionCancelledEventFilter](LuaEntityDeconstructionCancelledEventFilter]
|
|
229
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
229
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cancelled_deconstruction Online documentation}
|
|
230
230
|
*/
|
|
231
231
|
interface OnCancelledDeconstructionEvent extends EventData {
|
|
232
232
|
readonly entity: LuaEntity
|
|
@@ -244,7 +244,7 @@ declare module "factorio:runtime" {
|
|
|
244
244
|
* Called when the upgrade of an entity is canceled.
|
|
245
245
|
*
|
|
246
246
|
* Event filter: [LuaUpgradeCancelledEventFilter](LuaUpgradeCancelledEventFilter]
|
|
247
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
247
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cancelled_upgrade Online documentation}
|
|
248
248
|
*/
|
|
249
249
|
interface OnCancelledUpgradeEvent extends EventData {
|
|
250
250
|
readonly entity: LuaEntity
|
|
@@ -262,7 +262,7 @@ declare module "factorio:runtime" {
|
|
|
262
262
|
}
|
|
263
263
|
/**
|
|
264
264
|
* Called after a cargo pod has delivered its cargo.
|
|
265
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
265
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cargo_pod_delivered_cargo Online documentation}
|
|
266
266
|
*/
|
|
267
267
|
interface OnCargoPodDeliveredCargoEvent extends EventData {
|
|
268
268
|
readonly cargo_pod: LuaEntity
|
|
@@ -281,7 +281,7 @@ declare module "factorio:runtime" {
|
|
|
281
281
|
}
|
|
282
282
|
/**
|
|
283
283
|
* Called when a cargo pod departs a surface.
|
|
284
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
284
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cargo_pod_finished_ascending Online documentation}
|
|
285
285
|
*/
|
|
286
286
|
interface OnCargoPodFinishedAscendingEvent extends EventData {
|
|
287
287
|
readonly cargo_pod: LuaEntity
|
|
@@ -304,7 +304,7 @@ declare module "factorio:runtime" {
|
|
|
304
304
|
}
|
|
305
305
|
/**
|
|
306
306
|
* Called when a cargo pods lands on a surface, either at a station or on the ground.
|
|
307
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
307
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cargo_pod_finished_descending Online documentation}
|
|
308
308
|
*/
|
|
309
309
|
interface OnCargoPodFinishedDescendingEvent extends EventData {
|
|
310
310
|
readonly cargo_pod: LuaEntity
|
|
@@ -327,7 +327,7 @@ declare module "factorio:runtime" {
|
|
|
327
327
|
}
|
|
328
328
|
/**
|
|
329
329
|
* Called when a cargo pod departs from a space platform hub or by another method not attached to a rocket.
|
|
330
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
330
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cargo_pod_started_ascending Online documentation}
|
|
331
331
|
*/
|
|
332
332
|
interface OnCargoPodStartedAscendingEvent extends EventData {
|
|
333
333
|
readonly cargo_pod: LuaEntity
|
|
@@ -348,7 +348,7 @@ declare module "factorio:runtime" {
|
|
|
348
348
|
* Called when a character corpse expires due to timeout or all of the items being removed from it.
|
|
349
349
|
*
|
|
350
350
|
* this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
|
|
351
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
351
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_character_corpse_expired Online documentation}
|
|
352
352
|
*/
|
|
353
353
|
interface OnCharacterCorpseExpiredEvent extends EventData {
|
|
354
354
|
/**
|
|
@@ -366,7 +366,7 @@ declare module "factorio:runtime" {
|
|
|
366
366
|
}
|
|
367
367
|
/**
|
|
368
368
|
* Called when a chart tag is created.
|
|
369
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
369
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_chart_tag_added Online documentation}
|
|
370
370
|
*/
|
|
371
371
|
interface OnChartTagAddedEvent extends EventData {
|
|
372
372
|
readonly tag: LuaCustomChartTag
|
|
@@ -383,7 +383,7 @@ declare module "factorio:runtime" {
|
|
|
383
383
|
}
|
|
384
384
|
/**
|
|
385
385
|
* Called when a chart tag is modified by a player or by script.
|
|
386
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
386
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_chart_tag_modified Online documentation}
|
|
387
387
|
*/
|
|
388
388
|
interface OnChartTagModifiedEvent extends EventData {
|
|
389
389
|
readonly tag: LuaCustomChartTag
|
|
@@ -405,7 +405,7 @@ declare module "factorio:runtime" {
|
|
|
405
405
|
}
|
|
406
406
|
/**
|
|
407
407
|
* Called just before a chart tag is deleted.
|
|
408
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
408
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_chart_tag_removed Online documentation}
|
|
409
409
|
*/
|
|
410
410
|
interface OnChartTagRemovedEvent extends EventData {
|
|
411
411
|
readonly tag: LuaCustomChartTag
|
|
@@ -422,7 +422,7 @@ declare module "factorio:runtime" {
|
|
|
422
422
|
}
|
|
423
423
|
/**
|
|
424
424
|
* Called when a chunk is charted or re-charted.
|
|
425
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
425
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_chunk_charted Online documentation}
|
|
426
426
|
*/
|
|
427
427
|
interface OnChunkChartedEvent extends EventData {
|
|
428
428
|
readonly surface_index: SurfaceIndex
|
|
@@ -443,7 +443,7 @@ declare module "factorio:runtime" {
|
|
|
443
443
|
}
|
|
444
444
|
/**
|
|
445
445
|
* Called when one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
|
|
446
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
446
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_chunk_deleted Online documentation}
|
|
447
447
|
*/
|
|
448
448
|
interface OnChunkDeletedEvent extends EventData {
|
|
449
449
|
readonly surface_index: SurfaceIndex
|
|
@@ -462,7 +462,7 @@ declare module "factorio:runtime" {
|
|
|
462
462
|
}
|
|
463
463
|
/**
|
|
464
464
|
* Called when a chunk is generated.
|
|
465
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
465
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_chunk_generated Online documentation}
|
|
466
466
|
*/
|
|
467
467
|
interface OnChunkGeneratedEvent extends EventData {
|
|
468
468
|
/**
|
|
@@ -488,7 +488,7 @@ declare module "factorio:runtime" {
|
|
|
488
488
|
}
|
|
489
489
|
/**
|
|
490
490
|
* Called when a combat robot expires through a lack of energy, or timeout.
|
|
491
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
491
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_combat_robot_expired Online documentation}
|
|
492
492
|
*/
|
|
493
493
|
interface OnCombatRobotExpiredEvent extends EventData {
|
|
494
494
|
readonly robot: LuaEntity
|
|
@@ -509,7 +509,7 @@ declare module "factorio:runtime" {
|
|
|
509
509
|
* Called when a message is sent to the in-game console, either by a player or through the server interface.
|
|
510
510
|
*
|
|
511
511
|
* This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
|
|
512
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
512
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_console_chat Online documentation}
|
|
513
513
|
*/
|
|
514
514
|
interface OnConsoleChatEvent extends EventData {
|
|
515
515
|
/**
|
|
@@ -531,7 +531,7 @@ declare module "factorio:runtime" {
|
|
|
531
531
|
}
|
|
532
532
|
/**
|
|
533
533
|
* Called when someone enters a command-like message regardless of it being a valid command.
|
|
534
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
534
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_console_command Online documentation}
|
|
535
535
|
*/
|
|
536
536
|
interface OnConsoleCommandEvent extends EventData {
|
|
537
537
|
/**
|
|
@@ -557,7 +557,7 @@ declare module "factorio:runtime" {
|
|
|
557
557
|
}
|
|
558
558
|
/**
|
|
559
559
|
* Called when a cutscene is cancelled by the player or by script.
|
|
560
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
560
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cutscene_cancelled Online documentation}
|
|
561
561
|
*/
|
|
562
562
|
interface OnCutsceneCancelledEvent extends EventData {
|
|
563
563
|
/**
|
|
@@ -575,7 +575,7 @@ declare module "factorio:runtime" {
|
|
|
575
575
|
}
|
|
576
576
|
/**
|
|
577
577
|
* Called when a cutscene finishes naturally (was not cancelled).
|
|
578
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
578
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cutscene_finished Online documentation}
|
|
579
579
|
*/
|
|
580
580
|
interface OnCutsceneFinishedEvent extends EventData {
|
|
581
581
|
/**
|
|
@@ -593,7 +593,7 @@ declare module "factorio:runtime" {
|
|
|
593
593
|
}
|
|
594
594
|
/**
|
|
595
595
|
* Called when a cutscene starts.
|
|
596
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
596
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cutscene_started Online documentation}
|
|
597
597
|
*/
|
|
598
598
|
interface OnCutsceneStartedEvent extends EventData {
|
|
599
599
|
/**
|
|
@@ -613,7 +613,7 @@ declare module "factorio:runtime" {
|
|
|
613
613
|
* Called when a cutscene is playing, each time it reaches a waypoint in that cutscene.
|
|
614
614
|
*
|
|
615
615
|
* This refers to an index in the table previously passed to set_controller which started the cutscene.
|
|
616
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
616
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_cutscene_waypoint_reached Online documentation}
|
|
617
617
|
*/
|
|
618
618
|
interface OnCutsceneWaypointReachedEvent extends EventData {
|
|
619
619
|
/**
|
|
@@ -637,7 +637,7 @@ declare module "factorio:runtime" {
|
|
|
637
637
|
* Called when an entity is cloned. The filter applies to the source entity.
|
|
638
638
|
*
|
|
639
639
|
* Event filter: [LuaEntityClonedEventFilter](LuaEntityClonedEventFilter]
|
|
640
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
640
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_entity_cloned Online documentation}
|
|
641
641
|
*/
|
|
642
642
|
interface OnEntityClonedEvent extends EventData {
|
|
643
643
|
readonly source: LuaEntity
|
|
@@ -655,7 +655,7 @@ declare module "factorio:runtime" {
|
|
|
655
655
|
* Called after an entity has been recolored either by the player or through script.
|
|
656
656
|
*
|
|
657
657
|
* Automatic recoloring due to {@link LuaPlayer#color LuaPlayer::color} will not raise events, as that is a separate mechanism.
|
|
658
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
658
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_entity_color_changed Online documentation}
|
|
659
659
|
*/
|
|
660
660
|
interface OnEntityColorChangedEvent extends EventData {
|
|
661
661
|
/**
|
|
@@ -675,7 +675,7 @@ declare module "factorio:runtime" {
|
|
|
675
675
|
* Called when an entity is damaged. This is not called when an entities health is set directly by another mod.
|
|
676
676
|
*
|
|
677
677
|
* Event filter: [LuaEntityDamagedEventFilter](LuaEntityDamagedEventFilter]
|
|
678
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
678
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_entity_damaged Online documentation}
|
|
679
679
|
*/
|
|
680
680
|
interface OnEntityDamagedEvent extends EventData {
|
|
681
681
|
readonly entity: LuaEntity
|
|
@@ -717,7 +717,7 @@ declare module "factorio:runtime" {
|
|
|
717
717
|
* Called when an entity dies.
|
|
718
718
|
*
|
|
719
719
|
* Event filter: [LuaEntityDiedEventFilter](LuaEntityDiedEventFilter]
|
|
720
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
720
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_entity_died Online documentation}
|
|
721
721
|
*/
|
|
722
722
|
interface OnEntityDiedEvent extends EventData {
|
|
723
723
|
/**
|
|
@@ -751,7 +751,7 @@ declare module "factorio:runtime" {
|
|
|
751
751
|
}
|
|
752
752
|
/**
|
|
753
753
|
* Called when one of an entity's logistic slots changes.
|
|
754
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
754
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_entity_logistic_slot_changed Online documentation}
|
|
755
755
|
*/
|
|
756
756
|
interface OnEntityLogisticSlotChangedEvent extends EventData {
|
|
757
757
|
/**
|
|
@@ -781,7 +781,7 @@ declare module "factorio:runtime" {
|
|
|
781
781
|
}
|
|
782
782
|
/**
|
|
783
783
|
* Called after an entity has been renamed either by the player or through script.
|
|
784
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
784
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_entity_renamed Online documentation}
|
|
785
785
|
*/
|
|
786
786
|
interface OnEntityRenamedEvent extends EventData {
|
|
787
787
|
/**
|
|
@@ -802,7 +802,7 @@ declare module "factorio:runtime" {
|
|
|
802
802
|
}
|
|
803
803
|
/**
|
|
804
804
|
* Called after entity copy-paste is done.
|
|
805
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
805
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_entity_settings_pasted Online documentation}
|
|
806
806
|
*/
|
|
807
807
|
interface OnEntitySettingsPastedEvent extends EventData {
|
|
808
808
|
readonly player_index: PlayerIndex
|
|
@@ -825,7 +825,7 @@ declare module "factorio:runtime" {
|
|
|
825
825
|
}
|
|
826
826
|
/**
|
|
827
827
|
* Called when an entity is spawned by a EnemySpawner
|
|
828
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
828
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_entity_spawned Online documentation}
|
|
829
829
|
*/
|
|
830
830
|
interface OnEntitySpawnedEvent extends EventData {
|
|
831
831
|
readonly spawner: LuaEntity
|
|
@@ -841,7 +841,7 @@ declare module "factorio:runtime" {
|
|
|
841
841
|
}
|
|
842
842
|
/**
|
|
843
843
|
* Called after equipment is inserted into an equipment grid.
|
|
844
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
844
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_equipment_inserted Online documentation}
|
|
845
845
|
*/
|
|
846
846
|
interface OnEquipmentInsertedEvent extends EventData {
|
|
847
847
|
/**
|
|
@@ -863,7 +863,7 @@ declare module "factorio:runtime" {
|
|
|
863
863
|
}
|
|
864
864
|
/**
|
|
865
865
|
* Called after equipment is removed from an equipment grid.
|
|
866
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
866
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_equipment_removed Online documentation}
|
|
867
867
|
*/
|
|
868
868
|
interface OnEquipmentRemovedEvent extends EventData {
|
|
869
869
|
/**
|
|
@@ -893,7 +893,7 @@ declare module "factorio:runtime" {
|
|
|
893
893
|
}
|
|
894
894
|
/**
|
|
895
895
|
* Called when the a forces cease fire values change.
|
|
896
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
896
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_force_cease_fire_changed Online documentation}
|
|
897
897
|
*/
|
|
898
898
|
interface OnForceCeaseFireChangedEvent extends EventData {
|
|
899
899
|
/**
|
|
@@ -921,7 +921,7 @@ declare module "factorio:runtime" {
|
|
|
921
921
|
* Called when a new force is created using `game.create_force()`
|
|
922
922
|
*
|
|
923
923
|
* This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will always exist.
|
|
924
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
924
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_force_created Online documentation}
|
|
925
925
|
*/
|
|
926
926
|
interface OnForceCreatedEvent extends EventData {
|
|
927
927
|
/**
|
|
@@ -939,7 +939,7 @@ declare module "factorio:runtime" {
|
|
|
939
939
|
}
|
|
940
940
|
/**
|
|
941
941
|
* Called when the a forces friends change.
|
|
942
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
942
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_force_friends_changed Online documentation}
|
|
943
943
|
*/
|
|
944
944
|
interface OnForceFriendsChangedEvent extends EventData {
|
|
945
945
|
/**
|
|
@@ -965,7 +965,7 @@ declare module "factorio:runtime" {
|
|
|
965
965
|
}
|
|
966
966
|
/**
|
|
967
967
|
* Called when {@link LuaForce#reset LuaForce::reset} is finished.
|
|
968
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
968
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_force_reset Online documentation}
|
|
969
969
|
*/
|
|
970
970
|
interface OnForceResetEvent extends EventData {
|
|
971
971
|
readonly force: LuaForce
|
|
@@ -982,7 +982,7 @@ declare module "factorio:runtime" {
|
|
|
982
982
|
* Called after two forces have been merged using `game.merge_forces()`.
|
|
983
983
|
*
|
|
984
984
|
* The source force is invalidated before this event is called and the name can be re-used in this event if desired.
|
|
985
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
985
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_forces_merged Online documentation}
|
|
986
986
|
*/
|
|
987
987
|
interface OnForcesMergedEvent extends EventData {
|
|
988
988
|
/**
|
|
@@ -1008,7 +1008,7 @@ declare module "factorio:runtime" {
|
|
|
1008
1008
|
}
|
|
1009
1009
|
/**
|
|
1010
1010
|
* Called when two forces are about to be merged using `game.merge_forces()`.
|
|
1011
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1011
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_forces_merging Online documentation}
|
|
1012
1012
|
*/
|
|
1013
1013
|
interface OnForcesMergingEvent extends EventData {
|
|
1014
1014
|
/**
|
|
@@ -1032,7 +1032,7 @@ declare module "factorio:runtime" {
|
|
|
1032
1032
|
* 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.
|
|
1033
1033
|
*
|
|
1034
1034
|
* This event is not fired when the scenario is loaded via the map editor.
|
|
1035
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1035
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_game_created_from_scenario Online documentation}
|
|
1036
1036
|
*/
|
|
1037
1037
|
interface OnGameCreatedFromScenarioEvent extends EventData {
|
|
1038
1038
|
/**
|
|
@@ -1046,7 +1046,7 @@ declare module "factorio:runtime" {
|
|
|
1046
1046
|
}
|
|
1047
1047
|
/**
|
|
1048
1048
|
* Called when {@link LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
|
|
1049
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1049
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_checked_state_changed Online documentation}
|
|
1050
1050
|
*/
|
|
1051
1051
|
interface OnGuiCheckedStateChangedEvent extends EventData {
|
|
1052
1052
|
/**
|
|
@@ -1068,7 +1068,7 @@ declare module "factorio:runtime" {
|
|
|
1068
1068
|
}
|
|
1069
1069
|
/**
|
|
1070
1070
|
* Called when {@link LuaGuiElement} is clicked.
|
|
1071
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1071
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_click Online documentation}
|
|
1072
1072
|
*/
|
|
1073
1073
|
interface OnGuiClickEvent extends EventData {
|
|
1074
1074
|
/**
|
|
@@ -1114,7 +1114,7 @@ declare module "factorio:runtime" {
|
|
|
1114
1114
|
* This can only be raised when the GUI's player controller is still valid. If a GUI is thus closed due to the player disconnecting, dying, or becoming a spectator in other ways, it won't cause this event to be raised.
|
|
1115
1115
|
*
|
|
1116
1116
|
* It's not advised to open any other GUI during this event because if this is run as a request to open a different GUI the game will force close the new opened GUI without notice to ensure the original requested GUI is opened.
|
|
1117
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1117
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_closed Online documentation}
|
|
1118
1118
|
*/
|
|
1119
1119
|
interface OnGuiClosedEvent extends EventData {
|
|
1120
1120
|
/**
|
|
@@ -1168,7 +1168,7 @@ declare module "factorio:runtime" {
|
|
|
1168
1168
|
}
|
|
1169
1169
|
/**
|
|
1170
1170
|
* Called when a {@link LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
|
|
1171
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1171
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_confirmed Online documentation}
|
|
1172
1172
|
*/
|
|
1173
1173
|
interface OnGuiConfirmedEvent extends EventData {
|
|
1174
1174
|
/**
|
|
@@ -1202,7 +1202,7 @@ declare module "factorio:runtime" {
|
|
|
1202
1202
|
}
|
|
1203
1203
|
/**
|
|
1204
1204
|
* Called when {@link LuaGuiElement} element value is changed (related to choose element buttons).
|
|
1205
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1205
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_elem_changed Online documentation}
|
|
1206
1206
|
*/
|
|
1207
1207
|
interface OnGuiElemChangedEvent extends EventData {
|
|
1208
1208
|
/**
|
|
@@ -1226,7 +1226,7 @@ declare module "factorio:runtime" {
|
|
|
1226
1226
|
* Called when {@link LuaGuiElement} is hovered by the mouse.
|
|
1227
1227
|
*
|
|
1228
1228
|
* Only fired for events whose {@link LuaGuiElement#raise_hover_events LuaGuiElement::raise_hover_events} is `true`.
|
|
1229
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1229
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_hover Online documentation}
|
|
1230
1230
|
*/
|
|
1231
1231
|
interface OnGuiHoverEvent extends EventData {
|
|
1232
1232
|
/**
|
|
@@ -1250,7 +1250,7 @@ declare module "factorio:runtime" {
|
|
|
1250
1250
|
* Called when the player's cursor leaves a {@link LuaGuiElement} that was previously hovered.
|
|
1251
1251
|
*
|
|
1252
1252
|
* Only fired for events whose {@link LuaGuiElement#raise_hover_events LuaGuiElement::raise_hover_events} is `true`.
|
|
1253
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1253
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_leave Online documentation}
|
|
1254
1254
|
*/
|
|
1255
1255
|
interface OnGuiLeaveEvent extends EventData {
|
|
1256
1256
|
/**
|
|
@@ -1272,7 +1272,7 @@ declare module "factorio:runtime" {
|
|
|
1272
1272
|
}
|
|
1273
1273
|
/**
|
|
1274
1274
|
* Called when {@link LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
|
|
1275
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1275
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_location_changed Online documentation}
|
|
1276
1276
|
*/
|
|
1277
1277
|
interface OnGuiLocationChangedEvent extends EventData {
|
|
1278
1278
|
/**
|
|
@@ -1294,7 +1294,7 @@ declare module "factorio:runtime" {
|
|
|
1294
1294
|
}
|
|
1295
1295
|
/**
|
|
1296
1296
|
* Called when the player opens a GUI.
|
|
1297
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1297
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_opened Online documentation}
|
|
1298
1298
|
*/
|
|
1299
1299
|
interface OnGuiOpenedEvent extends EventData {
|
|
1300
1300
|
/**
|
|
@@ -1348,7 +1348,7 @@ declare module "factorio:runtime" {
|
|
|
1348
1348
|
}
|
|
1349
1349
|
/**
|
|
1350
1350
|
* Called when {@link LuaGuiElement} selected tab is changed (related to tabbed-panes).
|
|
1351
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1351
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_selected_tab_changed Online documentation}
|
|
1352
1352
|
*/
|
|
1353
1353
|
interface OnGuiSelectedTabChangedEvent extends EventData {
|
|
1354
1354
|
/**
|
|
@@ -1370,7 +1370,7 @@ declare module "factorio:runtime" {
|
|
|
1370
1370
|
}
|
|
1371
1371
|
/**
|
|
1372
1372
|
* Called when {@link LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
|
|
1373
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1373
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_selection_state_changed Online documentation}
|
|
1374
1374
|
*/
|
|
1375
1375
|
interface OnGuiSelectionStateChangedEvent extends EventData {
|
|
1376
1376
|
/**
|
|
@@ -1392,7 +1392,7 @@ declare module "factorio:runtime" {
|
|
|
1392
1392
|
}
|
|
1393
1393
|
/**
|
|
1394
1394
|
* Called when {@link LuaGuiElement} switch state is changed (related to switches).
|
|
1395
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1395
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_switch_state_changed Online documentation}
|
|
1396
1396
|
*/
|
|
1397
1397
|
interface OnGuiSwitchStateChangedEvent extends EventData {
|
|
1398
1398
|
/**
|
|
@@ -1414,7 +1414,7 @@ declare module "factorio:runtime" {
|
|
|
1414
1414
|
}
|
|
1415
1415
|
/**
|
|
1416
1416
|
* Called when {@link LuaGuiElement} text is changed by the player.
|
|
1417
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1417
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_text_changed Online documentation}
|
|
1418
1418
|
*/
|
|
1419
1419
|
interface OnGuiTextChangedEvent extends EventData {
|
|
1420
1420
|
/**
|
|
@@ -1440,7 +1440,7 @@ declare module "factorio:runtime" {
|
|
|
1440
1440
|
}
|
|
1441
1441
|
/**
|
|
1442
1442
|
* Called when {@link LuaGuiElement} slider value is changed (related to the slider element).
|
|
1443
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1443
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_gui_value_changed Online documentation}
|
|
1444
1444
|
*/
|
|
1445
1445
|
interface OnGuiValueChangedEvent extends EventData {
|
|
1446
1446
|
/**
|
|
@@ -1462,7 +1462,7 @@ declare module "factorio:runtime" {
|
|
|
1462
1462
|
}
|
|
1463
1463
|
/**
|
|
1464
1464
|
* Called when a land mine is armed.
|
|
1465
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1465
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_land_mine_armed Online documentation}
|
|
1466
1466
|
*/
|
|
1467
1467
|
interface OnLandMineArmedEvent extends EventData {
|
|
1468
1468
|
readonly mine: LuaEntity
|
|
@@ -1477,7 +1477,7 @@ declare module "factorio:runtime" {
|
|
|
1477
1477
|
}
|
|
1478
1478
|
/**
|
|
1479
1479
|
* Called when a custom {@link import("factorio:prototype").ShortcutPrototype Lua shortcut} is pressed.
|
|
1480
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1480
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_lua_shortcut Online documentation}
|
|
1481
1481
|
*/
|
|
1482
1482
|
interface OnLuaShortcutEvent extends EventData {
|
|
1483
1483
|
readonly player_index: PlayerIndex
|
|
@@ -1498,7 +1498,7 @@ declare module "factorio:runtime" {
|
|
|
1498
1498
|
* Called when an entity is marked for deconstruction with the Deconstruction planner or via script.
|
|
1499
1499
|
*
|
|
1500
1500
|
* Event filter: [LuaEntityMarkedForDeconstructionEventFilter](LuaEntityMarkedForDeconstructionEventFilter]
|
|
1501
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1501
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_marked_for_deconstruction Online documentation}
|
|
1502
1502
|
*/
|
|
1503
1503
|
interface OnMarkedForDeconstructionEvent extends EventData {
|
|
1504
1504
|
readonly entity: LuaEntity
|
|
@@ -1516,7 +1516,7 @@ declare module "factorio:runtime" {
|
|
|
1516
1516
|
* Called when an entity is marked for upgrade with the upgrade planner or via script.
|
|
1517
1517
|
*
|
|
1518
1518
|
* Event filter: [LuaEntityMarkedForUpgradeEventFilter](LuaEntityMarkedForUpgradeEventFilter]
|
|
1519
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1519
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_marked_for_upgrade Online documentation}
|
|
1520
1520
|
*/
|
|
1521
1521
|
interface OnMarkedForUpgradeEvent extends EventData {
|
|
1522
1522
|
readonly player_index?: PlayerIndex
|
|
@@ -1545,7 +1545,7 @@ declare module "factorio:runtime" {
|
|
|
1545
1545
|
}
|
|
1546
1546
|
/**
|
|
1547
1547
|
* Called after a player purchases some offer from a `market` entity.
|
|
1548
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1548
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_market_item_purchased Online documentation}
|
|
1549
1549
|
*/
|
|
1550
1550
|
interface OnMarketItemPurchasedEvent extends EventData {
|
|
1551
1551
|
/**
|
|
@@ -1575,7 +1575,7 @@ declare module "factorio:runtime" {
|
|
|
1575
1575
|
}
|
|
1576
1576
|
/**
|
|
1577
1577
|
* Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
|
|
1578
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1578
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_mod_item_opened Online documentation}
|
|
1579
1579
|
*/
|
|
1580
1580
|
interface OnModItemOpenedEvent extends EventData {
|
|
1581
1581
|
/**
|
|
@@ -1601,7 +1601,7 @@ declare module "factorio:runtime" {
|
|
|
1601
1601
|
}
|
|
1602
1602
|
/**
|
|
1603
1603
|
* Called when {@link LuaGameScript#is_multiplayer LuaGameScript::is_multiplayer} changes to true. May also be raised when it was already true but a game was loaded from a save file and with hosting.
|
|
1604
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1604
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_multiplayer_init Online documentation}
|
|
1605
1605
|
*/
|
|
1606
1606
|
interface OnMultiplayerInitEvent extends EventData {
|
|
1607
1607
|
/**
|
|
@@ -1617,7 +1617,7 @@ declare module "factorio:runtime" {
|
|
|
1617
1617
|
* Called after an object is destroyed which was registered with {@link LuaBootstrap#register_on_object_destroyed LuaBootstrap::register_on_object_destroyed} previously.
|
|
1618
1618
|
*
|
|
1619
1619
|
* Depending on when a given object is destroyed, this event will be fired at the end of the current tick or at the end of the next tick. The event's timing is independent of the in-world object being destroyed.
|
|
1620
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1620
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_object_destroyed Online documentation}
|
|
1621
1621
|
*/
|
|
1622
1622
|
interface OnObjectDestroyedEvent extends EventData {
|
|
1623
1623
|
/**
|
|
@@ -1643,7 +1643,7 @@ declare module "factorio:runtime" {
|
|
|
1643
1643
|
}
|
|
1644
1644
|
/**
|
|
1645
1645
|
* Called directly after a permission group is added.
|
|
1646
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1646
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_permission_group_added Online documentation}
|
|
1647
1647
|
*/
|
|
1648
1648
|
interface OnPermissionGroupAddedEvent extends EventData {
|
|
1649
1649
|
/**
|
|
@@ -1665,7 +1665,7 @@ declare module "factorio:runtime" {
|
|
|
1665
1665
|
}
|
|
1666
1666
|
/**
|
|
1667
1667
|
* Called directly after a permission group is deleted.
|
|
1668
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1668
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_permission_group_deleted Online documentation}
|
|
1669
1669
|
*/
|
|
1670
1670
|
interface OnPermissionGroupDeletedEvent extends EventData {
|
|
1671
1671
|
/**
|
|
@@ -1691,7 +1691,7 @@ declare module "factorio:runtime" {
|
|
|
1691
1691
|
}
|
|
1692
1692
|
/**
|
|
1693
1693
|
* Called directly after a permission group is edited in some way.
|
|
1694
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1694
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_permission_group_edited Online documentation}
|
|
1695
1695
|
*/
|
|
1696
1696
|
interface OnPermissionGroupEditedEvent extends EventData {
|
|
1697
1697
|
/**
|
|
@@ -1740,7 +1740,7 @@ declare module "factorio:runtime" {
|
|
|
1740
1740
|
}
|
|
1741
1741
|
/**
|
|
1742
1742
|
* Called directly after a permission string is imported.
|
|
1743
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1743
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_permission_string_imported Online documentation}
|
|
1744
1744
|
*/
|
|
1745
1745
|
interface OnPermissionStringImportedEvent extends EventData {
|
|
1746
1746
|
/**
|
|
@@ -1758,7 +1758,7 @@ declare module "factorio:runtime" {
|
|
|
1758
1758
|
}
|
|
1759
1759
|
/**
|
|
1760
1760
|
* Called when a player picks up an item.
|
|
1761
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1761
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_picked_up_item Online documentation}
|
|
1762
1762
|
*/
|
|
1763
1763
|
interface OnPickedUpItemEvent extends EventData {
|
|
1764
1764
|
readonly item_stack: ItemWithQualityCount
|
|
@@ -1774,7 +1774,7 @@ declare module "factorio:runtime" {
|
|
|
1774
1774
|
}
|
|
1775
1775
|
/**
|
|
1776
1776
|
* Called after a player alt-reverse-selects an area with a selection-tool item.
|
|
1777
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1777
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_alt_reverse_selected_area Online documentation}
|
|
1778
1778
|
*/
|
|
1779
1779
|
interface OnPlayerAltReverseSelectedAreaEvent extends EventData {
|
|
1780
1780
|
/**
|
|
@@ -1812,7 +1812,7 @@ declare module "factorio:runtime" {
|
|
|
1812
1812
|
}
|
|
1813
1813
|
/**
|
|
1814
1814
|
* Called after a player alt-selects an area with a selection-tool item.
|
|
1815
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1815
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_alt_selected_area Online documentation}
|
|
1816
1816
|
*/
|
|
1817
1817
|
interface OnPlayerAltSelectedAreaEvent extends EventData {
|
|
1818
1818
|
/**
|
|
@@ -1854,7 +1854,7 @@ declare module "factorio:runtime" {
|
|
|
1854
1854
|
}
|
|
1855
1855
|
/**
|
|
1856
1856
|
* Called after a players ammo inventory changed in some way.
|
|
1857
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1857
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_ammo_inventory_changed Online documentation}
|
|
1858
1858
|
*/
|
|
1859
1859
|
interface OnPlayerAmmoInventoryChangedEvent extends EventData {
|
|
1860
1860
|
readonly player_index: PlayerIndex
|
|
@@ -1869,7 +1869,7 @@ declare module "factorio:runtime" {
|
|
|
1869
1869
|
}
|
|
1870
1870
|
/**
|
|
1871
1871
|
* Called after a players armor inventory changed in some way.
|
|
1872
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1872
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_armor_inventory_changed Online documentation}
|
|
1873
1873
|
*/
|
|
1874
1874
|
interface OnPlayerArmorInventoryChangedEvent extends EventData {
|
|
1875
1875
|
readonly player_index: PlayerIndex
|
|
@@ -1884,7 +1884,7 @@ declare module "factorio:runtime" {
|
|
|
1884
1884
|
}
|
|
1885
1885
|
/**
|
|
1886
1886
|
* Called when a player is banned.
|
|
1887
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1887
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_banned Online documentation}
|
|
1888
1888
|
*/
|
|
1889
1889
|
interface OnPlayerBannedEvent extends EventData {
|
|
1890
1890
|
/**
|
|
@@ -1914,7 +1914,7 @@ declare module "factorio:runtime" {
|
|
|
1914
1914
|
}
|
|
1915
1915
|
/**
|
|
1916
1916
|
* Called after a player builds tiles.
|
|
1917
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1917
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_built_tile Online documentation}
|
|
1918
1918
|
*/
|
|
1919
1919
|
interface OnPlayerBuiltTileEvent extends EventData {
|
|
1920
1920
|
readonly player_index: PlayerIndex
|
|
@@ -1953,7 +1953,7 @@ declare module "factorio:runtime" {
|
|
|
1953
1953
|
}
|
|
1954
1954
|
/**
|
|
1955
1955
|
* Called when a player cancels crafting.
|
|
1956
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1956
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_cancelled_crafting Online documentation}
|
|
1957
1957
|
*/
|
|
1958
1958
|
interface OnPlayerCancelledCraftingEvent extends EventData {
|
|
1959
1959
|
/**
|
|
@@ -1983,7 +1983,7 @@ declare module "factorio:runtime" {
|
|
|
1983
1983
|
}
|
|
1984
1984
|
/**
|
|
1985
1985
|
* Called after a player changes forces.
|
|
1986
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
1986
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_changed_force Online documentation}
|
|
1987
1987
|
*/
|
|
1988
1988
|
interface OnPlayerChangedForceEvent extends EventData {
|
|
1989
1989
|
/**
|
|
@@ -2005,7 +2005,7 @@ declare module "factorio:runtime" {
|
|
|
2005
2005
|
}
|
|
2006
2006
|
/**
|
|
2007
2007
|
* Called when the tile position a player is located at changes.
|
|
2008
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2008
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_changed_position Online documentation}
|
|
2009
2009
|
*/
|
|
2010
2010
|
interface OnPlayerChangedPositionEvent extends EventData {
|
|
2011
2011
|
/**
|
|
@@ -2023,7 +2023,7 @@ declare module "factorio:runtime" {
|
|
|
2023
2023
|
}
|
|
2024
2024
|
/**
|
|
2025
2025
|
* Called after a player changes surfaces.
|
|
2026
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2026
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_changed_surface Online documentation}
|
|
2027
2027
|
*/
|
|
2028
2028
|
interface OnPlayerChangedSurfaceEvent extends EventData {
|
|
2029
2029
|
/**
|
|
@@ -2045,7 +2045,7 @@ declare module "factorio:runtime" {
|
|
|
2045
2045
|
}
|
|
2046
2046
|
/**
|
|
2047
2047
|
* Called when cheat mode is disabled on a player.
|
|
2048
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2048
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_cheat_mode_disabled Online documentation}
|
|
2049
2049
|
*/
|
|
2050
2050
|
interface OnPlayerCheatModeDisabledEvent extends EventData {
|
|
2051
2051
|
/**
|
|
@@ -2063,7 +2063,7 @@ declare module "factorio:runtime" {
|
|
|
2063
2063
|
}
|
|
2064
2064
|
/**
|
|
2065
2065
|
* Called when cheat mode is enabled on a player.
|
|
2066
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2066
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_cheat_mode_enabled Online documentation}
|
|
2067
2067
|
*/
|
|
2068
2068
|
interface OnPlayerCheatModeEnabledEvent extends EventData {
|
|
2069
2069
|
/**
|
|
@@ -2081,7 +2081,7 @@ declare module "factorio:runtime" {
|
|
|
2081
2081
|
}
|
|
2082
2082
|
/**
|
|
2083
2083
|
* Called when a player clicks a gps tag
|
|
2084
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2084
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_clicked_gps_tag Online documentation}
|
|
2085
2085
|
*/
|
|
2086
2086
|
interface OnPlayerClickedGpsTagEvent extends EventData {
|
|
2087
2087
|
/**
|
|
@@ -2107,7 +2107,7 @@ declare module "factorio:runtime" {
|
|
|
2107
2107
|
}
|
|
2108
2108
|
/**
|
|
2109
2109
|
* Called when a player clicks the "confirm" button in the configure Blueprint GUI.
|
|
2110
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2110
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_configured_blueprint Online documentation}
|
|
2111
2111
|
*/
|
|
2112
2112
|
interface OnPlayerConfiguredBlueprintEvent extends EventData {
|
|
2113
2113
|
/**
|
|
@@ -2125,7 +2125,7 @@ declare module "factorio:runtime" {
|
|
|
2125
2125
|
}
|
|
2126
2126
|
/**
|
|
2127
2127
|
* Called after a player changes controller types.
|
|
2128
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2128
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_controller_changed Online documentation}
|
|
2129
2129
|
*/
|
|
2130
2130
|
interface OnPlayerControllerChangedEvent extends EventData {
|
|
2131
2131
|
/**
|
|
@@ -2147,7 +2147,7 @@ declare module "factorio:runtime" {
|
|
|
2147
2147
|
}
|
|
2148
2148
|
/**
|
|
2149
2149
|
* 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 OnPrePlayerCraftedItemEvent on_pre_player_crafted_item}).
|
|
2150
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2150
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_crafted_item Online documentation}
|
|
2151
2151
|
*/
|
|
2152
2152
|
interface OnPlayerCraftedItemEvent extends EventData {
|
|
2153
2153
|
/**
|
|
@@ -2173,7 +2173,7 @@ declare module "factorio:runtime" {
|
|
|
2173
2173
|
}
|
|
2174
2174
|
/**
|
|
2175
2175
|
* Called after the player was created.
|
|
2176
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2176
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_created Online documentation}
|
|
2177
2177
|
*/
|
|
2178
2178
|
interface OnPlayerCreatedEvent extends EventData {
|
|
2179
2179
|
readonly player_index: PlayerIndex
|
|
@@ -2190,7 +2190,7 @@ declare module "factorio:runtime" {
|
|
|
2190
2190
|
* Called after a player's {@link LuaControl#cursor_stack cursor stack} changed in some way.
|
|
2191
2191
|
*
|
|
2192
2192
|
* This is fired in the same tick that the change happens, but not instantly.
|
|
2193
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2193
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_cursor_stack_changed Online documentation}
|
|
2194
2194
|
*/
|
|
2195
2195
|
interface OnPlayerCursorStackChangedEvent extends EventData {
|
|
2196
2196
|
readonly player_index: PlayerIndex
|
|
@@ -2205,7 +2205,7 @@ declare module "factorio:runtime" {
|
|
|
2205
2205
|
}
|
|
2206
2206
|
/**
|
|
2207
2207
|
* Called when a player selects an area with a deconstruction planner.
|
|
2208
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2208
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_deconstructed_area Online documentation}
|
|
2209
2209
|
*/
|
|
2210
2210
|
interface OnPlayerDeconstructedAreaEvent extends EventData {
|
|
2211
2211
|
/**
|
|
@@ -2251,7 +2251,7 @@ declare module "factorio:runtime" {
|
|
|
2251
2251
|
}
|
|
2252
2252
|
/**
|
|
2253
2253
|
* Called when a player is demoted.
|
|
2254
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2254
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_demoted Online documentation}
|
|
2255
2255
|
*/
|
|
2256
2256
|
interface OnPlayerDemotedEvent extends EventData {
|
|
2257
2257
|
/**
|
|
@@ -2269,7 +2269,7 @@ declare module "factorio:runtime" {
|
|
|
2269
2269
|
}
|
|
2270
2270
|
/**
|
|
2271
2271
|
* Called after a player dies.
|
|
2272
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2272
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_died Online documentation}
|
|
2273
2273
|
*/
|
|
2274
2274
|
interface OnPlayerDiedEvent extends EventData {
|
|
2275
2275
|
readonly player_index: PlayerIndex
|
|
@@ -2285,7 +2285,7 @@ declare module "factorio:runtime" {
|
|
|
2285
2285
|
}
|
|
2286
2286
|
/**
|
|
2287
2287
|
* Called when the display density scale changes for a given player. The display density scale is the scale value automatically applied based on the player's display DPI. This is only relevant on platforms that support high-density displays.
|
|
2288
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2288
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_display_density_scale_changed Online documentation}
|
|
2289
2289
|
*/
|
|
2290
2290
|
interface OnPlayerDisplayDensityScaleChangedEvent extends EventData {
|
|
2291
2291
|
/**
|
|
@@ -2307,7 +2307,7 @@ declare module "factorio:runtime" {
|
|
|
2307
2307
|
}
|
|
2308
2308
|
/**
|
|
2309
2309
|
* Called when the display resolution changes for a given player.
|
|
2310
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2310
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_display_resolution_changed Online documentation}
|
|
2311
2311
|
*/
|
|
2312
2312
|
interface OnPlayerDisplayResolutionChangedEvent extends EventData {
|
|
2313
2313
|
/**
|
|
@@ -2329,7 +2329,7 @@ declare module "factorio:runtime" {
|
|
|
2329
2329
|
}
|
|
2330
2330
|
/**
|
|
2331
2331
|
* Called when the display scale changes for a given player.
|
|
2332
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2332
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_display_scale_changed Online documentation}
|
|
2333
2333
|
*/
|
|
2334
2334
|
interface OnPlayerDisplayScaleChangedEvent extends EventData {
|
|
2335
2335
|
/**
|
|
@@ -2353,7 +2353,7 @@ declare module "factorio:runtime" {
|
|
|
2353
2353
|
* Called when the player's driving state has changed, meaning a player has either entered or left a vehicle.
|
|
2354
2354
|
*
|
|
2355
2355
|
* This event is not raised when the player is ejected from a vehicle due to it being destroyed.
|
|
2356
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2356
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_driving_changed_state Online documentation}
|
|
2357
2357
|
*/
|
|
2358
2358
|
interface OnPlayerDrivingChangedStateEvent extends EventData {
|
|
2359
2359
|
readonly player_index: PlayerIndex
|
|
@@ -2372,7 +2372,7 @@ declare module "factorio:runtime" {
|
|
|
2372
2372
|
}
|
|
2373
2373
|
/**
|
|
2374
2374
|
* Called when a player drops an item on the ground.
|
|
2375
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2375
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_dropped_item Online documentation}
|
|
2376
2376
|
*/
|
|
2377
2377
|
interface OnPlayerDroppedItemEvent extends EventData {
|
|
2378
2378
|
readonly player_index: PlayerIndex
|
|
@@ -2389,9 +2389,28 @@ declare module "factorio:runtime" {
|
|
|
2389
2389
|
*/
|
|
2390
2390
|
readonly tick: uint32
|
|
2391
2391
|
}
|
|
2392
|
+
/**
|
|
2393
|
+
* Called when a player drops a single item into an entity.
|
|
2394
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_dropped_item_into_entity Online documentation}
|
|
2395
|
+
*/
|
|
2396
|
+
interface OnPlayerDroppedItemIntoEntityEvent extends EventData {
|
|
2397
|
+
readonly player_index: PlayerIndex
|
|
2398
|
+
/**
|
|
2399
|
+
* The entity the item was dropped into.
|
|
2400
|
+
*/
|
|
2401
|
+
readonly entity: LuaEntity
|
|
2402
|
+
/**
|
|
2403
|
+
* Identifier of the event
|
|
2404
|
+
*/
|
|
2405
|
+
readonly name: typeof defines.events.on_player_dropped_item_into_entity
|
|
2406
|
+
/**
|
|
2407
|
+
* Tick the event was generated.
|
|
2408
|
+
*/
|
|
2409
|
+
readonly tick: uint32
|
|
2410
|
+
}
|
|
2392
2411
|
/**
|
|
2393
2412
|
* Called when a player fast-transfers something to or from an entity.
|
|
2394
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2413
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_fast_transferred Online documentation}
|
|
2395
2414
|
*/
|
|
2396
2415
|
interface OnPlayerFastTransferredEvent extends EventData {
|
|
2397
2416
|
/**
|
|
@@ -2423,7 +2442,7 @@ declare module "factorio:runtime" {
|
|
|
2423
2442
|
* Called when the player flips an entity. This event is only fired when the entity actually changes its orientation or mirroring, so it won't be triggered when pressing the flip keys on an entity that can't be flipped.
|
|
2424
2443
|
*
|
|
2425
2444
|
* This event reflects a change in the {@link LuaEntity#mirroring LuaEntity::mirroring} property.
|
|
2426
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2445
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_flipped_entity Online documentation}
|
|
2427
2446
|
*/
|
|
2428
2447
|
interface OnPlayerFlippedEntityEvent extends EventData {
|
|
2429
2448
|
/**
|
|
@@ -2446,7 +2465,7 @@ declare module "factorio:runtime" {
|
|
|
2446
2465
|
}
|
|
2447
2466
|
/**
|
|
2448
2467
|
* Called after player flushed fluid
|
|
2449
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2468
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_flushed_fluid Online documentation}
|
|
2450
2469
|
*/
|
|
2451
2470
|
interface OnPlayerFlushedFluidEvent extends EventData {
|
|
2452
2471
|
/**
|
|
@@ -2480,7 +2499,7 @@ declare module "factorio:runtime" {
|
|
|
2480
2499
|
}
|
|
2481
2500
|
/**
|
|
2482
2501
|
* Called after a players gun inventory changed in some way.
|
|
2483
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2502
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_gun_inventory_changed Online documentation}
|
|
2484
2503
|
*/
|
|
2485
2504
|
interface OnPlayerGunInventoryChangedEvent extends EventData {
|
|
2486
2505
|
readonly player_index: PlayerIndex
|
|
@@ -2495,7 +2514,7 @@ declare module "factorio:runtime" {
|
|
|
2495
2514
|
}
|
|
2496
2515
|
/**
|
|
2497
2516
|
* Called when a player's input method changes. See {@link LuaPlayer#input_method LuaPlayer::input_method}.
|
|
2498
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2517
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_input_method_changed Online documentation}
|
|
2499
2518
|
*/
|
|
2500
2519
|
interface OnPlayerInputMethodChangedEvent extends EventData {
|
|
2501
2520
|
/**
|
|
@@ -2513,7 +2532,7 @@ declare module "factorio:runtime" {
|
|
|
2513
2532
|
}
|
|
2514
2533
|
/**
|
|
2515
2534
|
* Called after a player joins the game. This is not called when loading a save file in singleplayer, as the player doesn't actually leave the game, and the save is just on pause until they rejoin.
|
|
2516
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2535
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_joined_game Online documentation}
|
|
2517
2536
|
*/
|
|
2518
2537
|
interface OnPlayerJoinedGameEvent extends EventData {
|
|
2519
2538
|
readonly player_index: PlayerIndex
|
|
@@ -2528,7 +2547,7 @@ declare module "factorio:runtime" {
|
|
|
2528
2547
|
}
|
|
2529
2548
|
/**
|
|
2530
2549
|
* Called when a player is kicked.
|
|
2531
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2550
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_kicked Online documentation}
|
|
2532
2551
|
*/
|
|
2533
2552
|
interface OnPlayerKickedEvent extends EventData {
|
|
2534
2553
|
/**
|
|
@@ -2554,7 +2573,7 @@ declare module "factorio:runtime" {
|
|
|
2554
2573
|
}
|
|
2555
2574
|
/**
|
|
2556
2575
|
* Called after a player leaves the game. This is not called when closing a save file in singleplayer, as the player doesn't actually leave the game, and the save is just on pause until they rejoin.
|
|
2557
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2576
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_left_game Online documentation}
|
|
2558
2577
|
*/
|
|
2559
2578
|
interface OnPlayerLeftGameEvent extends EventData {
|
|
2560
2579
|
readonly player_index: PlayerIndex
|
|
@@ -2570,7 +2589,7 @@ declare module "factorio:runtime" {
|
|
|
2570
2589
|
}
|
|
2571
2590
|
/**
|
|
2572
2591
|
* Called when a player's active locale changes. See {@link LuaPlayer#locale LuaPlayer::locale}.
|
|
2573
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2592
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_locale_changed Online documentation}
|
|
2574
2593
|
*/
|
|
2575
2594
|
interface OnPlayerLocaleChangedEvent extends EventData {
|
|
2576
2595
|
/**
|
|
@@ -2592,7 +2611,7 @@ declare module "factorio:runtime" {
|
|
|
2592
2611
|
}
|
|
2593
2612
|
/**
|
|
2594
2613
|
* Called after a players main inventory changed in some way.
|
|
2595
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2614
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_main_inventory_changed Online documentation}
|
|
2596
2615
|
*/
|
|
2597
2616
|
interface OnPlayerMainInventoryChangedEvent extends EventData {
|
|
2598
2617
|
readonly player_index: PlayerIndex
|
|
@@ -2613,7 +2632,7 @@ declare module "factorio:runtime" {
|
|
|
2613
2632
|
* 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.
|
|
2614
2633
|
*
|
|
2615
2634
|
* Event filter: [LuaPlayerMinedEntityEventFilter](LuaPlayerMinedEntityEventFilter]
|
|
2616
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2635
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_mined_entity Online documentation}
|
|
2617
2636
|
*/
|
|
2618
2637
|
interface OnPlayerMinedEntityEvent extends EventData {
|
|
2619
2638
|
/**
|
|
@@ -2639,7 +2658,7 @@ declare module "factorio:runtime" {
|
|
|
2639
2658
|
}
|
|
2640
2659
|
/**
|
|
2641
2660
|
* Called when the player mines something.
|
|
2642
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2661
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_mined_item Online documentation}
|
|
2643
2662
|
*/
|
|
2644
2663
|
interface OnPlayerMinedItemEvent extends EventData {
|
|
2645
2664
|
/**
|
|
@@ -2658,7 +2677,7 @@ declare module "factorio:runtime" {
|
|
|
2658
2677
|
}
|
|
2659
2678
|
/**
|
|
2660
2679
|
* Called after a player mines tiles.
|
|
2661
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2680
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_mined_tile Online documentation}
|
|
2662
2681
|
*/
|
|
2663
2682
|
interface OnPlayerMinedTileEvent extends EventData {
|
|
2664
2683
|
readonly player_index: PlayerIndex
|
|
@@ -2681,7 +2700,7 @@ declare module "factorio:runtime" {
|
|
|
2681
2700
|
}
|
|
2682
2701
|
/**
|
|
2683
2702
|
* Called when a player is muted.
|
|
2684
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2703
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_muted Online documentation}
|
|
2685
2704
|
*/
|
|
2686
2705
|
interface OnPlayerMutedEvent extends EventData {
|
|
2687
2706
|
/**
|
|
@@ -2699,7 +2718,7 @@ declare module "factorio:runtime" {
|
|
|
2699
2718
|
}
|
|
2700
2719
|
/**
|
|
2701
2720
|
* Called when a player invokes the "smart pipette" over an entity.
|
|
2702
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2721
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_pipette Online documentation}
|
|
2703
2722
|
*/
|
|
2704
2723
|
interface OnPlayerPipetteEvent extends EventData {
|
|
2705
2724
|
/**
|
|
@@ -2729,7 +2748,7 @@ declare module "factorio:runtime" {
|
|
|
2729
2748
|
}
|
|
2730
2749
|
/**
|
|
2731
2750
|
* Called after the player puts equipment in an equipment grid
|
|
2732
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2751
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_placed_equipment Online documentation}
|
|
2733
2752
|
*/
|
|
2734
2753
|
interface OnPlayerPlacedEquipmentEvent extends EventData {
|
|
2735
2754
|
readonly player_index: PlayerIndex
|
|
@@ -2752,7 +2771,7 @@ declare module "factorio:runtime" {
|
|
|
2752
2771
|
}
|
|
2753
2772
|
/**
|
|
2754
2773
|
* Called when a player is promoted.
|
|
2755
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2774
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_promoted Online documentation}
|
|
2756
2775
|
*/
|
|
2757
2776
|
interface OnPlayerPromotedEvent extends EventData {
|
|
2758
2777
|
/**
|
|
@@ -2770,7 +2789,7 @@ declare module "factorio:runtime" {
|
|
|
2770
2789
|
}
|
|
2771
2790
|
/**
|
|
2772
2791
|
* Called when a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link OnPlayerLeftGameEvent leaving} the game, and instead behaves like the player never existed in the save file.
|
|
2773
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2792
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_removed Online documentation}
|
|
2774
2793
|
*/
|
|
2775
2794
|
interface OnPlayerRemovedEvent extends EventData {
|
|
2776
2795
|
/**
|
|
@@ -2788,7 +2807,7 @@ declare module "factorio:runtime" {
|
|
|
2788
2807
|
}
|
|
2789
2808
|
/**
|
|
2790
2809
|
* Called after the player removes equipment from an equipment grid
|
|
2791
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2810
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_removed_equipment Online documentation}
|
|
2792
2811
|
*/
|
|
2793
2812
|
interface OnPlayerRemovedEquipmentEvent extends EventData {
|
|
2794
2813
|
readonly player_index: PlayerIndex
|
|
@@ -2821,7 +2840,7 @@ declare module "factorio:runtime" {
|
|
|
2821
2840
|
* Called when a player repairs an entity.
|
|
2822
2841
|
*
|
|
2823
2842
|
* Event filter: [LuaPlayerRepairedEntityEventFilter](LuaPlayerRepairedEntityEventFilter]
|
|
2824
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2843
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_repaired_entity Online documentation}
|
|
2825
2844
|
*/
|
|
2826
2845
|
interface OnPlayerRepairedEntityEvent extends EventData {
|
|
2827
2846
|
readonly player_index: PlayerIndex
|
|
@@ -2837,7 +2856,7 @@ declare module "factorio:runtime" {
|
|
|
2837
2856
|
}
|
|
2838
2857
|
/**
|
|
2839
2858
|
* Called after a player respawns.
|
|
2840
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2859
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_respawned Online documentation}
|
|
2841
2860
|
*/
|
|
2842
2861
|
interface OnPlayerRespawnedEvent extends EventData {
|
|
2843
2862
|
readonly player_index: PlayerIndex
|
|
@@ -2856,7 +2875,7 @@ declare module "factorio:runtime" {
|
|
|
2856
2875
|
}
|
|
2857
2876
|
/**
|
|
2858
2877
|
* Called after a player reverse-selects an area with a selection-tool item.
|
|
2859
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2878
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_reverse_selected_area Online documentation}
|
|
2860
2879
|
*/
|
|
2861
2880
|
interface OnPlayerReverseSelectedAreaEvent extends EventData {
|
|
2862
2881
|
/**
|
|
@@ -2896,7 +2915,7 @@ declare module "factorio:runtime" {
|
|
|
2896
2915
|
* 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.
|
|
2897
2916
|
*
|
|
2898
2917
|
* Entities being flipped will not fire this event, even if the flip involves rotating. See {@link OnPlayerFlippedEntityEvent on_player_flipped_entity}.
|
|
2899
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2918
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_rotated_entity Online documentation}
|
|
2900
2919
|
*/
|
|
2901
2920
|
interface OnPlayerRotatedEntityEvent extends EventData {
|
|
2902
2921
|
/**
|
|
@@ -2919,7 +2938,7 @@ declare module "factorio:runtime" {
|
|
|
2919
2938
|
}
|
|
2920
2939
|
/**
|
|
2921
2940
|
* Called after a player selects an area with a selection-tool item.
|
|
2922
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2941
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_selected_area Online documentation}
|
|
2923
2942
|
*/
|
|
2924
2943
|
interface OnPlayerSelectedAreaEvent extends EventData {
|
|
2925
2944
|
/**
|
|
@@ -2961,7 +2980,7 @@ declare module "factorio:runtime" {
|
|
|
2961
2980
|
}
|
|
2962
2981
|
/**
|
|
2963
2982
|
* Called when a player sets a quickbar slot to anything (new value, or set to empty).
|
|
2964
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2983
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_set_quick_bar_slot Online documentation}
|
|
2965
2984
|
*/
|
|
2966
2985
|
interface OnPlayerSetQuickBarSlotEvent extends EventData {
|
|
2967
2986
|
readonly player_index: PlayerIndex
|
|
@@ -2976,7 +2995,7 @@ declare module "factorio:runtime" {
|
|
|
2976
2995
|
}
|
|
2977
2996
|
/**
|
|
2978
2997
|
* Called when a player selects an area with a blueprint.
|
|
2979
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
2998
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_setup_blueprint Online documentation}
|
|
2980
2999
|
*/
|
|
2981
3000
|
interface OnPlayerSetupBlueprintEvent extends EventData {
|
|
2982
3001
|
/**
|
|
@@ -3026,7 +3045,7 @@ declare module "factorio:runtime" {
|
|
|
3026
3045
|
}
|
|
3027
3046
|
/**
|
|
3028
3047
|
* Called when a player toggles alt mode, also known as "show entity info".
|
|
3029
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3048
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_toggled_alt_mode Online documentation}
|
|
3030
3049
|
*/
|
|
3031
3050
|
interface OnPlayerToggledAltModeEvent extends EventData {
|
|
3032
3051
|
readonly player_index: PlayerIndex
|
|
@@ -3045,7 +3064,7 @@ declare module "factorio:runtime" {
|
|
|
3045
3064
|
}
|
|
3046
3065
|
/**
|
|
3047
3066
|
* Called when a player toggles the map editor on or off.
|
|
3048
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3067
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_toggled_map_editor Online documentation}
|
|
3049
3068
|
*/
|
|
3050
3069
|
interface OnPlayerToggledMapEditorEvent extends EventData {
|
|
3051
3070
|
readonly player_index: PlayerIndex
|
|
@@ -3060,7 +3079,7 @@ declare module "factorio:runtime" {
|
|
|
3060
3079
|
}
|
|
3061
3080
|
/**
|
|
3062
3081
|
* Called after a players trash inventory changed in some way.
|
|
3063
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3082
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_trash_inventory_changed Online documentation}
|
|
3064
3083
|
*/
|
|
3065
3084
|
interface OnPlayerTrashInventoryChangedEvent extends EventData {
|
|
3066
3085
|
readonly player_index: PlayerIndex
|
|
@@ -3075,7 +3094,7 @@ declare module "factorio:runtime" {
|
|
|
3075
3094
|
}
|
|
3076
3095
|
/**
|
|
3077
3096
|
* Called when a player is un-banned.
|
|
3078
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3097
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_unbanned Online documentation}
|
|
3079
3098
|
*/
|
|
3080
3099
|
interface OnPlayerUnbannedEvent extends EventData {
|
|
3081
3100
|
/**
|
|
@@ -3105,7 +3124,7 @@ declare module "factorio:runtime" {
|
|
|
3105
3124
|
}
|
|
3106
3125
|
/**
|
|
3107
3126
|
* Called when a player is unmuted.
|
|
3108
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3127
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_unmuted Online documentation}
|
|
3109
3128
|
*/
|
|
3110
3129
|
interface OnPlayerUnmutedEvent extends EventData {
|
|
3111
3130
|
/**
|
|
@@ -3123,7 +3142,7 @@ declare module "factorio:runtime" {
|
|
|
3123
3142
|
}
|
|
3124
3143
|
/**
|
|
3125
3144
|
* Called when a player uses a capsule that results in some game action.
|
|
3126
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3145
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_used_capsule Online documentation}
|
|
3127
3146
|
*/
|
|
3128
3147
|
interface OnPlayerUsedCapsuleEvent extends EventData {
|
|
3129
3148
|
/**
|
|
@@ -3153,7 +3172,7 @@ declare module "factorio:runtime" {
|
|
|
3153
3172
|
}
|
|
3154
3173
|
/**
|
|
3155
3174
|
* Called when a player uses spidertron remote to send all selected units to a given position
|
|
3156
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3175
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_player_used_spidertron_remote Online documentation}
|
|
3157
3176
|
*/
|
|
3158
3177
|
interface OnPlayerUsedSpidertronRemoteEvent extends EventData {
|
|
3159
3178
|
/**
|
|
@@ -3177,7 +3196,7 @@ declare module "factorio:runtime" {
|
|
|
3177
3196
|
* Called after an entity dies.
|
|
3178
3197
|
*
|
|
3179
3198
|
* Event filter: [LuaPostEntityDiedEventFilter](LuaPostEntityDiedEventFilter]
|
|
3180
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3199
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_post_entity_died Online documentation}
|
|
3181
3200
|
*/
|
|
3182
3201
|
interface OnPostEntityDiedEvent extends EventData {
|
|
3183
3202
|
/**
|
|
@@ -3229,7 +3248,7 @@ declare module "factorio:runtime" {
|
|
|
3229
3248
|
* Called after a segmented unit dies.
|
|
3230
3249
|
*
|
|
3231
3250
|
* Event filter: [LuaPostSegmentedUnitDiedEventFilter](LuaPostSegmentedUnitDiedEventFilter]
|
|
3232
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3251
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_post_segmented_unit_died Online documentation}
|
|
3233
3252
|
*/
|
|
3234
3253
|
interface OnPostSegmentedUnitDiedEvent extends EventData {
|
|
3235
3254
|
/**
|
|
@@ -3271,7 +3290,7 @@ declare module "factorio:runtime" {
|
|
|
3271
3290
|
}
|
|
3272
3291
|
/**
|
|
3273
3292
|
* Called when players uses an item to build something. Called before {@link OnBuiltEntityEvent on_built_entity}.
|
|
3274
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3293
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_build Online documentation}
|
|
3275
3294
|
*/
|
|
3276
3295
|
interface OnPreBuildEvent extends EventData {
|
|
3277
3296
|
/**
|
|
@@ -3317,7 +3336,7 @@ declare module "factorio:runtime" {
|
|
|
3317
3336
|
}
|
|
3318
3337
|
/**
|
|
3319
3338
|
* Called before one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
|
|
3320
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3339
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_chunk_deleted Online documentation}
|
|
3321
3340
|
*/
|
|
3322
3341
|
interface OnPreChunkDeletedEvent extends EventData {
|
|
3323
3342
|
readonly surface_index: SurfaceIndex
|
|
@@ -3336,7 +3355,7 @@ declare module "factorio:runtime" {
|
|
|
3336
3355
|
}
|
|
3337
3356
|
/**
|
|
3338
3357
|
* Called before entity copy-paste is done.
|
|
3339
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3358
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_entity_settings_pasted Online documentation}
|
|
3340
3359
|
*/
|
|
3341
3360
|
interface OnPreEntitySettingsPastedEvent extends EventData {
|
|
3342
3361
|
readonly player_index: PlayerIndex
|
|
@@ -3363,7 +3382,7 @@ declare module "factorio:runtime" {
|
|
|
3363
3382
|
* Also called for item request proxies before they are destroyed as a result of being marked for deconstruction.
|
|
3364
3383
|
*
|
|
3365
3384
|
* Event filter: [LuaPreGhostDeconstructedEventFilter](LuaPreGhostDeconstructedEventFilter]
|
|
3366
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3385
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_ghost_deconstructed Online documentation}
|
|
3367
3386
|
*/
|
|
3368
3387
|
interface OnPreGhostDeconstructedEvent extends EventData {
|
|
3369
3388
|
/**
|
|
@@ -3384,7 +3403,7 @@ declare module "factorio:runtime" {
|
|
|
3384
3403
|
* Called before a ghost entity is upgraded.
|
|
3385
3404
|
*
|
|
3386
3405
|
* Event filter: [LuaPreGhostUpgradedEventFilter](LuaPreGhostUpgradedEventFilter]
|
|
3387
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3406
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_ghost_upgraded Online documentation}
|
|
3388
3407
|
*/
|
|
3389
3408
|
interface OnPreGhostUpgradedEvent extends EventData {
|
|
3390
3409
|
/**
|
|
@@ -3405,7 +3424,7 @@ declare module "factorio:runtime" {
|
|
|
3405
3424
|
}
|
|
3406
3425
|
/**
|
|
3407
3426
|
* Called directly before a permission group is deleted.
|
|
3408
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3427
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_permission_group_deleted Online documentation}
|
|
3409
3428
|
*/
|
|
3410
3429
|
interface OnPrePermissionGroupDeletedEvent extends EventData {
|
|
3411
3430
|
/**
|
|
@@ -3427,7 +3446,7 @@ declare module "factorio:runtime" {
|
|
|
3427
3446
|
}
|
|
3428
3447
|
/**
|
|
3429
3448
|
* Called directly before a permission string is imported.
|
|
3430
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3449
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_permission_string_imported Online documentation}
|
|
3431
3450
|
*/
|
|
3432
3451
|
interface OnPrePermissionStringImportedEvent extends EventData {
|
|
3433
3452
|
/**
|
|
@@ -3445,7 +3464,7 @@ declare module "factorio:runtime" {
|
|
|
3445
3464
|
}
|
|
3446
3465
|
/**
|
|
3447
3466
|
* Called when a player queues something to be crafted.
|
|
3448
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3467
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_player_crafted_item Online documentation}
|
|
3449
3468
|
*/
|
|
3450
3469
|
interface OnPrePlayerCraftedItemEvent extends EventData {
|
|
3451
3470
|
/**
|
|
@@ -3475,7 +3494,7 @@ declare module "factorio:runtime" {
|
|
|
3475
3494
|
}
|
|
3476
3495
|
/**
|
|
3477
3496
|
* Called before a players dies.
|
|
3478
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3497
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_player_died Online documentation}
|
|
3479
3498
|
*/
|
|
3480
3499
|
interface OnPrePlayerDiedEvent extends EventData {
|
|
3481
3500
|
readonly player_index: PlayerIndex
|
|
@@ -3491,7 +3510,7 @@ declare module "factorio:runtime" {
|
|
|
3491
3510
|
}
|
|
3492
3511
|
/**
|
|
3493
3512
|
* Called before a player leaves the game.
|
|
3494
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3513
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_player_left_game Online documentation}
|
|
3495
3514
|
*/
|
|
3496
3515
|
interface OnPrePlayerLeftGameEvent extends EventData {
|
|
3497
3516
|
readonly player_index: PlayerIndex
|
|
@@ -3509,7 +3528,7 @@ declare module "factorio:runtime" {
|
|
|
3509
3528
|
* 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.
|
|
3510
3529
|
*
|
|
3511
3530
|
* Event filter: [LuaPrePlayerMinedEntityEventFilter](LuaPrePlayerMinedEntityEventFilter]
|
|
3512
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3531
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_player_mined_item Online documentation}
|
|
3513
3532
|
*/
|
|
3514
3533
|
interface OnPrePlayerMinedItemEvent extends EventData {
|
|
3515
3534
|
/**
|
|
@@ -3528,7 +3547,7 @@ declare module "factorio:runtime" {
|
|
|
3528
3547
|
}
|
|
3529
3548
|
/**
|
|
3530
3549
|
* Called before a player is removed (deleted) from the game. This is markedly different from a player temporarily {@link OnPlayerLeftGameEvent leaving} the game, and instead behaves like the player never existed in the save file.
|
|
3531
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3550
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_player_removed Online documentation}
|
|
3532
3551
|
*/
|
|
3533
3552
|
interface OnPrePlayerRemovedEvent extends EventData {
|
|
3534
3553
|
/**
|
|
@@ -3546,7 +3565,7 @@ declare module "factorio:runtime" {
|
|
|
3546
3565
|
}
|
|
3547
3566
|
/**
|
|
3548
3567
|
* Called before a player toggles the map editor on or off.
|
|
3549
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3568
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_player_toggled_map_editor Online documentation}
|
|
3550
3569
|
*/
|
|
3551
3570
|
interface OnPrePlayerToggledMapEditorEvent extends EventData {
|
|
3552
3571
|
readonly player_index: PlayerIndex
|
|
@@ -3561,7 +3580,7 @@ declare module "factorio:runtime" {
|
|
|
3561
3580
|
}
|
|
3562
3581
|
/**
|
|
3563
3582
|
* Called directly before a robot explodes cliffs.
|
|
3564
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3583
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_robot_exploded_cliff Online documentation}
|
|
3565
3584
|
*/
|
|
3566
3585
|
interface OnPreRobotExplodedCliffEvent extends EventData {
|
|
3567
3586
|
readonly robot: LuaEntity
|
|
@@ -3585,7 +3604,7 @@ declare module "factorio:runtime" {
|
|
|
3585
3604
|
}
|
|
3586
3605
|
/**
|
|
3587
3606
|
* Called just before the scenario finishes.
|
|
3588
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3607
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_scenario_finished Online documentation}
|
|
3589
3608
|
*/
|
|
3590
3609
|
interface OnPreScenarioFinishedEvent extends EventData {
|
|
3591
3610
|
/**
|
|
@@ -3603,7 +3622,7 @@ declare module "factorio:runtime" {
|
|
|
3603
3622
|
}
|
|
3604
3623
|
/**
|
|
3605
3624
|
* Called just before a script inventory is resized.
|
|
3606
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3625
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_script_inventory_resized Online documentation}
|
|
3607
3626
|
*/
|
|
3608
3627
|
interface OnPreScriptInventoryResizedEvent extends EventData {
|
|
3609
3628
|
/**
|
|
@@ -3634,7 +3653,7 @@ declare module "factorio:runtime" {
|
|
|
3634
3653
|
}
|
|
3635
3654
|
/**
|
|
3636
3655
|
* Called just before a surface is cleared (all entities removed and all chunks deleted).
|
|
3637
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3656
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_surface_cleared Online documentation}
|
|
3638
3657
|
*/
|
|
3639
3658
|
interface OnPreSurfaceClearedEvent extends EventData {
|
|
3640
3659
|
readonly surface_index: SurfaceIndex
|
|
@@ -3649,7 +3668,7 @@ declare module "factorio:runtime" {
|
|
|
3649
3668
|
}
|
|
3650
3669
|
/**
|
|
3651
3670
|
* Called just before a surface is deleted.
|
|
3652
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3671
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_pre_surface_deleted Online documentation}
|
|
3653
3672
|
*/
|
|
3654
3673
|
interface OnPreSurfaceDeletedEvent extends EventData {
|
|
3655
3674
|
readonly surface_index: SurfaceIndex
|
|
@@ -3664,7 +3683,7 @@ declare module "factorio:runtime" {
|
|
|
3664
3683
|
}
|
|
3665
3684
|
/**
|
|
3666
3685
|
* Called when the player triggers "redo".
|
|
3667
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3686
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_redo_applied Online documentation}
|
|
3668
3687
|
*/
|
|
3669
3688
|
interface OnRedoAppliedEvent extends EventData {
|
|
3670
3689
|
/**
|
|
@@ -3686,7 +3705,7 @@ declare module "factorio:runtime" {
|
|
|
3686
3705
|
}
|
|
3687
3706
|
/**
|
|
3688
3707
|
* Called when research is cancelled.
|
|
3689
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3708
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_research_cancelled Online documentation}
|
|
3690
3709
|
*/
|
|
3691
3710
|
interface OnResearchCancelledEvent extends EventData {
|
|
3692
3711
|
/**
|
|
@@ -3712,7 +3731,7 @@ declare module "factorio:runtime" {
|
|
|
3712
3731
|
}
|
|
3713
3732
|
/**
|
|
3714
3733
|
* Called when a research finishes.
|
|
3715
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3734
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_research_finished Online documentation}
|
|
3716
3735
|
*/
|
|
3717
3736
|
interface OnResearchFinishedEvent extends EventData {
|
|
3718
3737
|
/**
|
|
@@ -3734,7 +3753,7 @@ declare module "factorio:runtime" {
|
|
|
3734
3753
|
}
|
|
3735
3754
|
/**
|
|
3736
3755
|
* Called when research is moved forwards or backwards in the research queue.
|
|
3737
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3756
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_research_moved Online documentation}
|
|
3738
3757
|
*/
|
|
3739
3758
|
interface OnResearchMovedEvent extends EventData {
|
|
3740
3759
|
/**
|
|
@@ -3756,7 +3775,7 @@ declare module "factorio:runtime" {
|
|
|
3756
3775
|
}
|
|
3757
3776
|
/**
|
|
3758
3777
|
* Called when research is queued.
|
|
3759
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3778
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_research_queued Online documentation}
|
|
3760
3779
|
*/
|
|
3761
3780
|
interface OnResearchQueuedEvent extends EventData {
|
|
3762
3781
|
/**
|
|
@@ -3782,7 +3801,7 @@ declare module "factorio:runtime" {
|
|
|
3782
3801
|
}
|
|
3783
3802
|
/**
|
|
3784
3803
|
* Called when a research is reversed (unresearched).
|
|
3785
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3804
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_research_reversed Online documentation}
|
|
3786
3805
|
*/
|
|
3787
3806
|
interface OnResearchReversedEvent extends EventData {
|
|
3788
3807
|
/**
|
|
@@ -3804,7 +3823,7 @@ declare module "factorio:runtime" {
|
|
|
3804
3823
|
}
|
|
3805
3824
|
/**
|
|
3806
3825
|
* Called when a technology research starts.
|
|
3807
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3826
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_research_started Online documentation}
|
|
3808
3827
|
*/
|
|
3809
3828
|
interface OnResearchStartedEvent extends EventData {
|
|
3810
3829
|
/**
|
|
@@ -3823,7 +3842,7 @@ declare module "factorio:runtime" {
|
|
|
3823
3842
|
}
|
|
3824
3843
|
/**
|
|
3825
3844
|
* Called when a resource entity reaches 0 or its minimum yield for infinite resources.
|
|
3826
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3845
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_resource_depleted Online documentation}
|
|
3827
3846
|
*/
|
|
3828
3847
|
interface OnResourceDepletedEvent extends EventData {
|
|
3829
3848
|
readonly entity: LuaEntity
|
|
@@ -3840,7 +3859,7 @@ declare module "factorio:runtime" {
|
|
|
3840
3859
|
* Called when a construction robot builds an entity.
|
|
3841
3860
|
*
|
|
3842
3861
|
* Event filter: [LuaRobotBuiltEntityEventFilter](LuaRobotBuiltEntityEventFilter]
|
|
3843
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3862
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_robot_built_entity Online documentation}
|
|
3844
3863
|
*/
|
|
3845
3864
|
interface OnRobotBuiltEntityEvent extends EventData {
|
|
3846
3865
|
/**
|
|
@@ -3870,7 +3889,7 @@ declare module "factorio:runtime" {
|
|
|
3870
3889
|
}
|
|
3871
3890
|
/**
|
|
3872
3891
|
* Called after a robot builds tiles.
|
|
3873
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3892
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_robot_built_tile Online documentation}
|
|
3874
3893
|
*/
|
|
3875
3894
|
interface OnRobotBuiltTileEvent extends EventData {
|
|
3876
3895
|
/**
|
|
@@ -3912,7 +3931,7 @@ declare module "factorio:runtime" {
|
|
|
3912
3931
|
}
|
|
3913
3932
|
/**
|
|
3914
3933
|
* Called directly after a robot explodes cliffs.
|
|
3915
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3934
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_robot_exploded_cliff Online documentation}
|
|
3916
3935
|
*/
|
|
3917
3936
|
interface OnRobotExplodedCliffEvent extends EventData {
|
|
3918
3937
|
readonly robot: LuaEntity
|
|
@@ -3935,7 +3954,7 @@ declare module "factorio:runtime" {
|
|
|
3935
3954
|
}
|
|
3936
3955
|
/**
|
|
3937
3956
|
* Called when a robot mines an entity.
|
|
3938
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3957
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_robot_mined Online documentation}
|
|
3939
3958
|
*/
|
|
3940
3959
|
interface OnRobotMinedEvent extends EventData {
|
|
3941
3960
|
/**
|
|
@@ -3963,7 +3982,7 @@ declare module "factorio:runtime" {
|
|
|
3963
3982
|
* 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.
|
|
3964
3983
|
*
|
|
3965
3984
|
* Event filter: [LuaRobotMinedEntityEventFilter](LuaRobotMinedEntityEventFilter]
|
|
3966
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
3985
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_robot_mined_entity Online documentation}
|
|
3967
3986
|
*/
|
|
3968
3987
|
interface OnRobotMinedEntityEvent extends EventData {
|
|
3969
3988
|
/**
|
|
@@ -3989,7 +4008,7 @@ declare module "factorio:runtime" {
|
|
|
3989
4008
|
}
|
|
3990
4009
|
/**
|
|
3991
4010
|
* Called after a robot mines tiles.
|
|
3992
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4011
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_robot_mined_tile Online documentation}
|
|
3993
4012
|
*/
|
|
3994
4013
|
interface OnRobotMinedTileEvent extends EventData {
|
|
3995
4014
|
/**
|
|
@@ -4017,7 +4036,7 @@ declare module "factorio:runtime" {
|
|
|
4017
4036
|
* Called before a robot mines an entity.
|
|
4018
4037
|
*
|
|
4019
4038
|
* Event filter: [LuaPreRobotMinedEntityEventFilter](LuaPreRobotMinedEntityEventFilter]
|
|
4020
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4039
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_robot_pre_mined Online documentation}
|
|
4021
4040
|
*/
|
|
4022
4041
|
interface OnRobotPreMinedEvent extends EventData {
|
|
4023
4042
|
/**
|
|
@@ -4039,7 +4058,7 @@ declare module "factorio:runtime" {
|
|
|
4039
4058
|
}
|
|
4040
4059
|
/**
|
|
4041
4060
|
* Called when a rocket silo is ordered to be launched.
|
|
4042
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4061
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_rocket_launch_ordered Online documentation}
|
|
4043
4062
|
*/
|
|
4044
4063
|
interface OnRocketLaunchOrderedEvent extends EventData {
|
|
4045
4064
|
readonly rocket: LuaEntity
|
|
@@ -4059,7 +4078,7 @@ declare module "factorio:runtime" {
|
|
|
4059
4078
|
}
|
|
4060
4079
|
/**
|
|
4061
4080
|
* Called when a rocket finishes ascending. (Triggers listening for finished rocket launch past 2.0 have been moved to 'on_cargo_pod_finished_ascending' as rocket and cargo pod are two separate entities)
|
|
4062
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4081
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_rocket_launched Online documentation}
|
|
4063
4082
|
*/
|
|
4064
4083
|
interface OnRocketLaunchedEvent extends EventData {
|
|
4065
4084
|
readonly rocket: LuaEntity
|
|
@@ -4075,7 +4094,7 @@ declare module "factorio:runtime" {
|
|
|
4075
4094
|
}
|
|
4076
4095
|
/**
|
|
4077
4096
|
* Called when a runtime mod setting is changed by a player.
|
|
4078
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4097
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_runtime_mod_setting_changed Online documentation}
|
|
4079
4098
|
*/
|
|
4080
4099
|
interface OnRuntimeModSettingChangedEvent extends EventData {
|
|
4081
4100
|
/**
|
|
@@ -4098,7 +4117,7 @@ declare module "factorio:runtime" {
|
|
|
4098
4117
|
}
|
|
4099
4118
|
/**
|
|
4100
4119
|
* Called just after a script inventory is resized.
|
|
4101
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4120
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_script_inventory_resized Online documentation}
|
|
4102
4121
|
*/
|
|
4103
4122
|
interface OnScriptInventoryResizedEvent extends EventData {
|
|
4104
4123
|
/**
|
|
@@ -4133,7 +4152,7 @@ declare module "factorio:runtime" {
|
|
|
4133
4152
|
}
|
|
4134
4153
|
/**
|
|
4135
4154
|
* Called when a {@link LuaSurface#request_path LuaSurface::request_path} call completes.
|
|
4136
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4155
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_script_path_request_finished Online documentation}
|
|
4137
4156
|
*/
|
|
4138
4157
|
interface OnScriptPathRequestFinishedEvent extends EventData {
|
|
4139
4158
|
/**
|
|
@@ -4159,7 +4178,7 @@ declare module "factorio:runtime" {
|
|
|
4159
4178
|
}
|
|
4160
4179
|
/**
|
|
4161
4180
|
* Called when a script trigger effect is triggered.
|
|
4162
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4181
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_script_trigger_effect Online documentation}
|
|
4163
4182
|
*/
|
|
4164
4183
|
interface OnScriptTriggerEffectEvent extends EventData {
|
|
4165
4184
|
/**
|
|
@@ -4192,7 +4211,7 @@ declare module "factorio:runtime" {
|
|
|
4192
4211
|
* Called when an entity of type `radar` finishes scanning a sector.
|
|
4193
4212
|
*
|
|
4194
4213
|
* Event filter: [LuaSectorScannedEventFilter](LuaSectorScannedEventFilter]
|
|
4195
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4214
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_sector_scanned Online documentation}
|
|
4196
4215
|
*/
|
|
4197
4216
|
interface OnSectorScannedEvent extends EventData {
|
|
4198
4217
|
/**
|
|
@@ -4218,7 +4237,7 @@ declare module "factorio:runtime" {
|
|
|
4218
4237
|
}
|
|
4219
4238
|
/**
|
|
4220
4239
|
* Called when an individual segment of a SegmentedUnit is created.
|
|
4221
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4240
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_segment_entity_created Online documentation}
|
|
4222
4241
|
*/
|
|
4223
4242
|
interface OnSegmentEntityCreatedEvent extends EventData {
|
|
4224
4243
|
readonly entity: LuaEntity
|
|
@@ -4235,7 +4254,7 @@ declare module "factorio:runtime" {
|
|
|
4235
4254
|
* Called when a segmented unit is created for any reason.
|
|
4236
4255
|
*
|
|
4237
4256
|
* Event filter: [LuaSegmentedUnitCreatedEventFilter](LuaSegmentedUnitCreatedEventFilter]
|
|
4238
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4257
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_segmented_unit_created Online documentation}
|
|
4239
4258
|
*/
|
|
4240
4259
|
interface OnSegmentedUnitCreatedEvent extends EventData {
|
|
4241
4260
|
/**
|
|
@@ -4263,7 +4282,7 @@ declare module "factorio:runtime" {
|
|
|
4263
4282
|
* Called when a segmented unit is damaged. This is not called when a segmented unit's health is set directly by another mod.
|
|
4264
4283
|
*
|
|
4265
4284
|
* Event filter: [LuaSegmentedUnitDamagedEventFilter](LuaSegmentedUnitDamagedEventFilter]
|
|
4266
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4285
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_segmented_unit_damaged Online documentation}
|
|
4267
4286
|
*/
|
|
4268
4287
|
interface OnSegmentedUnitDamagedEvent extends EventData {
|
|
4269
4288
|
readonly segmented_unit: LuaSegmentedUnit
|
|
@@ -4305,7 +4324,7 @@ declare module "factorio:runtime" {
|
|
|
4305
4324
|
* Called when a segmented unit dies.
|
|
4306
4325
|
*
|
|
4307
4326
|
* Event filter: [LuaSegmentedUnitDiedEventFilter](LuaSegmentedUnitDiedEventFilter]
|
|
4308
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4327
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_segmented_unit_died Online documentation}
|
|
4309
4328
|
*/
|
|
4310
4329
|
interface OnSegmentedUnitDiedEvent extends EventData {
|
|
4311
4330
|
/**
|
|
@@ -4335,7 +4354,7 @@ declare module "factorio:runtime" {
|
|
|
4335
4354
|
}
|
|
4336
4355
|
/**
|
|
4337
4356
|
* Called after the selected entity changes for a given player.
|
|
4338
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4357
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_selected_entity_changed Online documentation}
|
|
4339
4358
|
*/
|
|
4340
4359
|
interface OnSelectedEntityChangedEvent extends EventData {
|
|
4341
4360
|
/**
|
|
@@ -4357,7 +4376,7 @@ declare module "factorio:runtime" {
|
|
|
4357
4376
|
}
|
|
4358
4377
|
/**
|
|
4359
4378
|
* Called when {@link LuaGameScript#is_multiplayer LuaGameScript::is_multiplayer} changes to false. May also be raised when it was already false but a game was loaded from a save file without hosting.
|
|
4360
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4379
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_singleplayer_init Online documentation}
|
|
4361
4380
|
*/
|
|
4362
4381
|
interface OnSingleplayerInitEvent extends EventData {
|
|
4363
4382
|
/**
|
|
@@ -4373,7 +4392,7 @@ declare module "factorio:runtime" {
|
|
|
4373
4392
|
* Called when a space platform builds an entity.
|
|
4374
4393
|
*
|
|
4375
4394
|
* Event filter: [LuaPlatformBuiltEntityEventFilter](LuaPlatformBuiltEntityEventFilter]
|
|
4376
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4395
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_space_platform_built_entity Online documentation}
|
|
4377
4396
|
*/
|
|
4378
4397
|
interface OnSpacePlatformBuiltEntityEvent extends EventData {
|
|
4379
4398
|
/**
|
|
@@ -4403,7 +4422,7 @@ declare module "factorio:runtime" {
|
|
|
4403
4422
|
}
|
|
4404
4423
|
/**
|
|
4405
4424
|
* Called after a space platform builds tiles.
|
|
4406
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4425
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_space_platform_built_tile Online documentation}
|
|
4407
4426
|
*/
|
|
4408
4427
|
interface OnSpacePlatformBuiltTileEvent extends EventData {
|
|
4409
4428
|
/**
|
|
@@ -4445,7 +4464,7 @@ declare module "factorio:runtime" {
|
|
|
4445
4464
|
}
|
|
4446
4465
|
/**
|
|
4447
4466
|
* Called when a space platform changes state
|
|
4448
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4467
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_space_platform_changed_state Online documentation}
|
|
4449
4468
|
*/
|
|
4450
4469
|
interface OnSpacePlatformChangedStateEvent extends EventData {
|
|
4451
4470
|
readonly platform: LuaSpacePlatform
|
|
@@ -4467,7 +4486,7 @@ declare module "factorio:runtime" {
|
|
|
4467
4486
|
* 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.
|
|
4468
4487
|
*
|
|
4469
4488
|
* Event filter: [LuaPlatformMinedEntityEventFilter](LuaPlatformMinedEntityEventFilter]
|
|
4470
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4489
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_space_platform_mined_entity Online documentation}
|
|
4471
4490
|
*/
|
|
4472
4491
|
interface OnSpacePlatformMinedEntityEvent extends EventData {
|
|
4473
4492
|
/**
|
|
@@ -4493,7 +4512,7 @@ declare module "factorio:runtime" {
|
|
|
4493
4512
|
}
|
|
4494
4513
|
/**
|
|
4495
4514
|
* Called when a platform mines an entity.
|
|
4496
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4515
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_space_platform_mined_item Online documentation}
|
|
4497
4516
|
*/
|
|
4498
4517
|
interface OnSpacePlatformMinedItemEvent extends EventData {
|
|
4499
4518
|
/**
|
|
@@ -4515,7 +4534,7 @@ declare module "factorio:runtime" {
|
|
|
4515
4534
|
}
|
|
4516
4535
|
/**
|
|
4517
4536
|
* Called after a platform mines tiles.
|
|
4518
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4537
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_space_platform_mined_tile Online documentation}
|
|
4519
4538
|
*/
|
|
4520
4539
|
interface OnSpacePlatformMinedTileEvent extends EventData {
|
|
4521
4540
|
/**
|
|
@@ -4543,7 +4562,7 @@ declare module "factorio:runtime" {
|
|
|
4543
4562
|
* Called before a platform mines an entity.
|
|
4544
4563
|
*
|
|
4545
4564
|
* Event filter: [LuaPrePlatformMinedEntityEventFilter](LuaPrePlatformMinedEntityEventFilter]
|
|
4546
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4565
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_space_platform_pre_mined Online documentation}
|
|
4547
4566
|
*/
|
|
4548
4567
|
interface OnSpacePlatformPreMinedEvent extends EventData {
|
|
4549
4568
|
/**
|
|
@@ -4565,7 +4584,7 @@ declare module "factorio:runtime" {
|
|
|
4565
4584
|
}
|
|
4566
4585
|
/**
|
|
4567
4586
|
* Called when a spider finishes moving to its autopilot position.
|
|
4568
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4587
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_spider_command_completed Online documentation}
|
|
4569
4588
|
*/
|
|
4570
4589
|
interface OnSpiderCommandCompletedEvent extends EventData {
|
|
4571
4590
|
/**
|
|
@@ -4583,7 +4602,7 @@ declare module "factorio:runtime" {
|
|
|
4583
4602
|
}
|
|
4584
4603
|
/**
|
|
4585
4604
|
* 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.
|
|
4586
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4605
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_string_translated Online documentation}
|
|
4587
4606
|
*/
|
|
4588
4607
|
interface OnStringTranslatedEvent extends EventData {
|
|
4589
4608
|
/**
|
|
@@ -4617,7 +4636,7 @@ declare module "factorio:runtime" {
|
|
|
4617
4636
|
}
|
|
4618
4637
|
/**
|
|
4619
4638
|
* Called just after a surface is cleared (all entities removed and all chunks deleted).
|
|
4620
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4639
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_surface_cleared Online documentation}
|
|
4621
4640
|
*/
|
|
4622
4641
|
interface OnSurfaceClearedEvent extends EventData {
|
|
4623
4642
|
readonly surface_index: SurfaceIndex
|
|
@@ -4634,7 +4653,7 @@ declare module "factorio:runtime" {
|
|
|
4634
4653
|
* Called when a surface is created.
|
|
4635
4654
|
*
|
|
4636
4655
|
* This is not called when the default surface is created as it will always exist.
|
|
4637
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4656
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_surface_created Online documentation}
|
|
4638
4657
|
*/
|
|
4639
4658
|
interface OnSurfaceCreatedEvent extends EventData {
|
|
4640
4659
|
readonly surface_index: SurfaceIndex
|
|
@@ -4649,7 +4668,7 @@ declare module "factorio:runtime" {
|
|
|
4649
4668
|
}
|
|
4650
4669
|
/**
|
|
4651
4670
|
* Called after a surface is deleted.
|
|
4652
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4671
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_surface_deleted Online documentation}
|
|
4653
4672
|
*/
|
|
4654
4673
|
interface OnSurfaceDeletedEvent extends EventData {
|
|
4655
4674
|
readonly surface_index: SurfaceIndex
|
|
@@ -4664,7 +4683,7 @@ declare module "factorio:runtime" {
|
|
|
4664
4683
|
}
|
|
4665
4684
|
/**
|
|
4666
4685
|
* Called after a surface is imported via the map editor.
|
|
4667
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4686
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_surface_imported Online documentation}
|
|
4668
4687
|
*/
|
|
4669
4688
|
interface OnSurfaceImportedEvent extends EventData {
|
|
4670
4689
|
readonly surface_index: SurfaceIndex
|
|
@@ -4683,7 +4702,7 @@ declare module "factorio:runtime" {
|
|
|
4683
4702
|
}
|
|
4684
4703
|
/**
|
|
4685
4704
|
* Called when a surface is renamed.
|
|
4686
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4705
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_surface_renamed Online documentation}
|
|
4687
4706
|
*/
|
|
4688
4707
|
interface OnSurfaceRenamedEvent extends EventData {
|
|
4689
4708
|
readonly surface_index: SurfaceIndex
|
|
@@ -4700,7 +4719,7 @@ declare module "factorio:runtime" {
|
|
|
4700
4719
|
}
|
|
4701
4720
|
/**
|
|
4702
4721
|
* Called when {@link LuaForce#reset_technology_effects LuaForce::reset_technology_effects} is finished.
|
|
4703
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4722
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_technology_effects_reset Online documentation}
|
|
4704
4723
|
*/
|
|
4705
4724
|
interface OnTechnologyEffectsResetEvent extends EventData {
|
|
4706
4725
|
readonly force: LuaForce
|
|
@@ -4715,7 +4734,7 @@ declare module "factorio:runtime" {
|
|
|
4715
4734
|
}
|
|
4716
4735
|
/**
|
|
4717
4736
|
* Called when a territory is created for any reason.
|
|
4718
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4737
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_territory_created Online documentation}
|
|
4719
4738
|
*/
|
|
4720
4739
|
interface OnTerritoryCreatedEvent extends EventData {
|
|
4721
4740
|
/**
|
|
@@ -4737,7 +4756,7 @@ declare module "factorio:runtime" {
|
|
|
4737
4756
|
}
|
|
4738
4757
|
/**
|
|
4739
4758
|
* Called when a territory is destroyed from a surface.
|
|
4740
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4759
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_territory_destroyed Online documentation}
|
|
4741
4760
|
*/
|
|
4742
4761
|
interface OnTerritoryDestroyedEvent extends EventData {
|
|
4743
4762
|
/**
|
|
@@ -4755,7 +4774,7 @@ declare module "factorio:runtime" {
|
|
|
4755
4774
|
}
|
|
4756
4775
|
/**
|
|
4757
4776
|
* It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
|
|
4758
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4777
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_tick Online documentation}
|
|
4759
4778
|
*/
|
|
4760
4779
|
interface OnTickEvent extends EventData {
|
|
4761
4780
|
/**
|
|
@@ -4773,7 +4792,7 @@ declare module "factorio:runtime" {
|
|
|
4773
4792
|
* After this event any items in the buffer will be transferred into the tower as if they came from mining the entity.
|
|
4774
4793
|
*
|
|
4775
4794
|
* 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.
|
|
4776
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4795
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_tower_mined_plant Online documentation}
|
|
4777
4796
|
*/
|
|
4778
4797
|
interface OnTowerMinedPlantEvent extends EventData {
|
|
4779
4798
|
/**
|
|
@@ -4799,7 +4818,7 @@ declare module "factorio:runtime" {
|
|
|
4799
4818
|
}
|
|
4800
4819
|
/**
|
|
4801
4820
|
* Called before an agricultural tower plants a seed.
|
|
4802
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4821
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_tower_planted_seed Online documentation}
|
|
4803
4822
|
*/
|
|
4804
4823
|
interface OnTowerPlantedSeedEvent extends EventData {
|
|
4805
4824
|
/**
|
|
@@ -4825,7 +4844,7 @@ declare module "factorio:runtime" {
|
|
|
4825
4844
|
}
|
|
4826
4845
|
/**
|
|
4827
4846
|
* Called before an agricultural tower mines a plant.
|
|
4828
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4847
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_tower_pre_mined_plant Online documentation}
|
|
4829
4848
|
*/
|
|
4830
4849
|
interface OnTowerPreMinedPlantEvent extends EventData {
|
|
4831
4850
|
/**
|
|
@@ -4847,7 +4866,7 @@ declare module "factorio:runtime" {
|
|
|
4847
4866
|
}
|
|
4848
4867
|
/**
|
|
4849
4868
|
* Called when a train changes state (started to stopped and vice versa)
|
|
4850
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4869
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_train_changed_state Online documentation}
|
|
4851
4870
|
*/
|
|
4852
4871
|
interface OnTrainChangedStateEvent extends EventData {
|
|
4853
4872
|
readonly train: LuaTrain
|
|
@@ -4863,7 +4882,7 @@ declare module "factorio:runtime" {
|
|
|
4863
4882
|
}
|
|
4864
4883
|
/**
|
|
4865
4884
|
* Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
|
|
4866
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4885
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_train_created Online documentation}
|
|
4867
4886
|
*/
|
|
4868
4887
|
interface OnTrainCreatedEvent extends EventData {
|
|
4869
4888
|
readonly train: LuaTrain
|
|
@@ -4886,7 +4905,7 @@ declare module "factorio:runtime" {
|
|
|
4886
4905
|
}
|
|
4887
4906
|
/**
|
|
4888
4907
|
* Called when a trains schedule is changed either by the player or through script.
|
|
4889
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4908
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_train_schedule_changed Online documentation}
|
|
4890
4909
|
*/
|
|
4891
4910
|
interface OnTrainScheduleChangedEvent extends EventData {
|
|
4892
4911
|
readonly train: LuaTrain
|
|
@@ -4905,7 +4924,7 @@ declare module "factorio:runtime" {
|
|
|
4905
4924
|
}
|
|
4906
4925
|
/**
|
|
4907
4926
|
* Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined `trigger_created_entity=true`.
|
|
4908
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4927
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_trigger_created_entity Online documentation}
|
|
4909
4928
|
*/
|
|
4910
4929
|
interface OnTriggerCreatedEntityEvent extends EventData {
|
|
4911
4930
|
readonly entity: LuaEntity
|
|
@@ -4921,7 +4940,7 @@ declare module "factorio:runtime" {
|
|
|
4921
4940
|
}
|
|
4922
4941
|
/**
|
|
4923
4942
|
* Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined `trigger_fired_artillery=true`.
|
|
4924
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4943
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_trigger_fired_artillery Online documentation}
|
|
4925
4944
|
*/
|
|
4926
4945
|
interface OnTriggerFiredArtilleryEvent extends EventData {
|
|
4927
4946
|
readonly entity: LuaEntity
|
|
@@ -4937,7 +4956,7 @@ declare module "factorio:runtime" {
|
|
|
4937
4956
|
}
|
|
4938
4957
|
/**
|
|
4939
4958
|
* Called when new packets are processed by {@link LuaHelpers#recv_udp LuaHelpers::recv_udp}.
|
|
4940
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4959
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_udp_packet_received Online documentation}
|
|
4941
4960
|
*/
|
|
4942
4961
|
interface OnUdpPacketReceivedEvent extends EventData {
|
|
4943
4962
|
/**
|
|
@@ -4963,7 +4982,7 @@ declare module "factorio:runtime" {
|
|
|
4963
4982
|
}
|
|
4964
4983
|
/**
|
|
4965
4984
|
* Called when the player triggers "undo".
|
|
4966
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
4985
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_undo_applied Online documentation}
|
|
4967
4986
|
*/
|
|
4968
4987
|
interface OnUndoAppliedEvent extends EventData {
|
|
4969
4988
|
/**
|
|
@@ -4985,7 +5004,7 @@ declare module "factorio:runtime" {
|
|
|
4985
5004
|
}
|
|
4986
5005
|
/**
|
|
4987
5006
|
* Called when a unit is added to a unit group.
|
|
4988
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5007
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_unit_added_to_group Online documentation}
|
|
4989
5008
|
*/
|
|
4990
5009
|
interface OnUnitAddedToGroupEvent extends EventData {
|
|
4991
5010
|
readonly unit: LuaEntity
|
|
@@ -5001,7 +5020,7 @@ declare module "factorio:runtime" {
|
|
|
5001
5020
|
}
|
|
5002
5021
|
/**
|
|
5003
5022
|
* Called when a new unit group is created, before any members are added to it.
|
|
5004
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5023
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_unit_group_created Online documentation}
|
|
5005
5024
|
*/
|
|
5006
5025
|
interface OnUnitGroupCreatedEvent extends EventData {
|
|
5007
5026
|
readonly group: LuaCommandable
|
|
@@ -5016,7 +5035,7 @@ declare module "factorio:runtime" {
|
|
|
5016
5035
|
}
|
|
5017
5036
|
/**
|
|
5018
5037
|
* Called when a unit group finishes gathering and starts executing its command.
|
|
5019
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5038
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_unit_group_finished_gathering Online documentation}
|
|
5020
5039
|
*/
|
|
5021
5040
|
interface OnUnitGroupFinishedGatheringEvent extends EventData {
|
|
5022
5041
|
readonly group: LuaCommandable
|
|
@@ -5031,7 +5050,7 @@ declare module "factorio:runtime" {
|
|
|
5031
5050
|
}
|
|
5032
5051
|
/**
|
|
5033
5052
|
* Called when a unit is removed from a unit group.
|
|
5034
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5053
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_unit_removed_from_group Online documentation}
|
|
5035
5054
|
*/
|
|
5036
5055
|
interface OnUnitRemovedFromGroupEvent extends EventData {
|
|
5037
5056
|
readonly unit: LuaEntity
|
|
@@ -5047,7 +5066,7 @@ declare module "factorio:runtime" {
|
|
|
5047
5066
|
}
|
|
5048
5067
|
/**
|
|
5049
5068
|
* Called when a worker (construction or logistic) robot expires through a lack of energy.
|
|
5050
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5069
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#on_worker_robot_expired Online documentation}
|
|
5051
5070
|
*/
|
|
5052
5071
|
interface OnWorkerRobotExpiredEvent extends EventData {
|
|
5053
5072
|
readonly robot: LuaEntity
|
|
@@ -5064,7 +5083,7 @@ declare module "factorio:runtime" {
|
|
|
5064
5083
|
* 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}.
|
|
5065
5084
|
*
|
|
5066
5085
|
* Event filter: [LuaScriptRaisedBuiltEventFilter](LuaScriptRaisedBuiltEventFilter]
|
|
5067
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5086
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#script_raised_built Online documentation}
|
|
5068
5087
|
*/
|
|
5069
5088
|
interface ScriptRaisedBuiltEvent extends EventData {
|
|
5070
5089
|
/**
|
|
@@ -5084,7 +5103,7 @@ declare module "factorio:runtime" {
|
|
|
5084
5103
|
* 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}.
|
|
5085
5104
|
*
|
|
5086
5105
|
* Event filter: [LuaScriptRaisedDestroyEventFilter](LuaScriptRaisedDestroyEventFilter]
|
|
5087
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5106
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#script_raised_destroy Online documentation}
|
|
5088
5107
|
*/
|
|
5089
5108
|
interface ScriptRaisedDestroyEvent extends EventData {
|
|
5090
5109
|
/**
|
|
@@ -5104,7 +5123,7 @@ declare module "factorio:runtime" {
|
|
|
5104
5123
|
* A static event that mods can use to tell other mods they destroyed a segmented unit 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_segmented_unit LuaBootstrap::raise_script_destroy_segmented_unit}, or when `raise_destroy` is passed to {@link LuaSegmentedUnit#destroy LuaSegmentedUnit::destroy}.
|
|
5105
5124
|
*
|
|
5106
5125
|
* Event filter: [LuaScriptRaisedDestroySegmentedUnitEventFilter](LuaScriptRaisedDestroySegmentedUnitEventFilter]
|
|
5107
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5126
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#script_raised_destroy_segmented_unit Online documentation}
|
|
5108
5127
|
*/
|
|
5109
5128
|
interface ScriptRaisedDestroySegmentedUnitEvent extends EventData {
|
|
5110
5129
|
/**
|
|
@@ -5124,7 +5143,7 @@ declare module "factorio:runtime" {
|
|
|
5124
5143
|
* 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}.
|
|
5125
5144
|
*
|
|
5126
5145
|
* Event filter: [LuaScriptRaisedReviveEventFilter](LuaScriptRaisedReviveEventFilter]
|
|
5127
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5146
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#script_raised_revive Online documentation}
|
|
5128
5147
|
*/
|
|
5129
5148
|
interface ScriptRaisedReviveEvent extends EventData {
|
|
5130
5149
|
/**
|
|
@@ -5146,7 +5165,7 @@ declare module "factorio:runtime" {
|
|
|
5146
5165
|
}
|
|
5147
5166
|
/**
|
|
5148
5167
|
* 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}.
|
|
5149
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5168
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#script_raised_set_tiles Online documentation}
|
|
5150
5169
|
*/
|
|
5151
5170
|
interface ScriptRaisedSetTilesEvent extends EventData {
|
|
5152
5171
|
/**
|
|
@@ -5170,7 +5189,7 @@ declare module "factorio:runtime" {
|
|
|
5170
5189
|
* 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}.
|
|
5171
5190
|
*
|
|
5172
5191
|
* Event filter: [LuaScriptRaisedTeleportedEventFilter](LuaScriptRaisedTeleportedEventFilter]
|
|
5173
|
-
* @see {@link https://lua-api.factorio.com/2.0.
|
|
5192
|
+
* @see {@link https://lua-api.factorio.com/2.0.70/events.html#script_raised_teleported Online documentation}
|
|
5174
5193
|
*/
|
|
5175
5194
|
interface ScriptRaisedTeleportedEvent extends EventData {
|
|
5176
5195
|
/**
|