typed-factorio 1.3.1 → 1.5.0
Sign up to get free protection for your applications and to get access to all the features.
- package/Changelog.md +41 -9
- package/README.md +14 -19
- package/custom-index-template.d.ts +1 -0
- package/generated/builtin-types.d.ts +24 -19
- package/generated/classes.d.ts +6155 -7729
- package/generated/concepts.d.ts +3181 -1943
- package/generated/defines.d.ts +126 -193
- package/generated/events.d.ts +234 -382
- package/generated/global-functions.d.ts +33 -0
- package/generated/global-objects.d.ts +7 -14
- package/package.json +22 -21
- package/runtime/index.d.ts +1 -0
- package/runtime/librariesAndFunctions.d.ts +0 -32
package/generated/events.d.ts
CHANGED
@@ -4,8 +4,7 @@
|
|
4
4
|
|
5
5
|
/**
|
6
6
|
* Called when a {@linkplain https://wiki.factorio.com/Prototype/CustomInput CustomInput} is activated.
|
7
|
-
*
|
8
|
-
* {@link https://lua-api.factorio.com/latest/events.html#CustomInputEvent View documentation}
|
7
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#CustomInputEvent Online documentation}
|
9
8
|
*/
|
10
9
|
interface CustomInputEvent extends EventData {
|
11
10
|
/**
|
@@ -19,7 +18,7 @@ interface CustomInputEvent extends EventData {
|
|
19
18
|
/**
|
20
19
|
* The mouse cursor position when the custom input was activated.
|
21
20
|
*/
|
22
|
-
readonly cursor_position:
|
21
|
+
readonly cursor_position: MapPosition
|
23
22
|
/**
|
24
23
|
* Information about the prototype that is selected when the custom input is used. Needs to be enabled on the custom input's prototype. `nil` if none is selected.
|
25
24
|
*/
|
@@ -36,8 +35,7 @@ interface CustomInputEvent extends EventData {
|
|
36
35
|
|
37
36
|
/**
|
38
37
|
* Called when a unit/group completes a command.
|
39
|
-
*
|
40
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_ai_command_completed View documentation}
|
38
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_ai_command_completed Online documentation}
|
41
39
|
*/
|
42
40
|
interface OnAiCommandCompletedEvent extends EventData {
|
43
41
|
/**
|
@@ -61,14 +59,13 @@ interface OnAiCommandCompletedEvent extends EventData {
|
|
61
59
|
|
62
60
|
/**
|
63
61
|
* Called when an area of the map is cloned.
|
64
|
-
*
|
65
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_area_cloned View documentation}
|
62
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_area_cloned Online documentation}
|
66
63
|
*/
|
67
64
|
interface OnAreaClonedEvent extends EventData {
|
68
65
|
readonly source_surface: LuaSurface
|
69
|
-
readonly source_area:
|
66
|
+
readonly source_area: BoundingBox
|
70
67
|
readonly destination_surface: LuaSurface
|
71
|
-
readonly destination_area:
|
68
|
+
readonly destination_area: BoundingBox
|
72
69
|
readonly destination_force?: LuaForce
|
73
70
|
readonly clone_tiles: boolean
|
74
71
|
readonly clone_entities: boolean
|
@@ -87,9 +84,8 @@ interface OnAreaClonedEvent extends EventData {
|
|
87
84
|
|
88
85
|
/**
|
89
86
|
* Called when a biter migration builds a base.
|
90
|
-
*
|
91
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_biter_base_built View documentation}
|
92
87
|
* @remarks This will be called multiple times for each migration, once for every biter that is sacrificed to build part of the new base.
|
88
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_biter_base_built Online documentation}
|
93
89
|
*/
|
94
90
|
interface OnBiterBaseBuiltEvent extends EventData {
|
95
91
|
/**
|
@@ -108,14 +104,13 @@ interface OnBiterBaseBuiltEvent extends EventData {
|
|
108
104
|
|
109
105
|
/**
|
110
106
|
* Called when a set of positions on the map is cloned.
|
111
|
-
*
|
112
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_brush_cloned View documentation}
|
107
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_brush_cloned Online documentation}
|
113
108
|
*/
|
114
109
|
interface OnBrushClonedEvent extends EventData {
|
115
|
-
readonly source_offset:
|
116
|
-
readonly destination_offset:
|
110
|
+
readonly source_offset: TilePosition
|
111
|
+
readonly destination_offset: TilePosition
|
117
112
|
readonly source_surface: LuaSurface
|
118
|
-
readonly source_positions:
|
113
|
+
readonly source_positions: TilePosition[]
|
119
114
|
readonly destination_surface: LuaSurface
|
120
115
|
readonly destination_force?: LuaForce
|
121
116
|
readonly clone_tiles: boolean
|
@@ -135,8 +130,7 @@ interface OnBrushClonedEvent extends EventData {
|
|
135
130
|
|
136
131
|
/**
|
137
132
|
* Called when a {@link defines.command.build_base} command reaches its destination, and before building starts.
|
138
|
-
*
|
139
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_build_base_arrived View documentation}
|
133
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_build_base_arrived Online documentation}
|
140
134
|
*/
|
141
135
|
interface OnBuildBaseArrivedEvent extends EventData {
|
142
136
|
/**
|
@@ -159,8 +153,7 @@ interface OnBuildBaseArrivedEvent extends EventData {
|
|
159
153
|
|
160
154
|
/**
|
161
155
|
* Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter}.
|
162
|
-
*
|
163
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_built_entity View documentation}
|
156
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_built_entity Online documentation}
|
164
157
|
*/
|
165
158
|
interface OnBuiltEntityEvent extends EventData {
|
166
159
|
readonly created_entity: LuaEntity
|
@@ -186,8 +179,7 @@ interface OnBuiltEntityEvent extends EventData {
|
|
186
179
|
|
187
180
|
/**
|
188
181
|
* Called when the deconstruction of an entity is canceled. Can be filtered using {@link LuaEntityDeconstructionCancelledEventFilter}.
|
189
|
-
*
|
190
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_deconstruction View documentation}
|
182
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_deconstruction Online documentation}
|
191
183
|
*/
|
192
184
|
interface OnCancelledDeconstructionEvent extends EventData {
|
193
185
|
readonly entity: LuaEntity
|
@@ -204,8 +196,7 @@ interface OnCancelledDeconstructionEvent extends EventData {
|
|
204
196
|
|
205
197
|
/**
|
206
198
|
* Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter}.
|
207
|
-
*
|
208
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_upgrade View documentation}
|
199
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_upgrade Online documentation}
|
209
200
|
*/
|
210
201
|
interface OnCancelledUpgradeEvent extends EventData {
|
211
202
|
readonly entity: LuaEntity
|
@@ -222,9 +213,8 @@ interface OnCancelledUpgradeEvent extends EventData {
|
|
222
213
|
|
223
214
|
/**
|
224
215
|
* Called when a character corpse expires due to timeout or all of the items being removed from it.
|
225
|
-
*
|
226
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_character_corpse_expired View documentation}
|
227
216
|
* @remarks this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
|
217
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_character_corpse_expired Online documentation}
|
228
218
|
*/
|
229
219
|
interface OnCharacterCorpseExpiredEvent extends EventData {
|
230
220
|
/**
|
@@ -243,8 +233,7 @@ interface OnCharacterCorpseExpiredEvent extends EventData {
|
|
243
233
|
|
244
234
|
/**
|
245
235
|
* Called when a chart tag is created.
|
246
|
-
*
|
247
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_added View documentation}
|
236
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_added Online documentation}
|
248
237
|
*/
|
249
238
|
interface OnChartTagAddedEvent extends EventData {
|
250
239
|
readonly tag: LuaCustomChartTag
|
@@ -262,8 +251,7 @@ interface OnChartTagAddedEvent extends EventData {
|
|
262
251
|
|
263
252
|
/**
|
264
253
|
* Called when a chart tag is modified by a player.
|
265
|
-
*
|
266
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_modified View documentation}
|
254
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_modified Online documentation}
|
267
255
|
*/
|
268
256
|
interface OnChartTagModifiedEvent extends EventData {
|
269
257
|
readonly tag: LuaCustomChartTag
|
@@ -284,8 +272,7 @@ interface OnChartTagModifiedEvent extends EventData {
|
|
284
272
|
|
285
273
|
/**
|
286
274
|
* Called just before a chart tag is deleted.
|
287
|
-
*
|
288
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_removed View documentation}
|
275
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_removed Online documentation}
|
289
276
|
*/
|
290
277
|
interface OnChartTagRemovedEvent extends EventData {
|
291
278
|
readonly tag: LuaCustomChartTag
|
@@ -303,16 +290,15 @@ interface OnChartTagRemovedEvent extends EventData {
|
|
303
290
|
|
304
291
|
/**
|
305
292
|
* Called when a chunk is charted or re-charted.
|
306
|
-
*
|
307
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_chunk_charted View documentation}
|
293
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_chunk_charted Online documentation}
|
308
294
|
*/
|
309
295
|
interface OnChunkChartedEvent extends EventData {
|
310
296
|
readonly surface_index: SurfaceIndex
|
311
|
-
readonly position:
|
297
|
+
readonly position: ChunkPosition
|
312
298
|
/**
|
313
299
|
* Area of the chunk.
|
314
300
|
*/
|
315
|
-
readonly area:
|
301
|
+
readonly area: BoundingBox
|
316
302
|
readonly force: LuaForce
|
317
303
|
/**
|
318
304
|
* Identifier of the event
|
@@ -326,15 +312,14 @@ interface OnChunkChartedEvent extends EventData {
|
|
326
312
|
|
327
313
|
/**
|
328
314
|
* Called when one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
|
329
|
-
*
|
330
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_chunk_deleted View documentation}
|
315
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_chunk_deleted Online documentation}
|
331
316
|
*/
|
332
317
|
interface OnChunkDeletedEvent extends EventData {
|
333
318
|
readonly surface_index: SurfaceIndex
|
334
319
|
/**
|
335
320
|
* The chunks deleted.
|
336
321
|
*/
|
337
|
-
readonly positions:
|
322
|
+
readonly positions: ChunkPosition[]
|
338
323
|
/**
|
339
324
|
* Identifier of the event
|
340
325
|
*/
|
@@ -347,18 +332,17 @@ interface OnChunkDeletedEvent extends EventData {
|
|
347
332
|
|
348
333
|
/**
|
349
334
|
* Called when a chunk is generated.
|
350
|
-
*
|
351
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_chunk_generated View documentation}
|
335
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_chunk_generated Online documentation}
|
352
336
|
*/
|
353
337
|
interface OnChunkGeneratedEvent extends EventData {
|
354
338
|
/**
|
355
339
|
* Area of the chunk.
|
356
340
|
*/
|
357
|
-
readonly area:
|
341
|
+
readonly area: BoundingBox
|
358
342
|
/**
|
359
343
|
* Position of the chunk.
|
360
344
|
*/
|
361
|
-
readonly position:
|
345
|
+
readonly position: ChunkPosition
|
362
346
|
/**
|
363
347
|
* The surface the chunk is on.
|
364
348
|
*/
|
@@ -375,8 +359,7 @@ interface OnChunkGeneratedEvent extends EventData {
|
|
375
359
|
|
376
360
|
/**
|
377
361
|
* Called when a combat robot expires through a lack of energy, or timeout.
|
378
|
-
*
|
379
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_combat_robot_expired View documentation}
|
362
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_combat_robot_expired Online documentation}
|
380
363
|
*/
|
381
364
|
interface OnCombatRobotExpiredEvent extends EventData {
|
382
365
|
readonly robot: LuaEntity
|
@@ -396,9 +379,8 @@ interface OnCombatRobotExpiredEvent extends EventData {
|
|
396
379
|
|
397
380
|
/**
|
398
381
|
* Called when a message is sent to the in-game console, either by a player or through the server interface.
|
399
|
-
*
|
400
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_console_chat View documentation}
|
401
382
|
* @remarks This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
|
383
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_console_chat Online documentation}
|
402
384
|
*/
|
403
385
|
interface OnConsoleChatEvent extends EventData {
|
404
386
|
/**
|
@@ -421,8 +403,7 @@ interface OnConsoleChatEvent extends EventData {
|
|
421
403
|
|
422
404
|
/**
|
423
405
|
* Called when someone enters a command-like message regardless of it being a valid command.
|
424
|
-
*
|
425
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_console_command View documentation}
|
406
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_console_command Online documentation}
|
426
407
|
*/
|
427
408
|
interface OnConsoleCommandEvent extends EventData {
|
428
409
|
/**
|
@@ -449,8 +430,7 @@ interface OnConsoleCommandEvent extends EventData {
|
|
449
430
|
|
450
431
|
/**
|
451
432
|
* Called when a cutscene is cancelled by the player or by script.
|
452
|
-
*
|
453
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_cancelled View documentation}
|
433
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_cancelled Online documentation}
|
454
434
|
*/
|
455
435
|
interface OnCutsceneCancelledEvent extends EventData {
|
456
436
|
/**
|
@@ -471,9 +451,8 @@ interface OnCutsceneCancelledEvent extends EventData {
|
|
471
451
|
* Called when a cutscene is playing, each time it reaches a waypoint in that cutscene.
|
472
452
|
*
|
473
453
|
* This refers to an index in the table previously passed to set_controller which started the cutscene.
|
474
|
-
*
|
475
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_waypoint_reached View documentation}
|
476
454
|
* @remarks Due to implementation omission, waypoint_index is 0-based.
|
455
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_waypoint_reached Online documentation}
|
477
456
|
*/
|
478
457
|
interface OnCutsceneWaypointReachedEvent extends EventData {
|
479
458
|
/**
|
@@ -496,9 +475,8 @@ interface OnCutsceneWaypointReachedEvent extends EventData {
|
|
496
475
|
|
497
476
|
/**
|
498
477
|
* Called when the map difficulty settings are changed.
|
499
|
-
*
|
500
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_difficulty_settings_changed View documentation}
|
501
478
|
* @remarks It's not guaranteed that both settings are changed - just that at least one has been changed.
|
479
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_difficulty_settings_changed Online documentation}
|
502
480
|
*/
|
503
481
|
interface OnDifficultySettingsChangedEvent extends EventData {
|
504
482
|
readonly old_recipe_difficulty: uint
|
@@ -515,8 +493,7 @@ interface OnDifficultySettingsChangedEvent extends EventData {
|
|
515
493
|
|
516
494
|
/**
|
517
495
|
* Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter}.
|
518
|
-
*
|
519
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_cloned View documentation}
|
496
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_cloned Online documentation}
|
520
497
|
*/
|
521
498
|
interface OnEntityClonedEvent extends EventData {
|
522
499
|
readonly source: LuaEntity
|
@@ -533,9 +510,8 @@ interface OnEntityClonedEvent extends EventData {
|
|
533
510
|
|
534
511
|
/**
|
535
512
|
* Called when an entity is damaged. Can be filtered using {@link LuaEntityDamagedEventFilter}.
|
536
|
-
*
|
537
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_damaged View documentation}
|
538
513
|
* @remarks This is not called when an entities health is set directly by another mod.
|
514
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_damaged Online documentation}
|
539
515
|
*/
|
540
516
|
interface OnEntityDamagedEvent extends EventData {
|
541
517
|
readonly entity: LuaEntity
|
@@ -572,9 +548,8 @@ interface OnEntityDamagedEvent extends EventData {
|
|
572
548
|
|
573
549
|
/**
|
574
550
|
* Called after an entity is destroyed that has been registered with {@link LuaBootstrap#register_on_entity_destroyed LuaBootstrap::register_on_entity_destroyed}.
|
575
|
-
*
|
576
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_destroyed View documentation}
|
577
551
|
* @remarks Depending on when a given entity is destroyed, this event will be fired at the end of the current tick or at the end of the next tick.
|
552
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_destroyed Online documentation}
|
578
553
|
*/
|
579
554
|
interface OnEntityDestroyedEvent extends EventData {
|
580
555
|
/**
|
@@ -597,8 +572,7 @@ interface OnEntityDestroyedEvent extends EventData {
|
|
597
572
|
|
598
573
|
/**
|
599
574
|
* Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter}.
|
600
|
-
*
|
601
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_died View documentation}
|
575
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_died Online documentation}
|
602
576
|
*/
|
603
577
|
interface OnEntityDiedEvent extends EventData {
|
604
578
|
/**
|
@@ -633,9 +607,8 @@ interface OnEntityDiedEvent extends EventData {
|
|
633
607
|
|
634
608
|
/**
|
635
609
|
* Called when one of an entity's personal logistic slots changes.
|
636
|
-
*
|
637
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_logistic_slot_changed View documentation}
|
638
610
|
* @remarks "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the request slots on logistic chests.
|
611
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_logistic_slot_changed Online documentation}
|
639
612
|
*/
|
640
613
|
interface OnEntityLogisticSlotChangedEvent extends EventData {
|
641
614
|
/**
|
@@ -662,8 +635,7 @@ interface OnEntityLogisticSlotChangedEvent extends EventData {
|
|
662
635
|
|
663
636
|
/**
|
664
637
|
* Called after an entity has been renamed either by the player or through script.
|
665
|
-
*
|
666
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_renamed View documentation}
|
638
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_renamed Online documentation}
|
667
639
|
*/
|
668
640
|
interface OnEntityRenamedEvent extends EventData {
|
669
641
|
/**
|
@@ -685,8 +657,7 @@ interface OnEntityRenamedEvent extends EventData {
|
|
685
657
|
|
686
658
|
/**
|
687
659
|
* Called after entity copy-paste is done.
|
688
|
-
*
|
689
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_settings_pasted View documentation}
|
660
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_settings_pasted Online documentation}
|
690
661
|
*/
|
691
662
|
interface OnEntitySettingsPastedEvent extends EventData {
|
692
663
|
readonly player_index: PlayerIndex
|
@@ -710,8 +681,7 @@ interface OnEntitySettingsPastedEvent extends EventData {
|
|
710
681
|
|
711
682
|
/**
|
712
683
|
* Called when an entity is spawned by a EnemySpawner
|
713
|
-
*
|
714
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_spawned View documentation}
|
684
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_entity_spawned Online documentation}
|
715
685
|
*/
|
716
686
|
interface OnEntitySpawnedEvent extends EventData {
|
717
687
|
readonly spawner: LuaEntity
|
@@ -728,8 +698,7 @@ interface OnEntitySpawnedEvent extends EventData {
|
|
728
698
|
|
729
699
|
/**
|
730
700
|
* Called after equipment is inserted into an equipment grid.
|
731
|
-
*
|
732
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_equipment_inserted View documentation}
|
701
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_equipment_inserted Online documentation}
|
733
702
|
*/
|
734
703
|
interface OnEquipmentInsertedEvent extends EventData {
|
735
704
|
/**
|
@@ -752,8 +721,7 @@ interface OnEquipmentInsertedEvent extends EventData {
|
|
752
721
|
|
753
722
|
/**
|
754
723
|
* Called after equipment is removed from an equipment grid.
|
755
|
-
*
|
756
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_equipment_removed View documentation}
|
724
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_equipment_removed Online documentation}
|
757
725
|
*/
|
758
726
|
interface OnEquipmentRemovedEvent extends EventData {
|
759
727
|
/**
|
@@ -780,8 +748,7 @@ interface OnEquipmentRemovedEvent extends EventData {
|
|
780
748
|
|
781
749
|
/**
|
782
750
|
* Called when the a forces cease fire values change.
|
783
|
-
*
|
784
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_force_cease_fire_changed View documentation}
|
751
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_force_cease_fire_changed Online documentation}
|
785
752
|
*/
|
786
753
|
interface OnForceCeaseFireChangedEvent extends EventData {
|
787
754
|
/**
|
@@ -808,9 +775,8 @@ interface OnForceCeaseFireChangedEvent extends EventData {
|
|
808
775
|
|
809
776
|
/**
|
810
777
|
* Called when a new force is created using `game.create_force()`
|
811
|
-
*
|
812
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_force_created View documentation}
|
813
778
|
* @remarks This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will always exist.
|
779
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_force_created Online documentation}
|
814
780
|
*/
|
815
781
|
interface OnForceCreatedEvent extends EventData {
|
816
782
|
/**
|
@@ -829,8 +795,7 @@ interface OnForceCreatedEvent extends EventData {
|
|
829
795
|
|
830
796
|
/**
|
831
797
|
* Called when the a forces friends change.
|
832
|
-
*
|
833
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_force_friends_changed View documentation}
|
798
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_force_friends_changed Online documentation}
|
834
799
|
*/
|
835
800
|
interface OnForceFriendsChangedEvent extends EventData {
|
836
801
|
/**
|
@@ -857,8 +822,7 @@ interface OnForceFriendsChangedEvent extends EventData {
|
|
857
822
|
|
858
823
|
/**
|
859
824
|
* Called when {@link LuaForce#reset LuaForce::reset} is finished.
|
860
|
-
*
|
861
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_force_reset View documentation}
|
825
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_force_reset Online documentation}
|
862
826
|
*/
|
863
827
|
interface OnForceResetEvent extends EventData {
|
864
828
|
readonly force: LuaForce
|
@@ -874,9 +838,8 @@ interface OnForceResetEvent extends EventData {
|
|
874
838
|
|
875
839
|
/**
|
876
840
|
* Called after two forces have been merged using `game.merge_forces()`.
|
877
|
-
*
|
878
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_forces_merged View documentation}
|
879
841
|
* @remarks The source force is invalidated before this event is called and the name can be re-used in this event if desired.
|
842
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_forces_merged Online documentation}
|
880
843
|
*/
|
881
844
|
interface OnForcesMergedEvent extends EventData {
|
882
845
|
/**
|
@@ -903,8 +866,7 @@ interface OnForcesMergedEvent extends EventData {
|
|
903
866
|
|
904
867
|
/**
|
905
868
|
* Called when two forces are about to be merged using `game.merge_forces()`.
|
906
|
-
*
|
907
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_forces_merging View documentation}
|
869
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_forces_merging Online documentation}
|
908
870
|
*/
|
909
871
|
interface OnForcesMergingEvent extends EventData {
|
910
872
|
/**
|
@@ -927,9 +889,8 @@ interface OnForcesMergingEvent extends EventData {
|
|
927
889
|
|
928
890
|
/**
|
929
891
|
* 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.
|
930
|
-
*
|
931
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_game_created_from_scenario View documentation}
|
932
892
|
* @remarks This event is not fired when the scenario is loaded via the map editor.
|
893
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_game_created_from_scenario Online documentation}
|
933
894
|
*/
|
934
895
|
interface OnGameCreatedFromScenarioEvent extends EventData {
|
935
896
|
/**
|
@@ -944,8 +905,7 @@ interface OnGameCreatedFromScenarioEvent extends EventData {
|
|
944
905
|
|
945
906
|
/**
|
946
907
|
* Called when {@link LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
|
947
|
-
*
|
948
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_checked_state_changed View documentation}
|
908
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_checked_state_changed Online documentation}
|
949
909
|
*/
|
950
910
|
interface OnGuiCheckedStateChangedEvent extends EventData {
|
951
911
|
/**
|
@@ -968,8 +928,7 @@ interface OnGuiCheckedStateChangedEvent extends EventData {
|
|
968
928
|
|
969
929
|
/**
|
970
930
|
* Called when {@link LuaGuiElement} is clicked.
|
971
|
-
*
|
972
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_click View documentation}
|
931
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_click Online documentation}
|
973
932
|
*/
|
974
933
|
interface OnGuiClickEvent extends EventData {
|
975
934
|
/**
|
@@ -1010,9 +969,8 @@ interface OnGuiClickEvent extends EventData {
|
|
1010
969
|
* Called when the player closes the GUI they have open.
|
1011
970
|
*
|
1012
971
|
* 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.
|
1013
|
-
*
|
1014
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_closed View documentation}
|
1015
972
|
* @remarks 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.
|
973
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_closed Online documentation}
|
1016
974
|
*/
|
1017
975
|
interface OnGuiClosedEvent extends EventData {
|
1018
976
|
/**
|
@@ -1050,7 +1008,11 @@ interface OnGuiClosedEvent extends EventData {
|
|
1050
1008
|
/**
|
1051
1009
|
* The tile position that was open
|
1052
1010
|
*/
|
1053
|
-
readonly tile_position?:
|
1011
|
+
readonly tile_position?: TilePosition
|
1012
|
+
/**
|
1013
|
+
* The script inventory that was open
|
1014
|
+
*/
|
1015
|
+
readonly inventory?: LuaInventory
|
1054
1016
|
/**
|
1055
1017
|
* Identifier of the event
|
1056
1018
|
*/
|
@@ -1063,8 +1025,7 @@ interface OnGuiClosedEvent extends EventData {
|
|
1063
1025
|
|
1064
1026
|
/**
|
1065
1027
|
* Called when a {@link LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
|
1066
|
-
*
|
1067
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_confirmed View documentation}
|
1028
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_confirmed Online documentation}
|
1068
1029
|
*/
|
1069
1030
|
interface OnGuiConfirmedEvent extends EventData {
|
1070
1031
|
/**
|
@@ -1099,8 +1060,7 @@ interface OnGuiConfirmedEvent extends EventData {
|
|
1099
1060
|
|
1100
1061
|
/**
|
1101
1062
|
* Called when {@link LuaGuiElement} element value is changed (related to choose element buttons).
|
1102
|
-
*
|
1103
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_elem_changed View documentation}
|
1063
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_elem_changed Online documentation}
|
1104
1064
|
*/
|
1105
1065
|
interface OnGuiElemChangedEvent extends EventData {
|
1106
1066
|
/**
|
@@ -1123,8 +1083,7 @@ interface OnGuiElemChangedEvent extends EventData {
|
|
1123
1083
|
|
1124
1084
|
/**
|
1125
1085
|
* Called when {@link LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
|
1126
|
-
*
|
1127
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_location_changed View documentation}
|
1086
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_location_changed Online documentation}
|
1128
1087
|
*/
|
1129
1088
|
interface OnGuiLocationChangedEvent extends EventData {
|
1130
1089
|
/**
|
@@ -1147,8 +1106,7 @@ interface OnGuiLocationChangedEvent extends EventData {
|
|
1147
1106
|
|
1148
1107
|
/**
|
1149
1108
|
* Called when the player opens a GUI.
|
1150
|
-
*
|
1151
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_opened View documentation}
|
1109
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_opened Online documentation}
|
1152
1110
|
*/
|
1153
1111
|
interface OnGuiOpenedEvent extends EventData {
|
1154
1112
|
/**
|
@@ -1179,6 +1137,10 @@ interface OnGuiOpenedEvent extends EventData {
|
|
1179
1137
|
* The custom GUI element that was opened
|
1180
1138
|
*/
|
1181
1139
|
readonly element?: LuaGuiElement
|
1140
|
+
/**
|
1141
|
+
* The script inventory that was opened
|
1142
|
+
*/
|
1143
|
+
readonly inventory?: LuaInventory
|
1182
1144
|
/**
|
1183
1145
|
* Identifier of the event
|
1184
1146
|
*/
|
@@ -1191,8 +1153,7 @@ interface OnGuiOpenedEvent extends EventData {
|
|
1191
1153
|
|
1192
1154
|
/**
|
1193
1155
|
* Called when {@link LuaGuiElement} selected tab is changed (related to tabbed-panes).
|
1194
|
-
*
|
1195
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_selected_tab_changed View documentation}
|
1156
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_selected_tab_changed Online documentation}
|
1196
1157
|
*/
|
1197
1158
|
interface OnGuiSelectedTabChangedEvent extends EventData {
|
1198
1159
|
/**
|
@@ -1215,8 +1176,7 @@ interface OnGuiSelectedTabChangedEvent extends EventData {
|
|
1215
1176
|
|
1216
1177
|
/**
|
1217
1178
|
* Called when {@link LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
|
1218
|
-
*
|
1219
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_selection_state_changed View documentation}
|
1179
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_selection_state_changed Online documentation}
|
1220
1180
|
*/
|
1221
1181
|
interface OnGuiSelectionStateChangedEvent extends EventData {
|
1222
1182
|
/**
|
@@ -1239,8 +1199,7 @@ interface OnGuiSelectionStateChangedEvent extends EventData {
|
|
1239
1199
|
|
1240
1200
|
/**
|
1241
1201
|
* Called when {@link LuaGuiElement} switch state is changed (related to switches).
|
1242
|
-
*
|
1243
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_switch_state_changed View documentation}
|
1202
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_switch_state_changed Online documentation}
|
1244
1203
|
*/
|
1245
1204
|
interface OnGuiSwitchStateChangedEvent extends EventData {
|
1246
1205
|
/**
|
@@ -1263,8 +1222,7 @@ interface OnGuiSwitchStateChangedEvent extends EventData {
|
|
1263
1222
|
|
1264
1223
|
/**
|
1265
1224
|
* Called when {@link LuaGuiElement} text is changed by the player.
|
1266
|
-
*
|
1267
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_text_changed View documentation}
|
1225
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_text_changed Online documentation}
|
1268
1226
|
*/
|
1269
1227
|
interface OnGuiTextChangedEvent extends EventData {
|
1270
1228
|
/**
|
@@ -1291,8 +1249,7 @@ interface OnGuiTextChangedEvent extends EventData {
|
|
1291
1249
|
|
1292
1250
|
/**
|
1293
1251
|
* Called when {@link LuaGuiElement} slider value is changed (related to the slider element).
|
1294
|
-
*
|
1295
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_value_changed View documentation}
|
1252
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_gui_value_changed Online documentation}
|
1296
1253
|
*/
|
1297
1254
|
interface OnGuiValueChangedEvent extends EventData {
|
1298
1255
|
/**
|
@@ -1315,8 +1272,7 @@ interface OnGuiValueChangedEvent extends EventData {
|
|
1315
1272
|
|
1316
1273
|
/**
|
1317
1274
|
* Called when a land mine is armed.
|
1318
|
-
*
|
1319
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_land_mine_armed View documentation}
|
1275
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_land_mine_armed Online documentation}
|
1320
1276
|
*/
|
1321
1277
|
interface OnLandMineArmedEvent extends EventData {
|
1322
1278
|
readonly mine: LuaEntity
|
@@ -1332,8 +1288,7 @@ interface OnLandMineArmedEvent extends EventData {
|
|
1332
1288
|
|
1333
1289
|
/**
|
1334
1290
|
* Called when a custom Lua shortcut is pressed.
|
1335
|
-
*
|
1336
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_lua_shortcut View documentation}
|
1291
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_lua_shortcut Online documentation}
|
1337
1292
|
*/
|
1338
1293
|
interface OnLuaShortcutEvent extends EventData {
|
1339
1294
|
readonly player_index: PlayerIndex
|
@@ -1353,8 +1308,7 @@ interface OnLuaShortcutEvent extends EventData {
|
|
1353
1308
|
|
1354
1309
|
/**
|
1355
1310
|
* Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using {@link LuaEntityMarkedForDeconstructionEventFilter}.
|
1356
|
-
*
|
1357
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_deconstruction View documentation}
|
1311
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_deconstruction Online documentation}
|
1358
1312
|
*/
|
1359
1313
|
interface OnMarkedForDeconstructionEvent extends EventData {
|
1360
1314
|
readonly entity: LuaEntity
|
@@ -1371,8 +1325,7 @@ interface OnMarkedForDeconstructionEvent extends EventData {
|
|
1371
1325
|
|
1372
1326
|
/**
|
1373
1327
|
* Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using {@link LuaEntityMarkedForUpgradeEventFilter}.
|
1374
|
-
*
|
1375
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_upgrade View documentation}
|
1328
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_upgrade Online documentation}
|
1376
1329
|
*/
|
1377
1330
|
interface OnMarkedForUpgradeEvent extends EventData {
|
1378
1331
|
readonly entity: LuaEntity
|
@@ -1394,8 +1347,7 @@ interface OnMarkedForUpgradeEvent extends EventData {
|
|
1394
1347
|
|
1395
1348
|
/**
|
1396
1349
|
* Called after a player purchases some offer from a `market` entity.
|
1397
|
-
*
|
1398
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_market_item_purchased View documentation}
|
1350
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_market_item_purchased Online documentation}
|
1399
1351
|
*/
|
1400
1352
|
interface OnMarketItemPurchasedEvent extends EventData {
|
1401
1353
|
/**
|
@@ -1426,8 +1378,7 @@ interface OnMarketItemPurchasedEvent extends EventData {
|
|
1426
1378
|
|
1427
1379
|
/**
|
1428
1380
|
* Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
|
1429
|
-
*
|
1430
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_mod_item_opened View documentation}
|
1381
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_mod_item_opened Online documentation}
|
1431
1382
|
*/
|
1432
1383
|
interface OnModItemOpenedEvent extends EventData {
|
1433
1384
|
/**
|
@@ -1450,8 +1401,7 @@ interface OnModItemOpenedEvent extends EventData {
|
|
1450
1401
|
|
1451
1402
|
/**
|
1452
1403
|
* Called directly after a permission group is added.
|
1453
|
-
*
|
1454
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_added View documentation}
|
1404
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_added Online documentation}
|
1455
1405
|
*/
|
1456
1406
|
interface OnPermissionGroupAddedEvent extends EventData {
|
1457
1407
|
/**
|
@@ -1474,8 +1424,7 @@ interface OnPermissionGroupAddedEvent extends EventData {
|
|
1474
1424
|
|
1475
1425
|
/**
|
1476
1426
|
* Called directly after a permission group is deleted.
|
1477
|
-
*
|
1478
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_deleted View documentation}
|
1427
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_deleted Online documentation}
|
1479
1428
|
*/
|
1480
1429
|
interface OnPermissionGroupDeletedEvent extends EventData {
|
1481
1430
|
/**
|
@@ -1502,8 +1451,7 @@ interface OnPermissionGroupDeletedEvent extends EventData {
|
|
1502
1451
|
|
1503
1452
|
/**
|
1504
1453
|
* Called directly after a permission group is edited in some way.
|
1505
|
-
*
|
1506
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_edited View documentation}
|
1454
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_edited Online documentation}
|
1507
1455
|
*/
|
1508
1456
|
interface OnPermissionGroupEditedEvent extends EventData {
|
1509
1457
|
/**
|
@@ -1553,8 +1501,7 @@ interface OnPermissionGroupEditedEvent extends EventData {
|
|
1553
1501
|
|
1554
1502
|
/**
|
1555
1503
|
* Called directly after a permission string is imported.
|
1556
|
-
*
|
1557
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_permission_string_imported View documentation}
|
1504
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_permission_string_imported Online documentation}
|
1558
1505
|
*/
|
1559
1506
|
interface OnPermissionStringImportedEvent extends EventData {
|
1560
1507
|
/**
|
@@ -1573,8 +1520,7 @@ interface OnPermissionStringImportedEvent extends EventData {
|
|
1573
1520
|
|
1574
1521
|
/**
|
1575
1522
|
* Called when a player picks up an item.
|
1576
|
-
*
|
1577
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_picked_up_item View documentation}
|
1523
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_picked_up_item Online documentation}
|
1578
1524
|
*/
|
1579
1525
|
interface OnPickedUpItemEvent extends EventData {
|
1580
1526
|
readonly item_stack: SimpleItemStack
|
@@ -1591,8 +1537,7 @@ interface OnPickedUpItemEvent extends EventData {
|
|
1591
1537
|
|
1592
1538
|
/**
|
1593
1539
|
* Called after a player alt-selects an area with a selection-tool item.
|
1594
|
-
*
|
1595
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_alt_selected_area View documentation}
|
1540
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_alt_selected_area Online documentation}
|
1596
1541
|
*/
|
1597
1542
|
interface OnPlayerAltSelectedAreaEvent extends EventData {
|
1598
1543
|
/**
|
@@ -1606,7 +1551,7 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
|
|
1606
1551
|
/**
|
1607
1552
|
* The area selected.
|
1608
1553
|
*/
|
1609
|
-
readonly area:
|
1554
|
+
readonly area: BoundingBox
|
1610
1555
|
/**
|
1611
1556
|
* The item used to select the area.
|
1612
1557
|
*/
|
@@ -1631,8 +1576,7 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
|
|
1631
1576
|
|
1632
1577
|
/**
|
1633
1578
|
* Called after a players ammo inventory changed in some way.
|
1634
|
-
*
|
1635
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_ammo_inventory_changed View documentation}
|
1579
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_ammo_inventory_changed Online documentation}
|
1636
1580
|
*/
|
1637
1581
|
interface OnPlayerAmmoInventoryChangedEvent extends EventData {
|
1638
1582
|
readonly player_index: PlayerIndex
|
@@ -1648,8 +1592,7 @@ interface OnPlayerAmmoInventoryChangedEvent extends EventData {
|
|
1648
1592
|
|
1649
1593
|
/**
|
1650
1594
|
* Called after a players armor inventory changed in some way.
|
1651
|
-
*
|
1652
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_armor_inventory_changed View documentation}
|
1595
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_armor_inventory_changed Online documentation}
|
1653
1596
|
*/
|
1654
1597
|
interface OnPlayerArmorInventoryChangedEvent extends EventData {
|
1655
1598
|
readonly player_index: PlayerIndex
|
@@ -1665,8 +1608,7 @@ interface OnPlayerArmorInventoryChangedEvent extends EventData {
|
|
1665
1608
|
|
1666
1609
|
/**
|
1667
1610
|
* Called when a player is banned.
|
1668
|
-
*
|
1669
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_banned View documentation}
|
1611
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_banned Online documentation}
|
1670
1612
|
*/
|
1671
1613
|
interface OnPlayerBannedEvent extends EventData {
|
1672
1614
|
/**
|
@@ -1697,8 +1639,7 @@ interface OnPlayerBannedEvent extends EventData {
|
|
1697
1639
|
|
1698
1640
|
/**
|
1699
1641
|
* Called after a player builds tiles.
|
1700
|
-
*
|
1701
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_built_tile View documentation}
|
1642
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_built_tile Online documentation}
|
1702
1643
|
*/
|
1703
1644
|
interface OnPlayerBuiltTileEvent extends EventData {
|
1704
1645
|
readonly player_index: PlayerIndex
|
@@ -1734,8 +1675,7 @@ interface OnPlayerBuiltTileEvent extends EventData {
|
|
1734
1675
|
|
1735
1676
|
/**
|
1736
1677
|
* Called when a player cancels crafting.
|
1737
|
-
*
|
1738
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_cancelled_crafting View documentation}
|
1678
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_cancelled_crafting Online documentation}
|
1739
1679
|
*/
|
1740
1680
|
interface OnPlayerCancelledCraftingEvent extends EventData {
|
1741
1681
|
/**
|
@@ -1766,8 +1706,7 @@ interface OnPlayerCancelledCraftingEvent extends EventData {
|
|
1766
1706
|
|
1767
1707
|
/**
|
1768
1708
|
* Called after a player changes forces.
|
1769
|
-
*
|
1770
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_force View documentation}
|
1709
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_force Online documentation}
|
1771
1710
|
*/
|
1772
1711
|
interface OnPlayerChangedForceEvent extends EventData {
|
1773
1712
|
/**
|
@@ -1790,8 +1729,7 @@ interface OnPlayerChangedForceEvent extends EventData {
|
|
1790
1729
|
|
1791
1730
|
/**
|
1792
1731
|
* Called when the tile position a player is located at changes.
|
1793
|
-
*
|
1794
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_position View documentation}
|
1732
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_position Online documentation}
|
1795
1733
|
*/
|
1796
1734
|
interface OnPlayerChangedPositionEvent extends EventData {
|
1797
1735
|
/**
|
@@ -1810,9 +1748,8 @@ interface OnPlayerChangedPositionEvent extends EventData {
|
|
1810
1748
|
|
1811
1749
|
/**
|
1812
1750
|
* Called after a player changes surfaces.
|
1813
|
-
*
|
1814
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_surface View documentation}
|
1815
1751
|
* @remarks In the instance a player is moved off a surface due to it being deleted this is not called.
|
1752
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_surface Online documentation}
|
1816
1753
|
*/
|
1817
1754
|
interface OnPlayerChangedSurfaceEvent extends EventData {
|
1818
1755
|
/**
|
@@ -1835,8 +1772,7 @@ interface OnPlayerChangedSurfaceEvent extends EventData {
|
|
1835
1772
|
|
1836
1773
|
/**
|
1837
1774
|
* Called when cheat mode is disabled on a player.
|
1838
|
-
*
|
1839
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_disabled View documentation}
|
1775
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_disabled Online documentation}
|
1840
1776
|
*/
|
1841
1777
|
interface OnPlayerCheatModeDisabledEvent extends EventData {
|
1842
1778
|
/**
|
@@ -1855,8 +1791,7 @@ interface OnPlayerCheatModeDisabledEvent extends EventData {
|
|
1855
1791
|
|
1856
1792
|
/**
|
1857
1793
|
* Called when cheat mode is enabled on a player.
|
1858
|
-
*
|
1859
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_enabled View documentation}
|
1794
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_enabled Online documentation}
|
1860
1795
|
*/
|
1861
1796
|
interface OnPlayerCheatModeEnabledEvent extends EventData {
|
1862
1797
|
/**
|
@@ -1875,8 +1810,7 @@ interface OnPlayerCheatModeEnabledEvent extends EventData {
|
|
1875
1810
|
|
1876
1811
|
/**
|
1877
1812
|
* Called when a player clicks a gps tag
|
1878
|
-
*
|
1879
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_clicked_gps_tag View documentation}
|
1813
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_clicked_gps_tag Online documentation}
|
1880
1814
|
*/
|
1881
1815
|
interface OnPlayerClickedGpsTagEvent extends EventData {
|
1882
1816
|
/**
|
@@ -1886,7 +1820,7 @@ interface OnPlayerClickedGpsTagEvent extends EventData {
|
|
1886
1820
|
/**
|
1887
1821
|
* Map position contained in gps tag
|
1888
1822
|
*/
|
1889
|
-
readonly position:
|
1823
|
+
readonly position: MapPosition
|
1890
1824
|
/**
|
1891
1825
|
* Surface name contained in gps tag, even when such surface does not exists
|
1892
1826
|
*/
|
@@ -1903,8 +1837,7 @@ interface OnPlayerClickedGpsTagEvent extends EventData {
|
|
1903
1837
|
|
1904
1838
|
/**
|
1905
1839
|
* Called when a player clicks the "confirm" button in the configure Blueprint GUI.
|
1906
|
-
*
|
1907
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_blueprint View documentation}
|
1840
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_blueprint Online documentation}
|
1908
1841
|
*/
|
1909
1842
|
interface OnPlayerConfiguredBlueprintEvent extends EventData {
|
1910
1843
|
/**
|
@@ -1923,8 +1856,7 @@ interface OnPlayerConfiguredBlueprintEvent extends EventData {
|
|
1923
1856
|
|
1924
1857
|
/**
|
1925
1858
|
* Called when a player configures spidertron remote to be connected with a given spidertron
|
1926
|
-
*
|
1927
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_spider_remote View documentation}
|
1859
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_spider_remote Online documentation}
|
1928
1860
|
*/
|
1929
1861
|
interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
|
1930
1862
|
/**
|
@@ -1947,8 +1879,7 @@ interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
|
|
1947
1879
|
|
1948
1880
|
/**
|
1949
1881
|
* 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}).
|
1950
|
-
*
|
1951
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_crafted_item View documentation}
|
1882
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_crafted_item Online documentation}
|
1952
1883
|
*/
|
1953
1884
|
interface OnPlayerCraftedItemEvent extends EventData {
|
1954
1885
|
/**
|
@@ -1975,8 +1906,7 @@ interface OnPlayerCraftedItemEvent extends EventData {
|
|
1975
1906
|
|
1976
1907
|
/**
|
1977
1908
|
* Called after the player was created.
|
1978
|
-
*
|
1979
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_created View documentation}
|
1909
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_created Online documentation}
|
1980
1910
|
*/
|
1981
1911
|
interface OnPlayerCreatedEvent extends EventData {
|
1982
1912
|
readonly player_index: PlayerIndex
|
@@ -1992,8 +1922,7 @@ interface OnPlayerCreatedEvent extends EventData {
|
|
1992
1922
|
|
1993
1923
|
/**
|
1994
1924
|
* Called after a players cursorstack changed in some way.
|
1995
|
-
*
|
1996
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_cursor_stack_changed View documentation}
|
1925
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_cursor_stack_changed Online documentation}
|
1997
1926
|
*/
|
1998
1927
|
interface OnPlayerCursorStackChangedEvent extends EventData {
|
1999
1928
|
readonly player_index: PlayerIndex
|
@@ -2009,8 +1938,7 @@ interface OnPlayerCursorStackChangedEvent extends EventData {
|
|
2009
1938
|
|
2010
1939
|
/**
|
2011
1940
|
* Called when a player selects an area with a deconstruction planner.
|
2012
|
-
*
|
2013
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_deconstructed_area View documentation}
|
1941
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_deconstructed_area Online documentation}
|
2014
1942
|
*/
|
2015
1943
|
interface OnPlayerDeconstructedAreaEvent extends EventData {
|
2016
1944
|
/**
|
@@ -2024,7 +1952,7 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
|
|
2024
1952
|
/**
|
2025
1953
|
* The area selected.
|
2026
1954
|
*/
|
2027
|
-
readonly area:
|
1955
|
+
readonly area: BoundingBox
|
2028
1956
|
/**
|
2029
1957
|
* The item used to select the area.
|
2030
1958
|
*/
|
@@ -2045,8 +1973,7 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
|
|
2045
1973
|
|
2046
1974
|
/**
|
2047
1975
|
* Called when a player is demoted.
|
2048
|
-
*
|
2049
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_demoted View documentation}
|
1976
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_demoted Online documentation}
|
2050
1977
|
*/
|
2051
1978
|
interface OnPlayerDemotedEvent extends EventData {
|
2052
1979
|
/**
|
@@ -2065,8 +1992,7 @@ interface OnPlayerDemotedEvent extends EventData {
|
|
2065
1992
|
|
2066
1993
|
/**
|
2067
1994
|
* Called after a player dies.
|
2068
|
-
*
|
2069
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_died View documentation}
|
1995
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_died Online documentation}
|
2070
1996
|
*/
|
2071
1997
|
interface OnPlayerDiedEvent extends EventData {
|
2072
1998
|
readonly player_index: PlayerIndex
|
@@ -2083,8 +2009,7 @@ interface OnPlayerDiedEvent extends EventData {
|
|
2083
2009
|
|
2084
2010
|
/**
|
2085
2011
|
* Called when the display resolution changes for a given player.
|
2086
|
-
*
|
2087
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_display_resolution_changed View documentation}
|
2012
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_display_resolution_changed Online documentation}
|
2088
2013
|
*/
|
2089
2014
|
interface OnPlayerDisplayResolutionChangedEvent extends EventData {
|
2090
2015
|
/**
|
@@ -2107,8 +2032,7 @@ interface OnPlayerDisplayResolutionChangedEvent extends EventData {
|
|
2107
2032
|
|
2108
2033
|
/**
|
2109
2034
|
* Called when the display scale changes for a given player.
|
2110
|
-
*
|
2111
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_display_scale_changed View documentation}
|
2035
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_display_scale_changed Online documentation}
|
2112
2036
|
*/
|
2113
2037
|
interface OnPlayerDisplayScaleChangedEvent extends EventData {
|
2114
2038
|
/**
|
@@ -2131,8 +2055,7 @@ interface OnPlayerDisplayScaleChangedEvent extends EventData {
|
|
2131
2055
|
|
2132
2056
|
/**
|
2133
2057
|
* Called when the player's driving state has changed, this means a player has either entered or left a vehicle.
|
2134
|
-
*
|
2135
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_driving_changed_state View documentation}
|
2058
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_driving_changed_state Online documentation}
|
2136
2059
|
*/
|
2137
2060
|
interface OnPlayerDrivingChangedStateEvent extends EventData {
|
2138
2061
|
readonly player_index: PlayerIndex
|
@@ -2152,8 +2075,7 @@ interface OnPlayerDrivingChangedStateEvent extends EventData {
|
|
2152
2075
|
|
2153
2076
|
/**
|
2154
2077
|
* Called when a player drops an item on the ground.
|
2155
|
-
*
|
2156
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_dropped_item View documentation}
|
2078
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_dropped_item Online documentation}
|
2157
2079
|
*/
|
2158
2080
|
interface OnPlayerDroppedItemEvent extends EventData {
|
2159
2081
|
readonly player_index: PlayerIndex
|
@@ -2173,8 +2095,7 @@ interface OnPlayerDroppedItemEvent extends EventData {
|
|
2173
2095
|
|
2174
2096
|
/**
|
2175
2097
|
* Called when a player fast-transfers something to or from an entity.
|
2176
|
-
*
|
2177
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_fast_transferred View documentation}
|
2098
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_fast_transferred Online documentation}
|
2178
2099
|
*/
|
2179
2100
|
interface OnPlayerFastTransferredEvent extends EventData {
|
2180
2101
|
/**
|
@@ -2201,8 +2122,7 @@ interface OnPlayerFastTransferredEvent extends EventData {
|
|
2201
2122
|
|
2202
2123
|
/**
|
2203
2124
|
* Called after player flushed fluid
|
2204
|
-
*
|
2205
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_flushed_fluid View documentation}
|
2125
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_flushed_fluid Online documentation}
|
2206
2126
|
*/
|
2207
2127
|
interface OnPlayerFlushedFluidEvent extends EventData {
|
2208
2128
|
/**
|
@@ -2237,8 +2157,7 @@ interface OnPlayerFlushedFluidEvent extends EventData {
|
|
2237
2157
|
|
2238
2158
|
/**
|
2239
2159
|
* Called after a players gun inventory changed in some way.
|
2240
|
-
*
|
2241
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_gun_inventory_changed View documentation}
|
2160
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_gun_inventory_changed Online documentation}
|
2242
2161
|
*/
|
2243
2162
|
interface OnPlayerGunInventoryChangedEvent extends EventData {
|
2244
2163
|
readonly player_index: PlayerIndex
|
@@ -2253,9 +2172,8 @@ interface OnPlayerGunInventoryChangedEvent extends EventData {
|
|
2253
2172
|
}
|
2254
2173
|
|
2255
2174
|
/**
|
2256
|
-
* Called after a player joins the game.
|
2257
|
-
*
|
2258
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_joined_game View documentation}
|
2175
|
+
* 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.
|
2176
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_joined_game Online documentation}
|
2259
2177
|
*/
|
2260
2178
|
interface OnPlayerJoinedGameEvent extends EventData {
|
2261
2179
|
readonly player_index: PlayerIndex
|
@@ -2271,8 +2189,7 @@ interface OnPlayerJoinedGameEvent extends EventData {
|
|
2271
2189
|
|
2272
2190
|
/**
|
2273
2191
|
* Called when a player is kicked.
|
2274
|
-
*
|
2275
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_kicked View documentation}
|
2192
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_kicked Online documentation}
|
2276
2193
|
*/
|
2277
2194
|
interface OnPlayerKickedEvent extends EventData {
|
2278
2195
|
/**
|
@@ -2298,9 +2215,8 @@ interface OnPlayerKickedEvent extends EventData {
|
|
2298
2215
|
}
|
2299
2216
|
|
2300
2217
|
/**
|
2301
|
-
* Called after a player leaves the game.
|
2302
|
-
*
|
2303
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_left_game View documentation}
|
2218
|
+
* 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.
|
2219
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_left_game Online documentation}
|
2304
2220
|
*/
|
2305
2221
|
interface OnPlayerLeftGameEvent extends EventData {
|
2306
2222
|
readonly player_index: PlayerIndex
|
@@ -2317,8 +2233,7 @@ interface OnPlayerLeftGameEvent extends EventData {
|
|
2317
2233
|
|
2318
2234
|
/**
|
2319
2235
|
* Called after a players main inventory changed in some way.
|
2320
|
-
*
|
2321
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_main_inventory_changed View documentation}
|
2236
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_main_inventory_changed Online documentation}
|
2322
2237
|
*/
|
2323
2238
|
interface OnPlayerMainInventoryChangedEvent extends EventData {
|
2324
2239
|
readonly player_index: PlayerIndex
|
@@ -2334,9 +2249,8 @@ interface OnPlayerMainInventoryChangedEvent extends EventData {
|
|
2334
2249
|
|
2335
2250
|
/**
|
2336
2251
|
* Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the player as if they came from mining the entity. Can be filtered using {@link LuaPlayerMinedEntityEventFilter}.
|
2337
|
-
*
|
2338
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_entity View documentation}
|
2339
2252
|
* @remarks 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.
|
2253
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_entity Online documentation}
|
2340
2254
|
*/
|
2341
2255
|
interface OnPlayerMinedEntityEvent extends EventData {
|
2342
2256
|
/**
|
@@ -2363,8 +2277,7 @@ interface OnPlayerMinedEntityEvent extends EventData {
|
|
2363
2277
|
|
2364
2278
|
/**
|
2365
2279
|
* Called when the player mines something.
|
2366
|
-
*
|
2367
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_item View documentation}
|
2280
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_item Online documentation}
|
2368
2281
|
*/
|
2369
2282
|
interface OnPlayerMinedItemEvent extends EventData {
|
2370
2283
|
/**
|
@@ -2384,8 +2297,7 @@ interface OnPlayerMinedItemEvent extends EventData {
|
|
2384
2297
|
|
2385
2298
|
/**
|
2386
2299
|
* Called after a player mines tiles.
|
2387
|
-
*
|
2388
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_tile View documentation}
|
2300
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_tile Online documentation}
|
2389
2301
|
*/
|
2390
2302
|
interface OnPlayerMinedTileEvent extends EventData {
|
2391
2303
|
readonly player_index: PlayerIndex
|
@@ -2409,8 +2321,7 @@ interface OnPlayerMinedTileEvent extends EventData {
|
|
2409
2321
|
|
2410
2322
|
/**
|
2411
2323
|
* Called when a player is muted.
|
2412
|
-
*
|
2413
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_muted View documentation}
|
2324
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_muted Online documentation}
|
2414
2325
|
*/
|
2415
2326
|
interface OnPlayerMutedEvent extends EventData {
|
2416
2327
|
/**
|
@@ -2429,8 +2340,7 @@ interface OnPlayerMutedEvent extends EventData {
|
|
2429
2340
|
|
2430
2341
|
/**
|
2431
2342
|
* Called when a player invokes the "smart pipette" over an entity.
|
2432
|
-
*
|
2433
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_pipette View documentation}
|
2343
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_pipette Online documentation}
|
2434
2344
|
*/
|
2435
2345
|
interface OnPlayerPipetteEvent extends EventData {
|
2436
2346
|
/**
|
@@ -2457,8 +2367,7 @@ interface OnPlayerPipetteEvent extends EventData {
|
|
2457
2367
|
|
2458
2368
|
/**
|
2459
2369
|
* Called after the player puts equipment in an equipment grid
|
2460
|
-
*
|
2461
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_placed_equipment View documentation}
|
2370
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_placed_equipment Online documentation}
|
2462
2371
|
*/
|
2463
2372
|
interface OnPlayerPlacedEquipmentEvent extends EventData {
|
2464
2373
|
readonly player_index: PlayerIndex
|
@@ -2482,8 +2391,7 @@ interface OnPlayerPlacedEquipmentEvent extends EventData {
|
|
2482
2391
|
|
2483
2392
|
/**
|
2484
2393
|
* Called when a player is promoted.
|
2485
|
-
*
|
2486
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_promoted View documentation}
|
2394
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_promoted Online documentation}
|
2487
2395
|
*/
|
2488
2396
|
interface OnPlayerPromotedEvent extends EventData {
|
2489
2397
|
/**
|
@@ -2502,8 +2410,7 @@ interface OnPlayerPromotedEvent extends EventData {
|
|
2502
2410
|
|
2503
2411
|
/**
|
2504
2412
|
* Called when a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.
|
2505
|
-
*
|
2506
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_removed View documentation}
|
2413
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_removed Online documentation}
|
2507
2414
|
*/
|
2508
2415
|
interface OnPlayerRemovedEvent extends EventData {
|
2509
2416
|
/**
|
@@ -2522,8 +2429,7 @@ interface OnPlayerRemovedEvent extends EventData {
|
|
2522
2429
|
|
2523
2430
|
/**
|
2524
2431
|
* Called after the player removes equipment from an equipment grid
|
2525
|
-
*
|
2526
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_removed_equipment View documentation}
|
2432
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_removed_equipment Online documentation}
|
2527
2433
|
*/
|
2528
2434
|
interface OnPlayerRemovedEquipmentEvent extends EventData {
|
2529
2435
|
readonly player_index: PlayerIndex
|
@@ -2551,8 +2457,7 @@ interface OnPlayerRemovedEquipmentEvent extends EventData {
|
|
2551
2457
|
|
2552
2458
|
/**
|
2553
2459
|
* Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter}.
|
2554
|
-
*
|
2555
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_repaired_entity View documentation}
|
2460
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_repaired_entity Online documentation}
|
2556
2461
|
*/
|
2557
2462
|
interface OnPlayerRepairedEntityEvent extends EventData {
|
2558
2463
|
readonly player_index: PlayerIndex
|
@@ -2569,8 +2474,7 @@ interface OnPlayerRepairedEntityEvent extends EventData {
|
|
2569
2474
|
|
2570
2475
|
/**
|
2571
2476
|
* Called after a player respawns.
|
2572
|
-
*
|
2573
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_respawned View documentation}
|
2477
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_respawned Online documentation}
|
2574
2478
|
*/
|
2575
2479
|
interface OnPlayerRespawnedEvent extends EventData {
|
2576
2480
|
readonly player_index: PlayerIndex
|
@@ -2590,8 +2494,7 @@ interface OnPlayerRespawnedEvent extends EventData {
|
|
2590
2494
|
|
2591
2495
|
/**
|
2592
2496
|
* Called after a player reverse-selects an area with a selection-tool item.
|
2593
|
-
*
|
2594
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_reverse_selected_area View documentation}
|
2497
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_reverse_selected_area Online documentation}
|
2595
2498
|
*/
|
2596
2499
|
interface OnPlayerReverseSelectedAreaEvent extends EventData {
|
2597
2500
|
/**
|
@@ -2605,7 +2508,7 @@ interface OnPlayerReverseSelectedAreaEvent extends EventData {
|
|
2605
2508
|
/**
|
2606
2509
|
* The area selected.
|
2607
2510
|
*/
|
2608
|
-
readonly area:
|
2511
|
+
readonly area: BoundingBox
|
2609
2512
|
/**
|
2610
2513
|
* The item used to select the area.
|
2611
2514
|
*/
|
@@ -2630,8 +2533,7 @@ interface OnPlayerReverseSelectedAreaEvent extends EventData {
|
|
2630
2533
|
|
2631
2534
|
/**
|
2632
2535
|
* 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.
|
2633
|
-
*
|
2634
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_rotated_entity View documentation}
|
2536
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_rotated_entity Online documentation}
|
2635
2537
|
*/
|
2636
2538
|
interface OnPlayerRotatedEntityEvent extends EventData {
|
2637
2539
|
/**
|
@@ -2655,8 +2557,7 @@ interface OnPlayerRotatedEntityEvent extends EventData {
|
|
2655
2557
|
|
2656
2558
|
/**
|
2657
2559
|
* Called after a player selects an area with a selection-tool item.
|
2658
|
-
*
|
2659
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_selected_area View documentation}
|
2560
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_selected_area Online documentation}
|
2660
2561
|
*/
|
2661
2562
|
interface OnPlayerSelectedAreaEvent extends EventData {
|
2662
2563
|
/**
|
@@ -2670,7 +2571,7 @@ interface OnPlayerSelectedAreaEvent extends EventData {
|
|
2670
2571
|
/**
|
2671
2572
|
* The area selected.
|
2672
2573
|
*/
|
2673
|
-
readonly area:
|
2574
|
+
readonly area: BoundingBox
|
2674
2575
|
/**
|
2675
2576
|
* The item used to select the area.
|
2676
2577
|
*/
|
@@ -2695,8 +2596,7 @@ interface OnPlayerSelectedAreaEvent extends EventData {
|
|
2695
2596
|
|
2696
2597
|
/**
|
2697
2598
|
* Called when a player sets a quickbar slot to anything (new value, or set to empty).
|
2698
|
-
*
|
2699
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_set_quick_bar_slot View documentation}
|
2599
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_set_quick_bar_slot Online documentation}
|
2700
2600
|
*/
|
2701
2601
|
interface OnPlayerSetQuickBarSlotEvent extends EventData {
|
2702
2602
|
readonly player_index: PlayerIndex
|
@@ -2712,8 +2612,7 @@ interface OnPlayerSetQuickBarSlotEvent extends EventData {
|
|
2712
2612
|
|
2713
2613
|
/**
|
2714
2614
|
* Called when a player selects an area with a blueprint.
|
2715
|
-
*
|
2716
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_setup_blueprint View documentation}
|
2615
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_setup_blueprint Online documentation}
|
2717
2616
|
*/
|
2718
2617
|
interface OnPlayerSetupBlueprintEvent extends EventData {
|
2719
2618
|
/**
|
@@ -2727,7 +2626,7 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
|
|
2727
2626
|
/**
|
2728
2627
|
* The area selected.
|
2729
2628
|
*/
|
2730
|
-
readonly area:
|
2629
|
+
readonly area: BoundingBox
|
2731
2630
|
/**
|
2732
2631
|
* The item used to select the area.
|
2733
2632
|
*/
|
@@ -2752,8 +2651,7 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
|
|
2752
2651
|
|
2753
2652
|
/**
|
2754
2653
|
* Called when a player toggles alt mode, also known as "show entity info".
|
2755
|
-
*
|
2756
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_alt_mode View documentation}
|
2654
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_alt_mode Online documentation}
|
2757
2655
|
*/
|
2758
2656
|
interface OnPlayerToggledAltModeEvent extends EventData {
|
2759
2657
|
readonly player_index: PlayerIndex
|
@@ -2773,8 +2671,7 @@ interface OnPlayerToggledAltModeEvent extends EventData {
|
|
2773
2671
|
|
2774
2672
|
/**
|
2775
2673
|
* Called when a player toggles the map editor on or off.
|
2776
|
-
*
|
2777
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_map_editor View documentation}
|
2674
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_map_editor Online documentation}
|
2778
2675
|
*/
|
2779
2676
|
interface OnPlayerToggledMapEditorEvent extends EventData {
|
2780
2677
|
readonly player_index: PlayerIndex
|
@@ -2790,8 +2687,7 @@ interface OnPlayerToggledMapEditorEvent extends EventData {
|
|
2790
2687
|
|
2791
2688
|
/**
|
2792
2689
|
* Called after a players trash inventory changed in some way.
|
2793
|
-
*
|
2794
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_trash_inventory_changed View documentation}
|
2690
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_trash_inventory_changed Online documentation}
|
2795
2691
|
*/
|
2796
2692
|
interface OnPlayerTrashInventoryChangedEvent extends EventData {
|
2797
2693
|
readonly player_index: PlayerIndex
|
@@ -2807,8 +2703,7 @@ interface OnPlayerTrashInventoryChangedEvent extends EventData {
|
|
2807
2703
|
|
2808
2704
|
/**
|
2809
2705
|
* Called when a player is un-banned.
|
2810
|
-
*
|
2811
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_unbanned View documentation}
|
2706
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_unbanned Online documentation}
|
2812
2707
|
*/
|
2813
2708
|
interface OnPlayerUnbannedEvent extends EventData {
|
2814
2709
|
/**
|
@@ -2839,8 +2734,7 @@ interface OnPlayerUnbannedEvent extends EventData {
|
|
2839
2734
|
|
2840
2735
|
/**
|
2841
2736
|
* Called when a player is unmuted.
|
2842
|
-
*
|
2843
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_unmuted View documentation}
|
2737
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_unmuted Online documentation}
|
2844
2738
|
*/
|
2845
2739
|
interface OnPlayerUnmutedEvent extends EventData {
|
2846
2740
|
/**
|
@@ -2859,8 +2753,7 @@ interface OnPlayerUnmutedEvent extends EventData {
|
|
2859
2753
|
|
2860
2754
|
/**
|
2861
2755
|
* Called when a player uses a capsule that results in some game action.
|
2862
|
-
*
|
2863
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_used_capsule View documentation}
|
2756
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_used_capsule Online documentation}
|
2864
2757
|
*/
|
2865
2758
|
interface OnPlayerUsedCapsuleEvent extends EventData {
|
2866
2759
|
/**
|
@@ -2874,7 +2767,7 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
|
|
2874
2767
|
/**
|
2875
2768
|
* The position the capsule was used.
|
2876
2769
|
*/
|
2877
|
-
readonly position:
|
2770
|
+
readonly position: MapPosition
|
2878
2771
|
/**
|
2879
2772
|
* Identifier of the event
|
2880
2773
|
*/
|
@@ -2887,8 +2780,7 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
|
|
2887
2780
|
|
2888
2781
|
/**
|
2889
2782
|
* Called when a player uses spidertron remote to send a spidertron to a given position
|
2890
|
-
*
|
2891
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_player_used_spider_remote View documentation}
|
2783
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_player_used_spider_remote Online documentation}
|
2892
2784
|
*/
|
2893
2785
|
interface OnPlayerUsedSpiderRemoteEvent extends EventData {
|
2894
2786
|
/**
|
@@ -2902,7 +2794,7 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
|
|
2902
2794
|
/**
|
2903
2795
|
* Goal position to which spidertron was sent to.
|
2904
2796
|
*/
|
2905
|
-
readonly position:
|
2797
|
+
readonly position: MapPosition
|
2906
2798
|
/**
|
2907
2799
|
* If the use was successful. It may fail when spidertron has different driver or when player is on different surface.
|
2908
2800
|
*/
|
@@ -2919,8 +2811,7 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
|
|
2919
2811
|
|
2920
2812
|
/**
|
2921
2813
|
* Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter}.
|
2922
|
-
*
|
2923
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_post_entity_died View documentation}
|
2814
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_post_entity_died Online documentation}
|
2924
2815
|
*/
|
2925
2816
|
interface OnPostEntityDiedEvent extends EventData {
|
2926
2817
|
/**
|
@@ -2934,7 +2825,7 @@ interface OnPostEntityDiedEvent extends EventData {
|
|
2934
2825
|
/**
|
2935
2826
|
* Position where the entity died.
|
2936
2827
|
*/
|
2937
|
-
readonly position:
|
2828
|
+
readonly position: MapPosition
|
2938
2829
|
/**
|
2939
2830
|
* The entity prototype of the entity that died.
|
2940
2831
|
*/
|
@@ -2967,8 +2858,7 @@ interface OnPostEntityDiedEvent extends EventData {
|
|
2967
2858
|
|
2968
2859
|
/**
|
2969
2860
|
* Called when players uses an item to build something. Called before {@link OnBuiltEntityEvent on_built_entity}.
|
2970
|
-
*
|
2971
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_build View documentation}
|
2861
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_build Online documentation}
|
2972
2862
|
*/
|
2973
2863
|
interface OnPreBuildEvent extends EventData {
|
2974
2864
|
/**
|
@@ -2978,7 +2868,7 @@ interface OnPreBuildEvent extends EventData {
|
|
2978
2868
|
/**
|
2979
2869
|
* Where the item was placed.
|
2980
2870
|
*/
|
2981
|
-
readonly position:
|
2871
|
+
readonly position: MapPosition
|
2982
2872
|
/**
|
2983
2873
|
* Item was placed using shift building.
|
2984
2874
|
*/
|
@@ -3011,15 +2901,14 @@ interface OnPreBuildEvent extends EventData {
|
|
3011
2901
|
|
3012
2902
|
/**
|
3013
2903
|
* Called before one or more chunks are deleted using {@link LuaSurface#delete_chunk LuaSurface::delete_chunk}.
|
3014
|
-
*
|
3015
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_chunk_deleted View documentation}
|
2904
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_chunk_deleted Online documentation}
|
3016
2905
|
*/
|
3017
2906
|
interface OnPreChunkDeletedEvent extends EventData {
|
3018
2907
|
readonly surface_index: SurfaceIndex
|
3019
2908
|
/**
|
3020
2909
|
* The chunks to be deleted.
|
3021
2910
|
*/
|
3022
|
-
readonly positions:
|
2911
|
+
readonly positions: ChunkPosition[]
|
3023
2912
|
/**
|
3024
2913
|
* Identifier of the event
|
3025
2914
|
*/
|
@@ -3032,8 +2921,7 @@ interface OnPreChunkDeletedEvent extends EventData {
|
|
3032
2921
|
|
3033
2922
|
/**
|
3034
2923
|
* Called before entity copy-paste is done.
|
3035
|
-
*
|
3036
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_entity_settings_pasted View documentation}
|
2924
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_entity_settings_pasted Online documentation}
|
3037
2925
|
*/
|
3038
2926
|
interface OnPreEntitySettingsPastedEvent extends EventData {
|
3039
2927
|
readonly player_index: PlayerIndex
|
@@ -3057,8 +2945,7 @@ interface OnPreEntitySettingsPastedEvent extends EventData {
|
|
3057
2945
|
|
3058
2946
|
/**
|
3059
2947
|
* Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using {@link LuaPreGhostDeconstructedEventFilter}.
|
3060
|
-
*
|
3061
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_ghost_deconstructed View documentation}
|
2948
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_ghost_deconstructed Online documentation}
|
3062
2949
|
*/
|
3063
2950
|
interface OnPreGhostDeconstructedEvent extends EventData {
|
3064
2951
|
/**
|
@@ -3076,10 +2963,29 @@ interface OnPreGhostDeconstructedEvent extends EventData {
|
|
3076
2963
|
readonly tick: uint
|
3077
2964
|
}
|
3078
2965
|
|
2966
|
+
/**
|
2967
|
+
* Called before a ghost entity is upgraded. Can be filtered using {@link LuaPreGhostUpgradedEventFilter}.
|
2968
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_ghost_upgraded Online documentation}
|
2969
|
+
*/
|
2970
|
+
interface OnPreGhostUpgradedEvent extends EventData {
|
2971
|
+
/**
|
2972
|
+
* The player that did the upgrade if any.
|
2973
|
+
*/
|
2974
|
+
readonly player_index?: PlayerIndex
|
2975
|
+
readonly ghost: LuaEntity
|
2976
|
+
/**
|
2977
|
+
* Identifier of the event
|
2978
|
+
*/
|
2979
|
+
readonly name: typeof defines.events.on_pre_ghost_upgraded
|
2980
|
+
/**
|
2981
|
+
* Tick the event was generated.
|
2982
|
+
*/
|
2983
|
+
readonly tick: uint
|
2984
|
+
}
|
2985
|
+
|
3079
2986
|
/**
|
3080
2987
|
* Called directly before a permission group is deleted.
|
3081
|
-
*
|
3082
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_group_deleted View documentation}
|
2988
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_group_deleted Online documentation}
|
3083
2989
|
*/
|
3084
2990
|
interface OnPrePermissionGroupDeletedEvent extends EventData {
|
3085
2991
|
/**
|
@@ -3102,8 +3008,7 @@ interface OnPrePermissionGroupDeletedEvent extends EventData {
|
|
3102
3008
|
|
3103
3009
|
/**
|
3104
3010
|
* Called directly before a permission string is imported.
|
3105
|
-
*
|
3106
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_string_imported View documentation}
|
3011
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_string_imported Online documentation}
|
3107
3012
|
*/
|
3108
3013
|
interface OnPrePermissionStringImportedEvent extends EventData {
|
3109
3014
|
/**
|
@@ -3122,8 +3027,7 @@ interface OnPrePermissionStringImportedEvent extends EventData {
|
|
3122
3027
|
|
3123
3028
|
/**
|
3124
3029
|
* Called when a player queues something to be crafted.
|
3125
|
-
*
|
3126
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_crafted_item View documentation}
|
3030
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_crafted_item Online documentation}
|
3127
3031
|
*/
|
3128
3032
|
interface OnPrePlayerCraftedItemEvent extends EventData {
|
3129
3033
|
/**
|
@@ -3154,8 +3058,7 @@ interface OnPrePlayerCraftedItemEvent extends EventData {
|
|
3154
3058
|
|
3155
3059
|
/**
|
3156
3060
|
* Called before a players dies.
|
3157
|
-
*
|
3158
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_died View documentation}
|
3061
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_died Online documentation}
|
3159
3062
|
*/
|
3160
3063
|
interface OnPrePlayerDiedEvent extends EventData {
|
3161
3064
|
readonly player_index: PlayerIndex
|
@@ -3172,8 +3075,7 @@ interface OnPrePlayerDiedEvent extends EventData {
|
|
3172
3075
|
|
3173
3076
|
/**
|
3174
3077
|
* Called before a player leaves the game.
|
3175
|
-
*
|
3176
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_left_game View documentation}
|
3078
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_left_game Online documentation}
|
3177
3079
|
*/
|
3178
3080
|
interface OnPrePlayerLeftGameEvent extends EventData {
|
3179
3081
|
readonly player_index: PlayerIndex
|
@@ -3190,8 +3092,7 @@ interface OnPrePlayerLeftGameEvent extends EventData {
|
|
3190
3092
|
|
3191
3093
|
/**
|
3192
3094
|
* Called when the player finishes mining an entity, before the entity is removed from map. Can be filtered using {@link LuaPrePlayerMinedEntityEventFilter}.
|
3193
|
-
*
|
3194
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_mined_item View documentation}
|
3095
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_mined_item Online documentation}
|
3195
3096
|
*/
|
3196
3097
|
interface OnPrePlayerMinedItemEvent extends EventData {
|
3197
3098
|
/**
|
@@ -3211,8 +3112,7 @@ interface OnPrePlayerMinedItemEvent extends EventData {
|
|
3211
3112
|
|
3212
3113
|
/**
|
3213
3114
|
* Called before a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.
|
3214
|
-
*
|
3215
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_removed View documentation}
|
3115
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_removed Online documentation}
|
3216
3116
|
*/
|
3217
3117
|
interface OnPrePlayerRemovedEvent extends EventData {
|
3218
3118
|
/**
|
@@ -3231,8 +3131,7 @@ interface OnPrePlayerRemovedEvent extends EventData {
|
|
3231
3131
|
|
3232
3132
|
/**
|
3233
3133
|
* Called before a player toggles the map editor on or off.
|
3234
|
-
*
|
3235
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_toggled_map_editor View documentation}
|
3134
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_toggled_map_editor Online documentation}
|
3236
3135
|
*/
|
3237
3136
|
interface OnPrePlayerToggledMapEditorEvent extends EventData {
|
3238
3137
|
readonly player_index: PlayerIndex
|
@@ -3248,8 +3147,7 @@ interface OnPrePlayerToggledMapEditorEvent extends EventData {
|
|
3248
3147
|
|
3249
3148
|
/**
|
3250
3149
|
* Called directly before a robot explodes cliffs.
|
3251
|
-
*
|
3252
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_robot_exploded_cliff View documentation}
|
3150
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_robot_exploded_cliff Online documentation}
|
3253
3151
|
*/
|
3254
3152
|
interface OnPreRobotExplodedCliffEvent extends EventData {
|
3255
3153
|
readonly robot: LuaEntity
|
@@ -3270,8 +3168,7 @@ interface OnPreRobotExplodedCliffEvent extends EventData {
|
|
3270
3168
|
|
3271
3169
|
/**
|
3272
3170
|
* Called just before a script inventory is resized.
|
3273
|
-
*
|
3274
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_script_inventory_resized View documentation}
|
3171
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_script_inventory_resized Online documentation}
|
3275
3172
|
*/
|
3276
3173
|
interface OnPreScriptInventoryResizedEvent extends EventData {
|
3277
3174
|
/**
|
@@ -3303,8 +3200,7 @@ interface OnPreScriptInventoryResizedEvent extends EventData {
|
|
3303
3200
|
|
3304
3201
|
/**
|
3305
3202
|
* Called just before a surface is cleared (all entities removed and all chunks deleted).
|
3306
|
-
*
|
3307
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_cleared View documentation}
|
3203
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_cleared Online documentation}
|
3308
3204
|
*/
|
3309
3205
|
interface OnPreSurfaceClearedEvent extends EventData {
|
3310
3206
|
readonly surface_index: SurfaceIndex
|
@@ -3320,8 +3216,7 @@ interface OnPreSurfaceClearedEvent extends EventData {
|
|
3320
3216
|
|
3321
3217
|
/**
|
3322
3218
|
* Called just before a surface is deleted.
|
3323
|
-
*
|
3324
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_deleted View documentation}
|
3219
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_deleted Online documentation}
|
3325
3220
|
*/
|
3326
3221
|
interface OnPreSurfaceDeletedEvent extends EventData {
|
3327
3222
|
readonly surface_index: SurfaceIndex
|
@@ -3337,8 +3232,7 @@ interface OnPreSurfaceDeletedEvent extends EventData {
|
|
3337
3232
|
|
3338
3233
|
/**
|
3339
3234
|
* Called when research is cancelled.
|
3340
|
-
*
|
3341
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_research_cancelled View documentation}
|
3235
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_research_cancelled Online documentation}
|
3342
3236
|
*/
|
3343
3237
|
interface OnResearchCancelledEvent extends EventData {
|
3344
3238
|
/**
|
@@ -3361,8 +3255,7 @@ interface OnResearchCancelledEvent extends EventData {
|
|
3361
3255
|
|
3362
3256
|
/**
|
3363
3257
|
* Called when a research finishes.
|
3364
|
-
*
|
3365
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_research_finished View documentation}
|
3258
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_research_finished Online documentation}
|
3366
3259
|
*/
|
3367
3260
|
interface OnResearchFinishedEvent extends EventData {
|
3368
3261
|
/**
|
@@ -3385,8 +3278,7 @@ interface OnResearchFinishedEvent extends EventData {
|
|
3385
3278
|
|
3386
3279
|
/**
|
3387
3280
|
* Called when a research is reversed (unresearched).
|
3388
|
-
*
|
3389
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_research_reversed View documentation}
|
3281
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_research_reversed Online documentation}
|
3390
3282
|
*/
|
3391
3283
|
interface OnResearchReversedEvent extends EventData {
|
3392
3284
|
/**
|
@@ -3409,8 +3301,7 @@ interface OnResearchReversedEvent extends EventData {
|
|
3409
3301
|
|
3410
3302
|
/**
|
3411
3303
|
* Called when a technology research starts.
|
3412
|
-
*
|
3413
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_research_started View documentation}
|
3304
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_research_started Online documentation}
|
3414
3305
|
*/
|
3415
3306
|
interface OnResearchStartedEvent extends EventData {
|
3416
3307
|
/**
|
@@ -3430,8 +3321,7 @@ interface OnResearchStartedEvent extends EventData {
|
|
3430
3321
|
|
3431
3322
|
/**
|
3432
3323
|
* Called when a resource entity reaches 0 or its minimum yield for infinite resources.
|
3433
|
-
*
|
3434
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_resource_depleted View documentation}
|
3324
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_resource_depleted Online documentation}
|
3435
3325
|
*/
|
3436
3326
|
interface OnResourceDepletedEvent extends EventData {
|
3437
3327
|
readonly entity: LuaEntity
|
@@ -3447,8 +3337,7 @@ interface OnResourceDepletedEvent extends EventData {
|
|
3447
3337
|
|
3448
3338
|
/**
|
3449
3339
|
* Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter}.
|
3450
|
-
*
|
3451
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_entity View documentation}
|
3340
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_entity Online documentation}
|
3452
3341
|
*/
|
3453
3342
|
interface OnRobotBuiltEntityEvent extends EventData {
|
3454
3343
|
/**
|
@@ -3479,8 +3368,7 @@ interface OnRobotBuiltEntityEvent extends EventData {
|
|
3479
3368
|
|
3480
3369
|
/**
|
3481
3370
|
* Called after a robot builds tiles.
|
3482
|
-
*
|
3483
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_tile View documentation}
|
3371
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_tile Online documentation}
|
3484
3372
|
*/
|
3485
3373
|
interface OnRobotBuiltTileEvent extends EventData {
|
3486
3374
|
/**
|
@@ -3519,8 +3407,7 @@ interface OnRobotBuiltTileEvent extends EventData {
|
|
3519
3407
|
|
3520
3408
|
/**
|
3521
3409
|
* Called directly after a robot explodes cliffs.
|
3522
|
-
*
|
3523
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_exploded_cliff View documentation}
|
3410
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_exploded_cliff Online documentation}
|
3524
3411
|
*/
|
3525
3412
|
interface OnRobotExplodedCliffEvent extends EventData {
|
3526
3413
|
readonly robot: LuaEntity
|
@@ -3540,8 +3427,7 @@ interface OnRobotExplodedCliffEvent extends EventData {
|
|
3540
3427
|
|
3541
3428
|
/**
|
3542
3429
|
* Called when a robot mines an entity.
|
3543
|
-
*
|
3544
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined View documentation}
|
3430
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined Online documentation}
|
3545
3431
|
*/
|
3546
3432
|
interface OnRobotMinedEvent extends EventData {
|
3547
3433
|
/**
|
@@ -3564,9 +3450,8 @@ interface OnRobotMinedEvent extends EventData {
|
|
3564
3450
|
|
3565
3451
|
/**
|
3566
3452
|
* Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the robot as if they came from mining the entity. Can be filtered using {@link LuaRobotMinedEntityEventFilter}.
|
3567
|
-
*
|
3568
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_entity View documentation}
|
3569
3453
|
* @remarks 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.
|
3454
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_entity Online documentation}
|
3570
3455
|
*/
|
3571
3456
|
interface OnRobotMinedEntityEvent extends EventData {
|
3572
3457
|
/**
|
@@ -3593,8 +3478,7 @@ interface OnRobotMinedEntityEvent extends EventData {
|
|
3593
3478
|
|
3594
3479
|
/**
|
3595
3480
|
* Called after a robot mines tiles.
|
3596
|
-
*
|
3597
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_tile View documentation}
|
3481
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_tile Online documentation}
|
3598
3482
|
*/
|
3599
3483
|
interface OnRobotMinedTileEvent extends EventData {
|
3600
3484
|
/**
|
@@ -3621,8 +3505,7 @@ interface OnRobotMinedTileEvent extends EventData {
|
|
3621
3505
|
|
3622
3506
|
/**
|
3623
3507
|
* Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter}.
|
3624
|
-
*
|
3625
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_pre_mined View documentation}
|
3508
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_robot_pre_mined Online documentation}
|
3626
3509
|
*/
|
3627
3510
|
interface OnRobotPreMinedEvent extends EventData {
|
3628
3511
|
/**
|
@@ -3645,8 +3528,7 @@ interface OnRobotPreMinedEvent extends EventData {
|
|
3645
3528
|
|
3646
3529
|
/**
|
3647
3530
|
* Called when a rocket silo is ordered to be launched.
|
3648
|
-
*
|
3649
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launch_ordered View documentation}
|
3531
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launch_ordered Online documentation}
|
3650
3532
|
*/
|
3651
3533
|
interface OnRocketLaunchOrderedEvent extends EventData {
|
3652
3534
|
readonly rocket: LuaEntity
|
@@ -3667,8 +3549,7 @@ interface OnRocketLaunchOrderedEvent extends EventData {
|
|
3667
3549
|
|
3668
3550
|
/**
|
3669
3551
|
* Called when the rocket is launched.
|
3670
|
-
*
|
3671
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launched View documentation}
|
3552
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launched Online documentation}
|
3672
3553
|
*/
|
3673
3554
|
interface OnRocketLaunchedEvent extends EventData {
|
3674
3555
|
readonly rocket: LuaEntity
|
@@ -3689,8 +3570,7 @@ interface OnRocketLaunchedEvent extends EventData {
|
|
3689
3570
|
|
3690
3571
|
/**
|
3691
3572
|
* Called when a runtime mod setting is changed by a player.
|
3692
|
-
*
|
3693
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_runtime_mod_setting_changed View documentation}
|
3573
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_runtime_mod_setting_changed Online documentation}
|
3694
3574
|
*/
|
3695
3575
|
interface OnRuntimeModSettingChangedEvent extends EventData {
|
3696
3576
|
/**
|
@@ -3717,8 +3597,7 @@ interface OnRuntimeModSettingChangedEvent extends EventData {
|
|
3717
3597
|
|
3718
3598
|
/**
|
3719
3599
|
* Called just after a script inventory is resized.
|
3720
|
-
*
|
3721
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_script_inventory_resized View documentation}
|
3600
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_script_inventory_resized Online documentation}
|
3722
3601
|
*/
|
3723
3602
|
interface OnScriptInventoryResizedEvent extends EventData {
|
3724
3603
|
/**
|
@@ -3754,8 +3633,7 @@ interface OnScriptInventoryResizedEvent extends EventData {
|
|
3754
3633
|
|
3755
3634
|
/**
|
3756
3635
|
* Called when a {@link LuaSurface#request_path LuaSurface::request_path} call completes.
|
3757
|
-
*
|
3758
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_script_path_request_finished View documentation}
|
3636
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_script_path_request_finished Online documentation}
|
3759
3637
|
*/
|
3760
3638
|
interface OnScriptPathRequestFinishedEvent extends EventData {
|
3761
3639
|
/**
|
@@ -3782,8 +3660,7 @@ interface OnScriptPathRequestFinishedEvent extends EventData {
|
|
3782
3660
|
|
3783
3661
|
/**
|
3784
3662
|
* Called when a script trigger effect is triggered.
|
3785
|
-
*
|
3786
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_script_trigger_effect View documentation}
|
3663
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_script_trigger_effect Online documentation}
|
3787
3664
|
*/
|
3788
3665
|
interface OnScriptTriggerEffectEvent extends EventData {
|
3789
3666
|
/**
|
@@ -3794,9 +3671,9 @@ interface OnScriptTriggerEffectEvent extends EventData {
|
|
3794
3671
|
* The surface the effect happened on.
|
3795
3672
|
*/
|
3796
3673
|
readonly surface_index: SurfaceIndex
|
3797
|
-
readonly source_position?:
|
3674
|
+
readonly source_position?: MapPosition
|
3798
3675
|
readonly source_entity?: LuaEntity
|
3799
|
-
readonly target_position?:
|
3676
|
+
readonly target_position?: MapPosition
|
3800
3677
|
readonly target_entity?: LuaEntity
|
3801
3678
|
/**
|
3802
3679
|
* Identifier of the event
|
@@ -3810,8 +3687,7 @@ interface OnScriptTriggerEffectEvent extends EventData {
|
|
3810
3687
|
|
3811
3688
|
/**
|
3812
3689
|
* Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using {@link LuaSectorScannedEventFilter}.
|
3813
|
-
*
|
3814
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_sector_scanned View documentation}
|
3690
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_sector_scanned Online documentation}
|
3815
3691
|
*/
|
3816
3692
|
interface OnSectorScannedEvent extends EventData {
|
3817
3693
|
/**
|
@@ -3821,11 +3697,11 @@ interface OnSectorScannedEvent extends EventData {
|
|
3821
3697
|
/**
|
3822
3698
|
* The chunk scanned.
|
3823
3699
|
*/
|
3824
|
-
readonly chunk_position:
|
3700
|
+
readonly chunk_position: ChunkPosition
|
3825
3701
|
/**
|
3826
3702
|
* Area of the scanned chunk.
|
3827
3703
|
*/
|
3828
|
-
readonly area:
|
3704
|
+
readonly area: BoundingBox
|
3829
3705
|
/**
|
3830
3706
|
* Identifier of the event
|
3831
3707
|
*/
|
@@ -3838,8 +3714,7 @@ interface OnSectorScannedEvent extends EventData {
|
|
3838
3714
|
|
3839
3715
|
/**
|
3840
3716
|
* Called after the selected entity changes for a given player.
|
3841
|
-
*
|
3842
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_selected_entity_changed View documentation}
|
3717
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_selected_entity_changed Online documentation}
|
3843
3718
|
*/
|
3844
3719
|
interface OnSelectedEntityChangedEvent extends EventData {
|
3845
3720
|
/**
|
@@ -3862,8 +3737,7 @@ interface OnSelectedEntityChangedEvent extends EventData {
|
|
3862
3737
|
|
3863
3738
|
/**
|
3864
3739
|
* Called when a spider finishes moving to its autopilot position.
|
3865
|
-
*
|
3866
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_spider_command_completed View documentation}
|
3740
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_spider_command_completed Online documentation}
|
3867
3741
|
*/
|
3868
3742
|
interface OnSpiderCommandCompletedEvent extends EventData {
|
3869
3743
|
/**
|
@@ -3882,8 +3756,7 @@ interface OnSpiderCommandCompletedEvent extends EventData {
|
|
3882
3756
|
|
3883
3757
|
/**
|
3884
3758
|
* Called when a translation request generated through {@link LuaPlayer#request_translation LuaPlayer::request_translation} is translated.
|
3885
|
-
*
|
3886
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_string_translated View documentation}
|
3759
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_string_translated Online documentation}
|
3887
3760
|
*/
|
3888
3761
|
interface OnStringTranslatedEvent extends EventData {
|
3889
3762
|
/**
|
@@ -3914,8 +3787,7 @@ interface OnStringTranslatedEvent extends EventData {
|
|
3914
3787
|
|
3915
3788
|
/**
|
3916
3789
|
* Called just after a surface is cleared (all entities removed and all chunks deleted).
|
3917
|
-
*
|
3918
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_cleared View documentation}
|
3790
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_cleared Online documentation}
|
3919
3791
|
*/
|
3920
3792
|
interface OnSurfaceClearedEvent extends EventData {
|
3921
3793
|
readonly surface_index: SurfaceIndex
|
@@ -3931,9 +3803,8 @@ interface OnSurfaceClearedEvent extends EventData {
|
|
3931
3803
|
|
3932
3804
|
/**
|
3933
3805
|
* Called when a surface is created.
|
3934
|
-
*
|
3935
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_created View documentation}
|
3936
3806
|
* @remarks This is not called when the default surface is created as it will always exist.
|
3807
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_created Online documentation}
|
3937
3808
|
*/
|
3938
3809
|
interface OnSurfaceCreatedEvent extends EventData {
|
3939
3810
|
readonly surface_index: SurfaceIndex
|
@@ -3949,8 +3820,7 @@ interface OnSurfaceCreatedEvent extends EventData {
|
|
3949
3820
|
|
3950
3821
|
/**
|
3951
3822
|
* Called after a surface is deleted.
|
3952
|
-
*
|
3953
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_deleted View documentation}
|
3823
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_deleted Online documentation}
|
3954
3824
|
*/
|
3955
3825
|
interface OnSurfaceDeletedEvent extends EventData {
|
3956
3826
|
readonly surface_index: SurfaceIndex
|
@@ -3966,8 +3836,7 @@ interface OnSurfaceDeletedEvent extends EventData {
|
|
3966
3836
|
|
3967
3837
|
/**
|
3968
3838
|
* Called after a surface is imported.
|
3969
|
-
*
|
3970
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_imported View documentation}
|
3839
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_imported Online documentation}
|
3971
3840
|
*/
|
3972
3841
|
interface OnSurfaceImportedEvent extends EventData {
|
3973
3842
|
readonly surface_index: SurfaceIndex
|
@@ -3987,8 +3856,7 @@ interface OnSurfaceImportedEvent extends EventData {
|
|
3987
3856
|
|
3988
3857
|
/**
|
3989
3858
|
* Called when a surface is renamed.
|
3990
|
-
*
|
3991
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_renamed View documentation}
|
3859
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_surface_renamed Online documentation}
|
3992
3860
|
*/
|
3993
3861
|
interface OnSurfaceRenamedEvent extends EventData {
|
3994
3862
|
readonly surface_index: SurfaceIndex
|
@@ -4006,8 +3874,7 @@ interface OnSurfaceRenamedEvent extends EventData {
|
|
4006
3874
|
|
4007
3875
|
/**
|
4008
3876
|
* Called when {@link LuaForce#reset_technology_effects LuaForce::reset_technology_effects} is finished.
|
4009
|
-
*
|
4010
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_technology_effects_reset View documentation}
|
3877
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_technology_effects_reset Online documentation}
|
4011
3878
|
*/
|
4012
3879
|
interface OnTechnologyEffectsResetEvent extends EventData {
|
4013
3880
|
readonly force: LuaForce
|
@@ -4023,8 +3890,7 @@ interface OnTechnologyEffectsResetEvent extends EventData {
|
|
4023
3890
|
|
4024
3891
|
/**
|
4025
3892
|
* It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
|
4026
|
-
*
|
4027
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_tick View documentation}
|
3893
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_tick Online documentation}
|
4028
3894
|
*/
|
4029
3895
|
interface OnTickEvent extends EventData {
|
4030
3896
|
/**
|
@@ -4039,8 +3905,7 @@ interface OnTickEvent extends EventData {
|
|
4039
3905
|
|
4040
3906
|
/**
|
4041
3907
|
* Called when a train changes state (started to stopped and vice versa)
|
4042
|
-
*
|
4043
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_train_changed_state View documentation}
|
3908
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_train_changed_state Online documentation}
|
4044
3909
|
*/
|
4045
3910
|
interface OnTrainChangedStateEvent extends EventData {
|
4046
3911
|
readonly train: LuaTrain
|
@@ -4057,8 +3922,7 @@ interface OnTrainChangedStateEvent extends EventData {
|
|
4057
3922
|
|
4058
3923
|
/**
|
4059
3924
|
* Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
|
4060
|
-
*
|
4061
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_train_created View documentation}
|
3925
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_train_created Online documentation}
|
4062
3926
|
*/
|
4063
3927
|
interface OnTrainCreatedEvent extends EventData {
|
4064
3928
|
readonly train: LuaTrain
|
@@ -4082,8 +3946,7 @@ interface OnTrainCreatedEvent extends EventData {
|
|
4082
3946
|
|
4083
3947
|
/**
|
4084
3948
|
* Called when a trains schedule is changed either by the player or through script.
|
4085
|
-
*
|
4086
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_train_schedule_changed View documentation}
|
3949
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_train_schedule_changed Online documentation}
|
4087
3950
|
*/
|
4088
3951
|
interface OnTrainScheduleChangedEvent extends EventData {
|
4089
3952
|
readonly train: LuaTrain
|
@@ -4103,8 +3966,7 @@ interface OnTrainScheduleChangedEvent extends EventData {
|
|
4103
3966
|
|
4104
3967
|
/**
|
4105
3968
|
* Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined `trigger_created_entity="true"`.
|
4106
|
-
*
|
4107
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_trigger_created_entity View documentation}
|
3969
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_trigger_created_entity Online documentation}
|
4108
3970
|
*/
|
4109
3971
|
interface OnTriggerCreatedEntityEvent extends EventData {
|
4110
3972
|
readonly entity: LuaEntity
|
@@ -4121,8 +3983,7 @@ interface OnTriggerCreatedEntityEvent extends EventData {
|
|
4121
3983
|
|
4122
3984
|
/**
|
4123
3985
|
* Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined `trigger_fired_artillery="true"`.
|
4124
|
-
*
|
4125
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_trigger_fired_artillery View documentation}
|
3986
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_trigger_fired_artillery Online documentation}
|
4126
3987
|
*/
|
4127
3988
|
interface OnTriggerFiredArtilleryEvent extends EventData {
|
4128
3989
|
readonly entity: LuaEntity
|
@@ -4139,8 +4000,7 @@ interface OnTriggerFiredArtilleryEvent extends EventData {
|
|
4139
4000
|
|
4140
4001
|
/**
|
4141
4002
|
* Called when a unit is added to a unit group.
|
4142
|
-
*
|
4143
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_unit_added_to_group View documentation}
|
4003
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_unit_added_to_group Online documentation}
|
4144
4004
|
*/
|
4145
4005
|
interface OnUnitAddedToGroupEvent extends EventData {
|
4146
4006
|
readonly unit: LuaEntity
|
@@ -4157,8 +4017,7 @@ interface OnUnitAddedToGroupEvent extends EventData {
|
|
4157
4017
|
|
4158
4018
|
/**
|
4159
4019
|
* Called when a new unit group is created, before any members are added to it.
|
4160
|
-
*
|
4161
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_created View documentation}
|
4020
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_created Online documentation}
|
4162
4021
|
*/
|
4163
4022
|
interface OnUnitGroupCreatedEvent extends EventData {
|
4164
4023
|
readonly group: LuaUnitGroup
|
@@ -4174,8 +4033,7 @@ interface OnUnitGroupCreatedEvent extends EventData {
|
|
4174
4033
|
|
4175
4034
|
/**
|
4176
4035
|
* Called when a unit group finishes gathering and starts executing its command.
|
4177
|
-
*
|
4178
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_finished_gathering View documentation}
|
4036
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_finished_gathering Online documentation}
|
4179
4037
|
*/
|
4180
4038
|
interface OnUnitGroupFinishedGatheringEvent extends EventData {
|
4181
4039
|
readonly group: LuaUnitGroup
|
@@ -4191,8 +4049,7 @@ interface OnUnitGroupFinishedGatheringEvent extends EventData {
|
|
4191
4049
|
|
4192
4050
|
/**
|
4193
4051
|
* Called when a unit is removed from a unit group.
|
4194
|
-
*
|
4195
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_unit_removed_from_group View documentation}
|
4052
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_unit_removed_from_group Online documentation}
|
4196
4053
|
*/
|
4197
4054
|
interface OnUnitRemovedFromGroupEvent extends EventData {
|
4198
4055
|
readonly unit: LuaEntity
|
@@ -4209,8 +4066,7 @@ interface OnUnitRemovedFromGroupEvent extends EventData {
|
|
4209
4066
|
|
4210
4067
|
/**
|
4211
4068
|
* Called when a worker (construction or logistic) robot expires through a lack of energy.
|
4212
|
-
*
|
4213
|
-
* {@link https://lua-api.factorio.com/latest/events.html#on_worker_robot_expired View documentation}
|
4069
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#on_worker_robot_expired Online documentation}
|
4214
4070
|
*/
|
4215
4071
|
interface OnWorkerRobotExpiredEvent extends EventData {
|
4216
4072
|
readonly robot: LuaEntity
|
@@ -4226,8 +4082,7 @@ interface OnWorkerRobotExpiredEvent extends EventData {
|
|
4226
4082
|
|
4227
4083
|
/**
|
4228
4084
|
* A static event mods can use to tell other mods they built something by script. This event is only raised if a mod does so with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event} or {@link LuaBootstrap#raise_script_built LuaBootstrap::raise_script_built}, or when `raise_built` is passed to {@link LuaSurface#create_entity LuaSurface::create_entity}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter}.
|
4229
|
-
*
|
4230
|
-
* {@link https://lua-api.factorio.com/latest/events.html#script_raised_built View documentation}
|
4085
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#script_raised_built Online documentation}
|
4231
4086
|
*/
|
4232
4087
|
interface ScriptRaisedBuiltEvent extends EventData {
|
4233
4088
|
/**
|
@@ -4246,8 +4101,7 @@ interface ScriptRaisedBuiltEvent extends EventData {
|
|
4246
4101
|
|
4247
4102
|
/**
|
4248
4103
|
* A static event mods can use to tell other mods they destroyed something by script. This event is only raised if a mod does so with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event} or {@link LuaBootstrap#raise_script_destroy LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to {@link LuaEntity#destroy LuaEntity::destroy}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter}.
|
4249
|
-
*
|
4250
|
-
* {@link https://lua-api.factorio.com/latest/events.html#script_raised_destroy View documentation}
|
4104
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#script_raised_destroy Online documentation}
|
4251
4105
|
*/
|
4252
4106
|
interface ScriptRaisedDestroyEvent extends EventData {
|
4253
4107
|
/**
|
@@ -4266,8 +4120,7 @@ interface ScriptRaisedDestroyEvent extends EventData {
|
|
4266
4120
|
|
4267
4121
|
/**
|
4268
4122
|
* A static event mods can use to tell other mods they revived something by script. This event is only raised if a mod does so with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event} or {@link LuaBootstrap#raise_script_revive LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to {@link LuaEntity#revive LuaEntity::revive}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter}.
|
4269
|
-
*
|
4270
|
-
* {@link https://lua-api.factorio.com/latest/events.html#script_raised_revive View documentation}
|
4123
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#script_raised_revive Online documentation}
|
4271
4124
|
*/
|
4272
4125
|
interface ScriptRaisedReviveEvent extends EventData {
|
4273
4126
|
/**
|
@@ -4290,8 +4143,7 @@ interface ScriptRaisedReviveEvent extends EventData {
|
|
4290
4143
|
|
4291
4144
|
/**
|
4292
4145
|
* 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}.
|
4293
|
-
*
|
4294
|
-
* {@link https://lua-api.factorio.com/latest/events.html#script_raised_set_tiles View documentation}
|
4146
|
+
* @see {@link https://lua-api.factorio.com/latest/events.html#script_raised_set_tiles Online documentation}
|
4295
4147
|
*/
|
4296
4148
|
interface ScriptRaisedSetTilesEvent extends EventData {
|
4297
4149
|
/**
|
@@ -4301,7 +4153,7 @@ interface ScriptRaisedSetTilesEvent extends EventData {
|
|
4301
4153
|
/**
|
4302
4154
|
* The tiles that were changed.
|
4303
4155
|
*/
|
4304
|
-
readonly tiles:
|
4156
|
+
readonly tiles: Tile[]
|
4305
4157
|
/**
|
4306
4158
|
* Identifier of the event
|
4307
4159
|
*/
|