typed-factorio 0.14.1 → 0.17.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Changelog.md +30 -6
- package/README.md +8 -3
- package/generated/classes.d.ts +13802 -8167
- package/generated/concepts.d.ts +98 -13
- package/generated/events.d.ts +201 -201
- package/generated/index.d.ts +1 -1
- package/generator/typescript-internal.d.ts +9 -0
- package/package.json +3 -3
- package/runtime/pairs.d.ts +8 -7
- package/runtime/util.d.ts +1 -5
package/generated/events.d.ts
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
/**
|
6
6
|
* Called when a {@link https://wiki.factorio.com/Prototype/CustomInput CustomInput} is activated.
|
7
7
|
*
|
8
|
-
* {@link https://lua-api.factorio.com/latest/
|
8
|
+
* {@link https://lua-api.factorio.com/latest/events.html#CustomInputEvent View documentation}
|
9
9
|
*/
|
10
10
|
interface CustomInputEvent extends EventData {
|
11
11
|
/** The player that activated the custom input. */
|
@@ -13,7 +13,7 @@ interface CustomInputEvent extends EventData {
|
|
13
13
|
/** The prototype name of the custom input that was activated. */
|
14
14
|
readonly input_name: string
|
15
15
|
/** The mouse cursor position when the custom input was activated. */
|
16
|
-
readonly cursor_position:
|
16
|
+
readonly cursor_position: PositionTable
|
17
17
|
/** Information about the prototype that is selected when the custom input is used. `nil` if none is selected. */
|
18
18
|
readonly selected_prototype?: SelectedPrototypeData
|
19
19
|
/** Identifier of the event */
|
@@ -25,7 +25,7 @@ interface CustomInputEvent extends EventData {
|
|
25
25
|
/**
|
26
26
|
* Called when a unit/group completes a command.
|
27
27
|
*
|
28
|
-
* {@link https://lua-api.factorio.com/latest/
|
28
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_ai_command_completed View documentation}
|
29
29
|
*/
|
30
30
|
interface OnAiCommandCompletedEvent extends EventData {
|
31
31
|
/** Unit_number/group_number of the unit/group which just completed a command. */
|
@@ -42,13 +42,13 @@ interface OnAiCommandCompletedEvent extends EventData {
|
|
42
42
|
/**
|
43
43
|
* Called when an area of the map is cloned.
|
44
44
|
*
|
45
|
-
* {@link https://lua-api.factorio.com/latest/
|
45
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_area_cloned View documentation}
|
46
46
|
*/
|
47
47
|
interface OnAreaClonedEvent extends EventData {
|
48
48
|
readonly source_surface: LuaSurface
|
49
|
-
readonly source_area:
|
49
|
+
readonly source_area: BoundingBoxRead
|
50
50
|
readonly destination_surface: LuaSurface
|
51
|
-
readonly destination_area:
|
51
|
+
readonly destination_area: BoundingBoxRead
|
52
52
|
readonly destination_force?: LuaForce
|
53
53
|
readonly clone_tiles: boolean
|
54
54
|
readonly clone_entities: boolean
|
@@ -67,7 +67,7 @@ interface OnAreaClonedEvent extends EventData {
|
|
67
67
|
* **Note**: This will be called multiple times for each migration, once for every biter that is sacrificed to build
|
68
68
|
* part of the new base.
|
69
69
|
*
|
70
|
-
* {@link https://lua-api.factorio.com/latest/
|
70
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_biter_base_built View documentation}
|
71
71
|
*/
|
72
72
|
interface OnBiterBaseBuiltEvent extends EventData {
|
73
73
|
/** The entity that was built. */
|
@@ -81,13 +81,13 @@ interface OnBiterBaseBuiltEvent extends EventData {
|
|
81
81
|
/**
|
82
82
|
* Called when a set of positions on the map is cloned.
|
83
83
|
*
|
84
|
-
* {@link https://lua-api.factorio.com/latest/
|
84
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_brush_cloned View documentation}
|
85
85
|
*/
|
86
86
|
interface OnBrushClonedEvent extends EventData {
|
87
|
-
readonly source_offset:
|
88
|
-
readonly destination_offset:
|
87
|
+
readonly source_offset: TilePositionTable
|
88
|
+
readonly destination_offset: TilePositionTable
|
89
89
|
readonly source_surface: LuaSurface
|
90
|
-
readonly source_positions:
|
90
|
+
readonly source_positions: TilePositionTable[]
|
91
91
|
readonly destination_surface: LuaSurface
|
92
92
|
readonly destination_force?: LuaForce
|
93
93
|
readonly clone_tiles: boolean
|
@@ -104,7 +104,7 @@ interface OnBrushClonedEvent extends EventData {
|
|
104
104
|
/**
|
105
105
|
* Called when a {@link defines.command.build_base} command reaches its destination, and before building starts.
|
106
106
|
*
|
107
|
-
* {@link https://lua-api.factorio.com/latest/
|
107
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_build_base_arrived View documentation}
|
108
108
|
*/
|
109
109
|
interface OnBuildBaseArrivedEvent extends EventData {
|
110
110
|
/** The unit the command was assigned to. */
|
@@ -120,7 +120,7 @@ interface OnBuildBaseArrivedEvent extends EventData {
|
|
120
120
|
/**
|
121
121
|
* Called when player builds something. Can be filtered using {@link LuaPlayerBuiltEntityEventFilter}.
|
122
122
|
*
|
123
|
-
* {@link https://lua-api.factorio.com/latest/
|
123
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_built_entity View documentation}
|
124
124
|
*/
|
125
125
|
interface OnBuiltEntityEvent extends EventData {
|
126
126
|
readonly created_entity: LuaEntity
|
@@ -140,7 +140,7 @@ interface OnBuiltEntityEvent extends EventData {
|
|
140
140
|
* Called when the deconstruction of an entity is canceled. Can be filtered using
|
141
141
|
* {@link LuaEntityDeconstructionCancelledEventFilter}.
|
142
142
|
*
|
143
|
-
* {@link https://lua-api.factorio.com/latest/
|
143
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_deconstruction View documentation}
|
144
144
|
*/
|
145
145
|
interface OnCancelledDeconstructionEvent extends EventData {
|
146
146
|
readonly entity: LuaEntity
|
@@ -154,7 +154,7 @@ interface OnCancelledDeconstructionEvent extends EventData {
|
|
154
154
|
/**
|
155
155
|
* Called when the upgrade of an entity is canceled. Can be filtered using {@link LuaUpgradeCancelledEventFilter}.
|
156
156
|
*
|
157
|
-
* {@link https://lua-api.factorio.com/latest/
|
157
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_cancelled_upgrade View documentation}
|
158
158
|
*/
|
159
159
|
interface OnCancelledUpgradeEvent extends EventData {
|
160
160
|
readonly entity: LuaEntity
|
@@ -170,7 +170,7 @@ interface OnCancelledUpgradeEvent extends EventData {
|
|
170
170
|
*
|
171
171
|
* **Note**: this is not called if the corpse is mined. See {@link defines.events.on_pre_player_mined_item} to detect that.
|
172
172
|
*
|
173
|
-
* {@link https://lua-api.factorio.com/latest/
|
173
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_character_corpse_expired View documentation}
|
174
174
|
*/
|
175
175
|
interface OnCharacterCorpseExpiredEvent extends EventData {
|
176
176
|
/** The corpse. */
|
@@ -184,7 +184,7 @@ interface OnCharacterCorpseExpiredEvent extends EventData {
|
|
184
184
|
/**
|
185
185
|
* Called when a chart tag is created.
|
186
186
|
*
|
187
|
-
* {@link https://lua-api.factorio.com/latest/
|
187
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_added View documentation}
|
188
188
|
*/
|
189
189
|
interface OnChartTagAddedEvent extends EventData {
|
190
190
|
readonly tag: LuaCustomChartTag
|
@@ -199,7 +199,7 @@ interface OnChartTagAddedEvent extends EventData {
|
|
199
199
|
/**
|
200
200
|
* Called when a chart tag is modified by a player.
|
201
201
|
*
|
202
|
-
* {@link https://lua-api.factorio.com/latest/
|
202
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_modified View documentation}
|
203
203
|
*/
|
204
204
|
interface OnChartTagModifiedEvent extends EventData {
|
205
205
|
readonly tag: LuaCustomChartTag
|
@@ -217,7 +217,7 @@ interface OnChartTagModifiedEvent extends EventData {
|
|
217
217
|
/**
|
218
218
|
* Called just before a chart tag is deleted.
|
219
219
|
*
|
220
|
-
* {@link https://lua-api.factorio.com/latest/
|
220
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_chart_tag_removed View documentation}
|
221
221
|
*/
|
222
222
|
interface OnChartTagRemovedEvent extends EventData {
|
223
223
|
readonly tag: LuaCustomChartTag
|
@@ -232,13 +232,13 @@ interface OnChartTagRemovedEvent extends EventData {
|
|
232
232
|
/**
|
233
233
|
* Called when a chunk is charted or re-charted.
|
234
234
|
*
|
235
|
-
* {@link https://lua-api.factorio.com/latest/
|
235
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_chunk_charted View documentation}
|
236
236
|
*/
|
237
237
|
interface OnChunkChartedEvent extends EventData {
|
238
238
|
readonly surface_index: uint
|
239
|
-
readonly position:
|
239
|
+
readonly position: ChunkPositionTable
|
240
240
|
/** Area of the chunk. */
|
241
|
-
readonly area:
|
241
|
+
readonly area: BoundingBoxRead
|
242
242
|
readonly force: LuaForce
|
243
243
|
/** Identifier of the event */
|
244
244
|
readonly name: typeof defines.events.on_chunk_charted
|
@@ -249,12 +249,12 @@ interface OnChunkChartedEvent extends EventData {
|
|
249
249
|
/**
|
250
250
|
* Called when one or more chunks are deleted using {@link LuaSurface.delete_chunk LuaSurface::delete_chunk}.
|
251
251
|
*
|
252
|
-
* {@link https://lua-api.factorio.com/latest/
|
252
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_chunk_deleted View documentation}
|
253
253
|
*/
|
254
254
|
interface OnChunkDeletedEvent extends EventData {
|
255
255
|
readonly surface_index: uint
|
256
256
|
/** The chunks deleted. */
|
257
|
-
readonly positions:
|
257
|
+
readonly positions: ChunkPositionTable[]
|
258
258
|
/** Identifier of the event */
|
259
259
|
readonly name: typeof defines.events.on_chunk_deleted
|
260
260
|
/** Tick the event was generated. */
|
@@ -264,13 +264,13 @@ interface OnChunkDeletedEvent extends EventData {
|
|
264
264
|
/**
|
265
265
|
* Called when a chunk is generated.
|
266
266
|
*
|
267
|
-
* {@link https://lua-api.factorio.com/latest/
|
267
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_chunk_generated View documentation}
|
268
268
|
*/
|
269
269
|
interface OnChunkGeneratedEvent extends EventData {
|
270
270
|
/** Area of the chunk. */
|
271
|
-
readonly area:
|
271
|
+
readonly area: BoundingBoxRead
|
272
272
|
/** Position of the chunk. */
|
273
|
-
readonly position:
|
273
|
+
readonly position: ChunkPositionTable
|
274
274
|
/** The surface the chunk is on. */
|
275
275
|
readonly surface: LuaSurface
|
276
276
|
/** Identifier of the event */
|
@@ -282,7 +282,7 @@ interface OnChunkGeneratedEvent extends EventData {
|
|
282
282
|
/**
|
283
283
|
* Called when a combat robot expires through a lack of energy, or timeout.
|
284
284
|
*
|
285
|
-
* {@link https://lua-api.factorio.com/latest/
|
285
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_combat_robot_expired View documentation}
|
286
286
|
*/
|
287
287
|
interface OnCombatRobotExpiredEvent extends EventData {
|
288
288
|
readonly robot: LuaEntity
|
@@ -299,7 +299,7 @@ interface OnCombatRobotExpiredEvent extends EventData {
|
|
299
299
|
*
|
300
300
|
* **Note**: This event only fires for plain messages, not for any commands (including `/shout` or `/whisper`).
|
301
301
|
*
|
302
|
-
* {@link https://lua-api.factorio.com/latest/
|
302
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_console_chat View documentation}
|
303
303
|
*/
|
304
304
|
interface OnConsoleChatEvent extends EventData {
|
305
305
|
/** The player doing the chatting, if any. */
|
@@ -315,7 +315,7 @@ interface OnConsoleChatEvent extends EventData {
|
|
315
315
|
/**
|
316
316
|
* Called when someone enters a command-like message regardless of it being a valid command.
|
317
317
|
*
|
318
|
-
* {@link https://lua-api.factorio.com/latest/
|
318
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_console_command View documentation}
|
319
319
|
*/
|
320
320
|
interface OnConsoleCommandEvent extends EventData {
|
321
321
|
/** The player if any. */
|
@@ -333,7 +333,7 @@ interface OnConsoleCommandEvent extends EventData {
|
|
333
333
|
/**
|
334
334
|
* Called when a cutscene is cancelled by the player or by script.
|
335
335
|
*
|
336
|
-
* {@link https://lua-api.factorio.com/latest/
|
336
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_cancelled View documentation}
|
337
337
|
*/
|
338
338
|
interface OnCutsceneCancelledEvent extends EventData {
|
339
339
|
/** The player the cutscene was shown to. */
|
@@ -351,7 +351,7 @@ interface OnCutsceneCancelledEvent extends EventData {
|
|
351
351
|
*
|
352
352
|
* **Note**: Due to implementation omission, waypoint_index is 0-based.
|
353
353
|
*
|
354
|
-
* {@link https://lua-api.factorio.com/latest/
|
354
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_cutscene_waypoint_reached View documentation}
|
355
355
|
*/
|
356
356
|
interface OnCutsceneWaypointReachedEvent extends EventData {
|
357
357
|
/** The player index of the player viewing the cutscene. */
|
@@ -369,7 +369,7 @@ interface OnCutsceneWaypointReachedEvent extends EventData {
|
|
369
369
|
*
|
370
370
|
* **Note**: It's not guaranteed that both settings are changed - just that at least one has been changed.
|
371
371
|
*
|
372
|
-
* {@link https://lua-api.factorio.com/latest/
|
372
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_difficulty_settings_changed View documentation}
|
373
373
|
*/
|
374
374
|
interface OnDifficultySettingsChangedEvent extends EventData {
|
375
375
|
readonly old_recipe_difficulty: uint
|
@@ -383,7 +383,7 @@ interface OnDifficultySettingsChangedEvent extends EventData {
|
|
383
383
|
/**
|
384
384
|
* Called when an entity is cloned. Can be filtered for the source entity using {@link LuaEntityClonedEventFilter}.
|
385
385
|
*
|
386
|
-
* {@link https://lua-api.factorio.com/latest/
|
386
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_cloned View documentation}
|
387
387
|
*/
|
388
388
|
interface OnEntityClonedEvent extends EventData {
|
389
389
|
readonly source: LuaEntity
|
@@ -399,7 +399,7 @@ interface OnEntityClonedEvent extends EventData {
|
|
399
399
|
*
|
400
400
|
* **Note**: This is not called when an entities health is set directly by another mod.
|
401
401
|
*
|
402
|
-
* {@link https://lua-api.factorio.com/latest/
|
402
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_damaged View documentation}
|
403
403
|
*/
|
404
404
|
interface OnEntityDamagedEvent extends EventData {
|
405
405
|
readonly entity: LuaEntity
|
@@ -427,7 +427,7 @@ interface OnEntityDamagedEvent extends EventData {
|
|
427
427
|
* **Note**: Depending on when a given entity is destroyed this will be fired at the end of the current tick or end of
|
428
428
|
* the next tick.
|
429
429
|
*
|
430
|
-
* {@link https://lua-api.factorio.com/latest/
|
430
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_destroyed View documentation}
|
431
431
|
*/
|
432
432
|
interface OnEntityDestroyedEvent extends EventData {
|
433
433
|
readonly registration_number: uint64
|
@@ -441,7 +441,7 @@ interface OnEntityDestroyedEvent extends EventData {
|
|
441
441
|
/**
|
442
442
|
* Called when an entity dies. Can be filtered using {@link LuaEntityDiedEventFilter}.
|
443
443
|
*
|
444
|
-
* {@link https://lua-api.factorio.com/latest/
|
444
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_died View documentation}
|
445
445
|
*/
|
446
446
|
interface OnEntityDiedEvent extends EventData {
|
447
447
|
/** The entity that died. */
|
@@ -466,7 +466,7 @@ interface OnEntityDiedEvent extends EventData {
|
|
466
466
|
* **Note**: "Personal logistic slot" refers to a character or vehicle's personal request / auto-trash slots, not the
|
467
467
|
* request slots on logistic chests.
|
468
468
|
*
|
469
|
-
* {@link https://lua-api.factorio.com/latest/
|
469
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_logistic_slot_changed View documentation}
|
470
470
|
*/
|
471
471
|
interface OnEntityLogisticSlotChangedEvent extends EventData {
|
472
472
|
/** The player who changed the slot, or `nil` if changed by script. */
|
@@ -484,7 +484,7 @@ interface OnEntityLogisticSlotChangedEvent extends EventData {
|
|
484
484
|
/**
|
485
485
|
* Called after an entity has been renamed either by the player or through script.
|
486
486
|
*
|
487
|
-
* {@link https://lua-api.factorio.com/latest/
|
487
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_renamed View documentation}
|
488
488
|
*/
|
489
489
|
interface OnEntityRenamedEvent extends EventData {
|
490
490
|
/** If by_script is true this will not be included. */
|
@@ -501,7 +501,7 @@ interface OnEntityRenamedEvent extends EventData {
|
|
501
501
|
/**
|
502
502
|
* Called after entity copy-paste is done.
|
503
503
|
*
|
504
|
-
* {@link https://lua-api.factorio.com/latest/
|
504
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_settings_pasted View documentation}
|
505
505
|
*/
|
506
506
|
interface OnEntitySettingsPastedEvent extends EventData {
|
507
507
|
readonly player_index: uint
|
@@ -518,7 +518,7 @@ interface OnEntitySettingsPastedEvent extends EventData {
|
|
518
518
|
/**
|
519
519
|
* Called when an entity is spawned by a EnemySpawner
|
520
520
|
*
|
521
|
-
* {@link https://lua-api.factorio.com/latest/
|
521
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_entity_spawned View documentation}
|
522
522
|
*/
|
523
523
|
interface OnEntitySpawnedEvent extends EventData {
|
524
524
|
readonly spawner: LuaEntity
|
@@ -532,7 +532,7 @@ interface OnEntitySpawnedEvent extends EventData {
|
|
532
532
|
/**
|
533
533
|
* Called after equipment is inserted into an equipment grid.
|
534
534
|
*
|
535
|
-
* {@link https://lua-api.factorio.com/latest/
|
535
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_equipment_inserted View documentation}
|
536
536
|
*/
|
537
537
|
interface OnEquipmentInsertedEvent extends EventData {
|
538
538
|
/** The equipment grid inserted into. */
|
@@ -548,7 +548,7 @@ interface OnEquipmentInsertedEvent extends EventData {
|
|
548
548
|
/**
|
549
549
|
* Called after equipment is removed from an equipment grid.
|
550
550
|
*
|
551
|
-
* {@link https://lua-api.factorio.com/latest/
|
551
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_equipment_removed View documentation}
|
552
552
|
*/
|
553
553
|
interface OnEquipmentRemovedEvent extends EventData {
|
554
554
|
/** The equipment grid removed from. */
|
@@ -566,7 +566,7 @@ interface OnEquipmentRemovedEvent extends EventData {
|
|
566
566
|
/**
|
567
567
|
* Called when the a forces cease fire values change.
|
568
568
|
*
|
569
|
-
* {@link https://lua-api.factorio.com/latest/
|
569
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_force_cease_fire_changed View documentation}
|
570
570
|
*/
|
571
571
|
interface OnForceCeaseFireChangedEvent extends EventData {
|
572
572
|
/** The force who's cease fire changed. */
|
@@ -587,7 +587,7 @@ interface OnForceCeaseFireChangedEvent extends EventData {
|
|
587
587
|
* **Note**: This is not called when the default forces (`'player'`, `'enemy'`, `'neutral'`) are created as they will
|
588
588
|
* always exist.
|
589
589
|
*
|
590
|
-
* {@link https://lua-api.factorio.com/latest/
|
590
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_force_created View documentation}
|
591
591
|
*/
|
592
592
|
interface OnForceCreatedEvent extends EventData {
|
593
593
|
/** The newly created force. */
|
@@ -601,7 +601,7 @@ interface OnForceCreatedEvent extends EventData {
|
|
601
601
|
/**
|
602
602
|
* Called when the a forces friends change.
|
603
603
|
*
|
604
|
-
* {@link https://lua-api.factorio.com/latest/
|
604
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_force_friends_changed View documentation}
|
605
605
|
*/
|
606
606
|
interface OnForceFriendsChangedEvent extends EventData {
|
607
607
|
/** The force who's friends changed. */
|
@@ -619,7 +619,7 @@ interface OnForceFriendsChangedEvent extends EventData {
|
|
619
619
|
/**
|
620
620
|
* Called when {@link LuaForce.reset LuaForce::reset} is finished.
|
621
621
|
*
|
622
|
-
* {@link https://lua-api.factorio.com/latest/
|
622
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_force_reset View documentation}
|
623
623
|
*/
|
624
624
|
interface OnForceResetEvent extends EventData {
|
625
625
|
readonly force: LuaForce
|
@@ -634,7 +634,7 @@ interface OnForceResetEvent extends EventData {
|
|
634
634
|
*
|
635
635
|
* **Note**: The source force is invalidated before this event is called and the name can be re-used in this event if desired.
|
636
636
|
*
|
637
|
-
* {@link https://lua-api.factorio.com/latest/
|
637
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_forces_merged View documentation}
|
638
638
|
*/
|
639
639
|
interface OnForcesMergedEvent extends EventData {
|
640
640
|
/** The force destroyed. */
|
@@ -652,7 +652,7 @@ interface OnForcesMergedEvent extends EventData {
|
|
652
652
|
/**
|
653
653
|
* Called when two forces are about to be merged using `game.merge_forces()`.
|
654
654
|
*
|
655
|
-
* {@link https://lua-api.factorio.com/latest/
|
655
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_forces_merging View documentation}
|
656
656
|
*/
|
657
657
|
interface OnForcesMergingEvent extends EventData {
|
658
658
|
/** The force to be destroyed */
|
@@ -671,7 +671,7 @@ interface OnForcesMergingEvent extends EventData {
|
|
671
671
|
*
|
672
672
|
* **Note**: This event is not fired when the scenario is loaded via the map editor.
|
673
673
|
*
|
674
|
-
* {@link https://lua-api.factorio.com/latest/
|
674
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_game_created_from_scenario View documentation}
|
675
675
|
*/
|
676
676
|
interface OnGameCreatedFromScenarioEvent extends EventData {
|
677
677
|
/** Identifier of the event */
|
@@ -683,7 +683,7 @@ interface OnGameCreatedFromScenarioEvent extends EventData {
|
|
683
683
|
/**
|
684
684
|
* Called when {@link LuaGuiElement} checked state is changed (related to checkboxes and radio buttons).
|
685
685
|
*
|
686
|
-
* {@link https://lua-api.factorio.com/latest/
|
686
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_checked_state_changed View documentation}
|
687
687
|
*/
|
688
688
|
interface OnGuiCheckedStateChangedEvent extends EventData {
|
689
689
|
/** The element whose checked state changed. */
|
@@ -699,7 +699,7 @@ interface OnGuiCheckedStateChangedEvent extends EventData {
|
|
699
699
|
/**
|
700
700
|
* Called when {@link LuaGuiElement} is clicked.
|
701
701
|
*
|
702
|
-
* {@link https://lua-api.factorio.com/latest/
|
702
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_click View documentation}
|
703
703
|
*/
|
704
704
|
interface OnGuiClickEvent extends EventData {
|
705
705
|
/** The clicked element. */
|
@@ -728,7 +728,7 @@ interface OnGuiClickEvent extends EventData {
|
|
728
728
|
* **Note**: It's not advised to open any other GUI during this event because if this is run as a request to open a
|
729
729
|
* different GUI the game will force close the new opened GUI without notice to ensure the original requested GUI is opened.
|
730
730
|
*
|
731
|
-
* {@link https://lua-api.factorio.com/latest/
|
731
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_closed View documentation}
|
732
732
|
*/
|
733
733
|
interface OnGuiClosedEvent extends EventData {
|
734
734
|
/** The player. */
|
@@ -748,7 +748,7 @@ interface OnGuiClosedEvent extends EventData {
|
|
748
748
|
/** The technology that was automatically selected when opening the research GUI */
|
749
749
|
readonly technology?: LuaTechnology
|
750
750
|
/** The tile position that was open */
|
751
|
-
readonly tile_position?:
|
751
|
+
readonly tile_position?: TilePositionTable
|
752
752
|
/** Identifier of the event */
|
753
753
|
readonly name: typeof defines.events.on_gui_closed
|
754
754
|
/** Tick the event was generated. */
|
@@ -758,7 +758,7 @@ interface OnGuiClosedEvent extends EventData {
|
|
758
758
|
/**
|
759
759
|
* Called when a {@link LuaGuiElement} is confirmed, for example by pressing Enter in a textfield.
|
760
760
|
*
|
761
|
-
* {@link https://lua-api.factorio.com/latest/
|
761
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_confirmed View documentation}
|
762
762
|
*/
|
763
763
|
interface OnGuiConfirmedEvent extends EventData {
|
764
764
|
/** The confirmed element. */
|
@@ -780,7 +780,7 @@ interface OnGuiConfirmedEvent extends EventData {
|
|
780
780
|
/**
|
781
781
|
* Called when {@link LuaGuiElement} element value is changed (related to choose element buttons).
|
782
782
|
*
|
783
|
-
* {@link https://lua-api.factorio.com/latest/
|
783
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_elem_changed View documentation}
|
784
784
|
*/
|
785
785
|
interface OnGuiElemChangedEvent extends EventData {
|
786
786
|
/** The element whose element value changed. */
|
@@ -796,7 +796,7 @@ interface OnGuiElemChangedEvent extends EventData {
|
|
796
796
|
/**
|
797
797
|
* Called when {@link LuaGuiElement} element location is changed (related to frames in `player.gui.screen`).
|
798
798
|
*
|
799
|
-
* {@link https://lua-api.factorio.com/latest/
|
799
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_location_changed View documentation}
|
800
800
|
*/
|
801
801
|
interface OnGuiLocationChangedEvent extends EventData {
|
802
802
|
/** The element whose location changed. */
|
@@ -812,7 +812,7 @@ interface OnGuiLocationChangedEvent extends EventData {
|
|
812
812
|
/**
|
813
813
|
* Called when the player opens a GUI.
|
814
814
|
*
|
815
|
-
* {@link https://lua-api.factorio.com/latest/
|
815
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_opened View documentation}
|
816
816
|
*/
|
817
817
|
interface OnGuiOpenedEvent extends EventData {
|
818
818
|
/** The player. */
|
@@ -838,7 +838,7 @@ interface OnGuiOpenedEvent extends EventData {
|
|
838
838
|
/**
|
839
839
|
* Called when {@link LuaGuiElement} selected tab is changed (related to tabbed-panes).
|
840
840
|
*
|
841
|
-
* {@link https://lua-api.factorio.com/latest/
|
841
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_selected_tab_changed View documentation}
|
842
842
|
*/
|
843
843
|
interface OnGuiSelectedTabChangedEvent extends EventData {
|
844
844
|
/** The tabbed pane whose selected tab changed. */
|
@@ -854,7 +854,7 @@ interface OnGuiSelectedTabChangedEvent extends EventData {
|
|
854
854
|
/**
|
855
855
|
* Called when {@link LuaGuiElement} selection state is changed (related to drop-downs and listboxes).
|
856
856
|
*
|
857
|
-
* {@link https://lua-api.factorio.com/latest/
|
857
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_selection_state_changed View documentation}
|
858
858
|
*/
|
859
859
|
interface OnGuiSelectionStateChangedEvent extends EventData {
|
860
860
|
/** The element whose selection state changed. */
|
@@ -870,7 +870,7 @@ interface OnGuiSelectionStateChangedEvent extends EventData {
|
|
870
870
|
/**
|
871
871
|
* Called when {@link LuaGuiElement} switch state is changed (related to switches).
|
872
872
|
*
|
873
|
-
* {@link https://lua-api.factorio.com/latest/
|
873
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_switch_state_changed View documentation}
|
874
874
|
*/
|
875
875
|
interface OnGuiSwitchStateChangedEvent extends EventData {
|
876
876
|
/** The switch whose switch state changed. */
|
@@ -886,7 +886,7 @@ interface OnGuiSwitchStateChangedEvent extends EventData {
|
|
886
886
|
/**
|
887
887
|
* Called when {@link LuaGuiElement} text is changed by the player.
|
888
888
|
*
|
889
|
-
* {@link https://lua-api.factorio.com/latest/
|
889
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_text_changed View documentation}
|
890
890
|
*/
|
891
891
|
interface OnGuiTextChangedEvent extends EventData {
|
892
892
|
/** The edited element. */
|
@@ -904,7 +904,7 @@ interface OnGuiTextChangedEvent extends EventData {
|
|
904
904
|
/**
|
905
905
|
* Called when {@link LuaGuiElement} slider value is changed (related to the slider element).
|
906
906
|
*
|
907
|
-
* {@link https://lua-api.factorio.com/latest/
|
907
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_gui_value_changed View documentation}
|
908
908
|
*/
|
909
909
|
interface OnGuiValueChangedEvent extends EventData {
|
910
910
|
/** The element whose value changed. */
|
@@ -920,7 +920,7 @@ interface OnGuiValueChangedEvent extends EventData {
|
|
920
920
|
/**
|
921
921
|
* Called when a land mine is armed.
|
922
922
|
*
|
923
|
-
* {@link https://lua-api.factorio.com/latest/
|
923
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_land_mine_armed View documentation}
|
924
924
|
*/
|
925
925
|
interface OnLandMineArmedEvent extends EventData {
|
926
926
|
readonly mine: LuaEntity
|
@@ -933,7 +933,7 @@ interface OnLandMineArmedEvent extends EventData {
|
|
933
933
|
/**
|
934
934
|
* Called when a custom Lua shortcut is pressed.
|
935
935
|
*
|
936
|
-
* {@link https://lua-api.factorio.com/latest/
|
936
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_lua_shortcut View documentation}
|
937
937
|
*/
|
938
938
|
interface OnLuaShortcutEvent extends EventData {
|
939
939
|
readonly player_index: uint
|
@@ -949,7 +949,7 @@ interface OnLuaShortcutEvent extends EventData {
|
|
949
949
|
* Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered
|
950
950
|
* using {@link LuaEntityMarkedForDeconstructionEventFilter}.
|
951
951
|
*
|
952
|
-
* {@link https://lua-api.factorio.com/latest/
|
952
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_deconstruction View documentation}
|
953
953
|
*/
|
954
954
|
interface OnMarkedForDeconstructionEvent extends EventData {
|
955
955
|
readonly entity: LuaEntity
|
@@ -964,7 +964,7 @@ interface OnMarkedForDeconstructionEvent extends EventData {
|
|
964
964
|
* Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using
|
965
965
|
* {@link LuaEntityMarkedForUpgradeEventFilter}.
|
966
966
|
*
|
967
|
-
* {@link https://lua-api.factorio.com/latest/
|
967
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_marked_for_upgrade View documentation}
|
968
968
|
*/
|
969
969
|
interface OnMarkedForUpgradeEvent extends EventData {
|
970
970
|
readonly entity: LuaEntity
|
@@ -981,7 +981,7 @@ interface OnMarkedForUpgradeEvent extends EventData {
|
|
981
981
|
/**
|
982
982
|
* Called after a player purchases some offer from a `market` entity.
|
983
983
|
*
|
984
|
-
* {@link https://lua-api.factorio.com/latest/
|
984
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_market_item_purchased View documentation}
|
985
985
|
*/
|
986
986
|
interface OnMarketItemPurchasedEvent extends EventData {
|
987
987
|
/** The player who did the purchasing. */
|
@@ -1001,7 +1001,7 @@ interface OnMarketItemPurchasedEvent extends EventData {
|
|
1001
1001
|
/**
|
1002
1002
|
* Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag
|
1003
1003
|
*
|
1004
|
-
* {@link https://lua-api.factorio.com/latest/
|
1004
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_mod_item_opened View documentation}
|
1005
1005
|
*/
|
1006
1006
|
interface OnModItemOpenedEvent extends EventData {
|
1007
1007
|
/** The player. */
|
@@ -1017,7 +1017,7 @@ interface OnModItemOpenedEvent extends EventData {
|
|
1017
1017
|
/**
|
1018
1018
|
* Called directly after a permission group is added.
|
1019
1019
|
*
|
1020
|
-
* {@link https://lua-api.factorio.com/latest/
|
1020
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_added View documentation}
|
1021
1021
|
*/
|
1022
1022
|
interface OnPermissionGroupAddedEvent extends EventData {
|
1023
1023
|
/** The player that added the group. */
|
@@ -1033,7 +1033,7 @@ interface OnPermissionGroupAddedEvent extends EventData {
|
|
1033
1033
|
/**
|
1034
1034
|
* Called directly after a permission group is deleted.
|
1035
1035
|
*
|
1036
|
-
* {@link https://lua-api.factorio.com/latest/
|
1036
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_deleted View documentation}
|
1037
1037
|
*/
|
1038
1038
|
interface OnPermissionGroupDeletedEvent extends EventData {
|
1039
1039
|
/** The player doing the deletion. */
|
@@ -1051,7 +1051,7 @@ interface OnPermissionGroupDeletedEvent extends EventData {
|
|
1051
1051
|
/**
|
1052
1052
|
* Called directly after a permission group is edited in some way.
|
1053
1053
|
*
|
1054
|
-
* {@link https://lua-api.factorio.com/latest/
|
1054
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_permission_group_edited View documentation}
|
1055
1055
|
*/
|
1056
1056
|
interface OnPermissionGroupEditedEvent extends EventData {
|
1057
1057
|
/** The player that did the editing. */
|
@@ -1084,7 +1084,7 @@ interface OnPermissionGroupEditedEvent extends EventData {
|
|
1084
1084
|
/**
|
1085
1085
|
* Called directly after a permission string is imported.
|
1086
1086
|
*
|
1087
|
-
* {@link https://lua-api.factorio.com/latest/
|
1087
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_permission_string_imported View documentation}
|
1088
1088
|
*/
|
1089
1089
|
interface OnPermissionStringImportedEvent extends EventData {
|
1090
1090
|
/** The player that imported the string. */
|
@@ -1098,7 +1098,7 @@ interface OnPermissionStringImportedEvent extends EventData {
|
|
1098
1098
|
/**
|
1099
1099
|
* Called when a player picks up an item.
|
1100
1100
|
*
|
1101
|
-
* {@link https://lua-api.factorio.com/latest/
|
1101
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_picked_up_item View documentation}
|
1102
1102
|
*/
|
1103
1103
|
interface OnPickedUpItemEvent extends EventData {
|
1104
1104
|
readonly item_stack: SimpleItemStack
|
@@ -1112,7 +1112,7 @@ interface OnPickedUpItemEvent extends EventData {
|
|
1112
1112
|
/**
|
1113
1113
|
* Called after a player alt-selects an area with a selection-tool item.
|
1114
1114
|
*
|
1115
|
-
* {@link https://lua-api.factorio.com/latest/
|
1115
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_alt_selected_area View documentation}
|
1116
1116
|
*/
|
1117
1117
|
interface OnPlayerAltSelectedAreaEvent extends EventData {
|
1118
1118
|
/** The player doing the selection. */
|
@@ -1120,7 +1120,7 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
|
|
1120
1120
|
/** The surface selected. */
|
1121
1121
|
readonly surface: LuaSurface
|
1122
1122
|
/** The area selected. */
|
1123
|
-
readonly area:
|
1123
|
+
readonly area: BoundingBoxRead
|
1124
1124
|
/** The item used to select the area. */
|
1125
1125
|
readonly item: string
|
1126
1126
|
/** The entities selected. */
|
@@ -1136,7 +1136,7 @@ interface OnPlayerAltSelectedAreaEvent extends EventData {
|
|
1136
1136
|
/**
|
1137
1137
|
* Called after a players ammo inventory changed in some way.
|
1138
1138
|
*
|
1139
|
-
* {@link https://lua-api.factorio.com/latest/
|
1139
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_ammo_inventory_changed View documentation}
|
1140
1140
|
*/
|
1141
1141
|
interface OnPlayerAmmoInventoryChangedEvent extends EventData {
|
1142
1142
|
readonly player_index: uint
|
@@ -1149,7 +1149,7 @@ interface OnPlayerAmmoInventoryChangedEvent extends EventData {
|
|
1149
1149
|
/**
|
1150
1150
|
* Called after a players armor inventory changed in some way.
|
1151
1151
|
*
|
1152
|
-
* {@link https://lua-api.factorio.com/latest/
|
1152
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_armor_inventory_changed View documentation}
|
1153
1153
|
*/
|
1154
1154
|
interface OnPlayerArmorInventoryChangedEvent extends EventData {
|
1155
1155
|
readonly player_index: uint
|
@@ -1162,7 +1162,7 @@ interface OnPlayerArmorInventoryChangedEvent extends EventData {
|
|
1162
1162
|
/**
|
1163
1163
|
* Called when a player is banned.
|
1164
1164
|
*
|
1165
|
-
* {@link https://lua-api.factorio.com/latest/
|
1165
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_banned View documentation}
|
1166
1166
|
*/
|
1167
1167
|
interface OnPlayerBannedEvent extends EventData {
|
1168
1168
|
/** The player banned. */
|
@@ -1182,7 +1182,7 @@ interface OnPlayerBannedEvent extends EventData {
|
|
1182
1182
|
/**
|
1183
1183
|
* Called after a player builds tiles.
|
1184
1184
|
*
|
1185
|
-
* {@link https://lua-api.factorio.com/latest/
|
1185
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_built_tile View documentation}
|
1186
1186
|
*/
|
1187
1187
|
interface OnPlayerBuiltTileEvent extends EventData {
|
1188
1188
|
readonly player_index: uint
|
@@ -1205,7 +1205,7 @@ interface OnPlayerBuiltTileEvent extends EventData {
|
|
1205
1205
|
/**
|
1206
1206
|
* Called when a player cancels crafting.
|
1207
1207
|
*
|
1208
|
-
* {@link https://lua-api.factorio.com/latest/
|
1208
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_cancelled_crafting View documentation}
|
1209
1209
|
*/
|
1210
1210
|
interface OnPlayerCancelledCraftingEvent extends EventData {
|
1211
1211
|
/** The player that did the crafting. */
|
@@ -1225,7 +1225,7 @@ interface OnPlayerCancelledCraftingEvent extends EventData {
|
|
1225
1225
|
/**
|
1226
1226
|
* Called after a player changes forces.
|
1227
1227
|
*
|
1228
|
-
* {@link https://lua-api.factorio.com/latest/
|
1228
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_force View documentation}
|
1229
1229
|
*/
|
1230
1230
|
interface OnPlayerChangedForceEvent extends EventData {
|
1231
1231
|
/** The player who changed forces. */
|
@@ -1241,7 +1241,7 @@ interface OnPlayerChangedForceEvent extends EventData {
|
|
1241
1241
|
/**
|
1242
1242
|
* Called when the tile position a player is located at changes.
|
1243
1243
|
*
|
1244
|
-
* {@link https://lua-api.factorio.com/latest/
|
1244
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_position View documentation}
|
1245
1245
|
*/
|
1246
1246
|
interface OnPlayerChangedPositionEvent extends EventData {
|
1247
1247
|
/** The player. */
|
@@ -1257,7 +1257,7 @@ interface OnPlayerChangedPositionEvent extends EventData {
|
|
1257
1257
|
*
|
1258
1258
|
* **Note**: In the instance a player is moved off a surface due to it being deleted this is not called.
|
1259
1259
|
*
|
1260
|
-
* {@link https://lua-api.factorio.com/latest/
|
1260
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_changed_surface View documentation}
|
1261
1261
|
*/
|
1262
1262
|
interface OnPlayerChangedSurfaceEvent extends EventData {
|
1263
1263
|
/** The player who changed surfaces. */
|
@@ -1273,7 +1273,7 @@ interface OnPlayerChangedSurfaceEvent extends EventData {
|
|
1273
1273
|
/**
|
1274
1274
|
* Called when cheat mode is disabled on a player.
|
1275
1275
|
*
|
1276
|
-
* {@link https://lua-api.factorio.com/latest/
|
1276
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_disabled View documentation}
|
1277
1277
|
*/
|
1278
1278
|
interface OnPlayerCheatModeDisabledEvent extends EventData {
|
1279
1279
|
/** The player. */
|
@@ -1287,7 +1287,7 @@ interface OnPlayerCheatModeDisabledEvent extends EventData {
|
|
1287
1287
|
/**
|
1288
1288
|
* Called when cheat mode is enabled on a player.
|
1289
1289
|
*
|
1290
|
-
* {@link https://lua-api.factorio.com/latest/
|
1290
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_cheat_mode_enabled View documentation}
|
1291
1291
|
*/
|
1292
1292
|
interface OnPlayerCheatModeEnabledEvent extends EventData {
|
1293
1293
|
/** The player. */
|
@@ -1301,13 +1301,13 @@ interface OnPlayerCheatModeEnabledEvent extends EventData {
|
|
1301
1301
|
/**
|
1302
1302
|
* Called when a player clicks a gps tag
|
1303
1303
|
*
|
1304
|
-
* {@link https://lua-api.factorio.com/latest/
|
1304
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_clicked_gps_tag View documentation}
|
1305
1305
|
*/
|
1306
1306
|
interface OnPlayerClickedGpsTagEvent extends EventData {
|
1307
1307
|
/** Index of the player */
|
1308
1308
|
readonly player_index: uint
|
1309
1309
|
/** Map position contained in gps tag */
|
1310
|
-
readonly position:
|
1310
|
+
readonly position: PositionTable
|
1311
1311
|
/** Surface name contained in gps tag, even when such surface does not exists */
|
1312
1312
|
readonly surface: string
|
1313
1313
|
/** Identifier of the event */
|
@@ -1319,7 +1319,7 @@ interface OnPlayerClickedGpsTagEvent extends EventData {
|
|
1319
1319
|
/**
|
1320
1320
|
* Called when a player clicks the "confirm" button in the configure Blueprint GUI.
|
1321
1321
|
*
|
1322
|
-
* {@link https://lua-api.factorio.com/latest/
|
1322
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_blueprint View documentation}
|
1323
1323
|
*/
|
1324
1324
|
interface OnPlayerConfiguredBlueprintEvent extends EventData {
|
1325
1325
|
/** The player. */
|
@@ -1333,7 +1333,7 @@ interface OnPlayerConfiguredBlueprintEvent extends EventData {
|
|
1333
1333
|
/**
|
1334
1334
|
* Called when a player configures spidertron remote to be connected with a given spidertron
|
1335
1335
|
*
|
1336
|
-
* {@link https://lua-api.factorio.com/latest/
|
1336
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_configured_spider_remote View documentation}
|
1337
1337
|
*/
|
1338
1338
|
interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
|
1339
1339
|
/** The player that configured the remote. */
|
@@ -1350,7 +1350,7 @@ interface OnPlayerConfiguredSpiderRemoteEvent extends EventData {
|
|
1350
1350
|
* Called when the player finishes crafting an item. This event fires just before the results are inserted into the
|
1351
1351
|
* player's inventory, not when the crafting is queued (see {@link OnPrePlayerCraftedItemEvent on_pre_player_crafted_item}).
|
1352
1352
|
*
|
1353
|
-
* {@link https://lua-api.factorio.com/latest/
|
1353
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_crafted_item View documentation}
|
1354
1354
|
*/
|
1355
1355
|
interface OnPlayerCraftedItemEvent extends EventData {
|
1356
1356
|
/** The item that has been crafted. */
|
@@ -1368,7 +1368,7 @@ interface OnPlayerCraftedItemEvent extends EventData {
|
|
1368
1368
|
/**
|
1369
1369
|
* Called after the player was created.
|
1370
1370
|
*
|
1371
|
-
* {@link https://lua-api.factorio.com/latest/
|
1371
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_created View documentation}
|
1372
1372
|
*/
|
1373
1373
|
interface OnPlayerCreatedEvent extends EventData {
|
1374
1374
|
readonly player_index: uint
|
@@ -1381,7 +1381,7 @@ interface OnPlayerCreatedEvent extends EventData {
|
|
1381
1381
|
/**
|
1382
1382
|
* Called after a players cursorstack changed in some way.
|
1383
1383
|
*
|
1384
|
-
* {@link https://lua-api.factorio.com/latest/
|
1384
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_cursor_stack_changed View documentation}
|
1385
1385
|
*/
|
1386
1386
|
interface OnPlayerCursorStackChangedEvent extends EventData {
|
1387
1387
|
readonly player_index: uint
|
@@ -1394,7 +1394,7 @@ interface OnPlayerCursorStackChangedEvent extends EventData {
|
|
1394
1394
|
/**
|
1395
1395
|
* Called when a player selects an area with a deconstruction planner.
|
1396
1396
|
*
|
1397
|
-
* {@link https://lua-api.factorio.com/latest/
|
1397
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_deconstructed_area View documentation}
|
1398
1398
|
*/
|
1399
1399
|
interface OnPlayerDeconstructedAreaEvent extends EventData {
|
1400
1400
|
/** The player doing the selection. */
|
@@ -1402,7 +1402,7 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
|
|
1402
1402
|
/** The surface selected. */
|
1403
1403
|
readonly surface: LuaSurface
|
1404
1404
|
/** The area selected. */
|
1405
|
-
readonly area:
|
1405
|
+
readonly area: BoundingBoxRead
|
1406
1406
|
/** The item used to select the area. */
|
1407
1407
|
readonly item: string
|
1408
1408
|
/** If normal selection or alt selection was used. */
|
@@ -1416,7 +1416,7 @@ interface OnPlayerDeconstructedAreaEvent extends EventData {
|
|
1416
1416
|
/**
|
1417
1417
|
* Called when a player is demoted.
|
1418
1418
|
*
|
1419
|
-
* {@link https://lua-api.factorio.com/latest/
|
1419
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_demoted View documentation}
|
1420
1420
|
*/
|
1421
1421
|
interface OnPlayerDemotedEvent extends EventData {
|
1422
1422
|
/** The player. */
|
@@ -1430,7 +1430,7 @@ interface OnPlayerDemotedEvent extends EventData {
|
|
1430
1430
|
/**
|
1431
1431
|
* Called after a player dies.
|
1432
1432
|
*
|
1433
|
-
* {@link https://lua-api.factorio.com/latest/
|
1433
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_died View documentation}
|
1434
1434
|
*/
|
1435
1435
|
interface OnPlayerDiedEvent extends EventData {
|
1436
1436
|
readonly player_index: uint
|
@@ -1444,7 +1444,7 @@ interface OnPlayerDiedEvent extends EventData {
|
|
1444
1444
|
/**
|
1445
1445
|
* Called when the display resolution changes for a given player.
|
1446
1446
|
*
|
1447
|
-
* {@link https://lua-api.factorio.com/latest/
|
1447
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_display_resolution_changed View documentation}
|
1448
1448
|
*/
|
1449
1449
|
interface OnPlayerDisplayResolutionChangedEvent extends EventData {
|
1450
1450
|
/** The player */
|
@@ -1460,7 +1460,7 @@ interface OnPlayerDisplayResolutionChangedEvent extends EventData {
|
|
1460
1460
|
/**
|
1461
1461
|
* Called when the display scale changes for a given player.
|
1462
1462
|
*
|
1463
|
-
* {@link https://lua-api.factorio.com/latest/
|
1463
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_display_scale_changed View documentation}
|
1464
1464
|
*/
|
1465
1465
|
interface OnPlayerDisplayScaleChangedEvent extends EventData {
|
1466
1466
|
/** The player */
|
@@ -1476,7 +1476,7 @@ interface OnPlayerDisplayScaleChangedEvent extends EventData {
|
|
1476
1476
|
/**
|
1477
1477
|
* Called when the player's driving state has changed, this means a player has either entered or left a vehicle.
|
1478
1478
|
*
|
1479
|
-
* {@link https://lua-api.factorio.com/latest/
|
1479
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_driving_changed_state View documentation}
|
1480
1480
|
*/
|
1481
1481
|
interface OnPlayerDrivingChangedStateEvent extends EventData {
|
1482
1482
|
readonly player_index: uint
|
@@ -1491,7 +1491,7 @@ interface OnPlayerDrivingChangedStateEvent extends EventData {
|
|
1491
1491
|
/**
|
1492
1492
|
* Called when a player drops an item on the ground.
|
1493
1493
|
*
|
1494
|
-
* {@link https://lua-api.factorio.com/latest/
|
1494
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_dropped_item View documentation}
|
1495
1495
|
*/
|
1496
1496
|
interface OnPlayerDroppedItemEvent extends EventData {
|
1497
1497
|
readonly player_index: uint
|
@@ -1506,7 +1506,7 @@ interface OnPlayerDroppedItemEvent extends EventData {
|
|
1506
1506
|
/**
|
1507
1507
|
* Called when a player fast-transfers something to or from an entity.
|
1508
1508
|
*
|
1509
|
-
* {@link https://lua-api.factorio.com/latest/
|
1509
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_fast_transferred View documentation}
|
1510
1510
|
*/
|
1511
1511
|
interface OnPlayerFastTransferredEvent extends EventData {
|
1512
1512
|
/** The player transferred from or to. */
|
@@ -1524,7 +1524,7 @@ interface OnPlayerFastTransferredEvent extends EventData {
|
|
1524
1524
|
/**
|
1525
1525
|
* Called after player flushed fluid
|
1526
1526
|
*
|
1527
|
-
* {@link https://lua-api.factorio.com/latest/
|
1527
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_flushed_fluid View documentation}
|
1528
1528
|
*/
|
1529
1529
|
interface OnPlayerFlushedFluidEvent extends EventData {
|
1530
1530
|
/** Index of the player */
|
@@ -1546,7 +1546,7 @@ interface OnPlayerFlushedFluidEvent extends EventData {
|
|
1546
1546
|
/**
|
1547
1547
|
* Called after a players gun inventory changed in some way.
|
1548
1548
|
*
|
1549
|
-
* {@link https://lua-api.factorio.com/latest/
|
1549
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_gun_inventory_changed View documentation}
|
1550
1550
|
*/
|
1551
1551
|
interface OnPlayerGunInventoryChangedEvent extends EventData {
|
1552
1552
|
readonly player_index: uint
|
@@ -1559,7 +1559,7 @@ interface OnPlayerGunInventoryChangedEvent extends EventData {
|
|
1559
1559
|
/**
|
1560
1560
|
* Called after a player joins the game.
|
1561
1561
|
*
|
1562
|
-
* {@link https://lua-api.factorio.com/latest/
|
1562
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_joined_game View documentation}
|
1563
1563
|
*/
|
1564
1564
|
interface OnPlayerJoinedGameEvent extends EventData {
|
1565
1565
|
readonly player_index: uint
|
@@ -1572,7 +1572,7 @@ interface OnPlayerJoinedGameEvent extends EventData {
|
|
1572
1572
|
/**
|
1573
1573
|
* Called when a player is kicked.
|
1574
1574
|
*
|
1575
|
-
* {@link https://lua-api.factorio.com/latest/
|
1575
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_kicked View documentation}
|
1576
1576
|
*/
|
1577
1577
|
interface OnPlayerKickedEvent extends EventData {
|
1578
1578
|
/** The player kicked. */
|
@@ -1590,7 +1590,7 @@ interface OnPlayerKickedEvent extends EventData {
|
|
1590
1590
|
/**
|
1591
1591
|
* Called after a player leaves the game.
|
1592
1592
|
*
|
1593
|
-
* {@link https://lua-api.factorio.com/latest/
|
1593
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_left_game View documentation}
|
1594
1594
|
*/
|
1595
1595
|
interface OnPlayerLeftGameEvent extends EventData {
|
1596
1596
|
readonly player_index: uint
|
@@ -1604,7 +1604,7 @@ interface OnPlayerLeftGameEvent extends EventData {
|
|
1604
1604
|
/**
|
1605
1605
|
* Called after a players main inventory changed in some way.
|
1606
1606
|
*
|
1607
|
-
* {@link https://lua-api.factorio.com/latest/
|
1607
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_main_inventory_changed View documentation}
|
1608
1608
|
*/
|
1609
1609
|
interface OnPlayerMainInventoryChangedEvent extends EventData {
|
1610
1610
|
readonly player_index: uint
|
@@ -1622,7 +1622,7 @@ interface OnPlayerMainInventoryChangedEvent extends EventData {
|
|
1622
1622
|
* **Note**: The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding
|
1623
1623
|
* as more items are transferred into it.
|
1624
1624
|
*
|
1625
|
-
* {@link https://lua-api.factorio.com/latest/
|
1625
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_entity View documentation}
|
1626
1626
|
*/
|
1627
1627
|
interface OnPlayerMinedEntityEvent extends EventData {
|
1628
1628
|
/** The index of the player doing the mining. */
|
@@ -1640,7 +1640,7 @@ interface OnPlayerMinedEntityEvent extends EventData {
|
|
1640
1640
|
/**
|
1641
1641
|
* Called when the player mines something.
|
1642
1642
|
*
|
1643
|
-
* {@link https://lua-api.factorio.com/latest/
|
1643
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_item View documentation}
|
1644
1644
|
*/
|
1645
1645
|
interface OnPlayerMinedItemEvent extends EventData {
|
1646
1646
|
/** The item given to the player */
|
@@ -1655,7 +1655,7 @@ interface OnPlayerMinedItemEvent extends EventData {
|
|
1655
1655
|
/**
|
1656
1656
|
* Called after a player mines tiles.
|
1657
1657
|
*
|
1658
|
-
* {@link https://lua-api.factorio.com/latest/
|
1658
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_mined_tile View documentation}
|
1659
1659
|
*/
|
1660
1660
|
interface OnPlayerMinedTileEvent extends EventData {
|
1661
1661
|
readonly player_index: uint
|
@@ -1672,7 +1672,7 @@ interface OnPlayerMinedTileEvent extends EventData {
|
|
1672
1672
|
/**
|
1673
1673
|
* Called when a player is muted.
|
1674
1674
|
*
|
1675
|
-
* {@link https://lua-api.factorio.com/latest/
|
1675
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_muted View documentation}
|
1676
1676
|
*/
|
1677
1677
|
interface OnPlayerMutedEvent extends EventData {
|
1678
1678
|
/** The player. */
|
@@ -1686,7 +1686,7 @@ interface OnPlayerMutedEvent extends EventData {
|
|
1686
1686
|
/**
|
1687
1687
|
* Called when a player invokes the "smart pipette" over an entity.
|
1688
1688
|
*
|
1689
|
-
* {@link https://lua-api.factorio.com/latest/
|
1689
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_pipette View documentation}
|
1690
1690
|
*/
|
1691
1691
|
interface OnPlayerPipetteEvent extends EventData {
|
1692
1692
|
/** The player */
|
@@ -1704,7 +1704,7 @@ interface OnPlayerPipetteEvent extends EventData {
|
|
1704
1704
|
/**
|
1705
1705
|
* Called after the player puts equipment in an equipment grid
|
1706
1706
|
*
|
1707
|
-
* {@link https://lua-api.factorio.com/latest/
|
1707
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_placed_equipment View documentation}
|
1708
1708
|
*/
|
1709
1709
|
interface OnPlayerPlacedEquipmentEvent extends EventData {
|
1710
1710
|
readonly player_index: uint
|
@@ -1721,7 +1721,7 @@ interface OnPlayerPlacedEquipmentEvent extends EventData {
|
|
1721
1721
|
/**
|
1722
1722
|
* Called when a player is promoted.
|
1723
1723
|
*
|
1724
|
-
* {@link https://lua-api.factorio.com/latest/
|
1724
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_promoted View documentation}
|
1725
1725
|
*/
|
1726
1726
|
interface OnPlayerPromotedEvent extends EventData {
|
1727
1727
|
/** The player. */
|
@@ -1736,7 +1736,7 @@ interface OnPlayerPromotedEvent extends EventData {
|
|
1736
1736
|
* Called when a player is removed (deleted) from the game. Not to be confused with the player logging of this is
|
1737
1737
|
* different in that the player is deleted as if he never existed in the save file.
|
1738
1738
|
*
|
1739
|
-
* {@link https://lua-api.factorio.com/latest/
|
1739
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_removed View documentation}
|
1740
1740
|
*/
|
1741
1741
|
interface OnPlayerRemovedEvent extends EventData {
|
1742
1742
|
/** The player index that was removed */
|
@@ -1750,7 +1750,7 @@ interface OnPlayerRemovedEvent extends EventData {
|
|
1750
1750
|
/**
|
1751
1751
|
* Called after the player removes equipment from an equipment grid
|
1752
1752
|
*
|
1753
|
-
* {@link https://lua-api.factorio.com/latest/
|
1753
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_removed_equipment View documentation}
|
1754
1754
|
*/
|
1755
1755
|
interface OnPlayerRemovedEquipmentEvent extends EventData {
|
1756
1756
|
readonly player_index: uint
|
@@ -1769,7 +1769,7 @@ interface OnPlayerRemovedEquipmentEvent extends EventData {
|
|
1769
1769
|
/**
|
1770
1770
|
* Called when a player repairs an entity. Can be filtered using {@link LuaPlayerRepairedEntityEventFilter}.
|
1771
1771
|
*
|
1772
|
-
* {@link https://lua-api.factorio.com/latest/
|
1772
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_repaired_entity View documentation}
|
1773
1773
|
*/
|
1774
1774
|
interface OnPlayerRepairedEntityEvent extends EventData {
|
1775
1775
|
readonly player_index: uint
|
@@ -1783,7 +1783,7 @@ interface OnPlayerRepairedEntityEvent extends EventData {
|
|
1783
1783
|
/**
|
1784
1784
|
* Called after a player respawns.
|
1785
1785
|
*
|
1786
|
-
* {@link https://lua-api.factorio.com/latest/
|
1786
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_respawned View documentation}
|
1787
1787
|
*/
|
1788
1788
|
interface OnPlayerRespawnedEvent extends EventData {
|
1789
1789
|
readonly player_index: uint
|
@@ -1799,7 +1799,7 @@ interface OnPlayerRespawnedEvent extends EventData {
|
|
1799
1799
|
* Called when the player rotates an entity. This event is only fired when the entity actually changes its orientation
|
1800
1800
|
* -- pressing the rotate key on an entity that can't be rotated won't fire this event.
|
1801
1801
|
*
|
1802
|
-
* {@link https://lua-api.factorio.com/latest/
|
1802
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_rotated_entity View documentation}
|
1803
1803
|
*/
|
1804
1804
|
interface OnPlayerRotatedEntityEvent extends EventData {
|
1805
1805
|
/** The rotated entity. */
|
@@ -1816,7 +1816,7 @@ interface OnPlayerRotatedEntityEvent extends EventData {
|
|
1816
1816
|
/**
|
1817
1817
|
* Called after a player selects an area with a selection-tool item.
|
1818
1818
|
*
|
1819
|
-
* {@link https://lua-api.factorio.com/latest/
|
1819
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_selected_area View documentation}
|
1820
1820
|
*/
|
1821
1821
|
interface OnPlayerSelectedAreaEvent extends EventData {
|
1822
1822
|
/** The player doing the selection. */
|
@@ -1824,7 +1824,7 @@ interface OnPlayerSelectedAreaEvent extends EventData {
|
|
1824
1824
|
/** The surface selected. */
|
1825
1825
|
readonly surface: LuaSurface
|
1826
1826
|
/** The area selected. */
|
1827
|
-
readonly area:
|
1827
|
+
readonly area: BoundingBoxRead
|
1828
1828
|
/** The item used to select the area. */
|
1829
1829
|
readonly item: string
|
1830
1830
|
/** The entities selected. */
|
@@ -1840,7 +1840,7 @@ interface OnPlayerSelectedAreaEvent extends EventData {
|
|
1840
1840
|
/**
|
1841
1841
|
* Called when a player sets a quickbar slot to anything (new value, or set to empty).
|
1842
1842
|
*
|
1843
|
-
* {@link https://lua-api.factorio.com/latest/
|
1843
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_set_quick_bar_slot View documentation}
|
1844
1844
|
*/
|
1845
1845
|
interface OnPlayerSetQuickBarSlotEvent extends EventData {
|
1846
1846
|
readonly player_index: uint
|
@@ -1853,7 +1853,7 @@ interface OnPlayerSetQuickBarSlotEvent extends EventData {
|
|
1853
1853
|
/**
|
1854
1854
|
* Called when a player selects an area with a blueprint.
|
1855
1855
|
*
|
1856
|
-
* {@link https://lua-api.factorio.com/latest/
|
1856
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_setup_blueprint View documentation}
|
1857
1857
|
*/
|
1858
1858
|
interface OnPlayerSetupBlueprintEvent extends EventData {
|
1859
1859
|
/** The player doing the selection. */
|
@@ -1861,7 +1861,7 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
|
|
1861
1861
|
/** The surface selected. */
|
1862
1862
|
readonly surface: LuaSurface
|
1863
1863
|
/** The area selected. */
|
1864
|
-
readonly area:
|
1864
|
+
readonly area: BoundingBoxRead
|
1865
1865
|
/** The item used to select the area. */
|
1866
1866
|
readonly item: string
|
1867
1867
|
/** If normal selection or alt selection was used. */
|
@@ -1877,7 +1877,7 @@ interface OnPlayerSetupBlueprintEvent extends EventData {
|
|
1877
1877
|
/**
|
1878
1878
|
* Called when a player toggles alt mode, also known as "show entity info".
|
1879
1879
|
*
|
1880
|
-
* {@link https://lua-api.factorio.com/latest/
|
1880
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_alt_mode View documentation}
|
1881
1881
|
*/
|
1882
1882
|
interface OnPlayerToggledAltModeEvent extends EventData {
|
1883
1883
|
readonly player_index: uint
|
@@ -1895,7 +1895,7 @@ interface OnPlayerToggledAltModeEvent extends EventData {
|
|
1895
1895
|
/**
|
1896
1896
|
* Called when a player toggles the map editor on or off.
|
1897
1897
|
*
|
1898
|
-
* {@link https://lua-api.factorio.com/latest/
|
1898
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_toggled_map_editor View documentation}
|
1899
1899
|
*/
|
1900
1900
|
interface OnPlayerToggledMapEditorEvent extends EventData {
|
1901
1901
|
readonly player_index: uint
|
@@ -1908,7 +1908,7 @@ interface OnPlayerToggledMapEditorEvent extends EventData {
|
|
1908
1908
|
/**
|
1909
1909
|
* Called after a players trash inventory changed in some way.
|
1910
1910
|
*
|
1911
|
-
* {@link https://lua-api.factorio.com/latest/
|
1911
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_trash_inventory_changed View documentation}
|
1912
1912
|
*/
|
1913
1913
|
interface OnPlayerTrashInventoryChangedEvent extends EventData {
|
1914
1914
|
readonly player_index: uint
|
@@ -1921,7 +1921,7 @@ interface OnPlayerTrashInventoryChangedEvent extends EventData {
|
|
1921
1921
|
/**
|
1922
1922
|
* Called when a player is un-banned.
|
1923
1923
|
*
|
1924
|
-
* {@link https://lua-api.factorio.com/latest/
|
1924
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_unbanned View documentation}
|
1925
1925
|
*/
|
1926
1926
|
interface OnPlayerUnbannedEvent extends EventData {
|
1927
1927
|
/** The player un-banned. */
|
@@ -1941,7 +1941,7 @@ interface OnPlayerUnbannedEvent extends EventData {
|
|
1941
1941
|
/**
|
1942
1942
|
* Called when a player is unmuted.
|
1943
1943
|
*
|
1944
|
-
* {@link https://lua-api.factorio.com/latest/
|
1944
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_unmuted View documentation}
|
1945
1945
|
*/
|
1946
1946
|
interface OnPlayerUnmutedEvent extends EventData {
|
1947
1947
|
/** The player. */
|
@@ -1955,7 +1955,7 @@ interface OnPlayerUnmutedEvent extends EventData {
|
|
1955
1955
|
/**
|
1956
1956
|
* Called when a player uses a capsule that results in some game action.
|
1957
1957
|
*
|
1958
|
-
* {@link https://lua-api.factorio.com/latest/
|
1958
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_used_capsule View documentation}
|
1959
1959
|
*/
|
1960
1960
|
interface OnPlayerUsedCapsuleEvent extends EventData {
|
1961
1961
|
/** The player. */
|
@@ -1963,7 +1963,7 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
|
|
1963
1963
|
/** The capsule item used. */
|
1964
1964
|
readonly item: LuaItemPrototype
|
1965
1965
|
/** The position the capsule was used. */
|
1966
|
-
readonly position:
|
1966
|
+
readonly position: PositionTable
|
1967
1967
|
/** Identifier of the event */
|
1968
1968
|
readonly name: typeof defines.events.on_player_used_capsule
|
1969
1969
|
/** Tick the event was generated. */
|
@@ -1973,7 +1973,7 @@ interface OnPlayerUsedCapsuleEvent extends EventData {
|
|
1973
1973
|
/**
|
1974
1974
|
* Called when a player uses spidertron remote to send a spidertron to a given position
|
1975
1975
|
*
|
1976
|
-
* {@link https://lua-api.factorio.com/latest/
|
1976
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_player_used_spider_remote View documentation}
|
1977
1977
|
*/
|
1978
1978
|
interface OnPlayerUsedSpiderRemoteEvent extends EventData {
|
1979
1979
|
/** The player that used the remote. */
|
@@ -1981,7 +1981,7 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
|
|
1981
1981
|
/** Spider vehicle which was requested to move. */
|
1982
1982
|
readonly vehicle: LuaEntity
|
1983
1983
|
/** Goal position to which spidertron was sent to. */
|
1984
|
-
readonly position:
|
1984
|
+
readonly position: PositionTable
|
1985
1985
|
/** If the use was successful. It may fail when spidertron has different driver or when player is on different surface. */
|
1986
1986
|
readonly success: boolean
|
1987
1987
|
/** Identifier of the event */
|
@@ -1993,7 +1993,7 @@ interface OnPlayerUsedSpiderRemoteEvent extends EventData {
|
|
1993
1993
|
/**
|
1994
1994
|
* Called after an entity dies. Can be filtered using {@link LuaPostEntityDiedEventFilter}.
|
1995
1995
|
*
|
1996
|
-
* {@link https://lua-api.factorio.com/latest/
|
1996
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_post_entity_died View documentation}
|
1997
1997
|
*/
|
1998
1998
|
interface OnPostEntityDiedEvent extends EventData {
|
1999
1999
|
/** The ghost created by the entity dying if any. */
|
@@ -2001,7 +2001,7 @@ interface OnPostEntityDiedEvent extends EventData {
|
|
2001
2001
|
/** The force that did the killing if any. */
|
2002
2002
|
readonly force?: LuaForce
|
2003
2003
|
/** Position where the entity died. */
|
2004
|
-
readonly position:
|
2004
|
+
readonly position: PositionTable
|
2005
2005
|
/** The entity prototype of the entity that died. */
|
2006
2006
|
readonly prototype: LuaEntityPrototype
|
2007
2007
|
/** The damage type if any. */
|
@@ -2021,13 +2021,13 @@ interface OnPostEntityDiedEvent extends EventData {
|
|
2021
2021
|
/**
|
2022
2022
|
* Called when players uses an item to build something. Called before {@link OnBuiltEntityEvent on_built_entity}.
|
2023
2023
|
*
|
2024
|
-
* {@link https://lua-api.factorio.com/latest/
|
2024
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_build View documentation}
|
2025
2025
|
*/
|
2026
2026
|
interface OnPreBuildEvent extends EventData {
|
2027
2027
|
/** The player who did the placing. */
|
2028
2028
|
readonly player_index: uint
|
2029
2029
|
/** Where the item was placed. */
|
2030
|
-
readonly position:
|
2030
|
+
readonly position: PositionTable
|
2031
2031
|
/** Item was placed using shift building. */
|
2032
2032
|
readonly shift_build: boolean
|
2033
2033
|
/** The direction the item was facing when placed. */
|
@@ -2047,12 +2047,12 @@ interface OnPreBuildEvent extends EventData {
|
|
2047
2047
|
/**
|
2048
2048
|
* Called before one or more chunks are deleted using {@link LuaSurface.delete_chunk LuaSurface::delete_chunk}.
|
2049
2049
|
*
|
2050
|
-
* {@link https://lua-api.factorio.com/latest/
|
2050
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_chunk_deleted View documentation}
|
2051
2051
|
*/
|
2052
2052
|
interface OnPreChunkDeletedEvent extends EventData {
|
2053
2053
|
readonly surface_index: uint
|
2054
2054
|
/** The chunks to be deleted. */
|
2055
|
-
readonly positions:
|
2055
|
+
readonly positions: ChunkPositionTable[]
|
2056
2056
|
/** Identifier of the event */
|
2057
2057
|
readonly name: typeof defines.events.on_pre_chunk_deleted
|
2058
2058
|
/** Tick the event was generated. */
|
@@ -2062,7 +2062,7 @@ interface OnPreChunkDeletedEvent extends EventData {
|
|
2062
2062
|
/**
|
2063
2063
|
* Called before entity copy-paste is done.
|
2064
2064
|
*
|
2065
|
-
* {@link https://lua-api.factorio.com/latest/
|
2065
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_entity_settings_pasted View documentation}
|
2066
2066
|
*/
|
2067
2067
|
interface OnPreEntitySettingsPastedEvent extends EventData {
|
2068
2068
|
readonly player_index: uint
|
@@ -2080,7 +2080,7 @@ interface OnPreEntitySettingsPastedEvent extends EventData {
|
|
2080
2080
|
* Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using
|
2081
2081
|
* {@link LuaPreGhostDeconstructedEventFilter}.
|
2082
2082
|
*
|
2083
|
-
* {@link https://lua-api.factorio.com/latest/
|
2083
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_ghost_deconstructed View documentation}
|
2084
2084
|
*/
|
2085
2085
|
interface OnPreGhostDeconstructedEvent extends EventData {
|
2086
2086
|
/** The player that did the deconstruction if any. */
|
@@ -2095,7 +2095,7 @@ interface OnPreGhostDeconstructedEvent extends EventData {
|
|
2095
2095
|
/**
|
2096
2096
|
* Called directly before a permission group is deleted.
|
2097
2097
|
*
|
2098
|
-
* {@link https://lua-api.factorio.com/latest/
|
2098
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_group_deleted View documentation}
|
2099
2099
|
*/
|
2100
2100
|
interface OnPrePermissionGroupDeletedEvent extends EventData {
|
2101
2101
|
/** The player doing the deletion. */
|
@@ -2111,7 +2111,7 @@ interface OnPrePermissionGroupDeletedEvent extends EventData {
|
|
2111
2111
|
/**
|
2112
2112
|
* Called directly before a permission string is imported.
|
2113
2113
|
*
|
2114
|
-
* {@link https://lua-api.factorio.com/latest/
|
2114
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_permission_string_imported View documentation}
|
2115
2115
|
*/
|
2116
2116
|
interface OnPrePermissionStringImportedEvent extends EventData {
|
2117
2117
|
/** The player importing the string. */
|
@@ -2125,7 +2125,7 @@ interface OnPrePermissionStringImportedEvent extends EventData {
|
|
2125
2125
|
/**
|
2126
2126
|
* Called when a player queues something to be crafted.
|
2127
2127
|
*
|
2128
|
-
* {@link https://lua-api.factorio.com/latest/
|
2128
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_crafted_item View documentation}
|
2129
2129
|
*/
|
2130
2130
|
interface OnPrePlayerCraftedItemEvent extends EventData {
|
2131
2131
|
/** The player doing the crafting. */
|
@@ -2145,7 +2145,7 @@ interface OnPrePlayerCraftedItemEvent extends EventData {
|
|
2145
2145
|
/**
|
2146
2146
|
* Called before a players dies.
|
2147
2147
|
*
|
2148
|
-
* {@link https://lua-api.factorio.com/latest/
|
2148
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_died View documentation}
|
2149
2149
|
*/
|
2150
2150
|
interface OnPrePlayerDiedEvent extends EventData {
|
2151
2151
|
readonly player_index: uint
|
@@ -2159,7 +2159,7 @@ interface OnPrePlayerDiedEvent extends EventData {
|
|
2159
2159
|
/**
|
2160
2160
|
* Called before a player leaves the game.
|
2161
2161
|
*
|
2162
|
-
* {@link https://lua-api.factorio.com/latest/
|
2162
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_left_game View documentation}
|
2163
2163
|
*/
|
2164
2164
|
interface OnPrePlayerLeftGameEvent extends EventData {
|
2165
2165
|
readonly player_index: uint
|
@@ -2174,7 +2174,7 @@ interface OnPrePlayerLeftGameEvent extends EventData {
|
|
2174
2174
|
* Called when the player finishes mining an entity, before the entity is removed from map. Can be filtered using
|
2175
2175
|
* {@link LuaPrePlayerMinedEntityEventFilter}.
|
2176
2176
|
*
|
2177
|
-
* {@link https://lua-api.factorio.com/latest/
|
2177
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_mined_item View documentation}
|
2178
2178
|
*/
|
2179
2179
|
interface OnPrePlayerMinedItemEvent extends EventData {
|
2180
2180
|
/** The entity being mined */
|
@@ -2190,7 +2190,7 @@ interface OnPrePlayerMinedItemEvent extends EventData {
|
|
2190
2190
|
* Called before a player is removed (deleted) from the game. Not to be confused with the player logging of this is
|
2191
2191
|
* different in that the player is deleted as if he never existed in the save file.
|
2192
2192
|
*
|
2193
|
-
* {@link https://lua-api.factorio.com/latest/
|
2193
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_removed View documentation}
|
2194
2194
|
*/
|
2195
2195
|
interface OnPrePlayerRemovedEvent extends EventData {
|
2196
2196
|
/** The player index that will be removed */
|
@@ -2204,7 +2204,7 @@ interface OnPrePlayerRemovedEvent extends EventData {
|
|
2204
2204
|
/**
|
2205
2205
|
* Called before a player toggles the map editor on or off.
|
2206
2206
|
*
|
2207
|
-
* {@link https://lua-api.factorio.com/latest/
|
2207
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_player_toggled_map_editor View documentation}
|
2208
2208
|
*/
|
2209
2209
|
interface OnPrePlayerToggledMapEditorEvent extends EventData {
|
2210
2210
|
readonly player_index: uint
|
@@ -2217,7 +2217,7 @@ interface OnPrePlayerToggledMapEditorEvent extends EventData {
|
|
2217
2217
|
/**
|
2218
2218
|
* Called directly before a robot explodes cliffs.
|
2219
2219
|
*
|
2220
|
-
* {@link https://lua-api.factorio.com/latest/
|
2220
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_robot_exploded_cliff View documentation}
|
2221
2221
|
*/
|
2222
2222
|
interface OnPreRobotExplodedCliffEvent extends EventData {
|
2223
2223
|
readonly robot: LuaEntity
|
@@ -2233,7 +2233,7 @@ interface OnPreRobotExplodedCliffEvent extends EventData {
|
|
2233
2233
|
/**
|
2234
2234
|
* Called just before a script inventory is resized.
|
2235
2235
|
*
|
2236
|
-
* {@link https://lua-api.factorio.com/latest/
|
2236
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_script_inventory_resized View documentation}
|
2237
2237
|
*/
|
2238
2238
|
interface OnPreScriptInventoryResizedEvent extends EventData {
|
2239
2239
|
/** If done by console command; the player who ran the command. */
|
@@ -2254,7 +2254,7 @@ interface OnPreScriptInventoryResizedEvent extends EventData {
|
|
2254
2254
|
/**
|
2255
2255
|
* Called just before a surface is cleared (all entities removed and all chunks deleted).
|
2256
2256
|
*
|
2257
|
-
* {@link https://lua-api.factorio.com/latest/
|
2257
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_cleared View documentation}
|
2258
2258
|
*/
|
2259
2259
|
interface OnPreSurfaceClearedEvent extends EventData {
|
2260
2260
|
readonly surface_index: uint
|
@@ -2267,7 +2267,7 @@ interface OnPreSurfaceClearedEvent extends EventData {
|
|
2267
2267
|
/**
|
2268
2268
|
* Called just before a surface is deleted.
|
2269
2269
|
*
|
2270
|
-
* {@link https://lua-api.factorio.com/latest/
|
2270
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_pre_surface_deleted View documentation}
|
2271
2271
|
*/
|
2272
2272
|
interface OnPreSurfaceDeletedEvent extends EventData {
|
2273
2273
|
readonly surface_index: uint
|
@@ -2280,7 +2280,7 @@ interface OnPreSurfaceDeletedEvent extends EventData {
|
|
2280
2280
|
/**
|
2281
2281
|
* Called when a research finishes.
|
2282
2282
|
*
|
2283
|
-
* {@link https://lua-api.factorio.com/latest/
|
2283
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_research_finished View documentation}
|
2284
2284
|
*/
|
2285
2285
|
interface OnResearchFinishedEvent extends EventData {
|
2286
2286
|
/** The researched technology */
|
@@ -2296,7 +2296,7 @@ interface OnResearchFinishedEvent extends EventData {
|
|
2296
2296
|
/**
|
2297
2297
|
* Called when a research is reversed (unresearched).
|
2298
2298
|
*
|
2299
|
-
* {@link https://lua-api.factorio.com/latest/
|
2299
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_research_reversed View documentation}
|
2300
2300
|
*/
|
2301
2301
|
interface OnResearchReversedEvent extends EventData {
|
2302
2302
|
/** The technology un-researched */
|
@@ -2312,7 +2312,7 @@ interface OnResearchReversedEvent extends EventData {
|
|
2312
2312
|
/**
|
2313
2313
|
* Called when a technology research starts.
|
2314
2314
|
*
|
2315
|
-
* {@link https://lua-api.factorio.com/latest/
|
2315
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_research_started View documentation}
|
2316
2316
|
*/
|
2317
2317
|
interface OnResearchStartedEvent extends EventData {
|
2318
2318
|
/** The technology being researched */
|
@@ -2327,7 +2327,7 @@ interface OnResearchStartedEvent extends EventData {
|
|
2327
2327
|
/**
|
2328
2328
|
* Called when a resource entity reaches 0 or its minimum yield for infinite resources.
|
2329
2329
|
*
|
2330
|
-
* {@link https://lua-api.factorio.com/latest/
|
2330
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_resource_depleted View documentation}
|
2331
2331
|
*/
|
2332
2332
|
interface OnResourceDepletedEvent extends EventData {
|
2333
2333
|
readonly entity: LuaEntity
|
@@ -2340,7 +2340,7 @@ interface OnResourceDepletedEvent extends EventData {
|
|
2340
2340
|
/**
|
2341
2341
|
* Called when a construction robot builds an entity. Can be filtered using {@link LuaRobotBuiltEntityEventFilter}.
|
2342
2342
|
*
|
2343
|
-
* {@link https://lua-api.factorio.com/latest/
|
2343
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_entity View documentation}
|
2344
2344
|
*/
|
2345
2345
|
interface OnRobotBuiltEntityEvent extends EventData {
|
2346
2346
|
/** The robot that did the building. */
|
@@ -2360,7 +2360,7 @@ interface OnRobotBuiltEntityEvent extends EventData {
|
|
2360
2360
|
/**
|
2361
2361
|
* Called after a robot builds tiles.
|
2362
2362
|
*
|
2363
|
-
* {@link https://lua-api.factorio.com/latest/
|
2363
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_built_tile View documentation}
|
2364
2364
|
*/
|
2365
2365
|
interface OnRobotBuiltTileEvent extends EventData {
|
2366
2366
|
/** The robot. */
|
@@ -2384,7 +2384,7 @@ interface OnRobotBuiltTileEvent extends EventData {
|
|
2384
2384
|
/**
|
2385
2385
|
* Called directly after a robot explodes cliffs.
|
2386
2386
|
*
|
2387
|
-
* {@link https://lua-api.factorio.com/latest/
|
2387
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_exploded_cliff View documentation}
|
2388
2388
|
*/
|
2389
2389
|
interface OnRobotExplodedCliffEvent extends EventData {
|
2390
2390
|
readonly robot: LuaEntity
|
@@ -2399,7 +2399,7 @@ interface OnRobotExplodedCliffEvent extends EventData {
|
|
2399
2399
|
/**
|
2400
2400
|
* Called when a robot mines an entity.
|
2401
2401
|
*
|
2402
|
-
* {@link https://lua-api.factorio.com/latest/
|
2402
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined View documentation}
|
2403
2403
|
*/
|
2404
2404
|
interface OnRobotMinedEvent extends EventData {
|
2405
2405
|
/** The robot that did the mining. */
|
@@ -2420,7 +2420,7 @@ interface OnRobotMinedEvent extends EventData {
|
|
2420
2420
|
* **Note**: The buffer inventory is special in that it's only valid during this event and has a dynamic size expanding
|
2421
2421
|
* as more items are transferred into it.
|
2422
2422
|
*
|
2423
|
-
* {@link https://lua-api.factorio.com/latest/
|
2423
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_entity View documentation}
|
2424
2424
|
*/
|
2425
2425
|
interface OnRobotMinedEntityEvent extends EventData {
|
2426
2426
|
/** The robot doing the mining. */
|
@@ -2438,7 +2438,7 @@ interface OnRobotMinedEntityEvent extends EventData {
|
|
2438
2438
|
/**
|
2439
2439
|
* Called after a robot mines tiles.
|
2440
2440
|
*
|
2441
|
-
* {@link https://lua-api.factorio.com/latest/
|
2441
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_mined_tile View documentation}
|
2442
2442
|
*/
|
2443
2443
|
interface OnRobotMinedTileEvent extends EventData {
|
2444
2444
|
/** The robot. */
|
@@ -2456,7 +2456,7 @@ interface OnRobotMinedTileEvent extends EventData {
|
|
2456
2456
|
/**
|
2457
2457
|
* Called before a robot mines an entity. Can be filtered using {@link LuaPreRobotMinedEntityEventFilter}.
|
2458
2458
|
*
|
2459
|
-
* {@link https://lua-api.factorio.com/latest/
|
2459
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_robot_pre_mined View documentation}
|
2460
2460
|
*/
|
2461
2461
|
interface OnRobotPreMinedEvent extends EventData {
|
2462
2462
|
/** The robot that's about to do the mining. */
|
@@ -2472,7 +2472,7 @@ interface OnRobotPreMinedEvent extends EventData {
|
|
2472
2472
|
/**
|
2473
2473
|
* Called when a rocket silo is ordered to be launched.
|
2474
2474
|
*
|
2475
|
-
* {@link https://lua-api.factorio.com/latest/
|
2475
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launch_ordered View documentation}
|
2476
2476
|
*/
|
2477
2477
|
interface OnRocketLaunchOrderedEvent extends EventData {
|
2478
2478
|
readonly rocket: LuaEntity
|
@@ -2488,7 +2488,7 @@ interface OnRocketLaunchOrderedEvent extends EventData {
|
|
2488
2488
|
/**
|
2489
2489
|
* Called when the rocket is launched.
|
2490
2490
|
*
|
2491
|
-
* {@link https://lua-api.factorio.com/latest/
|
2491
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_rocket_launched View documentation}
|
2492
2492
|
*/
|
2493
2493
|
interface OnRocketLaunchedEvent extends EventData {
|
2494
2494
|
readonly rocket: LuaEntity
|
@@ -2504,7 +2504,7 @@ interface OnRocketLaunchedEvent extends EventData {
|
|
2504
2504
|
/**
|
2505
2505
|
* Called when a runtime mod setting is changed by a player.
|
2506
2506
|
*
|
2507
|
-
* {@link https://lua-api.factorio.com/latest/
|
2507
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_runtime_mod_setting_changed View documentation}
|
2508
2508
|
*/
|
2509
2509
|
interface OnRuntimeModSettingChangedEvent extends EventData {
|
2510
2510
|
/**
|
@@ -2526,7 +2526,7 @@ interface OnRuntimeModSettingChangedEvent extends EventData {
|
|
2526
2526
|
/**
|
2527
2527
|
* Called just after a script inventory is resized.
|
2528
2528
|
*
|
2529
|
-
* {@link https://lua-api.factorio.com/latest/
|
2529
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_script_inventory_resized View documentation}
|
2530
2530
|
*/
|
2531
2531
|
interface OnScriptInventoryResizedEvent extends EventData {
|
2532
2532
|
/** If done by console command; the player who ran the command. */
|
@@ -2549,7 +2549,7 @@ interface OnScriptInventoryResizedEvent extends EventData {
|
|
2549
2549
|
/**
|
2550
2550
|
* Called when a {@link LuaSurface.request_path LuaSurface::request_path} call completes.
|
2551
2551
|
*
|
2552
|
-
* {@link https://lua-api.factorio.com/latest/
|
2552
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_script_path_request_finished View documentation}
|
2553
2553
|
*/
|
2554
2554
|
interface OnScriptPathRequestFinishedEvent extends EventData {
|
2555
2555
|
/** The actual path that the pathfinder has determined. `nil` if pathfinding failed. */
|
@@ -2567,16 +2567,16 @@ interface OnScriptPathRequestFinishedEvent extends EventData {
|
|
2567
2567
|
/**
|
2568
2568
|
* Called when a script trigger effect is triggered.
|
2569
2569
|
*
|
2570
|
-
* {@link https://lua-api.factorio.com/latest/
|
2570
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_script_trigger_effect View documentation}
|
2571
2571
|
*/
|
2572
2572
|
interface OnScriptTriggerEffectEvent extends EventData {
|
2573
2573
|
/** The effect_id specified in the trigger effect. */
|
2574
2574
|
readonly effect_id: string
|
2575
2575
|
/** The surface the effect happened on. */
|
2576
2576
|
readonly surface_index: uint
|
2577
|
-
readonly source_position?:
|
2577
|
+
readonly source_position?: PositionTable
|
2578
2578
|
readonly source_entity?: LuaEntity
|
2579
|
-
readonly target_position?:
|
2579
|
+
readonly target_position?: PositionTable
|
2580
2580
|
readonly target_entity?: LuaEntity
|
2581
2581
|
/** Identifier of the event */
|
2582
2582
|
readonly name: typeof defines.events.on_script_trigger_effect
|
@@ -2588,15 +2588,15 @@ interface OnScriptTriggerEffectEvent extends EventData {
|
|
2588
2588
|
* Called when an entity of type `radar` finishes scanning a sector. Can be filtered for the radar using
|
2589
2589
|
* {@link LuaSectorScannedEventFilter}.
|
2590
2590
|
*
|
2591
|
-
* {@link https://lua-api.factorio.com/latest/
|
2591
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_sector_scanned View documentation}
|
2592
2592
|
*/
|
2593
2593
|
interface OnSectorScannedEvent extends EventData {
|
2594
2594
|
/** The radar that did the scanning. */
|
2595
2595
|
readonly radar: LuaEntity
|
2596
2596
|
/** The chunk scanned. */
|
2597
|
-
readonly chunk_position:
|
2597
|
+
readonly chunk_position: ChunkPositionTable
|
2598
2598
|
/** Area of the scanned chunk. */
|
2599
|
-
readonly area:
|
2599
|
+
readonly area: BoundingBoxRead
|
2600
2600
|
/** Identifier of the event */
|
2601
2601
|
readonly name: typeof defines.events.on_sector_scanned
|
2602
2602
|
/** Tick the event was generated. */
|
@@ -2606,7 +2606,7 @@ interface OnSectorScannedEvent extends EventData {
|
|
2606
2606
|
/**
|
2607
2607
|
* Called after the selected entity changes for a given player.
|
2608
2608
|
*
|
2609
|
-
* {@link https://lua-api.factorio.com/latest/
|
2609
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_selected_entity_changed View documentation}
|
2610
2610
|
*/
|
2611
2611
|
interface OnSelectedEntityChangedEvent extends EventData {
|
2612
2612
|
/** The player whose selected entity changed. */
|
@@ -2622,7 +2622,7 @@ interface OnSelectedEntityChangedEvent extends EventData {
|
|
2622
2622
|
/**
|
2623
2623
|
* Called when a spider finishes moving to its autopilot position.
|
2624
2624
|
*
|
2625
|
-
* {@link https://lua-api.factorio.com/latest/
|
2625
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_spider_command_completed View documentation}
|
2626
2626
|
*/
|
2627
2627
|
interface OnSpiderCommandCompletedEvent extends EventData {
|
2628
2628
|
/** Spider vehicle which was requested to move. */
|
@@ -2637,7 +2637,7 @@ interface OnSpiderCommandCompletedEvent extends EventData {
|
|
2637
2637
|
* Called when a translation request generated through
|
2638
2638
|
* {@link LuaPlayer.request_translation LuaPlayer::request_translation} is translated.
|
2639
2639
|
*
|
2640
|
-
* {@link https://lua-api.factorio.com/latest/
|
2640
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_string_translated View documentation}
|
2641
2641
|
*/
|
2642
2642
|
interface OnStringTranslatedEvent extends EventData {
|
2643
2643
|
/** The player whose locale was used for the translation. */
|
@@ -2657,7 +2657,7 @@ interface OnStringTranslatedEvent extends EventData {
|
|
2657
2657
|
/**
|
2658
2658
|
* Called just after a surface is cleared (all entities removed and all chunks deleted).
|
2659
2659
|
*
|
2660
|
-
* {@link https://lua-api.factorio.com/latest/
|
2660
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_cleared View documentation}
|
2661
2661
|
*/
|
2662
2662
|
interface OnSurfaceClearedEvent extends EventData {
|
2663
2663
|
readonly surface_index: uint
|
@@ -2672,7 +2672,7 @@ interface OnSurfaceClearedEvent extends EventData {
|
|
2672
2672
|
*
|
2673
2673
|
* **Note**: This is not called when the default surface is created as it will always exist.
|
2674
2674
|
*
|
2675
|
-
* {@link https://lua-api.factorio.com/latest/
|
2675
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_created View documentation}
|
2676
2676
|
*/
|
2677
2677
|
interface OnSurfaceCreatedEvent extends EventData {
|
2678
2678
|
readonly surface_index: uint
|
@@ -2685,7 +2685,7 @@ interface OnSurfaceCreatedEvent extends EventData {
|
|
2685
2685
|
/**
|
2686
2686
|
* Called after a surface is deleted.
|
2687
2687
|
*
|
2688
|
-
* {@link https://lua-api.factorio.com/latest/
|
2688
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_deleted View documentation}
|
2689
2689
|
*/
|
2690
2690
|
interface OnSurfaceDeletedEvent extends EventData {
|
2691
2691
|
readonly surface_index: uint
|
@@ -2698,7 +2698,7 @@ interface OnSurfaceDeletedEvent extends EventData {
|
|
2698
2698
|
/**
|
2699
2699
|
* Called after a surface is imported.
|
2700
2700
|
*
|
2701
|
-
* {@link https://lua-api.factorio.com/latest/
|
2701
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_imported View documentation}
|
2702
2702
|
*/
|
2703
2703
|
interface OnSurfaceImportedEvent extends EventData {
|
2704
2704
|
readonly surface_index: uint
|
@@ -2713,7 +2713,7 @@ interface OnSurfaceImportedEvent extends EventData {
|
|
2713
2713
|
/**
|
2714
2714
|
* Called when a surface is renamed.
|
2715
2715
|
*
|
2716
|
-
* {@link https://lua-api.factorio.com/latest/
|
2716
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_surface_renamed View documentation}
|
2717
2717
|
*/
|
2718
2718
|
interface OnSurfaceRenamedEvent extends EventData {
|
2719
2719
|
readonly surface_index: uint
|
@@ -2728,7 +2728,7 @@ interface OnSurfaceRenamedEvent extends EventData {
|
|
2728
2728
|
/**
|
2729
2729
|
* Called when {@link LuaForce.reset_technology_effects LuaForce::reset_technology_effects} is finished.
|
2730
2730
|
*
|
2731
|
-
* {@link https://lua-api.factorio.com/latest/
|
2731
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_technology_effects_reset View documentation}
|
2732
2732
|
*/
|
2733
2733
|
interface OnTechnologyEffectsResetEvent extends EventData {
|
2734
2734
|
readonly force: LuaForce
|
@@ -2741,7 +2741,7 @@ interface OnTechnologyEffectsResetEvent extends EventData {
|
|
2741
2741
|
/**
|
2742
2742
|
* It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.
|
2743
2743
|
*
|
2744
|
-
* {@link https://lua-api.factorio.com/latest/
|
2744
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_tick View documentation}
|
2745
2745
|
*/
|
2746
2746
|
interface OnTickEvent extends EventData {
|
2747
2747
|
/** Identifier of the event */
|
@@ -2753,7 +2753,7 @@ interface OnTickEvent extends EventData {
|
|
2753
2753
|
/**
|
2754
2754
|
* Called when a train changes state (started to stopped and vice versa)
|
2755
2755
|
*
|
2756
|
-
* {@link https://lua-api.factorio.com/latest/
|
2756
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_train_changed_state View documentation}
|
2757
2757
|
*/
|
2758
2758
|
interface OnTrainChangedStateEvent extends EventData {
|
2759
2759
|
readonly train: LuaTrain
|
@@ -2767,7 +2767,7 @@ interface OnTrainChangedStateEvent extends EventData {
|
|
2767
2767
|
/**
|
2768
2768
|
* Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
|
2769
2769
|
*
|
2770
|
-
* {@link https://lua-api.factorio.com/latest/
|
2770
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_train_created View documentation}
|
2771
2771
|
*/
|
2772
2772
|
interface OnTrainCreatedEvent extends EventData {
|
2773
2773
|
readonly train: LuaTrain
|
@@ -2784,7 +2784,7 @@ interface OnTrainCreatedEvent extends EventData {
|
|
2784
2784
|
/**
|
2785
2785
|
* Called when a trains schedule is changed either by the player or through script.
|
2786
2786
|
*
|
2787
|
-
* {@link https://lua-api.factorio.com/latest/
|
2787
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_train_schedule_changed View documentation}
|
2788
2788
|
*/
|
2789
2789
|
interface OnTrainScheduleChangedEvent extends EventData {
|
2790
2790
|
readonly train: LuaTrain
|
@@ -2800,7 +2800,7 @@ interface OnTrainScheduleChangedEvent extends EventData {
|
|
2800
2800
|
* Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined
|
2801
2801
|
* `trigger_created_entity="true"`.
|
2802
2802
|
*
|
2803
|
-
* {@link https://lua-api.factorio.com/latest/
|
2803
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_trigger_created_entity View documentation}
|
2804
2804
|
*/
|
2805
2805
|
interface OnTriggerCreatedEntityEvent extends EventData {
|
2806
2806
|
readonly entity: LuaEntity
|
@@ -2815,7 +2815,7 @@ interface OnTriggerCreatedEntityEvent extends EventData {
|
|
2815
2815
|
* Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger
|
2816
2816
|
* prototype defined `trigger_fired_artillery="true"`.
|
2817
2817
|
*
|
2818
|
-
* {@link https://lua-api.factorio.com/latest/
|
2818
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_trigger_fired_artillery View documentation}
|
2819
2819
|
*/
|
2820
2820
|
interface OnTriggerFiredArtilleryEvent extends EventData {
|
2821
2821
|
readonly entity: LuaEntity
|
@@ -2829,7 +2829,7 @@ interface OnTriggerFiredArtilleryEvent extends EventData {
|
|
2829
2829
|
/**
|
2830
2830
|
* Called when a unit is added to a unit group.
|
2831
2831
|
*
|
2832
|
-
* {@link https://lua-api.factorio.com/latest/
|
2832
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_unit_added_to_group View documentation}
|
2833
2833
|
*/
|
2834
2834
|
interface OnUnitAddedToGroupEvent extends EventData {
|
2835
2835
|
readonly unit: LuaEntity
|
@@ -2843,7 +2843,7 @@ interface OnUnitAddedToGroupEvent extends EventData {
|
|
2843
2843
|
/**
|
2844
2844
|
* Called when a new unit group is created, before any members are added to it.
|
2845
2845
|
*
|
2846
|
-
* {@link https://lua-api.factorio.com/latest/
|
2846
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_created View documentation}
|
2847
2847
|
*/
|
2848
2848
|
interface OnUnitGroupCreatedEvent extends EventData {
|
2849
2849
|
readonly group: LuaUnitGroup
|
@@ -2856,7 +2856,7 @@ interface OnUnitGroupCreatedEvent extends EventData {
|
|
2856
2856
|
/**
|
2857
2857
|
* Called when a unit group finishes gathering and starts executing its command.
|
2858
2858
|
*
|
2859
|
-
* {@link https://lua-api.factorio.com/latest/
|
2859
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_unit_group_finished_gathering View documentation}
|
2860
2860
|
*/
|
2861
2861
|
interface OnUnitGroupFinishedGatheringEvent extends EventData {
|
2862
2862
|
readonly group: LuaUnitGroup
|
@@ -2869,7 +2869,7 @@ interface OnUnitGroupFinishedGatheringEvent extends EventData {
|
|
2869
2869
|
/**
|
2870
2870
|
* Called when a unit is removed from a unit group.
|
2871
2871
|
*
|
2872
|
-
* {@link https://lua-api.factorio.com/latest/
|
2872
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_unit_removed_from_group View documentation}
|
2873
2873
|
*/
|
2874
2874
|
interface OnUnitRemovedFromGroupEvent extends EventData {
|
2875
2875
|
readonly unit: LuaEntity
|
@@ -2883,7 +2883,7 @@ interface OnUnitRemovedFromGroupEvent extends EventData {
|
|
2883
2883
|
/**
|
2884
2884
|
* Called when a worker (construction or logistic) robot expires through a lack of energy.
|
2885
2885
|
*
|
2886
|
-
* {@link https://lua-api.factorio.com/latest/
|
2886
|
+
* {@link https://lua-api.factorio.com/latest/events.html#on_worker_robot_expired View documentation}
|
2887
2887
|
*/
|
2888
2888
|
interface OnWorkerRobotExpiredEvent extends EventData {
|
2889
2889
|
readonly robot: LuaEntity
|
@@ -2899,7 +2899,7 @@ interface OnWorkerRobotExpiredEvent extends EventData {
|
|
2899
2899
|
* {@link LuaBootstrap.raise_script_built LuaBootstrap::raise_script_built}, or when `raise_built` is passed to
|
2900
2900
|
* {@link LuaSurface.create_entity LuaSurface::create_entity}. Can be filtered using {@link LuaScriptRaisedBuiltEventFilter}.
|
2901
2901
|
*
|
2902
|
-
* {@link https://lua-api.factorio.com/latest/
|
2902
|
+
* {@link https://lua-api.factorio.com/latest/events.html#script_raised_built View documentation}
|
2903
2903
|
*/
|
2904
2904
|
interface ScriptRaisedBuiltEvent extends EventData {
|
2905
2905
|
/** The entity that has been built. */
|
@@ -2916,7 +2916,7 @@ interface ScriptRaisedBuiltEvent extends EventData {
|
|
2916
2916
|
* {@link LuaBootstrap.raise_script_destroy LuaBootstrap::raise_script_destroy}, or when `raise_destroy` is passed to
|
2917
2917
|
* {@link LuaEntity.destroy LuaEntity::destroy}. Can be filtered using {@link LuaScriptRaisedDestroyEventFilter}.
|
2918
2918
|
*
|
2919
|
-
* {@link https://lua-api.factorio.com/latest/
|
2919
|
+
* {@link https://lua-api.factorio.com/latest/events.html#script_raised_destroy View documentation}
|
2920
2920
|
*/
|
2921
2921
|
interface ScriptRaisedDestroyEvent extends EventData {
|
2922
2922
|
/** The entity that was destroyed. */
|
@@ -2933,7 +2933,7 @@ interface ScriptRaisedDestroyEvent extends EventData {
|
|
2933
2933
|
* {@link LuaBootstrap.raise_script_revive LuaBootstrap::raise_script_revive}, or when `raise_revive` is passed to
|
2934
2934
|
* {@link LuaEntity.revive LuaEntity::revive}. Can be filtered using {@link LuaScriptRaisedReviveEventFilter}.
|
2935
2935
|
*
|
2936
|
-
* {@link https://lua-api.factorio.com/latest/
|
2936
|
+
* {@link https://lua-api.factorio.com/latest/events.html#script_raised_revive View documentation}
|
2937
2937
|
*/
|
2938
2938
|
interface ScriptRaisedReviveEvent extends EventData {
|
2939
2939
|
/** The entity that was revived. */
|
@@ -2952,13 +2952,13 @@ interface ScriptRaisedReviveEvent extends EventData {
|
|
2952
2952
|
* {@link LuaBootstrap.raise_script_set_tiles LuaBootstrap::raise_script_set_tiles}, or when `raise_event` is passed to
|
2953
2953
|
* {@link LuaSurface.set_tiles LuaSurface::set_tiles}.
|
2954
2954
|
*
|
2955
|
-
* {@link https://lua-api.factorio.com/latest/
|
2955
|
+
* {@link https://lua-api.factorio.com/latest/events.html#script_raised_set_tiles View documentation}
|
2956
2956
|
*/
|
2957
2957
|
interface ScriptRaisedSetTilesEvent extends EventData {
|
2958
2958
|
/** The surface whose tiles were changed. */
|
2959
2959
|
readonly surface_index: uint
|
2960
2960
|
/** The tiles that were changed. */
|
2961
|
-
readonly tiles:
|
2961
|
+
readonly tiles: TileRead[]
|
2962
2962
|
/** Identifier of the event */
|
2963
2963
|
readonly name: typeof defines.events.script_raised_set_tiles
|
2964
2964
|
/** Tick the event was generated. */
|