typed-factorio 0.13.0 → 0.14.1
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/Changelog.md +119 -98
- package/LICENSE +21 -21
- package/README.md +128 -113
- package/data/types.d.ts +13 -13
- package/generated/builtin-types.d.ts +11 -9
- package/generated/classes.d.ts +3924 -3552
- package/generated/concepts.d.ts +145 -121
- package/generated/defines.d.ts +102 -100
- package/generated/events.d.ts +176 -174
- package/generated/global-objects.d.ts +9 -7
- package/generated/index.d.ts +2 -0
- package/package.json +58 -58
- package/runtime/index.d.ts +10 -10
- package/runtime/librariesAndFunctions.d.ts +123 -123
- package/runtime/mod-gui.d.ts +11 -11
- package/runtime/pairs.d.ts +13 -13
- package/runtime/util.d.ts +120 -120
- package/settings/types.d.ts +120 -120
package/generated/events.d.ts
CHANGED
@@ -1,9 +1,11 @@
|
|
1
|
+
// This is an auto-generated file. Do not edit directly!
|
2
|
+
|
1
3
|
/** @noSelfInFile */
|
2
4
|
|
3
5
|
/**
|
4
6
|
* Called when a {@link https://wiki.factorio.com/Prototype/CustomInput CustomInput} is activated.
|
5
7
|
*
|
6
|
-
* {@link https://lua-api.factorio.com/
|
8
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#CustomInputEvent View documentation}
|
7
9
|
*/
|
8
10
|
interface CustomInputEvent extends EventData {
|
9
11
|
/** The player that activated the custom input. */
|
@@ -23,7 +25,7 @@ interface CustomInputEvent extends EventData {
|
|
23
25
|
/**
|
24
26
|
* Called when a unit/group completes a command.
|
25
27
|
*
|
26
|
-
* {@link https://lua-api.factorio.com/
|
28
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_ai_command_completed View documentation}
|
27
29
|
*/
|
28
30
|
interface OnAiCommandCompletedEvent extends EventData {
|
29
31
|
/** Unit_number/group_number of the unit/group which just completed a command. */
|
@@ -40,7 +42,7 @@ interface OnAiCommandCompletedEvent extends EventData {
|
|
40
42
|
/**
|
41
43
|
* Called when an area of the map is cloned.
|
42
44
|
*
|
43
|
-
* {@link https://lua-api.factorio.com/
|
45
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_area_cloned View documentation}
|
44
46
|
*/
|
45
47
|
interface OnAreaClonedEvent extends EventData {
|
46
48
|
readonly source_surface: LuaSurface
|
@@ -65,7 +67,7 @@ interface OnAreaClonedEvent extends EventData {
|
|
65
67
|
* **Note**: This will be called multiple times for each migration, once for every biter that is sacrificed to build
|
66
68
|
* part of the new base.
|
67
69
|
*
|
68
|
-
* {@link https://lua-api.factorio.com/
|
70
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_biter_base_built View documentation}
|
69
71
|
*/
|
70
72
|
interface OnBiterBaseBuiltEvent extends EventData {
|
71
73
|
/** The entity that was built. */
|
@@ -79,7 +81,7 @@ interface OnBiterBaseBuiltEvent extends EventData {
|
|
79
81
|
/**
|
80
82
|
* Called when a set of positions on the map is cloned.
|
81
83
|
*
|
82
|
-
* {@link https://lua-api.factorio.com/
|
84
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_brush_cloned View documentation}
|
83
85
|
*/
|
84
86
|
interface OnBrushClonedEvent extends EventData {
|
85
87
|
readonly source_offset: TilePosition
|
@@ -102,7 +104,7 @@ interface OnBrushClonedEvent extends EventData {
|
|
102
104
|
/**
|
103
105
|
* Called when a {@link defines.command.build_base} command reaches its destination, and before building starts.
|
104
106
|
*
|
105
|
-
* {@link https://lua-api.factorio.com/
|
107
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_build_base_arrived View documentation}
|
106
108
|
*/
|
107
109
|
interface OnBuildBaseArrivedEvent extends EventData {
|
108
110
|
/** The unit the command was assigned to. */
|
@@ -118,7 +120,7 @@ interface OnBuildBaseArrivedEvent extends EventData {
|
|
118
120
|
/**
|
119
121
|
* Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter}.
|
120
122
|
*
|
121
|
-
* {@link https://lua-api.factorio.com/
|
123
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_built_entity View documentation}
|
122
124
|
*/
|
123
125
|
interface OnBuiltEntityEvent extends EventData {
|
124
126
|
readonly created_entity: LuaEntity
|
@@ -138,7 +140,7 @@ interface OnBuiltEntityEvent extends EventData {
|
|
138
140
|
* Called when the deconstruction of an entity is canceled. Can be filtered using
|
139
141
|
* {@link LuaEntityDeconstructionCancelledEventFilter}.
|
140
142
|
*
|
141
|
-
* {@link https://lua-api.factorio.com/
|
143
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_cancelled_deconstruction View documentation}
|
142
144
|
*/
|
143
145
|
interface OnCancelledDeconstructionEvent extends EventData {
|
144
146
|
readonly entity: LuaEntity
|
@@ -152,7 +154,7 @@ interface OnCancelledDeconstructionEvent extends EventData {
|
|
152
154
|
/**
|
153
155
|
* Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter}.
|
154
156
|
*
|
155
|
-
* {@link https://lua-api.factorio.com/
|
157
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_cancelled_upgrade View documentation}
|
156
158
|
*/
|
157
159
|
interface OnCancelledUpgradeEvent extends EventData {
|
158
160
|
readonly entity: LuaEntity
|
@@ -168,7 +170,7 @@ interface OnCancelledUpgradeEvent extends EventData {
|
|
168
170
|
*
|
169
171
|
* **Note**: this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
|
170
172
|
*
|
171
|
-
* {@link https://lua-api.factorio.com/
|
173
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_character_corpse_expired View documentation}
|
172
174
|
*/
|
173
175
|
interface OnCharacterCorpseExpiredEvent extends EventData {
|
174
176
|
/** The corpse. */
|
@@ -182,7 +184,7 @@ interface OnCharacterCorpseExpiredEvent extends EventData {
|
|
182
184
|
/**
|
183
185
|
* Called when a chart tag is created.
|
184
186
|
*
|
185
|
-
* {@link https://lua-api.factorio.com/
|
187
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_chart_tag_added View documentation}
|
186
188
|
*/
|
187
189
|
interface OnChartTagAddedEvent extends EventData {
|
188
190
|
readonly tag: LuaCustomChartTag
|
@@ -197,7 +199,7 @@ interface OnChartTagAddedEvent extends EventData {
|
|
197
199
|
/**
|
198
200
|
* Called when a chart tag is modified by a player.
|
199
201
|
*
|
200
|
-
* {@link https://lua-api.factorio.com/
|
202
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_chart_tag_modified View documentation}
|
201
203
|
*/
|
202
204
|
interface OnChartTagModifiedEvent extends EventData {
|
203
205
|
readonly tag: LuaCustomChartTag
|
@@ -215,7 +217,7 @@ interface OnChartTagModifiedEvent extends EventData {
|
|
215
217
|
/**
|
216
218
|
* Called just before a chart tag is deleted.
|
217
219
|
*
|
218
|
-
* {@link https://lua-api.factorio.com/
|
220
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_chart_tag_removed View documentation}
|
219
221
|
*/
|
220
222
|
interface OnChartTagRemovedEvent extends EventData {
|
221
223
|
readonly tag: LuaCustomChartTag
|
@@ -230,7 +232,7 @@ interface OnChartTagRemovedEvent extends EventData {
|
|
230
232
|
/**
|
231
233
|
* Called when a chunk is charted or re-charted.
|
232
234
|
*
|
233
|
-
* {@link https://lua-api.factorio.com/
|
235
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_chunk_charted View documentation}
|
234
236
|
*/
|
235
237
|
interface OnChunkChartedEvent extends EventData {
|
236
238
|
readonly surface_index: uint
|
@@ -247,7 +249,7 @@ interface OnChunkChartedEvent extends EventData {
|
|
247
249
|
/**
|
248
250
|
* Called when one or more chunks are deleted using {@link LuaSurface.delete_chunk LuaSurface::delete_chunk}.
|
249
251
|
*
|
250
|
-
* {@link https://lua-api.factorio.com/
|
252
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_chunk_deleted View documentation}
|
251
253
|
*/
|
252
254
|
interface OnChunkDeletedEvent extends EventData {
|
253
255
|
readonly surface_index: uint
|
@@ -262,7 +264,7 @@ interface OnChunkDeletedEvent extends EventData {
|
|
262
264
|
/**
|
263
265
|
* Called when a chunk is generated.
|
264
266
|
*
|
265
|
-
* {@link https://lua-api.factorio.com/
|
267
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_chunk_generated View documentation}
|
266
268
|
*/
|
267
269
|
interface OnChunkGeneratedEvent extends EventData {
|
268
270
|
/** Area of the chunk. */
|
@@ -280,7 +282,7 @@ interface OnChunkGeneratedEvent extends EventData {
|
|
280
282
|
/**
|
281
283
|
* Called when a combat robot expires through a lack of energy, or timeout.
|
282
284
|
*
|
283
|
-
* {@link https://lua-api.factorio.com/
|
285
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_combat_robot_expired View documentation}
|
284
286
|
*/
|
285
287
|
interface OnCombatRobotExpiredEvent extends EventData {
|
286
288
|
readonly robot: LuaEntity
|
@@ -297,7 +299,7 @@ interface OnCombatRobotExpiredEvent extends EventData {
|
|
297
299
|
*
|
298
300
|
* **Note**: This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
|
299
301
|
*
|
300
|
-
* {@link https://lua-api.factorio.com/
|
302
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_console_chat View documentation}
|
301
303
|
*/
|
302
304
|
interface OnConsoleChatEvent extends EventData {
|
303
305
|
/** The player doing the chatting, if any. */
|
@@ -313,7 +315,7 @@ interface OnConsoleChatEvent extends EventData {
|
|
313
315
|
/**
|
314
316
|
* Called when someone enters a command-like message regardless of it being a valid command.
|
315
317
|
*
|
316
|
-
* {@link https://lua-api.factorio.com/
|
318
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_console_command View documentation}
|
317
319
|
*/
|
318
320
|
interface OnConsoleCommandEvent extends EventData {
|
319
321
|
/** The player if any. */
|
@@ -331,7 +333,7 @@ interface OnConsoleCommandEvent extends EventData {
|
|
331
333
|
/**
|
332
334
|
* Called when a cutscene is cancelled by the player or by script.
|
333
335
|
*
|
334
|
-
* {@link https://lua-api.factorio.com/
|
336
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_cutscene_cancelled View documentation}
|
335
337
|
*/
|
336
338
|
interface OnCutsceneCancelledEvent extends EventData {
|
337
339
|
/** The player the cutscene was shown to. */
|
@@ -349,7 +351,7 @@ interface OnCutsceneCancelledEvent extends EventData {
|
|
349
351
|
*
|
350
352
|
* **Note**: Due to implementation omission, waypoint_index is 0-based.
|
351
353
|
*
|
352
|
-
* {@link https://lua-api.factorio.com/
|
354
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_cutscene_waypoint_reached View documentation}
|
353
355
|
*/
|
354
356
|
interface OnCutsceneWaypointReachedEvent extends EventData {
|
355
357
|
/** The player index of the player viewing the cutscene. */
|
@@ -367,7 +369,7 @@ interface OnCutsceneWaypointReachedEvent extends EventData {
|
|
367
369
|
*
|
368
370
|
* **Note**: It's not guaranteed that both settings are changed - just that at least one has been changed.
|
369
371
|
*
|
370
|
-
* {@link https://lua-api.factorio.com/
|
372
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_difficulty_settings_changed View documentation}
|
371
373
|
*/
|
372
374
|
interface OnDifficultySettingsChangedEvent extends EventData {
|
373
375
|
readonly old_recipe_difficulty: uint
|
@@ -381,7 +383,7 @@ interface OnDifficultySettingsChangedEvent extends EventData {
|
|
381
383
|
/**
|
382
384
|
* Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter}.
|
383
385
|
*
|
384
|
-
* {@link https://lua-api.factorio.com/
|
386
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_entity_cloned View documentation}
|
385
387
|
*/
|
386
388
|
interface OnEntityClonedEvent extends EventData {
|
387
389
|
readonly source: LuaEntity
|
@@ -397,7 +399,7 @@ interface OnEntityClonedEvent extends EventData {
|
|
397
399
|
*
|
398
400
|
* **Note**: This is not called when an entities health is set directly by another mod.
|
399
401
|
*
|
400
|
-
* {@link https://lua-api.factorio.com/
|
402
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_entity_damaged View documentation}
|
401
403
|
*/
|
402
404
|
interface OnEntityDamagedEvent extends EventData {
|
403
405
|
readonly entity: LuaEntity
|
@@ -425,7 +427,7 @@ interface OnEntityDamagedEvent extends EventData {
|
|
425
427
|
* **Note**: Depending on when a given entity is destroyed this will be fired at the end of the current tick or end of
|
426
428
|
* the next tick.
|
427
429
|
*
|
428
|
-
* {@link https://lua-api.factorio.com/
|
430
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_entity_destroyed View documentation}
|
429
431
|
*/
|
430
432
|
interface OnEntityDestroyedEvent extends EventData {
|
431
433
|
readonly registration_number: uint64
|
@@ -439,7 +441,7 @@ interface OnEntityDestroyedEvent extends EventData {
|
|
439
441
|
/**
|
440
442
|
* Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter}.
|
441
443
|
*
|
442
|
-
* {@link https://lua-api.factorio.com/
|
444
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_entity_died View documentation}
|
443
445
|
*/
|
444
446
|
interface OnEntityDiedEvent extends EventData {
|
445
447
|
/** The entity that died. */
|
@@ -464,7 +466,7 @@ interface OnEntityDiedEvent extends EventData {
|
|
464
466
|
* **Note**: "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the
|
465
467
|
* request slots on logistic chests.
|
466
468
|
*
|
467
|
-
* {@link https://lua-api.factorio.com/
|
469
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_entity_logistic_slot_changed View documentation}
|
468
470
|
*/
|
469
471
|
interface OnEntityLogisticSlotChangedEvent extends EventData {
|
470
472
|
/** The player who changed the slot, or `nil` if changed by script. */
|
@@ -482,7 +484,7 @@ interface OnEntityLogisticSlotChangedEvent extends EventData {
|
|
482
484
|
/**
|
483
485
|
* Called after an entity has been renamed either by the player or through script.
|
484
486
|
*
|
485
|
-
* {@link https://lua-api.factorio.com/
|
487
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_entity_renamed View documentation}
|
486
488
|
*/
|
487
489
|
interface OnEntityRenamedEvent extends EventData {
|
488
490
|
/** If by_script is true this will not be included. */
|
@@ -499,7 +501,7 @@ interface OnEntityRenamedEvent extends EventData {
|
|
499
501
|
/**
|
500
502
|
* Called after entity copy-paste is done.
|
501
503
|
*
|
502
|
-
* {@link https://lua-api.factorio.com/
|
504
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_entity_settings_pasted View documentation}
|
503
505
|
*/
|
504
506
|
interface OnEntitySettingsPastedEvent extends EventData {
|
505
507
|
readonly player_index: uint
|
@@ -516,7 +518,7 @@ interface OnEntitySettingsPastedEvent extends EventData {
|
|
516
518
|
/**
|
517
519
|
* Called when an entity is spawned by a EnemySpawner
|
518
520
|
*
|
519
|
-
* {@link https://lua-api.factorio.com/
|
521
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_entity_spawned View documentation}
|
520
522
|
*/
|
521
523
|
interface OnEntitySpawnedEvent extends EventData {
|
522
524
|
readonly spawner: LuaEntity
|
@@ -530,7 +532,7 @@ interface OnEntitySpawnedEvent extends EventData {
|
|
530
532
|
/**
|
531
533
|
* Called after equipment is inserted into an equipment grid.
|
532
534
|
*
|
533
|
-
* {@link https://lua-api.factorio.com/
|
535
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_equipment_inserted View documentation}
|
534
536
|
*/
|
535
537
|
interface OnEquipmentInsertedEvent extends EventData {
|
536
538
|
/** The equipment grid inserted into. */
|
@@ -546,7 +548,7 @@ interface OnEquipmentInsertedEvent extends EventData {
|
|
546
548
|
/**
|
547
549
|
* Called after equipment is removed from an equipment grid.
|
548
550
|
*
|
549
|
-
* {@link https://lua-api.factorio.com/
|
551
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_equipment_removed View documentation}
|
550
552
|
*/
|
551
553
|
interface OnEquipmentRemovedEvent extends EventData {
|
552
554
|
/** The equipment grid removed from. */
|
@@ -564,7 +566,7 @@ interface OnEquipmentRemovedEvent extends EventData {
|
|
564
566
|
/**
|
565
567
|
* Called when the a forces cease fire values change.
|
566
568
|
*
|
567
|
-
* {@link https://lua-api.factorio.com/
|
569
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_force_cease_fire_changed View documentation}
|
568
570
|
*/
|
569
571
|
interface OnForceCeaseFireChangedEvent extends EventData {
|
570
572
|
/** The force who's cease fire changed. */
|
@@ -585,7 +587,7 @@ interface OnForceCeaseFireChangedEvent extends EventData {
|
|
585
587
|
* **Note**: This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will
|
586
588
|
* always exist.
|
587
589
|
*
|
588
|
-
* {@link https://lua-api.factorio.com/
|
590
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_force_created View documentation}
|
589
591
|
*/
|
590
592
|
interface OnForceCreatedEvent extends EventData {
|
591
593
|
/** The newly created force. */
|
@@ -599,7 +601,7 @@ interface OnForceCreatedEvent extends EventData {
|
|
599
601
|
/**
|
600
602
|
* Called when the a forces friends change.
|
601
603
|
*
|
602
|
-
* {@link https://lua-api.factorio.com/
|
604
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_force_friends_changed View documentation}
|
603
605
|
*/
|
604
606
|
interface OnForceFriendsChangedEvent extends EventData {
|
605
607
|
/** The force who's friends changed. */
|
@@ -617,7 +619,7 @@ interface OnForceFriendsChangedEvent extends EventData {
|
|
617
619
|
/**
|
618
620
|
* Called when {@link LuaForce.reset LuaForce::reset} is finished.
|
619
621
|
*
|
620
|
-
* {@link https://lua-api.factorio.com/
|
622
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_force_reset View documentation}
|
621
623
|
*/
|
622
624
|
interface OnForceResetEvent extends EventData {
|
623
625
|
readonly force: LuaForce
|
@@ -632,7 +634,7 @@ interface OnForceResetEvent extends EventData {
|
|
632
634
|
*
|
633
635
|
* **Note**: The source force is invalidated before this event is called and the name can be re-used in this event if desired.
|
634
636
|
*
|
635
|
-
* {@link https://lua-api.factorio.com/
|
637
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_forces_merged View documentation}
|
636
638
|
*/
|
637
639
|
interface OnForcesMergedEvent extends EventData {
|
638
640
|
/** The force destroyed. */
|
@@ -650,7 +652,7 @@ interface OnForcesMergedEvent extends EventData {
|
|
650
652
|
/**
|
651
653
|
* Called when two forces are about to be merged using `game.merge_forces()`.
|
652
654
|
*
|
653
|
-
* {@link https://lua-api.factorio.com/
|
655
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_forces_merging View documentation}
|
654
656
|
*/
|
655
657
|
interface OnForcesMergingEvent extends EventData {
|
656
658
|
/** The force to be destroyed */
|
@@ -669,7 +671,7 @@ interface OnForcesMergingEvent extends EventData {
|
|
669
671
|
*
|
670
672
|
* **Note**: This event is not fired when the scenario is loaded via the map editor.
|
671
673
|
*
|
672
|
-
* {@link https://lua-api.factorio.com/
|
674
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_game_created_from_scenario View documentation}
|
673
675
|
*/
|
674
676
|
interface OnGameCreatedFromScenarioEvent extends EventData {
|
675
677
|
/** Identifier of the event */
|
@@ -681,7 +683,7 @@ interface OnGameCreatedFromScenarioEvent extends EventData {
|
|
681
683
|
/**
|
682
684
|
* Called when {@link LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
|
683
685
|
*
|
684
|
-
* {@link https://lua-api.factorio.com/
|
686
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_checked_state_changed View documentation}
|
685
687
|
*/
|
686
688
|
interface OnGuiCheckedStateChangedEvent extends EventData {
|
687
689
|
/** The element whose checked state changed. */
|
@@ -697,7 +699,7 @@ interface OnGuiCheckedStateChangedEvent extends EventData {
|
|
697
699
|
/**
|
698
700
|
* Called when {@link LuaGuiElement} is clicked.
|
699
701
|
*
|
700
|
-
* {@link https://lua-api.factorio.com/
|
702
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_click View documentation}
|
701
703
|
*/
|
702
704
|
interface OnGuiClickEvent extends EventData {
|
703
705
|
/** The clicked element. */
|
@@ -726,7 +728,7 @@ interface OnGuiClickEvent extends EventData {
|
|
726
728
|
* **Note**: It's not advised to open any other GUI during this event because if this is run as a request to open a
|
727
729
|
* different GUI the game will force close the new opened GUI without notice to ensure the original requested GUI is opened.
|
728
730
|
*
|
729
|
-
* {@link https://lua-api.factorio.com/
|
731
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_closed View documentation}
|
730
732
|
*/
|
731
733
|
interface OnGuiClosedEvent extends EventData {
|
732
734
|
/** The player. */
|
@@ -756,7 +758,7 @@ interface OnGuiClosedEvent extends EventData {
|
|
756
758
|
/**
|
757
759
|
* Called when a {@link LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
|
758
760
|
*
|
759
|
-
* {@link https://lua-api.factorio.com/
|
761
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_confirmed View documentation}
|
760
762
|
*/
|
761
763
|
interface OnGuiConfirmedEvent extends EventData {
|
762
764
|
/** The confirmed element. */
|
@@ -778,7 +780,7 @@ interface OnGuiConfirmedEvent extends EventData {
|
|
778
780
|
/**
|
779
781
|
* Called when {@link LuaGuiElement} element value is changed (related to choose element buttons).
|
780
782
|
*
|
781
|
-
* {@link https://lua-api.factorio.com/
|
783
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_elem_changed View documentation}
|
782
784
|
*/
|
783
785
|
interface OnGuiElemChangedEvent extends EventData {
|
784
786
|
/** The element whose element value changed. */
|
@@ -794,7 +796,7 @@ interface OnGuiElemChangedEvent extends EventData {
|
|
794
796
|
/**
|
795
797
|
* Called when {@link LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
|
796
798
|
*
|
797
|
-
* {@link https://lua-api.factorio.com/
|
799
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_location_changed View documentation}
|
798
800
|
*/
|
799
801
|
interface OnGuiLocationChangedEvent extends EventData {
|
800
802
|
/** The element whose location changed. */
|
@@ -810,7 +812,7 @@ interface OnGuiLocationChangedEvent extends EventData {
|
|
810
812
|
/**
|
811
813
|
* Called when the player opens a GUI.
|
812
814
|
*
|
813
|
-
* {@link https://lua-api.factorio.com/
|
815
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_opened View documentation}
|
814
816
|
*/
|
815
817
|
interface OnGuiOpenedEvent extends EventData {
|
816
818
|
/** The player. */
|
@@ -836,7 +838,7 @@ interface OnGuiOpenedEvent extends EventData {
|
|
836
838
|
/**
|
837
839
|
* Called when {@link LuaGuiElement} selected tab is changed (related to tabbed-panes).
|
838
840
|
*
|
839
|
-
* {@link https://lua-api.factorio.com/
|
841
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_selected_tab_changed View documentation}
|
840
842
|
*/
|
841
843
|
interface OnGuiSelectedTabChangedEvent extends EventData {
|
842
844
|
/** The tabbed pane whose selected tab changed. */
|
@@ -852,7 +854,7 @@ interface OnGuiSelectedTabChangedEvent extends EventData {
|
|
852
854
|
/**
|
853
855
|
* Called when {@link LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
|
854
856
|
*
|
855
|
-
* {@link https://lua-api.factorio.com/
|
857
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_selection_state_changed View documentation}
|
856
858
|
*/
|
857
859
|
interface OnGuiSelectionStateChangedEvent extends EventData {
|
858
860
|
/** The element whose selection state changed. */
|
@@ -868,7 +870,7 @@ interface OnGuiSelectionStateChangedEvent extends EventData {
|
|
868
870
|
/**
|
869
871
|
* Called when {@link LuaGuiElement} switch state is changed (related to switches).
|
870
872
|
*
|
871
|
-
* {@link https://lua-api.factorio.com/
|
873
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_switch_state_changed View documentation}
|
872
874
|
*/
|
873
875
|
interface OnGuiSwitchStateChangedEvent extends EventData {
|
874
876
|
/** The switch whose switch state changed. */
|
@@ -884,7 +886,7 @@ interface OnGuiSwitchStateChangedEvent extends EventData {
|
|
884
886
|
/**
|
885
887
|
* Called when {@link LuaGuiElement} text is changed by the player.
|
886
888
|
*
|
887
|
-
* {@link https://lua-api.factorio.com/
|
889
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_text_changed View documentation}
|
888
890
|
*/
|
889
891
|
interface OnGuiTextChangedEvent extends EventData {
|
890
892
|
/** The edited element. */
|
@@ -902,7 +904,7 @@ interface OnGuiTextChangedEvent extends EventData {
|
|
902
904
|
/**
|
903
905
|
* Called when {@link LuaGuiElement} slider value is changed (related to the slider element).
|
904
906
|
*
|
905
|
-
* {@link https://lua-api.factorio.com/
|
907
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_gui_value_changed View documentation}
|
906
908
|
*/
|
907
909
|
interface OnGuiValueChangedEvent extends EventData {
|
908
910
|
/** The element whose value changed. */
|
@@ -918,7 +920,7 @@ interface OnGuiValueChangedEvent extends EventData {
|
|
918
920
|
/**
|
919
921
|
* Called when a land mine is armed.
|
920
922
|
*
|
921
|
-
* {@link https://lua-api.factorio.com/
|
923
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_land_mine_armed View documentation}
|
922
924
|
*/
|
923
925
|
interface OnLandMineArmedEvent extends EventData {
|
924
926
|
readonly mine: LuaEntity
|
@@ -931,7 +933,7 @@ interface OnLandMineArmedEvent extends EventData {
|
|
931
933
|
/**
|
932
934
|
* Called when a custom Lua shortcut is pressed.
|
933
935
|
*
|
934
|
-
* {@link https://lua-api.factorio.com/
|
936
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_lua_shortcut View documentation}
|
935
937
|
*/
|
936
938
|
interface OnLuaShortcutEvent extends EventData {
|
937
939
|
readonly player_index: uint
|
@@ -947,7 +949,7 @@ interface OnLuaShortcutEvent extends EventData {
|
|
947
949
|
* Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered
|
948
950
|
* using {@link LuaEntityMarkedForDeconstructionEventFilter}.
|
949
951
|
*
|
950
|
-
* {@link https://lua-api.factorio.com/
|
952
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_marked_for_deconstruction View documentation}
|
951
953
|
*/
|
952
954
|
interface OnMarkedForDeconstructionEvent extends EventData {
|
953
955
|
readonly entity: LuaEntity
|
@@ -962,7 +964,7 @@ interface OnMarkedForDeconstructionEvent extends EventData {
|
|
962
964
|
* Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using
|
963
965
|
* {@link LuaEntityMarkedForUpgradeEventFilter}.
|
964
966
|
*
|
965
|
-
* {@link https://lua-api.factorio.com/
|
967
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_marked_for_upgrade View documentation}
|
966
968
|
*/
|
967
969
|
interface OnMarkedForUpgradeEvent extends EventData {
|
968
970
|
readonly entity: LuaEntity
|
@@ -979,7 +981,7 @@ interface OnMarkedForUpgradeEvent extends EventData {
|
|
979
981
|
/**
|
980
982
|
* Called after a player purchases some offer from a `market` entity.
|
981
983
|
*
|
982
|
-
* {@link https://lua-api.factorio.com/
|
984
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_market_item_purchased View documentation}
|
983
985
|
*/
|
984
986
|
interface OnMarketItemPurchasedEvent extends EventData {
|
985
987
|
/** The player who did the purchasing. */
|
@@ -999,7 +1001,7 @@ interface OnMarketItemPurchasedEvent extends EventData {
|
|
999
1001
|
/**
|
1000
1002
|
* Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
|
1001
1003
|
*
|
1002
|
-
* {@link https://lua-api.factorio.com/
|
1004
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_mod_item_opened View documentation}
|
1003
1005
|
*/
|
1004
1006
|
interface OnModItemOpenedEvent extends EventData {
|
1005
1007
|
/** The player. */
|
@@ -1015,7 +1017,7 @@ interface OnModItemOpenedEvent extends EventData {
|
|
1015
1017
|
/**
|
1016
1018
|
* Called directly after a permission group is added.
|
1017
1019
|
*
|
1018
|
-
* {@link https://lua-api.factorio.com/
|
1020
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_permission_group_added View documentation}
|
1019
1021
|
*/
|
1020
1022
|
interface OnPermissionGroupAddedEvent extends EventData {
|
1021
1023
|
/** The player that added the group. */
|
@@ -1031,7 +1033,7 @@ interface OnPermissionGroupAddedEvent extends EventData {
|
|
1031
1033
|
/**
|
1032
1034
|
* Called directly after a permission group is deleted.
|
1033
1035
|
*
|
1034
|
-
* {@link https://lua-api.factorio.com/
|
1036
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_permission_group_deleted View documentation}
|
1035
1037
|
*/
|
1036
1038
|
interface OnPermissionGroupDeletedEvent extends EventData {
|
1037
1039
|
/** The player doing the deletion. */
|
@@ -1049,7 +1051,7 @@ interface OnPermissionGroupDeletedEvent extends EventData {
|
|
1049
1051
|
/**
|
1050
1052
|
* Called directly after a permission group is edited in some way.
|
1051
1053
|
*
|
1052
|
-
* {@link https://lua-api.factorio.com/
|
1054
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_permission_group_edited View documentation}
|
1053
1055
|
*/
|
1054
1056
|
interface OnPermissionGroupEditedEvent extends EventData {
|
1055
1057
|
/** The player that did the editing. */
|
@@ -1082,7 +1084,7 @@ interface OnPermissionGroupEditedEvent extends EventData {
|
|
1082
1084
|
/**
|
1083
1085
|
* Called directly after a permission string is imported.
|
1084
1086
|
*
|
1085
|
-
* {@link https://lua-api.factorio.com/
|
1087
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_permission_string_imported View documentation}
|
1086
1088
|
*/
|
1087
1089
|
interface OnPermissionStringImportedEvent extends EventData {
|
1088
1090
|
/** The player that imported the string. */
|
@@ -1096,7 +1098,7 @@ interface OnPermissionStringImportedEvent extends EventData {
|
|
1096
1098
|
/**
|
1097
1099
|
* Called when a player picks up an item.
|
1098
1100
|
*
|
1099
|
-
* {@link https://lua-api.factorio.com/
|
1101
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_picked_up_item View documentation}
|
1100
1102
|
*/
|
1101
1103
|
interface OnPickedUpItemEvent extends EventData {
|
1102
1104
|
readonly item_stack: SimpleItemStack
|
@@ -1110,7 +1112,7 @@ interface OnPickedUpItemEvent extends EventData {
|
|
1110
1112
|
/**
|
1111
1113
|
* Called after a player alt-selects an area with a selection-tool item.
|
1112
1114
|
*
|
1113
|
-
* {@link https://lua-api.factorio.com/
|
1115
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_alt_selected_area View documentation}
|
1114
1116
|
*/
|
1115
1117
|
interface OnPlayerAltSelectedAreaEvent extends EventData {
|
1116
1118
|
/** The player doing the selection. */
|
@@ -1134,7 +1136,7 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
|
|
1134
1136
|
/**
|
1135
1137
|
* Called after a players ammo inventory changed in some way.
|
1136
1138
|
*
|
1137
|
-
* {@link https://lua-api.factorio.com/
|
1139
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_ammo_inventory_changed View documentation}
|
1138
1140
|
*/
|
1139
1141
|
interface OnPlayerAmmoInventoryChangedEvent extends EventData {
|
1140
1142
|
readonly player_index: uint
|
@@ -1147,7 +1149,7 @@ interface OnPlayerAmmoInventoryChangedEvent extends EventData {
|
|
1147
1149
|
/**
|
1148
1150
|
* Called after a players armor inventory changed in some way.
|
1149
1151
|
*
|
1150
|
-
* {@link https://lua-api.factorio.com/
|
1152
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_armor_inventory_changed View documentation}
|
1151
1153
|
*/
|
1152
1154
|
interface OnPlayerArmorInventoryChangedEvent extends EventData {
|
1153
1155
|
readonly player_index: uint
|
@@ -1160,7 +1162,7 @@ interface OnPlayerArmorInventoryChangedEvent extends EventData {
|
|
1160
1162
|
/**
|
1161
1163
|
* Called when a player is banned.
|
1162
1164
|
*
|
1163
|
-
* {@link https://lua-api.factorio.com/
|
1165
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_banned View documentation}
|
1164
1166
|
*/
|
1165
1167
|
interface OnPlayerBannedEvent extends EventData {
|
1166
1168
|
/** The player banned. */
|
@@ -1180,7 +1182,7 @@ interface OnPlayerBannedEvent extends EventData {
|
|
1180
1182
|
/**
|
1181
1183
|
* Called after a player builds tiles.
|
1182
1184
|
*
|
1183
|
-
* {@link https://lua-api.factorio.com/
|
1185
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_built_tile View documentation}
|
1184
1186
|
*/
|
1185
1187
|
interface OnPlayerBuiltTileEvent extends EventData {
|
1186
1188
|
readonly player_index: uint
|
@@ -1203,7 +1205,7 @@ interface OnPlayerBuiltTileEvent extends EventData {
|
|
1203
1205
|
/**
|
1204
1206
|
* Called when a player cancels crafting.
|
1205
1207
|
*
|
1206
|
-
* {@link https://lua-api.factorio.com/
|
1208
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_cancelled_crafting View documentation}
|
1207
1209
|
*/
|
1208
1210
|
interface OnPlayerCancelledCraftingEvent extends EventData {
|
1209
1211
|
/** The player that did the crafting. */
|
@@ -1223,7 +1225,7 @@ interface OnPlayerCancelledCraftingEvent extends EventData {
|
|
1223
1225
|
/**
|
1224
1226
|
* Called after a player changes forces.
|
1225
1227
|
*
|
1226
|
-
* {@link https://lua-api.factorio.com/
|
1228
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_changed_force View documentation}
|
1227
1229
|
*/
|
1228
1230
|
interface OnPlayerChangedForceEvent extends EventData {
|
1229
1231
|
/** The player who changed forces. */
|
@@ -1239,7 +1241,7 @@ interface OnPlayerChangedForceEvent extends EventData {
|
|
1239
1241
|
/**
|
1240
1242
|
* Called when the tile position a player is located at changes.
|
1241
1243
|
*
|
1242
|
-
* {@link https://lua-api.factorio.com/
|
1244
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_changed_position View documentation}
|
1243
1245
|
*/
|
1244
1246
|
interface OnPlayerChangedPositionEvent extends EventData {
|
1245
1247
|
/** The player. */
|
@@ -1255,7 +1257,7 @@ interface OnPlayerChangedPositionEvent extends EventData {
|
|
1255
1257
|
*
|
1256
1258
|
* **Note**: In the instance a player is moved off a surface due to it being deleted this is not called.
|
1257
1259
|
*
|
1258
|
-
* {@link https://lua-api.factorio.com/
|
1260
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_changed_surface View documentation}
|
1259
1261
|
*/
|
1260
1262
|
interface OnPlayerChangedSurfaceEvent extends EventData {
|
1261
1263
|
/** The player who changed surfaces. */
|
@@ -1271,7 +1273,7 @@ interface OnPlayerChangedSurfaceEvent extends EventData {
|
|
1271
1273
|
/**
|
1272
1274
|
* Called when cheat mode is disabled on a player.
|
1273
1275
|
*
|
1274
|
-
* {@link https://lua-api.factorio.com/
|
1276
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_cheat_mode_disabled View documentation}
|
1275
1277
|
*/
|
1276
1278
|
interface OnPlayerCheatModeDisabledEvent extends EventData {
|
1277
1279
|
/** The player. */
|
@@ -1285,7 +1287,7 @@ interface OnPlayerCheatModeDisabledEvent extends EventData {
|
|
1285
1287
|
/**
|
1286
1288
|
* Called when cheat mode is enabled on a player.
|
1287
1289
|
*
|
1288
|
-
* {@link https://lua-api.factorio.com/
|
1290
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_cheat_mode_enabled View documentation}
|
1289
1291
|
*/
|
1290
1292
|
interface OnPlayerCheatModeEnabledEvent extends EventData {
|
1291
1293
|
/** The player. */
|
@@ -1299,7 +1301,7 @@ interface OnPlayerCheatModeEnabledEvent extends EventData {
|
|
1299
1301
|
/**
|
1300
1302
|
* Called when a player clicks a gps tag
|
1301
1303
|
*
|
1302
|
-
* {@link https://lua-api.factorio.com/
|
1304
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_clicked_gps_tag View documentation}
|
1303
1305
|
*/
|
1304
1306
|
interface OnPlayerClickedGpsTagEvent extends EventData {
|
1305
1307
|
/** Index of the player */
|
@@ -1317,7 +1319,7 @@ interface OnPlayerClickedGpsTagEvent extends EventData {
|
|
1317
1319
|
/**
|
1318
1320
|
* Called when a player clicks the "confirm" button in the configure Blueprint GUI.
|
1319
1321
|
*
|
1320
|
-
* {@link https://lua-api.factorio.com/
|
1322
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_configured_blueprint View documentation}
|
1321
1323
|
*/
|
1322
1324
|
interface OnPlayerConfiguredBlueprintEvent extends EventData {
|
1323
1325
|
/** The player. */
|
@@ -1331,7 +1333,7 @@ interface OnPlayerConfiguredBlueprintEvent extends EventData {
|
|
1331
1333
|
/**
|
1332
1334
|
* Called when a player configures spidertron remote to be connected with a given spidertron
|
1333
1335
|
*
|
1334
|
-
* {@link https://lua-api.factorio.com/
|
1336
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_configured_spider_remote View documentation}
|
1335
1337
|
*/
|
1336
1338
|
interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
|
1337
1339
|
/** The player that configured the remote. */
|
@@ -1348,7 +1350,7 @@ interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
|
|
1348
1350
|
* Called when the player finishes crafting an item. This event fires just before the results are inserted into the
|
1349
1351
|
* player's inventory, not when the crafting is queued (see {@link OnPrePlayerCraftedItemEvent on_pre_player_crafted_item}).
|
1350
1352
|
*
|
1351
|
-
* {@link https://lua-api.factorio.com/
|
1353
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_crafted_item View documentation}
|
1352
1354
|
*/
|
1353
1355
|
interface OnPlayerCraftedItemEvent extends EventData {
|
1354
1356
|
/** The item that has been crafted. */
|
@@ -1366,7 +1368,7 @@ interface OnPlayerCraftedItemEvent extends EventData {
|
|
1366
1368
|
/**
|
1367
1369
|
* Called after the player was created.
|
1368
1370
|
*
|
1369
|
-
* {@link https://lua-api.factorio.com/
|
1371
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_created View documentation}
|
1370
1372
|
*/
|
1371
1373
|
interface OnPlayerCreatedEvent extends EventData {
|
1372
1374
|
readonly player_index: uint
|
@@ -1379,7 +1381,7 @@ interface OnPlayerCreatedEvent extends EventData {
|
|
1379
1381
|
/**
|
1380
1382
|
* Called after a players cursorstack changed in some way.
|
1381
1383
|
*
|
1382
|
-
* {@link https://lua-api.factorio.com/
|
1384
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_cursor_stack_changed View documentation}
|
1383
1385
|
*/
|
1384
1386
|
interface OnPlayerCursorStackChangedEvent extends EventData {
|
1385
1387
|
readonly player_index: uint
|
@@ -1392,7 +1394,7 @@ interface OnPlayerCursorStackChangedEvent extends EventData {
|
|
1392
1394
|
/**
|
1393
1395
|
* Called when a player selects an area with a deconstruction planner.
|
1394
1396
|
*
|
1395
|
-
* {@link https://lua-api.factorio.com/
|
1397
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_deconstructed_area View documentation}
|
1396
1398
|
*/
|
1397
1399
|
interface OnPlayerDeconstructedAreaEvent extends EventData {
|
1398
1400
|
/** The player doing the selection. */
|
@@ -1414,7 +1416,7 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
|
|
1414
1416
|
/**
|
1415
1417
|
* Called when a player is demoted.
|
1416
1418
|
*
|
1417
|
-
* {@link https://lua-api.factorio.com/
|
1419
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_demoted View documentation}
|
1418
1420
|
*/
|
1419
1421
|
interface OnPlayerDemotedEvent extends EventData {
|
1420
1422
|
/** The player. */
|
@@ -1428,7 +1430,7 @@ interface OnPlayerDemotedEvent extends EventData {
|
|
1428
1430
|
/**
|
1429
1431
|
* Called after a player dies.
|
1430
1432
|
*
|
1431
|
-
* {@link https://lua-api.factorio.com/
|
1433
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_died View documentation}
|
1432
1434
|
*/
|
1433
1435
|
interface OnPlayerDiedEvent extends EventData {
|
1434
1436
|
readonly player_index: uint
|
@@ -1442,7 +1444,7 @@ interface OnPlayerDiedEvent extends EventData {
|
|
1442
1444
|
/**
|
1443
1445
|
* Called when the display resolution changes for a given player.
|
1444
1446
|
*
|
1445
|
-
* {@link https://lua-api.factorio.com/
|
1447
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_display_resolution_changed View documentation}
|
1446
1448
|
*/
|
1447
1449
|
interface OnPlayerDisplayResolutionChangedEvent extends EventData {
|
1448
1450
|
/** The player */
|
@@ -1458,7 +1460,7 @@ interface OnPlayerDisplayResolutionChangedEvent extends EventData {
|
|
1458
1460
|
/**
|
1459
1461
|
* Called when the display scale changes for a given player.
|
1460
1462
|
*
|
1461
|
-
* {@link https://lua-api.factorio.com/
|
1463
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_display_scale_changed View documentation}
|
1462
1464
|
*/
|
1463
1465
|
interface OnPlayerDisplayScaleChangedEvent extends EventData {
|
1464
1466
|
/** The player */
|
@@ -1474,7 +1476,7 @@ interface OnPlayerDisplayScaleChangedEvent extends EventData {
|
|
1474
1476
|
/**
|
1475
1477
|
* Called when the player's driving state has changed, this means a player has either entered or left a vehicle.
|
1476
1478
|
*
|
1477
|
-
* {@link https://lua-api.factorio.com/
|
1479
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_driving_changed_state View documentation}
|
1478
1480
|
*/
|
1479
1481
|
interface OnPlayerDrivingChangedStateEvent extends EventData {
|
1480
1482
|
readonly player_index: uint
|
@@ -1489,7 +1491,7 @@ interface OnPlayerDrivingChangedStateEvent extends EventData {
|
|
1489
1491
|
/**
|
1490
1492
|
* Called when a player drops an item on the ground.
|
1491
1493
|
*
|
1492
|
-
* {@link https://lua-api.factorio.com/
|
1494
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_dropped_item View documentation}
|
1493
1495
|
*/
|
1494
1496
|
interface OnPlayerDroppedItemEvent extends EventData {
|
1495
1497
|
readonly player_index: uint
|
@@ -1504,7 +1506,7 @@ interface OnPlayerDroppedItemEvent extends EventData {
|
|
1504
1506
|
/**
|
1505
1507
|
* Called when a player fast-transfers something to or from an entity.
|
1506
1508
|
*
|
1507
|
-
* {@link https://lua-api.factorio.com/
|
1509
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_fast_transferred View documentation}
|
1508
1510
|
*/
|
1509
1511
|
interface OnPlayerFastTransferredEvent extends EventData {
|
1510
1512
|
/** The player transferred from or to. */
|
@@ -1522,7 +1524,7 @@ interface OnPlayerFastTransferredEvent extends EventData {
|
|
1522
1524
|
/**
|
1523
1525
|
* Called after player flushed fluid
|
1524
1526
|
*
|
1525
|
-
* {@link https://lua-api.factorio.com/
|
1527
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_flushed_fluid View documentation}
|
1526
1528
|
*/
|
1527
1529
|
interface OnPlayerFlushedFluidEvent extends EventData {
|
1528
1530
|
/** Index of the player */
|
@@ -1544,7 +1546,7 @@ interface OnPlayerFlushedFluidEvent extends EventData {
|
|
1544
1546
|
/**
|
1545
1547
|
* Called after a players gun inventory changed in some way.
|
1546
1548
|
*
|
1547
|
-
* {@link https://lua-api.factorio.com/
|
1549
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_gun_inventory_changed View documentation}
|
1548
1550
|
*/
|
1549
1551
|
interface OnPlayerGunInventoryChangedEvent extends EventData {
|
1550
1552
|
readonly player_index: uint
|
@@ -1557,7 +1559,7 @@ interface OnPlayerGunInventoryChangedEvent extends EventData {
|
|
1557
1559
|
/**
|
1558
1560
|
* Called after a player joins the game.
|
1559
1561
|
*
|
1560
|
-
* {@link https://lua-api.factorio.com/
|
1562
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_joined_game View documentation}
|
1561
1563
|
*/
|
1562
1564
|
interface OnPlayerJoinedGameEvent extends EventData {
|
1563
1565
|
readonly player_index: uint
|
@@ -1570,7 +1572,7 @@ interface OnPlayerJoinedGameEvent extends EventData {
|
|
1570
1572
|
/**
|
1571
1573
|
* Called when a player is kicked.
|
1572
1574
|
*
|
1573
|
-
* {@link https://lua-api.factorio.com/
|
1575
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_kicked View documentation}
|
1574
1576
|
*/
|
1575
1577
|
interface OnPlayerKickedEvent extends EventData {
|
1576
1578
|
/** The player kicked. */
|
@@ -1588,7 +1590,7 @@ interface OnPlayerKickedEvent extends EventData {
|
|
1588
1590
|
/**
|
1589
1591
|
* Called after a player leaves the game.
|
1590
1592
|
*
|
1591
|
-
* {@link https://lua-api.factorio.com/
|
1593
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_left_game View documentation}
|
1592
1594
|
*/
|
1593
1595
|
interface OnPlayerLeftGameEvent extends EventData {
|
1594
1596
|
readonly player_index: uint
|
@@ -1602,7 +1604,7 @@ interface OnPlayerLeftGameEvent extends EventData {
|
|
1602
1604
|
/**
|
1603
1605
|
* Called after a players main inventory changed in some way.
|
1604
1606
|
*
|
1605
|
-
* {@link https://lua-api.factorio.com/
|
1607
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_main_inventory_changed View documentation}
|
1606
1608
|
*/
|
1607
1609
|
interface OnPlayerMainInventoryChangedEvent extends EventData {
|
1608
1610
|
readonly player_index: uint
|
@@ -1620,7 +1622,7 @@ interface OnPlayerMainInventoryChangedEvent extends EventData {
|
|
1620
1622
|
* **Note**: The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding
|
1621
1623
|
* as more items are transferred into it.
|
1622
1624
|
*
|
1623
|
-
* {@link https://lua-api.factorio.com/
|
1625
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_mined_entity View documentation}
|
1624
1626
|
*/
|
1625
1627
|
interface OnPlayerMinedEntityEvent extends EventData {
|
1626
1628
|
/** The index of the player doing the mining. */
|
@@ -1638,7 +1640,7 @@ interface OnPlayerMinedEntityEvent extends EventData {
|
|
1638
1640
|
/**
|
1639
1641
|
* Called when the player mines something.
|
1640
1642
|
*
|
1641
|
-
* {@link https://lua-api.factorio.com/
|
1643
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_mined_item View documentation}
|
1642
1644
|
*/
|
1643
1645
|
interface OnPlayerMinedItemEvent extends EventData {
|
1644
1646
|
/** The item given to the player */
|
@@ -1653,7 +1655,7 @@ interface OnPlayerMinedItemEvent extends EventData {
|
|
1653
1655
|
/**
|
1654
1656
|
* Called after a player mines tiles.
|
1655
1657
|
*
|
1656
|
-
* {@link https://lua-api.factorio.com/
|
1658
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_mined_tile View documentation}
|
1657
1659
|
*/
|
1658
1660
|
interface OnPlayerMinedTileEvent extends EventData {
|
1659
1661
|
readonly player_index: uint
|
@@ -1670,7 +1672,7 @@ interface OnPlayerMinedTileEvent extends EventData {
|
|
1670
1672
|
/**
|
1671
1673
|
* Called when a player is muted.
|
1672
1674
|
*
|
1673
|
-
* {@link https://lua-api.factorio.com/
|
1675
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_muted View documentation}
|
1674
1676
|
*/
|
1675
1677
|
interface OnPlayerMutedEvent extends EventData {
|
1676
1678
|
/** The player. */
|
@@ -1684,7 +1686,7 @@ interface OnPlayerMutedEvent extends EventData {
|
|
1684
1686
|
/**
|
1685
1687
|
* Called when a player invokes the "smart pipette" over an entity.
|
1686
1688
|
*
|
1687
|
-
* {@link https://lua-api.factorio.com/
|
1689
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_pipette View documentation}
|
1688
1690
|
*/
|
1689
1691
|
interface OnPlayerPipetteEvent extends EventData {
|
1690
1692
|
/** The player */
|
@@ -1702,7 +1704,7 @@ interface OnPlayerPipetteEvent extends EventData {
|
|
1702
1704
|
/**
|
1703
1705
|
* Called after the player puts equipment in an equipment grid
|
1704
1706
|
*
|
1705
|
-
* {@link https://lua-api.factorio.com/
|
1707
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_placed_equipment View documentation}
|
1706
1708
|
*/
|
1707
1709
|
interface OnPlayerPlacedEquipmentEvent extends EventData {
|
1708
1710
|
readonly player_index: uint
|
@@ -1719,7 +1721,7 @@ interface OnPlayerPlacedEquipmentEvent extends EventData {
|
|
1719
1721
|
/**
|
1720
1722
|
* Called when a player is promoted.
|
1721
1723
|
*
|
1722
|
-
* {@link https://lua-api.factorio.com/
|
1724
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_promoted View documentation}
|
1723
1725
|
*/
|
1724
1726
|
interface OnPlayerPromotedEvent extends EventData {
|
1725
1727
|
/** The player. */
|
@@ -1734,7 +1736,7 @@ interface OnPlayerPromotedEvent extends EventData {
|
|
1734
1736
|
* Called when a player is removed (deleted) from the game. Not to be confused with the player logging of this is
|
1735
1737
|
* different in that the player is deleted as if he never existed in the save file.
|
1736
1738
|
*
|
1737
|
-
* {@link https://lua-api.factorio.com/
|
1739
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_removed View documentation}
|
1738
1740
|
*/
|
1739
1741
|
interface OnPlayerRemovedEvent extends EventData {
|
1740
1742
|
/** The player index that was removed */
|
@@ -1748,7 +1750,7 @@ interface OnPlayerRemovedEvent extends EventData {
|
|
1748
1750
|
/**
|
1749
1751
|
* Called after the player removes equipment from an equipment grid
|
1750
1752
|
*
|
1751
|
-
* {@link https://lua-api.factorio.com/
|
1753
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_removed_equipment View documentation}
|
1752
1754
|
*/
|
1753
1755
|
interface OnPlayerRemovedEquipmentEvent extends EventData {
|
1754
1756
|
readonly player_index: uint
|
@@ -1767,7 +1769,7 @@ interface OnPlayerRemovedEquipmentEvent extends EventData {
|
|
1767
1769
|
/**
|
1768
1770
|
* Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter}.
|
1769
1771
|
*
|
1770
|
-
* {@link https://lua-api.factorio.com/
|
1772
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_repaired_entity View documentation}
|
1771
1773
|
*/
|
1772
1774
|
interface OnPlayerRepairedEntityEvent extends EventData {
|
1773
1775
|
readonly player_index: uint
|
@@ -1781,7 +1783,7 @@ interface OnPlayerRepairedEntityEvent extends EventData {
|
|
1781
1783
|
/**
|
1782
1784
|
* Called after a player respawns.
|
1783
1785
|
*
|
1784
|
-
* {@link https://lua-api.factorio.com/
|
1786
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_respawned View documentation}
|
1785
1787
|
*/
|
1786
1788
|
interface OnPlayerRespawnedEvent extends EventData {
|
1787
1789
|
readonly player_index: uint
|
@@ -1797,7 +1799,7 @@ interface OnPlayerRespawnedEvent extends EventData {
|
|
1797
1799
|
* Called when the player rotates an entity. This event is only fired when the entity actually changes its orientation
|
1798
1800
|
* -- pressing the rotate key on an entity that can't be rotated won't fire this event.
|
1799
1801
|
*
|
1800
|
-
* {@link https://lua-api.factorio.com/
|
1802
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_rotated_entity View documentation}
|
1801
1803
|
*/
|
1802
1804
|
interface OnPlayerRotatedEntityEvent extends EventData {
|
1803
1805
|
/** The rotated entity. */
|
@@ -1814,7 +1816,7 @@ interface OnPlayerRotatedEntityEvent extends EventData {
|
|
1814
1816
|
/**
|
1815
1817
|
* Called after a player selects an area with a selection-tool item.
|
1816
1818
|
*
|
1817
|
-
* {@link https://lua-api.factorio.com/
|
1819
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_selected_area View documentation}
|
1818
1820
|
*/
|
1819
1821
|
interface OnPlayerSelectedAreaEvent extends EventData {
|
1820
1822
|
/** The player doing the selection. */
|
@@ -1838,7 +1840,7 @@ interface OnPlayerSelectedAreaEvent extends EventData {
|
|
1838
1840
|
/**
|
1839
1841
|
* Called when a player sets a quickbar slot to anything (new value, or set to empty).
|
1840
1842
|
*
|
1841
|
-
* {@link https://lua-api.factorio.com/
|
1843
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_set_quick_bar_slot View documentation}
|
1842
1844
|
*/
|
1843
1845
|
interface OnPlayerSetQuickBarSlotEvent extends EventData {
|
1844
1846
|
readonly player_index: uint
|
@@ -1851,7 +1853,7 @@ interface OnPlayerSetQuickBarSlotEvent extends EventData {
|
|
1851
1853
|
/**
|
1852
1854
|
* Called when a player selects an area with a blueprint.
|
1853
1855
|
*
|
1854
|
-
* {@link https://lua-api.factorio.com/
|
1856
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_setup_blueprint View documentation}
|
1855
1857
|
*/
|
1856
1858
|
interface OnPlayerSetupBlueprintEvent extends EventData {
|
1857
1859
|
/** The player doing the selection. */
|
@@ -1875,7 +1877,7 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
|
|
1875
1877
|
/**
|
1876
1878
|
* Called when a player toggles alt mode, also known as "show entity info".
|
1877
1879
|
*
|
1878
|
-
* {@link https://lua-api.factorio.com/
|
1880
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_toggled_alt_mode View documentation}
|
1879
1881
|
*/
|
1880
1882
|
interface OnPlayerToggledAltModeEvent extends EventData {
|
1881
1883
|
readonly player_index: uint
|
@@ -1893,7 +1895,7 @@ interface OnPlayerToggledAltModeEvent extends EventData {
|
|
1893
1895
|
/**
|
1894
1896
|
* Called when a player toggles the map editor on or off.
|
1895
1897
|
*
|
1896
|
-
* {@link https://lua-api.factorio.com/
|
1898
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_toggled_map_editor View documentation}
|
1897
1899
|
*/
|
1898
1900
|
interface OnPlayerToggledMapEditorEvent extends EventData {
|
1899
1901
|
readonly player_index: uint
|
@@ -1906,7 +1908,7 @@ interface OnPlayerToggledMapEditorEvent extends EventData {
|
|
1906
1908
|
/**
|
1907
1909
|
* Called after a players trash inventory changed in some way.
|
1908
1910
|
*
|
1909
|
-
* {@link https://lua-api.factorio.com/
|
1911
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_trash_inventory_changed View documentation}
|
1910
1912
|
*/
|
1911
1913
|
interface OnPlayerTrashInventoryChangedEvent extends EventData {
|
1912
1914
|
readonly player_index: uint
|
@@ -1919,7 +1921,7 @@ interface OnPlayerTrashInventoryChangedEvent extends EventData {
|
|
1919
1921
|
/**
|
1920
1922
|
* Called when a player is un-banned.
|
1921
1923
|
*
|
1922
|
-
* {@link https://lua-api.factorio.com/
|
1924
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_unbanned View documentation}
|
1923
1925
|
*/
|
1924
1926
|
interface OnPlayerUnbannedEvent extends EventData {
|
1925
1927
|
/** The player un-banned. */
|
@@ -1939,7 +1941,7 @@ interface OnPlayerUnbannedEvent extends EventData {
|
|
1939
1941
|
/**
|
1940
1942
|
* Called when a player is unmuted.
|
1941
1943
|
*
|
1942
|
-
* {@link https://lua-api.factorio.com/
|
1944
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_unmuted View documentation}
|
1943
1945
|
*/
|
1944
1946
|
interface OnPlayerUnmutedEvent extends EventData {
|
1945
1947
|
/** The player. */
|
@@ -1953,7 +1955,7 @@ interface OnPlayerUnmutedEvent extends EventData {
|
|
1953
1955
|
/**
|
1954
1956
|
* Called when a player uses a capsule that results in some game action.
|
1955
1957
|
*
|
1956
|
-
* {@link https://lua-api.factorio.com/
|
1958
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_used_capsule View documentation}
|
1957
1959
|
*/
|
1958
1960
|
interface OnPlayerUsedCapsuleEvent extends EventData {
|
1959
1961
|
/** The player. */
|
@@ -1971,7 +1973,7 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
|
|
1971
1973
|
/**
|
1972
1974
|
* Called when a player uses spidertron remote to send a spidertron to a given position
|
1973
1975
|
*
|
1974
|
-
* {@link https://lua-api.factorio.com/
|
1976
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_player_used_spider_remote View documentation}
|
1975
1977
|
*/
|
1976
1978
|
interface OnPlayerUsedSpiderRemoteEvent extends EventData {
|
1977
1979
|
/** The player that used the remote. */
|
@@ -1991,7 +1993,7 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
|
|
1991
1993
|
/**
|
1992
1994
|
* Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter}.
|
1993
1995
|
*
|
1994
|
-
* {@link https://lua-api.factorio.com/
|
1996
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_post_entity_died View documentation}
|
1995
1997
|
*/
|
1996
1998
|
interface OnPostEntityDiedEvent extends EventData {
|
1997
1999
|
/** The ghost created by the entity dying if any. */
|
@@ -2019,7 +2021,7 @@ interface OnPostEntityDiedEvent extends EventData {
|
|
2019
2021
|
/**
|
2020
2022
|
* Called when players uses an item to build something. Called before {@link OnBuiltEntityEvent on_built_entity}.
|
2021
2023
|
*
|
2022
|
-
* {@link https://lua-api.factorio.com/
|
2024
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_build View documentation}
|
2023
2025
|
*/
|
2024
2026
|
interface OnPreBuildEvent extends EventData {
|
2025
2027
|
/** The player who did the placing. */
|
@@ -2045,7 +2047,7 @@ interface OnPreBuildEvent extends EventData {
|
|
2045
2047
|
/**
|
2046
2048
|
* Called before one or more chunks are deleted using {@link LuaSurface.delete_chunk LuaSurface::delete_chunk}.
|
2047
2049
|
*
|
2048
|
-
* {@link https://lua-api.factorio.com/
|
2050
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_chunk_deleted View documentation}
|
2049
2051
|
*/
|
2050
2052
|
interface OnPreChunkDeletedEvent extends EventData {
|
2051
2053
|
readonly surface_index: uint
|
@@ -2060,7 +2062,7 @@ interface OnPreChunkDeletedEvent extends EventData {
|
|
2060
2062
|
/**
|
2061
2063
|
* Called before entity copy-paste is done.
|
2062
2064
|
*
|
2063
|
-
* {@link https://lua-api.factorio.com/
|
2065
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_entity_settings_pasted View documentation}
|
2064
2066
|
*/
|
2065
2067
|
interface OnPreEntitySettingsPastedEvent extends EventData {
|
2066
2068
|
readonly player_index: uint
|
@@ -2078,7 +2080,7 @@ interface OnPreEntitySettingsPastedEvent extends EventData {
|
|
2078
2080
|
* Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using
|
2079
2081
|
* {@link LuaPreGhostDeconstructedEventFilter}.
|
2080
2082
|
*
|
2081
|
-
* {@link https://lua-api.factorio.com/
|
2083
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_ghost_deconstructed View documentation}
|
2082
2084
|
*/
|
2083
2085
|
interface OnPreGhostDeconstructedEvent extends EventData {
|
2084
2086
|
/** The player that did the deconstruction if any. */
|
@@ -2093,7 +2095,7 @@ interface OnPreGhostDeconstructedEvent extends EventData {
|
|
2093
2095
|
/**
|
2094
2096
|
* Called directly before a permission group is deleted.
|
2095
2097
|
*
|
2096
|
-
* {@link https://lua-api.factorio.com/
|
2098
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_permission_group_deleted View documentation}
|
2097
2099
|
*/
|
2098
2100
|
interface OnPrePermissionGroupDeletedEvent extends EventData {
|
2099
2101
|
/** The player doing the deletion. */
|
@@ -2109,7 +2111,7 @@ interface OnPrePermissionGroupDeletedEvent extends EventData {
|
|
2109
2111
|
/**
|
2110
2112
|
* Called directly before a permission string is imported.
|
2111
2113
|
*
|
2112
|
-
* {@link https://lua-api.factorio.com/
|
2114
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_permission_string_imported View documentation}
|
2113
2115
|
*/
|
2114
2116
|
interface OnPrePermissionStringImportedEvent extends EventData {
|
2115
2117
|
/** The player importing the string. */
|
@@ -2123,7 +2125,7 @@ interface OnPrePermissionStringImportedEvent extends EventData {
|
|
2123
2125
|
/**
|
2124
2126
|
* Called when a player queues something to be crafted.
|
2125
2127
|
*
|
2126
|
-
* {@link https://lua-api.factorio.com/
|
2128
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_player_crafted_item View documentation}
|
2127
2129
|
*/
|
2128
2130
|
interface OnPrePlayerCraftedItemEvent extends EventData {
|
2129
2131
|
/** The player doing the crafting. */
|
@@ -2143,7 +2145,7 @@ interface OnPrePlayerCraftedItemEvent extends EventData {
|
|
2143
2145
|
/**
|
2144
2146
|
* Called before a players dies.
|
2145
2147
|
*
|
2146
|
-
* {@link https://lua-api.factorio.com/
|
2148
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_player_died View documentation}
|
2147
2149
|
*/
|
2148
2150
|
interface OnPrePlayerDiedEvent extends EventData {
|
2149
2151
|
readonly player_index: uint
|
@@ -2157,7 +2159,7 @@ interface OnPrePlayerDiedEvent extends EventData {
|
|
2157
2159
|
/**
|
2158
2160
|
* Called before a player leaves the game.
|
2159
2161
|
*
|
2160
|
-
* {@link https://lua-api.factorio.com/
|
2162
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_player_left_game View documentation}
|
2161
2163
|
*/
|
2162
2164
|
interface OnPrePlayerLeftGameEvent extends EventData {
|
2163
2165
|
readonly player_index: uint
|
@@ -2172,7 +2174,7 @@ interface OnPrePlayerLeftGameEvent extends EventData {
|
|
2172
2174
|
* Called when the player finishes mining an entity, before the entity is removed from map. Can be filtered using
|
2173
2175
|
* {@link LuaPrePlayerMinedEntityEventFilter}.
|
2174
2176
|
*
|
2175
|
-
* {@link https://lua-api.factorio.com/
|
2177
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_player_mined_item View documentation}
|
2176
2178
|
*/
|
2177
2179
|
interface OnPrePlayerMinedItemEvent extends EventData {
|
2178
2180
|
/** The entity being mined */
|
@@ -2188,7 +2190,7 @@ interface OnPrePlayerMinedItemEvent extends EventData {
|
|
2188
2190
|
* Called before a player is removed (deleted) from the game. Not to be confused with the player logging of this is
|
2189
2191
|
* different in that the player is deleted as if he never existed in the save file.
|
2190
2192
|
*
|
2191
|
-
* {@link https://lua-api.factorio.com/
|
2193
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_player_removed View documentation}
|
2192
2194
|
*/
|
2193
2195
|
interface OnPrePlayerRemovedEvent extends EventData {
|
2194
2196
|
/** The player index that will be removed */
|
@@ -2202,7 +2204,7 @@ interface OnPrePlayerRemovedEvent extends EventData {
|
|
2202
2204
|
/**
|
2203
2205
|
* Called before a player toggles the map editor on or off.
|
2204
2206
|
*
|
2205
|
-
* {@link https://lua-api.factorio.com/
|
2207
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_player_toggled_map_editor View documentation}
|
2206
2208
|
*/
|
2207
2209
|
interface OnPrePlayerToggledMapEditorEvent extends EventData {
|
2208
2210
|
readonly player_index: uint
|
@@ -2215,7 +2217,7 @@ interface OnPrePlayerToggledMapEditorEvent extends EventData {
|
|
2215
2217
|
/**
|
2216
2218
|
* Called directly before a robot explodes cliffs.
|
2217
2219
|
*
|
2218
|
-
* {@link https://lua-api.factorio.com/
|
2220
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_robot_exploded_cliff View documentation}
|
2219
2221
|
*/
|
2220
2222
|
interface OnPreRobotExplodedCliffEvent extends EventData {
|
2221
2223
|
readonly robot: LuaEntity
|
@@ -2231,7 +2233,7 @@ interface OnPreRobotExplodedCliffEvent extends EventData {
|
|
2231
2233
|
/**
|
2232
2234
|
* Called just before a script inventory is resized.
|
2233
2235
|
*
|
2234
|
-
* {@link https://lua-api.factorio.com/
|
2236
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_script_inventory_resized View documentation}
|
2235
2237
|
*/
|
2236
2238
|
interface OnPreScriptInventoryResizedEvent extends EventData {
|
2237
2239
|
/** If done by console command; the player who ran the command. */
|
@@ -2252,7 +2254,7 @@ interface OnPreScriptInventoryResizedEvent extends EventData {
|
|
2252
2254
|
/**
|
2253
2255
|
* Called just before a surface is cleared (all entities removed and all chunks deleted).
|
2254
2256
|
*
|
2255
|
-
* {@link https://lua-api.factorio.com/
|
2257
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_surface_cleared View documentation}
|
2256
2258
|
*/
|
2257
2259
|
interface OnPreSurfaceClearedEvent extends EventData {
|
2258
2260
|
readonly surface_index: uint
|
@@ -2265,7 +2267,7 @@ interface OnPreSurfaceClearedEvent extends EventData {
|
|
2265
2267
|
/**
|
2266
2268
|
* Called just before a surface is deleted.
|
2267
2269
|
*
|
2268
|
-
* {@link https://lua-api.factorio.com/
|
2270
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_pre_surface_deleted View documentation}
|
2269
2271
|
*/
|
2270
2272
|
interface OnPreSurfaceDeletedEvent extends EventData {
|
2271
2273
|
readonly surface_index: uint
|
@@ -2278,7 +2280,7 @@ interface OnPreSurfaceDeletedEvent extends EventData {
|
|
2278
2280
|
/**
|
2279
2281
|
* Called when a research finishes.
|
2280
2282
|
*
|
2281
|
-
* {@link https://lua-api.factorio.com/
|
2283
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_research_finished View documentation}
|
2282
2284
|
*/
|
2283
2285
|
interface OnResearchFinishedEvent extends EventData {
|
2284
2286
|
/** The researched technology */
|
@@ -2294,7 +2296,7 @@ interface OnResearchFinishedEvent extends EventData {
|
|
2294
2296
|
/**
|
2295
2297
|
* Called when a research is reversed (unresearched).
|
2296
2298
|
*
|
2297
|
-
* {@link https://lua-api.factorio.com/
|
2299
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_research_reversed View documentation}
|
2298
2300
|
*/
|
2299
2301
|
interface OnResearchReversedEvent extends EventData {
|
2300
2302
|
/** The technology un-researched */
|
@@ -2310,7 +2312,7 @@ interface OnResearchReversedEvent extends EventData {
|
|
2310
2312
|
/**
|
2311
2313
|
* Called when a technology research starts.
|
2312
2314
|
*
|
2313
|
-
* {@link https://lua-api.factorio.com/
|
2315
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_research_started View documentation}
|
2314
2316
|
*/
|
2315
2317
|
interface OnResearchStartedEvent extends EventData {
|
2316
2318
|
/** The technology being researched */
|
@@ -2325,7 +2327,7 @@ interface OnResearchStartedEvent extends EventData {
|
|
2325
2327
|
/**
|
2326
2328
|
* Called when a resource entity reaches 0 or its minimum yield for infinite resources.
|
2327
2329
|
*
|
2328
|
-
* {@link https://lua-api.factorio.com/
|
2330
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_resource_depleted View documentation}
|
2329
2331
|
*/
|
2330
2332
|
interface OnResourceDepletedEvent extends EventData {
|
2331
2333
|
readonly entity: LuaEntity
|
@@ -2338,7 +2340,7 @@ interface OnResourceDepletedEvent extends EventData {
|
|
2338
2340
|
/**
|
2339
2341
|
* Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter}.
|
2340
2342
|
*
|
2341
|
-
* {@link https://lua-api.factorio.com/
|
2343
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_robot_built_entity View documentation}
|
2342
2344
|
*/
|
2343
2345
|
interface OnRobotBuiltEntityEvent extends EventData {
|
2344
2346
|
/** The robot that did the building. */
|
@@ -2358,7 +2360,7 @@ interface OnRobotBuiltEntityEvent extends EventData {
|
|
2358
2360
|
/**
|
2359
2361
|
* Called after a robot builds tiles.
|
2360
2362
|
*
|
2361
|
-
* {@link https://lua-api.factorio.com/
|
2363
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_robot_built_tile View documentation}
|
2362
2364
|
*/
|
2363
2365
|
interface OnRobotBuiltTileEvent extends EventData {
|
2364
2366
|
/** The robot. */
|
@@ -2382,7 +2384,7 @@ interface OnRobotBuiltTileEvent extends EventData {
|
|
2382
2384
|
/**
|
2383
2385
|
* Called directly after a robot explodes cliffs.
|
2384
2386
|
*
|
2385
|
-
* {@link https://lua-api.factorio.com/
|
2387
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_robot_exploded_cliff View documentation}
|
2386
2388
|
*/
|
2387
2389
|
interface OnRobotExplodedCliffEvent extends EventData {
|
2388
2390
|
readonly robot: LuaEntity
|
@@ -2397,7 +2399,7 @@ interface OnRobotExplodedCliffEvent extends EventData {
|
|
2397
2399
|
/**
|
2398
2400
|
* Called when a robot mines an entity.
|
2399
2401
|
*
|
2400
|
-
* {@link https://lua-api.factorio.com/
|
2402
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_robot_mined View documentation}
|
2401
2403
|
*/
|
2402
2404
|
interface OnRobotMinedEvent extends EventData {
|
2403
2405
|
/** The robot that did the mining. */
|
@@ -2418,7 +2420,7 @@ interface OnRobotMinedEvent extends EventData {
|
|
2418
2420
|
* **Note**: The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding
|
2419
2421
|
* as more items are transferred into it.
|
2420
2422
|
*
|
2421
|
-
* {@link https://lua-api.factorio.com/
|
2423
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_robot_mined_entity View documentation}
|
2422
2424
|
*/
|
2423
2425
|
interface OnRobotMinedEntityEvent extends EventData {
|
2424
2426
|
/** The robot doing the mining. */
|
@@ -2436,7 +2438,7 @@ interface OnRobotMinedEntityEvent extends EventData {
|
|
2436
2438
|
/**
|
2437
2439
|
* Called after a robot mines tiles.
|
2438
2440
|
*
|
2439
|
-
* {@link https://lua-api.factorio.com/
|
2441
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_robot_mined_tile View documentation}
|
2440
2442
|
*/
|
2441
2443
|
interface OnRobotMinedTileEvent extends EventData {
|
2442
2444
|
/** The robot. */
|
@@ -2454,7 +2456,7 @@ interface OnRobotMinedTileEvent extends EventData {
|
|
2454
2456
|
/**
|
2455
2457
|
* Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter}.
|
2456
2458
|
*
|
2457
|
-
* {@link https://lua-api.factorio.com/
|
2459
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_robot_pre_mined View documentation}
|
2458
2460
|
*/
|
2459
2461
|
interface OnRobotPreMinedEvent extends EventData {
|
2460
2462
|
/** The robot that's about to do the mining. */
|
@@ -2470,7 +2472,7 @@ interface OnRobotPreMinedEvent extends EventData {
|
|
2470
2472
|
/**
|
2471
2473
|
* Called when a rocket silo is ordered to be launched.
|
2472
2474
|
*
|
2473
|
-
* {@link https://lua-api.factorio.com/
|
2475
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_rocket_launch_ordered View documentation}
|
2474
2476
|
*/
|
2475
2477
|
interface OnRocketLaunchOrderedEvent extends EventData {
|
2476
2478
|
readonly rocket: LuaEntity
|
@@ -2486,7 +2488,7 @@ interface OnRocketLaunchOrderedEvent extends EventData {
|
|
2486
2488
|
/**
|
2487
2489
|
* Called when the rocket is launched.
|
2488
2490
|
*
|
2489
|
-
* {@link https://lua-api.factorio.com/
|
2491
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_rocket_launched View documentation}
|
2490
2492
|
*/
|
2491
2493
|
interface OnRocketLaunchedEvent extends EventData {
|
2492
2494
|
readonly rocket: LuaEntity
|
@@ -2502,7 +2504,7 @@ interface OnRocketLaunchedEvent extends EventData {
|
|
2502
2504
|
/**
|
2503
2505
|
* Called when a runtime mod setting is changed by a player.
|
2504
2506
|
*
|
2505
|
-
* {@link https://lua-api.factorio.com/
|
2507
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_runtime_mod_setting_changed View documentation}
|
2506
2508
|
*/
|
2507
2509
|
interface OnRuntimeModSettingChangedEvent extends EventData {
|
2508
2510
|
/**
|
@@ -2524,7 +2526,7 @@ interface OnRuntimeModSettingChangedEvent extends EventData {
|
|
2524
2526
|
/**
|
2525
2527
|
* Called just after a script inventory is resized.
|
2526
2528
|
*
|
2527
|
-
* {@link https://lua-api.factorio.com/
|
2529
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_script_inventory_resized View documentation}
|
2528
2530
|
*/
|
2529
2531
|
interface OnScriptInventoryResizedEvent extends EventData {
|
2530
2532
|
/** If done by console command; the player who ran the command. */
|
@@ -2547,7 +2549,7 @@ interface OnScriptInventoryResizedEvent extends EventData {
|
|
2547
2549
|
/**
|
2548
2550
|
* Called when a {@link LuaSurface.request_path LuaSurface::request_path} call completes.
|
2549
2551
|
*
|
2550
|
-
* {@link https://lua-api.factorio.com/
|
2552
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_script_path_request_finished View documentation}
|
2551
2553
|
*/
|
2552
2554
|
interface OnScriptPathRequestFinishedEvent extends EventData {
|
2553
2555
|
/** The actual path that the pathfinder has determined. `nil` if pathfinding failed. */
|
@@ -2565,7 +2567,7 @@ interface OnScriptPathRequestFinishedEvent extends EventData {
|
|
2565
2567
|
/**
|
2566
2568
|
* Called when a script trigger effect is triggered.
|
2567
2569
|
*
|
2568
|
-
* {@link https://lua-api.factorio.com/
|
2570
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_script_trigger_effect View documentation}
|
2569
2571
|
*/
|
2570
2572
|
interface OnScriptTriggerEffectEvent extends EventData {
|
2571
2573
|
/** The effect_id specified in the trigger effect. */
|
@@ -2586,7 +2588,7 @@ interface OnScriptTriggerEffectEvent extends EventData {
|
|
2586
2588
|
* Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using
|
2587
2589
|
* {@link LuaSectorScannedEventFilter}.
|
2588
2590
|
*
|
2589
|
-
* {@link https://lua-api.factorio.com/
|
2591
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_sector_scanned View documentation}
|
2590
2592
|
*/
|
2591
2593
|
interface OnSectorScannedEvent extends EventData {
|
2592
2594
|
/** The radar that did the scanning. */
|
@@ -2604,7 +2606,7 @@ interface OnSectorScannedEvent extends EventData {
|
|
2604
2606
|
/**
|
2605
2607
|
* Called after the selected entity changes for a given player.
|
2606
2608
|
*
|
2607
|
-
* {@link https://lua-api.factorio.com/
|
2609
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_selected_entity_changed View documentation}
|
2608
2610
|
*/
|
2609
2611
|
interface OnSelectedEntityChangedEvent extends EventData {
|
2610
2612
|
/** The player whose selected entity changed. */
|
@@ -2620,7 +2622,7 @@ interface OnSelectedEntityChangedEvent extends EventData {
|
|
2620
2622
|
/**
|
2621
2623
|
* Called when a spider finishes moving to its autopilot position.
|
2622
2624
|
*
|
2623
|
-
* {@link https://lua-api.factorio.com/
|
2625
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_spider_command_completed View documentation}
|
2624
2626
|
*/
|
2625
2627
|
interface OnSpiderCommandCompletedEvent extends EventData {
|
2626
2628
|
/** Spider vehicle which was requested to move. */
|
@@ -2635,7 +2637,7 @@ interface OnSpiderCommandCompletedEvent extends EventData {
|
|
2635
2637
|
* Called when a translation request generated through
|
2636
2638
|
* {@link LuaPlayer.request_translation LuaPlayer::request_translation} is translated.
|
2637
2639
|
*
|
2638
|
-
* {@link https://lua-api.factorio.com/
|
2640
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_string_translated View documentation}
|
2639
2641
|
*/
|
2640
2642
|
interface OnStringTranslatedEvent extends EventData {
|
2641
2643
|
/** The player whose locale was used for the translation. */
|
@@ -2655,7 +2657,7 @@ interface OnStringTranslatedEvent extends EventData {
|
|
2655
2657
|
/**
|
2656
2658
|
* Called just after a surface is cleared (all entities removed and all chunks deleted).
|
2657
2659
|
*
|
2658
|
-
* {@link https://lua-api.factorio.com/
|
2660
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_surface_cleared View documentation}
|
2659
2661
|
*/
|
2660
2662
|
interface OnSurfaceClearedEvent extends EventData {
|
2661
2663
|
readonly surface_index: uint
|
@@ -2670,7 +2672,7 @@ interface OnSurfaceClearedEvent extends EventData {
|
|
2670
2672
|
*
|
2671
2673
|
* **Note**: This is not called when the default surface is created as it will always exist.
|
2672
2674
|
*
|
2673
|
-
* {@link https://lua-api.factorio.com/
|
2675
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_surface_created View documentation}
|
2674
2676
|
*/
|
2675
2677
|
interface OnSurfaceCreatedEvent extends EventData {
|
2676
2678
|
readonly surface_index: uint
|
@@ -2683,7 +2685,7 @@ interface OnSurfaceCreatedEvent extends EventData {
|
|
2683
2685
|
/**
|
2684
2686
|
* Called after a surface is deleted.
|
2685
2687
|
*
|
2686
|
-
* {@link https://lua-api.factorio.com/
|
2688
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_surface_deleted View documentation}
|
2687
2689
|
*/
|
2688
2690
|
interface OnSurfaceDeletedEvent extends EventData {
|
2689
2691
|
readonly surface_index: uint
|
@@ -2696,7 +2698,7 @@ interface OnSurfaceDeletedEvent extends EventData {
|
|
2696
2698
|
/**
|
2697
2699
|
* Called after a surface is imported.
|
2698
2700
|
*
|
2699
|
-
* {@link https://lua-api.factorio.com/
|
2701
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_surface_imported View documentation}
|
2700
2702
|
*/
|
2701
2703
|
interface OnSurfaceImportedEvent extends EventData {
|
2702
2704
|
readonly surface_index: uint
|
@@ -2711,7 +2713,7 @@ interface OnSurfaceImportedEvent extends EventData {
|
|
2711
2713
|
/**
|
2712
2714
|
* Called when a surface is renamed.
|
2713
2715
|
*
|
2714
|
-
* {@link https://lua-api.factorio.com/
|
2716
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_surface_renamed View documentation}
|
2715
2717
|
*/
|
2716
2718
|
interface OnSurfaceRenamedEvent extends EventData {
|
2717
2719
|
readonly surface_index: uint
|
@@ -2726,7 +2728,7 @@ interface OnSurfaceRenamedEvent extends EventData {
|
|
2726
2728
|
/**
|
2727
2729
|
* Called when {@link LuaForce.reset_technology_effects LuaForce::reset_technology_effects} is finished.
|
2728
2730
|
*
|
2729
|
-
* {@link https://lua-api.factorio.com/
|
2731
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_technology_effects_reset View documentation}
|
2730
2732
|
*/
|
2731
2733
|
interface OnTechnologyEffectsResetEvent extends EventData {
|
2732
2734
|
readonly force: LuaForce
|
@@ -2739,7 +2741,7 @@ interface OnTechnologyEffectsResetEvent extends EventData {
|
|
2739
2741
|
/**
|
2740
2742
|
* It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
|
2741
2743
|
*
|
2742
|
-
* {@link https://lua-api.factorio.com/
|
2744
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_tick View documentation}
|
2743
2745
|
*/
|
2744
2746
|
interface OnTickEvent extends EventData {
|
2745
2747
|
/** Identifier of the event */
|
@@ -2751,7 +2753,7 @@ interface OnTickEvent extends EventData {
|
|
2751
2753
|
/**
|
2752
2754
|
* Called when a train changes state (started to stopped and vice versa)
|
2753
2755
|
*
|
2754
|
-
* {@link https://lua-api.factorio.com/
|
2756
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_train_changed_state View documentation}
|
2755
2757
|
*/
|
2756
2758
|
interface OnTrainChangedStateEvent extends EventData {
|
2757
2759
|
readonly train: LuaTrain
|
@@ -2765,7 +2767,7 @@ interface OnTrainChangedStateEvent extends EventData {
|
|
2765
2767
|
/**
|
2766
2768
|
* Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
|
2767
2769
|
*
|
2768
|
-
* {@link https://lua-api.factorio.com/
|
2770
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_train_created View documentation}
|
2769
2771
|
*/
|
2770
2772
|
interface OnTrainCreatedEvent extends EventData {
|
2771
2773
|
readonly train: LuaTrain
|
@@ -2782,7 +2784,7 @@ interface OnTrainCreatedEvent extends EventData {
|
|
2782
2784
|
/**
|
2783
2785
|
* Called when a trains schedule is changed either by the player or through script.
|
2784
2786
|
*
|
2785
|
-
* {@link https://lua-api.factorio.com/
|
2787
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_train_schedule_changed View documentation}
|
2786
2788
|
*/
|
2787
2789
|
interface OnTrainScheduleChangedEvent extends EventData {
|
2788
2790
|
readonly train: LuaTrain
|
@@ -2798,7 +2800,7 @@ interface OnTrainScheduleChangedEvent extends EventData {
|
|
2798
2800
|
* Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined
|
2799
2801
|
* `trigger_created_entity="true"`.
|
2800
2802
|
*
|
2801
|
-
* {@link https://lua-api.factorio.com/
|
2803
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_trigger_created_entity View documentation}
|
2802
2804
|
*/
|
2803
2805
|
interface OnTriggerCreatedEntityEvent extends EventData {
|
2804
2806
|
readonly entity: LuaEntity
|
@@ -2813,7 +2815,7 @@ interface OnTriggerCreatedEntityEvent extends EventData {
|
|
2813
2815
|
* Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger
|
2814
2816
|
* prototype defined `trigger_fired_artillery="true"`.
|
2815
2817
|
*
|
2816
|
-
* {@link https://lua-api.factorio.com/
|
2818
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_trigger_fired_artillery View documentation}
|
2817
2819
|
*/
|
2818
2820
|
interface OnTriggerFiredArtilleryEvent extends EventData {
|
2819
2821
|
readonly entity: LuaEntity
|
@@ -2827,7 +2829,7 @@ interface OnTriggerFiredArtilleryEvent extends EventData {
|
|
2827
2829
|
/**
|
2828
2830
|
* Called when a unit is added to a unit group.
|
2829
2831
|
*
|
2830
|
-
* {@link https://lua-api.factorio.com/
|
2832
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_unit_added_to_group View documentation}
|
2831
2833
|
*/
|
2832
2834
|
interface OnUnitAddedToGroupEvent extends EventData {
|
2833
2835
|
readonly unit: LuaEntity
|
@@ -2841,7 +2843,7 @@ interface OnUnitAddedToGroupEvent extends EventData {
|
|
2841
2843
|
/**
|
2842
2844
|
* Called when a new unit group is created, before any members are added to it.
|
2843
2845
|
*
|
2844
|
-
* {@link https://lua-api.factorio.com/
|
2846
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_unit_group_created View documentation}
|
2845
2847
|
*/
|
2846
2848
|
interface OnUnitGroupCreatedEvent extends EventData {
|
2847
2849
|
readonly group: LuaUnitGroup
|
@@ -2854,7 +2856,7 @@ interface OnUnitGroupCreatedEvent extends EventData {
|
|
2854
2856
|
/**
|
2855
2857
|
* Called when a unit group finishes gathering and starts executing its command.
|
2856
2858
|
*
|
2857
|
-
* {@link https://lua-api.factorio.com/
|
2859
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_unit_group_finished_gathering View documentation}
|
2858
2860
|
*/
|
2859
2861
|
interface OnUnitGroupFinishedGatheringEvent extends EventData {
|
2860
2862
|
readonly group: LuaUnitGroup
|
@@ -2867,7 +2869,7 @@ interface OnUnitGroupFinishedGatheringEvent extends EventData {
|
|
2867
2869
|
/**
|
2868
2870
|
* Called when a unit is removed from a unit group.
|
2869
2871
|
*
|
2870
|
-
* {@link https://lua-api.factorio.com/
|
2872
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_unit_removed_from_group View documentation}
|
2871
2873
|
*/
|
2872
2874
|
interface OnUnitRemovedFromGroupEvent extends EventData {
|
2873
2875
|
readonly unit: LuaEntity
|
@@ -2881,7 +2883,7 @@ interface OnUnitRemovedFromGroupEvent extends EventData {
|
|
2881
2883
|
/**
|
2882
2884
|
* Called when a worker (construction or logistic) robot expires through a lack of energy.
|
2883
2885
|
*
|
2884
|
-
* {@link https://lua-api.factorio.com/
|
2886
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#on_worker_robot_expired View documentation}
|
2885
2887
|
*/
|
2886
2888
|
interface OnWorkerRobotExpiredEvent extends EventData {
|
2887
2889
|
readonly robot: LuaEntity
|
@@ -2897,7 +2899,7 @@ interface OnWorkerRobotExpiredEvent extends EventData {
|
|
2897
2899
|
* {@link LuaBootstrap.raise_script_built LuaBootstrap::raise_script_built}, or when `raise_built` is passed to
|
2898
2900
|
* {@link LuaSurface.create_entity LuaSurface::create_entity}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter}.
|
2899
2901
|
*
|
2900
|
-
* {@link https://lua-api.factorio.com/
|
2902
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#script_raised_built View documentation}
|
2901
2903
|
*/
|
2902
2904
|
interface ScriptRaisedBuiltEvent extends EventData {
|
2903
2905
|
/** The entity that has been built. */
|
@@ -2914,7 +2916,7 @@ interface ScriptRaisedBuiltEvent extends EventData {
|
|
2914
2916
|
* {@link LuaBootstrap.raise_script_destroy LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to
|
2915
2917
|
* {@link LuaEntity.destroy LuaEntity::destroy}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter}.
|
2916
2918
|
*
|
2917
|
-
* {@link https://lua-api.factorio.com/
|
2919
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#script_raised_destroy View documentation}
|
2918
2920
|
*/
|
2919
2921
|
interface ScriptRaisedDestroyEvent extends EventData {
|
2920
2922
|
/** The entity that was destroyed. */
|
@@ -2931,7 +2933,7 @@ interface ScriptRaisedDestroyEvent extends EventData {
|
|
2931
2933
|
* {@link LuaBootstrap.raise_script_revive LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to
|
2932
2934
|
* {@link LuaEntity.revive LuaEntity::revive}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter}.
|
2933
2935
|
*
|
2934
|
-
* {@link https://lua-api.factorio.com/
|
2936
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#script_raised_revive View documentation}
|
2935
2937
|
*/
|
2936
2938
|
interface ScriptRaisedReviveEvent extends EventData {
|
2937
2939
|
/** The entity that was revived. */
|
@@ -2950,7 +2952,7 @@ interface ScriptRaisedReviveEvent extends EventData {
|
|
2950
2952
|
* {@link LuaBootstrap.raise_script_set_tiles LuaBootstrap::raise_script_set_tiles}, or when `raise_event` is passed to
|
2951
2953
|
* {@link LuaSurface.set_tiles LuaSurface::set_tiles}.
|
2952
2954
|
*
|
2953
|
-
* {@link https://lua-api.factorio.com/
|
2955
|
+
* {@link https://lua-api.factorio.com/latest/Events.html#script_raised_set_tiles View documentation}
|
2954
2956
|
*/
|
2955
2957
|
interface ScriptRaisedSetTilesEvent extends EventData {
|
2956
2958
|
/** The surface whose tiles were changed. */
|