typed-factorio 1.0.0-RC → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- package/Changelog.md +21 -8
- package/generated/classes.d.ts +293 -138
- package/generated/concepts.d.ts +182 -84
- package/generated/defines.d.ts +9 -0
- package/generated/events.d.ts +64 -0
- package/package.json +1 -1
package/generated/classes.d.ts
CHANGED
@@ -83,7 +83,7 @@ interface LuaAchievementPrototype {
|
|
83
83
|
*/
|
84
84
|
readonly name: string
|
85
85
|
/**
|
86
|
-
*
|
86
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
87
87
|
*
|
88
88
|
* {@link https://lua-api.factorio.com/latest/LuaAchievementPrototype.html#LuaAchievementPrototype.order View documentation}
|
89
89
|
*/
|
@@ -120,7 +120,7 @@ interface LuaAmmoCategoryPrototype {
|
|
120
120
|
*/
|
121
121
|
readonly name: string
|
122
122
|
/**
|
123
|
-
*
|
123
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
124
124
|
*
|
125
125
|
* {@link https://lua-api.factorio.com/latest/LuaAmmoCategoryPrototype.html#LuaAmmoCategoryPrototype.order View documentation}
|
126
126
|
*/
|
@@ -150,10 +150,10 @@ interface LuaAmmoCategoryPrototype {
|
|
150
150
|
*/
|
151
151
|
interface LuaArithmeticCombinatorControlBehavior extends LuaCombinatorControlBehavior {
|
152
152
|
/**
|
153
|
-
*
|
153
|
+
* This arithmetic combinator's parameters.
|
154
154
|
*
|
155
155
|
* {@link https://lua-api.factorio.com/latest/LuaArithmeticCombinatorControlBehavior.html#LuaArithmeticCombinatorControlBehavior.parameters View documentation}
|
156
|
-
* @remarks
|
156
|
+
* @remarks Writing `nil` clears the combinator's parameters.
|
157
157
|
*/
|
158
158
|
parameters: ArithmeticCombinatorParameters
|
159
159
|
/**
|
@@ -184,7 +184,7 @@ interface LuaAutoplaceControlPrototype {
|
|
184
184
|
*/
|
185
185
|
readonly name: string
|
186
186
|
/**
|
187
|
-
*
|
187
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
188
188
|
*
|
189
189
|
* {@link https://lua-api.factorio.com/latest/LuaAutoplaceControlPrototype.html#LuaAutoplaceControlPrototype.order View documentation}
|
190
190
|
*/
|
@@ -222,10 +222,11 @@ interface LuaAutoplaceControlPrototype {
|
|
222
222
|
*/
|
223
223
|
interface LuaBootstrap {
|
224
224
|
/**
|
225
|
-
* Register a
|
225
|
+
* Register a function to be run on mod initialization. This is only called when a new save game is created or when a save file is loaded that previously didn't contain the mod. During it, the mod gets the chance to set up initial values that it will use for its lifetime. It has full access to {@link LuaGameScript} and the {@link https://lua-api.factorio.com/latest/Global.html global} table and can change anything about them that it deems appropriate. No other events will be raised for the mod until it has finished this step.
|
226
226
|
*
|
227
227
|
* {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_init View documentation}
|
228
228
|
* @param f The handler for this event. Passing `nil` will unregister it.
|
229
|
+
* @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
|
229
230
|
* @example Initialize a `players` table in `global` for later use.
|
230
231
|
*
|
231
232
|
* ```
|
@@ -236,24 +237,26 @@ interface LuaBootstrap {
|
|
236
237
|
*/
|
237
238
|
on_init(f: (() => void) | undefined): void
|
238
239
|
/**
|
239
|
-
* Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session. It gives the mod the opportunity to do some very specific actions, should it need to. Doing anything other than these three will lead to desyncs, which breaks multiplayer and replay functionality. Access to {@link LuaGameScript}
|
240
|
+
* Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session. It gives the mod the opportunity to do some very specific actions, should it need to. Doing anything other than these three will lead to desyncs, which breaks multiplayer and replay functionality. Access to {@link LuaGameScript} is not available. The {@link https://lua-api.factorio.com/latest/Global.html global} table can be accessed and is safe to read from, but not write to, as doing so will lead to an error.
|
240
241
|
*
|
241
|
-
* The only legitimate uses of this event are
|
242
|
-
* - Re-setup {@link https://www.lua.org/pil/13.html metatables} as they are not persisted through save
|
243
|
-
* - Re-setup conditional event handlers.
|
242
|
+
* The only legitimate uses of this event are the following:
|
243
|
+
* - Re-setup {@link https://www.lua.org/pil/13.html metatables} as they are not persisted through the save/load cycle.
|
244
|
+
* - Re-setup conditional event handlers, meaning subscribing to an event only when some condition is met to save processing time.
|
244
245
|
* - Create local references to data stored in the {@link https://lua-api.factorio.com/latest/Global.html global} table.
|
245
246
|
*
|
246
|
-
* For all other purposes, {@link LuaBootstrap#on_init LuaBootstrap::on_init}, {@link LuaBootstrap#on_configuration_changed LuaBootstrap::on_configuration_changed} or
|
247
|
+
* For all other purposes, {@link LuaBootstrap#on_init LuaBootstrap::on_init}, {@link LuaBootstrap#on_configuration_changed LuaBootstrap::on_configuration_changed} or {@link https://lua-api.factorio.com/latest/Migrations.html migrations} should be used instead.
|
247
248
|
*
|
248
249
|
* {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_load View documentation}
|
249
250
|
* @param f The handler for this event. Passing `nil` will unregister it.
|
251
|
+
* @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
|
250
252
|
*/
|
251
253
|
on_load(f: (() => void) | undefined): void
|
252
254
|
/**
|
253
|
-
* Register a function to be run when mod configuration changes. This is called when the game version or any mod version
|
255
|
+
* Register a function to be run when mod configuration changes. This is called when the major game version or any mod version changed, when any mod was added or removed, when a startup setting has changed, or when any prototypes have been added or removed. It allows the mod to make any changes it deems appropriate to both the data structures in its {@link https://lua-api.factorio.com/latest/Global.html global} table or to the game state through {@link LuaGameScript}.
|
254
256
|
*
|
255
257
|
* {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.on_configuration_changed View documentation}
|
256
258
|
* @param f The handler for this event. Passing `nil` will unregister it.
|
259
|
+
* @remarks For more context, refer to the {@link https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle} page.
|
257
260
|
*/
|
258
261
|
on_configuration_changed(f: ((param1: ConfigurationChangedData) => void) | undefined): void
|
259
262
|
/**
|
@@ -915,12 +918,12 @@ interface LuaConstantCombinatorControlBehavior extends LuaControlBehavior {
|
|
915
918
|
*/
|
916
919
|
get_signal(index: uint): Signal
|
917
920
|
/**
|
918
|
-
*
|
921
|
+
* This constant combinator's parameters, or `nil` if the {@link LuaEntityPrototype#item_slot_count item_slot_count} of the combinator's prototype is `0`.
|
919
922
|
*
|
920
923
|
* {@link https://lua-api.factorio.com/latest/LuaConstantCombinatorControlBehavior.html#LuaConstantCombinatorControlBehavior.parameters View documentation}
|
921
|
-
* @remarks
|
924
|
+
* @remarks Writing `nil` clears the combinator's parameters.
|
922
925
|
*/
|
923
|
-
parameters: ConstantCombinatorParameters[]
|
926
|
+
parameters: ConstantCombinatorParameters[] | undefined
|
924
927
|
/**
|
925
928
|
* Turns this constant combinator on and off.
|
926
929
|
*
|
@@ -1281,7 +1284,7 @@ interface LuaControl {
|
|
1281
1284
|
*/
|
1282
1285
|
set_personal_logistic_slot(slot_index: uint, value: LogisticParameters): boolean
|
1283
1286
|
/**
|
1284
|
-
* Sets a vehicle logistic request and auto-trash slot to the given value. Only used on `spider-
|
1287
|
+
* Sets a vehicle logistic request and auto-trash slot to the given value. Only used on `spider-vehicle`.
|
1285
1288
|
*
|
1286
1289
|
* **Raised events:**
|
1287
1290
|
* - {@link OnEntityLogisticSlotChangedEvent on_entity_logistic_slot_changed}? _instantly_ Raised if setting of logistic slot was successful.
|
@@ -1294,7 +1297,7 @@ interface LuaControl {
|
|
1294
1297
|
*/
|
1295
1298
|
set_vehicle_logistic_slot(slot_index: uint, value: LogisticParameters): boolean
|
1296
1299
|
/**
|
1297
|
-
* Gets the parameters of a personal logistic request and auto-trash slot.
|
1300
|
+
* Gets the parameters of a personal logistic request and auto-trash slot. Only used on `spider-vehicle`.
|
1298
1301
|
*
|
1299
1302
|
* {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.get_personal_logistic_slot View documentation}
|
1300
1303
|
* @param slot_index The slot to get.
|
@@ -1551,6 +1554,10 @@ interface LuaControl {
|
|
1551
1554
|
/**
|
1552
1555
|
* `true` if the player is in a vehicle. Writing to this attribute puts the player in or out of a vehicle.
|
1553
1556
|
*
|
1557
|
+
* **Raised events:**
|
1558
|
+
* - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_ Raised if the driving state successfully changed.
|
1559
|
+
*
|
1560
|
+
*
|
1554
1561
|
* {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.driving View documentation}
|
1555
1562
|
*/
|
1556
1563
|
driving: boolean
|
@@ -1857,7 +1864,7 @@ interface LuaCustomInputPrototype {
|
|
1857
1864
|
*/
|
1858
1865
|
readonly name: string
|
1859
1866
|
/**
|
1860
|
-
*
|
1867
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
1861
1868
|
*
|
1862
1869
|
* {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.order View documentation}
|
1863
1870
|
*/
|
@@ -2021,7 +2028,7 @@ interface LuaDamagePrototype {
|
|
2021
2028
|
*/
|
2022
2029
|
readonly name: string
|
2023
2030
|
/**
|
2024
|
-
*
|
2031
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
2025
2032
|
*
|
2026
2033
|
* {@link https://lua-api.factorio.com/latest/LuaDamagePrototype.html#LuaDamagePrototype.order View documentation}
|
2027
2034
|
*/
|
@@ -2056,10 +2063,10 @@ interface LuaDamagePrototype {
|
|
2056
2063
|
*/
|
2057
2064
|
interface LuaDeciderCombinatorControlBehavior extends LuaCombinatorControlBehavior {
|
2058
2065
|
/**
|
2059
|
-
*
|
2066
|
+
* This decider combinator's parameters.
|
2060
2067
|
*
|
2061
2068
|
* {@link https://lua-api.factorio.com/latest/LuaDeciderCombinatorControlBehavior.html#LuaDeciderCombinatorControlBehavior.parameters View documentation}
|
2062
|
-
* @remarks
|
2069
|
+
* @remarks Writing `nil` clears the combinator's parameters.
|
2063
2070
|
*/
|
2064
2071
|
parameters: DeciderCombinatorParameters
|
2065
2072
|
/**
|
@@ -2090,7 +2097,7 @@ interface LuaDecorativePrototype {
|
|
2090
2097
|
*/
|
2091
2098
|
readonly name: string
|
2092
2099
|
/**
|
2093
|
-
*
|
2100
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
2094
2101
|
*
|
2095
2102
|
* {@link https://lua-api.factorio.com/latest/LuaDecorativePrototype.html#LuaDecorativePrototype.order View documentation}
|
2096
2103
|
*/
|
@@ -2169,7 +2176,7 @@ interface LuaElectricEnergySourcePrototype {
|
|
2169
2176
|
*/
|
2170
2177
|
interface LuaEntity extends LuaControl {
|
2171
2178
|
/**
|
2172
|
-
* Gets the
|
2179
|
+
* Gets the entity's output inventory if it has one.
|
2173
2180
|
*
|
2174
2181
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_output_inventory View documentation}
|
2175
2182
|
* @returns A reference to the entity's output inventory.
|
@@ -2882,6 +2889,9 @@ interface LuaEntity extends LuaControl {
|
|
2882
2889
|
/**
|
2883
2890
|
* Sets the driver of this vehicle.
|
2884
2891
|
*
|
2892
|
+
* **Raised events:**
|
2893
|
+
* - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_
|
2894
|
+
*
|
2885
2895
|
* _Can only be used if this is Vehicle_
|
2886
2896
|
*
|
2887
2897
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.set_driver View documentation}
|
@@ -2902,6 +2912,9 @@ interface LuaEntity extends LuaControl {
|
|
2902
2912
|
/**
|
2903
2913
|
* Sets the passenger of this car or spidertron.
|
2904
2914
|
*
|
2915
|
+
* **Raised events:**
|
2916
|
+
* - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_
|
2917
|
+
*
|
2905
2918
|
* _Can only be used if this is Vehicle_
|
2906
2919
|
*
|
2907
2920
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.set_passenger View documentation}
|
@@ -2909,7 +2922,7 @@ interface LuaEntity extends LuaControl {
|
|
2909
2922
|
*/
|
2910
2923
|
set_passenger(passenger: LuaEntity | PlayerIdentification): void
|
2911
2924
|
/**
|
2912
|
-
* Returns true if this entity is connected to an electric network.
|
2925
|
+
* Returns `true` if this entity produces or consumes electricity and is connected to an electric network that has at least one entity that can produce power.
|
2913
2926
|
*
|
2914
2927
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_connected_to_electric_network View documentation}
|
2915
2928
|
*/
|
@@ -3755,13 +3768,16 @@ interface LuaEntity extends LuaControl {
|
|
3755
3768
|
*/
|
3756
3769
|
kills: uint
|
3757
3770
|
/**
|
3758
|
-
* The last player that changed any setting on this entity. This includes building the entity, changing its color, or configuring its circuit network. Can be `nil` if the last user is not part of the save anymore.
|
3771
|
+
* The last player that changed any setting on this entity. This includes building the entity, changing its color, or configuring its circuit network. Can be `nil` if the last user is not part of the save anymore.
|
3772
|
+
*
|
3773
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
3759
3774
|
*
|
3760
3775
|
* _Can only be used if this is EntityWithOwner_
|
3761
3776
|
*
|
3762
3777
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.last_user View documentation}
|
3763
3778
|
*/
|
3764
|
-
last_user: LuaPlayer | undefined
|
3779
|
+
get last_user(): LuaPlayer | LuaPlayer | undefined
|
3780
|
+
set last_user(value: LuaPlayer | PlayerIdentification | undefined)
|
3765
3781
|
/**
|
3766
3782
|
* The buffer size for the electric energy source or nil if the entity doesn't have an electric energy source.
|
3767
3783
|
*
|
@@ -3842,7 +3858,7 @@ interface LuaEntity extends LuaControl {
|
|
3842
3858
|
*/
|
3843
3859
|
readonly bounding_box: BoundingBoxRead
|
3844
3860
|
/**
|
3845
|
-
* The secondary bounding box of this entity or `nil` if it doesn't have one.
|
3861
|
+
* The secondary bounding box of this entity or `nil` if it doesn't have one. This only exists for curved rails, and is automatically determined by the game.
|
3846
3862
|
*
|
3847
3863
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.secondary_bounding_box View documentation}
|
3848
3864
|
*/
|
@@ -3854,7 +3870,7 @@ interface LuaEntity extends LuaControl {
|
|
3854
3870
|
*/
|
3855
3871
|
readonly selection_box: BoundingBoxRead
|
3856
3872
|
/**
|
3857
|
-
* The secondary selection box of this entity or `nil` if it doesn't have one.
|
3873
|
+
* The secondary selection box of this entity or `nil` if it doesn't have one. This only exists for curved rails, and is automatically determined by the game.
|
3858
3874
|
*
|
3859
3875
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.secondary_selection_box View documentation}
|
3860
3876
|
*/
|
@@ -4087,14 +4103,19 @@ interface LuaEntity extends LuaControl {
|
|
4087
4103
|
*/
|
4088
4104
|
character_corpse_death_cause: LocalisedString
|
4089
4105
|
/**
|
4090
|
-
* The player this character is associated with or `nil` if
|
4106
|
+
* The player this character is associated with, or `nil` if there isn't one. Set to `nil` to clear.
|
4107
|
+
*
|
4108
|
+
* The player will be automatically disassociated when a controller is set on the character. Also, all characters associated to a player will be logged off when the player logs off in multiplayer.
|
4109
|
+
*
|
4110
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
4091
4111
|
*
|
4092
4112
|
* _Can only be used if this is Character_
|
4093
4113
|
*
|
4094
4114
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.associated_player View documentation}
|
4095
|
-
* @remarks A character associated with a player is not directly controlled by any player
|
4115
|
+
* @remarks A character associated with a player is not directly controlled by any player.
|
4096
4116
|
*/
|
4097
|
-
associated_player: LuaPlayer | undefined
|
4117
|
+
get associated_player(): LuaPlayer | LuaPlayer | undefined
|
4118
|
+
set associated_player(value: LuaPlayer | PlayerIdentification | undefined)
|
4098
4119
|
/**
|
4099
4120
|
* The last tick this character entity was attacked.
|
4100
4121
|
*
|
@@ -4240,9 +4261,12 @@ interface LuaEntity extends LuaControl {
|
|
4240
4261
|
/**
|
4241
4262
|
* The player that this `simple-entity-with-owner`, `simple-entity-with-force`, `flying-text`, or `highlight-box` is visible to. `nil` means it is rendered for every player.
|
4242
4263
|
*
|
4264
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
4265
|
+
*
|
4243
4266
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_player View documentation}
|
4244
4267
|
*/
|
4245
|
-
render_player: LuaPlayer | undefined
|
4268
|
+
get render_player(): LuaPlayer | LuaPlayer | undefined
|
4269
|
+
set render_player(value: LuaPlayer | PlayerIdentification | undefined)
|
4246
4270
|
/**
|
4247
4271
|
* The forces that this `simple-entity-with-owner`, `simple-entity-with-force`, or `flying-text` is visible to. `nil` or an empty array means it is rendered for every force.
|
4248
4272
|
*
|
@@ -4486,7 +4510,7 @@ interface LuaEntity extends LuaControl {
|
|
4486
4510
|
*/
|
4487
4511
|
interface BaseEntity extends LuaControl {
|
4488
4512
|
/**
|
4489
|
-
* Gets the
|
4513
|
+
* Gets the entity's output inventory if it has one.
|
4490
4514
|
*
|
4491
4515
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_output_inventory View documentation}
|
4492
4516
|
* @returns A reference to the entity's output inventory.
|
@@ -4876,7 +4900,7 @@ interface BaseEntity extends LuaControl {
|
|
4876
4900
|
readonly force?: LuaForce | string
|
4877
4901
|
}): LuaMultiReturn<[boolean, Record<string, uint> | undefined]>
|
4878
4902
|
/**
|
4879
|
-
* Returns true if this entity is connected to an electric network.
|
4903
|
+
* Returns `true` if this entity produces or consumes electricity and is connected to an electric network that has at least one entity that can produce power.
|
4880
4904
|
*
|
4881
4905
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_connected_to_electric_network View documentation}
|
4882
4906
|
*/
|
@@ -5388,7 +5412,7 @@ interface BaseEntity extends LuaControl {
|
|
5388
5412
|
*/
|
5389
5413
|
readonly bounding_box: BoundingBoxRead
|
5390
5414
|
/**
|
5391
|
-
* The secondary bounding box of this entity or `nil` if it doesn't have one.
|
5415
|
+
* The secondary bounding box of this entity or `nil` if it doesn't have one. This only exists for curved rails, and is automatically determined by the game.
|
5392
5416
|
*
|
5393
5417
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.secondary_bounding_box View documentation}
|
5394
5418
|
*/
|
@@ -5400,7 +5424,7 @@ interface BaseEntity extends LuaControl {
|
|
5400
5424
|
*/
|
5401
5425
|
readonly selection_box: BoundingBoxRead
|
5402
5426
|
/**
|
5403
|
-
* The secondary selection box of this entity or `nil` if it doesn't have one.
|
5427
|
+
* The secondary selection box of this entity or `nil` if it doesn't have one. This only exists for curved rails, and is automatically determined by the game.
|
5404
5428
|
*
|
5405
5429
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.secondary_selection_box View documentation}
|
5406
5430
|
*/
|
@@ -5556,9 +5580,12 @@ interface BaseEntity extends LuaControl {
|
|
5556
5580
|
/**
|
5557
5581
|
* The player that this `simple-entity-with-owner`, `simple-entity-with-force`, `flying-text`, or `highlight-box` is visible to. `nil` means it is rendered for every player.
|
5558
5582
|
*
|
5583
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
5584
|
+
*
|
5559
5585
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_player View documentation}
|
5560
5586
|
*/
|
5561
|
-
render_player: LuaPlayer | undefined
|
5587
|
+
get render_player(): LuaPlayer | LuaPlayer | undefined
|
5588
|
+
set render_player(value: LuaPlayer | PlayerIdentification | undefined)
|
5562
5589
|
/**
|
5563
5590
|
* The forces that this `simple-entity-with-owner`, `simple-entity-with-force`, or `flying-text` is visible to. `nil` or an empty array means it is rendered for every force.
|
5564
5591
|
*
|
@@ -6276,6 +6303,9 @@ interface VehicleEntity extends BaseEntity {
|
|
6276
6303
|
/**
|
6277
6304
|
* Sets the driver of this vehicle.
|
6278
6305
|
*
|
6306
|
+
* **Raised events:**
|
6307
|
+
* - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_
|
6308
|
+
*
|
6279
6309
|
* _Can only be used if this is Vehicle_
|
6280
6310
|
*
|
6281
6311
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.set_driver View documentation}
|
@@ -6296,6 +6326,9 @@ interface VehicleEntity extends BaseEntity {
|
|
6296
6326
|
/**
|
6297
6327
|
* Sets the passenger of this car or spidertron.
|
6298
6328
|
*
|
6329
|
+
* **Raised events:**
|
6330
|
+
* - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_
|
6331
|
+
*
|
6299
6332
|
* _Can only be used if this is Vehicle_
|
6300
6333
|
*
|
6301
6334
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.set_passenger View documentation}
|
@@ -6718,14 +6751,19 @@ interface CharacterEntity extends BaseEntity {
|
|
6718
6751
|
*/
|
6719
6752
|
readonly player: LuaPlayer | undefined
|
6720
6753
|
/**
|
6721
|
-
* The player this character is associated with or `nil` if
|
6754
|
+
* The player this character is associated with, or `nil` if there isn't one. Set to `nil` to clear.
|
6755
|
+
*
|
6756
|
+
* The player will be automatically disassociated when a controller is set on the character. Also, all characters associated to a player will be logged off when the player logs off in multiplayer.
|
6757
|
+
*
|
6758
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
6722
6759
|
*
|
6723
6760
|
* _Can only be used if this is Character_
|
6724
6761
|
*
|
6725
6762
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.associated_player View documentation}
|
6726
|
-
* @remarks A character associated with a player is not directly controlled by any player
|
6763
|
+
* @remarks A character associated with a player is not directly controlled by any player.
|
6727
6764
|
*/
|
6728
|
-
associated_player: LuaPlayer | undefined
|
6765
|
+
get associated_player(): LuaPlayer | LuaPlayer | undefined
|
6766
|
+
set associated_player(value: LuaPlayer | PlayerIdentification | undefined)
|
6729
6767
|
/**
|
6730
6768
|
* The last tick this character entity was attacked.
|
6731
6769
|
*
|
@@ -6825,13 +6863,16 @@ interface TurretEntity extends BaseEntity {
|
|
6825
6863
|
|
6826
6864
|
interface EntityWithOwnerEntity extends BaseEntity {
|
6827
6865
|
/**
|
6828
|
-
* The last player that changed any setting on this entity. This includes building the entity, changing its color, or configuring its circuit network. Can be `nil` if the last user is not part of the save anymore.
|
6866
|
+
* The last player that changed any setting on this entity. This includes building the entity, changing its color, or configuring its circuit network. Can be `nil` if the last user is not part of the save anymore.
|
6867
|
+
*
|
6868
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
6829
6869
|
*
|
6830
6870
|
* _Can only be used if this is EntityWithOwner_
|
6831
6871
|
*
|
6832
6872
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.last_user View documentation}
|
6833
6873
|
*/
|
6834
|
-
last_user: LuaPlayer | undefined
|
6874
|
+
get last_user(): LuaPlayer | LuaPlayer | undefined
|
6875
|
+
set last_user(value: LuaPlayer | PlayerIdentification | undefined)
|
6835
6876
|
}
|
6836
6877
|
|
6837
6878
|
interface ElectricEnergyInterfaceEntity extends BaseEntity {
|
@@ -7186,7 +7227,7 @@ interface LuaEntityPrototype {
|
|
7186
7227
|
*/
|
7187
7228
|
readonly default_collision_mask_with_flags: CollisionMaskWithFlags
|
7188
7229
|
/**
|
7189
|
-
*
|
7230
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
7190
7231
|
*
|
7191
7232
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.order View documentation}
|
7192
7233
|
*/
|
@@ -8309,6 +8350,58 @@ interface LuaEntityPrototype {
|
|
8309
8350
|
readonly robots_shrink_when_entering_and_exiting: boolean
|
8310
8351
|
}
|
8311
8352
|
| undefined
|
8353
|
+
/**
|
8354
|
+
* Gets the height of this prototype. `nil` if this is not a spider vechicle.
|
8355
|
+
*
|
8356
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.height View documentation}
|
8357
|
+
*/
|
8358
|
+
readonly height: double | undefined
|
8359
|
+
/**
|
8360
|
+
* Gets the torso rotation speed of this prototype. `nil` if this is not a spider vechicle.
|
8361
|
+
*
|
8362
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.torso_rotation_speed View documentation}
|
8363
|
+
*/
|
8364
|
+
readonly torso_rotation_speed: double | undefined
|
8365
|
+
/**
|
8366
|
+
* Does this prototoype automaticly cycle weapons. `nil` if this is not a spider vechicle.
|
8367
|
+
*
|
8368
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.automatic_weapon_cycling View documentation}
|
8369
|
+
*/
|
8370
|
+
readonly automatic_weapon_cycling: boolean | undefined
|
8371
|
+
/**
|
8372
|
+
* Gets the chain shooting cooldown modifier of this prototype. `nil` if this is not a spider vechicle.
|
8373
|
+
*
|
8374
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.chain_shooting_cooldown_modifier View documentation}
|
8375
|
+
*/
|
8376
|
+
readonly chain_shooting_cooldown_modifier: double | undefined
|
8377
|
+
/**
|
8378
|
+
* Gets the chunk exploration radius of this prototype. `nil` if this is not a spider vechicle.
|
8379
|
+
*
|
8380
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.chunk_exploration_radius View documentation}
|
8381
|
+
*/
|
8382
|
+
readonly chunk_exploration_radius: double | undefined
|
8383
|
+
/**
|
8384
|
+
* Gets the animation speed coefficient of this belt . `nil` if this is not transport belt connectable.
|
8385
|
+
*
|
8386
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.animation_speed_coefficient View documentation}
|
8387
|
+
*/
|
8388
|
+
readonly animation_speed_coefficient: double | undefined
|
8389
|
+
/**
|
8390
|
+
* Get the manual range modifier for artillery turret and artillery wagon prototypes. `nil` if not artillery type prototype
|
8391
|
+
*
|
8392
|
+
* subclass(ArtilleryWagon, ArtilleryTurret)
|
8393
|
+
*
|
8394
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.manual_range_modifier View documentation}
|
8395
|
+
*/
|
8396
|
+
readonly manual_range_modifier: double | undefined
|
8397
|
+
/**
|
8398
|
+
* The dying time of this corpse prototype. `nil` if not a corpse prototype.
|
8399
|
+
*
|
8400
|
+
* _Can only be used if this is Corpse_
|
8401
|
+
*
|
8402
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.dying_speed View documentation}
|
8403
|
+
*/
|
8404
|
+
readonly dying_speed: float | undefined
|
8312
8405
|
/**
|
8313
8406
|
* Gets the current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
|
8314
8407
|
*
|
@@ -8575,7 +8668,7 @@ interface BaseEntityPrototype {
|
|
8575
8668
|
*/
|
8576
8669
|
readonly default_collision_mask_with_flags: CollisionMaskWithFlags
|
8577
8670
|
/**
|
8578
|
-
*
|
8671
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
8579
8672
|
*
|
8580
8673
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.order View documentation}
|
8581
8674
|
*/
|
@@ -9620,6 +9713,50 @@ interface BaseEntityPrototype {
|
|
9620
9713
|
readonly robots_shrink_when_entering_and_exiting: boolean
|
9621
9714
|
}
|
9622
9715
|
| undefined
|
9716
|
+
/**
|
9717
|
+
* Gets the height of this prototype. `nil` if this is not a spider vechicle.
|
9718
|
+
*
|
9719
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.height View documentation}
|
9720
|
+
*/
|
9721
|
+
readonly height: double | undefined
|
9722
|
+
/**
|
9723
|
+
* Gets the torso rotation speed of this prototype. `nil` if this is not a spider vechicle.
|
9724
|
+
*
|
9725
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.torso_rotation_speed View documentation}
|
9726
|
+
*/
|
9727
|
+
readonly torso_rotation_speed: double | undefined
|
9728
|
+
/**
|
9729
|
+
* Does this prototoype automaticly cycle weapons. `nil` if this is not a spider vechicle.
|
9730
|
+
*
|
9731
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.automatic_weapon_cycling View documentation}
|
9732
|
+
*/
|
9733
|
+
readonly automatic_weapon_cycling: boolean | undefined
|
9734
|
+
/**
|
9735
|
+
* Gets the chain shooting cooldown modifier of this prototype. `nil` if this is not a spider vechicle.
|
9736
|
+
*
|
9737
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.chain_shooting_cooldown_modifier View documentation}
|
9738
|
+
*/
|
9739
|
+
readonly chain_shooting_cooldown_modifier: double | undefined
|
9740
|
+
/**
|
9741
|
+
* Gets the chunk exploration radius of this prototype. `nil` if this is not a spider vechicle.
|
9742
|
+
*
|
9743
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.chunk_exploration_radius View documentation}
|
9744
|
+
*/
|
9745
|
+
readonly chunk_exploration_radius: double | undefined
|
9746
|
+
/**
|
9747
|
+
* Gets the animation speed coefficient of this belt . `nil` if this is not transport belt connectable.
|
9748
|
+
*
|
9749
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.animation_speed_coefficient View documentation}
|
9750
|
+
*/
|
9751
|
+
readonly animation_speed_coefficient: double | undefined
|
9752
|
+
/**
|
9753
|
+
* Get the manual range modifier for artillery turret and artillery wagon prototypes. `nil` if not artillery type prototype
|
9754
|
+
*
|
9755
|
+
* subclass(ArtilleryWagon, ArtilleryTurret)
|
9756
|
+
*
|
9757
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.manual_range_modifier View documentation}
|
9758
|
+
*/
|
9759
|
+
readonly manual_range_modifier: double | undefined
|
9623
9760
|
/**
|
9624
9761
|
* Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
|
9625
9762
|
*/
|
@@ -9727,6 +9864,17 @@ interface EntityWithOwnerEntityPrototype extends BaseEntityPrototype {
|
|
9727
9864
|
readonly allow_run_time_change_of_is_military_target: boolean
|
9728
9865
|
}
|
9729
9866
|
|
9867
|
+
interface CorpseEntityPrototype extends BaseEntityPrototype {
|
9868
|
+
/**
|
9869
|
+
* The dying time of this corpse prototype. `nil` if not a corpse prototype.
|
9870
|
+
*
|
9871
|
+
* _Can only be used if this is Corpse_
|
9872
|
+
*
|
9873
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.dying_speed View documentation}
|
9874
|
+
*/
|
9875
|
+
readonly dying_speed: float | undefined
|
9876
|
+
}
|
9877
|
+
|
9730
9878
|
interface CharacterEntityPrototype extends BaseEntityPrototype {
|
9731
9879
|
/**
|
9732
9880
|
* Gets the current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
|
@@ -9936,7 +10084,7 @@ interface LuaEquipmentCategoryPrototype {
|
|
9936
10084
|
*/
|
9937
10085
|
readonly name: string
|
9938
10086
|
/**
|
9939
|
-
*
|
10087
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
9940
10088
|
*
|
9941
10089
|
* {@link https://lua-api.factorio.com/latest/LuaEquipmentCategoryPrototype.html#LuaEquipmentCategoryPrototype.order View documentation}
|
9942
10090
|
*/
|
@@ -10154,7 +10302,7 @@ interface LuaEquipmentGridPrototype {
|
|
10154
10302
|
*/
|
10155
10303
|
readonly name: string
|
10156
10304
|
/**
|
10157
|
-
*
|
10305
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
10158
10306
|
*
|
10159
10307
|
* {@link https://lua-api.factorio.com/latest/LuaEquipmentGridPrototype.html#LuaEquipmentGridPrototype.order View documentation}
|
10160
10308
|
*/
|
@@ -10209,7 +10357,7 @@ interface LuaEquipmentPrototype {
|
|
10209
10357
|
*/
|
10210
10358
|
readonly type: string
|
10211
10359
|
/**
|
10212
|
-
*
|
10360
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
10213
10361
|
*
|
10214
10362
|
* {@link https://lua-api.factorio.com/latest/LuaEquipmentPrototype.html#LuaEquipmentPrototype.order View documentation}
|
10215
10363
|
*/
|
@@ -10344,7 +10492,7 @@ interface LuaEquipmentPrototype {
|
|
10344
10492
|
*
|
10345
10493
|
* Examples:
|
10346
10494
|
* - The item production GUI shows "consumption" on the right, thus `output` describes the item consumption numbers. The same goes for fluid consumption.
|
10347
|
-
* - The kills
|
10495
|
+
* - The kills GUI shows "losses" on the right, so `output` describes how many of the force's entities were killed by enemies.
|
10348
10496
|
* - The electric network GUI shows "power consumption" on the left side, so in this case `input` describes the power consumption numbers.
|
10349
10497
|
*
|
10350
10498
|
* {@link https://lua-api.factorio.com/latest/LuaFlowStatistics.html View documentation}
|
@@ -10382,7 +10530,11 @@ interface LuaFlowStatistics {
|
|
10382
10530
|
*/
|
10383
10531
|
set_output_count(name: string, count: uint64 | double): void
|
10384
10532
|
/**
|
10385
|
-
* Gets the flow count value for the given time frame.
|
10533
|
+
* Gets the flow count value for the given time frame. If `sample_index` is not provided, then the value returned is the average across the provided precision time period. These are the values shown in the bottom section of the statistics GUIs.
|
10534
|
+
*
|
10535
|
+
* Use `sample_index` to access the data used to generate the statistics graphs. Each precision level contains 300 samples of data so at a precision of 1 minute, each sample contains data averaged across 60s / 300 = 0.2s = 12 ticks.
|
10536
|
+
*
|
10537
|
+
* All return values are normalized to be per-tick for electric networks and per-minute for all other types.
|
10386
10538
|
*
|
10387
10539
|
* {@link https://lua-api.factorio.com/latest/LuaFlowStatistics.html#LuaFlowStatistics.get_flow_count View documentation}
|
10388
10540
|
*/
|
@@ -10396,11 +10548,15 @@ interface LuaFlowStatistics {
|
|
10396
10548
|
*/
|
10397
10549
|
readonly input: boolean
|
10398
10550
|
/**
|
10399
|
-
* The precision to read.
|
10551
|
+
* The precision range to read.
|
10400
10552
|
*/
|
10401
10553
|
readonly precision_index: defines.flow_precision_index
|
10402
10554
|
/**
|
10403
|
-
* If
|
10555
|
+
* The sample index to read from within the precision range. If not provided, the entire precision range is read. Must be between 1 and 300 where 1 is the most recent sample and 300 is the oldest.
|
10556
|
+
*/
|
10557
|
+
readonly sample_index?: uint16
|
10558
|
+
/**
|
10559
|
+
* If true, the count of items/fluids/entities is returned instead of the per-time-frame value.
|
10404
10560
|
*/
|
10405
10561
|
readonly count?: boolean
|
10406
10562
|
}): double
|
@@ -10481,7 +10637,7 @@ interface LuaFluidBox extends Array<Fluid | undefined> {
|
|
10481
10637
|
*/
|
10482
10638
|
get_capacity(index: uint): double
|
10483
10639
|
/**
|
10484
|
-
* The
|
10640
|
+
* The fluidboxes to which the fluidbox at the given index is connected.
|
10485
10641
|
*
|
10486
10642
|
* {@link https://lua-api.factorio.com/latest/LuaFluidBox.html#LuaFluidBox.get_connections View documentation}
|
10487
10643
|
*/
|
@@ -10719,7 +10875,7 @@ interface LuaFluidPrototype {
|
|
10719
10875
|
*/
|
10720
10876
|
readonly heat_capacity: double
|
10721
10877
|
/**
|
10722
|
-
*
|
10878
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
10723
10879
|
*
|
10724
10880
|
* {@link https://lua-api.factorio.com/latest/LuaFluidPrototype.html#LuaFluidPrototype.order View documentation}
|
10725
10881
|
*/
|
@@ -11546,7 +11702,7 @@ interface LuaFuelCategoryPrototype {
|
|
11546
11702
|
*/
|
11547
11703
|
readonly name: string
|
11548
11704
|
/**
|
11549
|
-
*
|
11705
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
11550
11706
|
*
|
11551
11707
|
* {@link https://lua-api.factorio.com/latest/LuaFuelCategoryPrototype.html#LuaFuelCategoryPrototype.order View documentation}
|
11552
11708
|
*/
|
@@ -11959,11 +12115,10 @@ interface LuaGameScript {
|
|
11959
12115
|
*/
|
11960
12116
|
is_valid_sound_path(sound_path: SoundPath): boolean
|
11961
12117
|
/**
|
11962
|
-
* Checks if the given SpritePath is valid and contains a loaded sprite.
|
12118
|
+
* Checks if the given SpritePath is valid and contains a loaded sprite. The existence of the image is not checked for paths of type `file`.
|
11963
12119
|
*
|
11964
12120
|
* {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.is_valid_sprite_path View documentation}
|
11965
12121
|
* @param sprite_path Path to the image.
|
11966
|
-
* @remarks The existence of the image is not checked for paths of type `file`.
|
11967
12122
|
*/
|
11968
12123
|
is_valid_sprite_path(sprite_path: SpritePath): boolean
|
11969
12124
|
/**
|
@@ -12279,7 +12434,9 @@ interface LuaGameScript {
|
|
12279
12434
|
*/
|
12280
12435
|
decode_string(string: string): string | undefined
|
12281
12436
|
/**
|
12282
|
-
*
|
12437
|
+
* This property is only populated inside {@link LuaCommandProcessor custom command} handlers and when writing {@link https://wiki.factorio.com/Console#Scripting_and_cheat_commands Lua console commands}. Returns the player that is typing the command, `nil` in all other instances.
|
12438
|
+
*
|
12439
|
+
* See {@link LuaGameScript#players LuaGameScript::players} for accessing all players.
|
12283
12440
|
*
|
12284
12441
|
* {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.player View documentation}
|
12285
12442
|
*/
|
@@ -12727,6 +12884,11 @@ interface LuaGroup {
|
|
12727
12884
|
* @remarks Can only be used on groups, not on subgroups.
|
12728
12885
|
*/
|
12729
12886
|
readonly order_in_recipe: string
|
12887
|
+
/**
|
12888
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
12889
|
+
*
|
12890
|
+
* {@link https://lua-api.factorio.com/latest/LuaGroup.html#LuaGroup.order View documentation}
|
12891
|
+
*/
|
12730
12892
|
readonly order: string
|
12731
12893
|
/**
|
12732
12894
|
* Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
|
@@ -12753,6 +12915,8 @@ interface LuaGui {
|
|
12753
12915
|
/**
|
12754
12916
|
* Returns `true` if sprite_path is valid and contains loaded sprite, otherwise `false`. Sprite path of type `file` doesn't validate if file exists.
|
12755
12917
|
*
|
12918
|
+
* If you want to avoid needing a LuaGui object, {@link LuaGameScript#is_valid_sprite_path LuaGameScript::is_valid_sprite_path} can be used instead.
|
12919
|
+
*
|
12756
12920
|
* {@link https://lua-api.factorio.com/latest/LuaGui.html#LuaGui.is_valid_sprite_path View documentation}
|
12757
12921
|
* @param sprite_path Path to a image.
|
12758
12922
|
*/
|
@@ -12852,7 +13016,7 @@ interface BaseGuiSpec {
|
|
12852
13016
|
*/
|
12853
13017
|
readonly type: GuiElementType
|
12854
13018
|
/**
|
12855
|
-
* Name of the child element.
|
13019
|
+
* Name of the child element. It must be unique within the parent element.
|
12856
13020
|
*/
|
12857
13021
|
readonly name?: string
|
12858
13022
|
/**
|
@@ -13371,7 +13535,7 @@ interface BaseGuiElement {
|
|
13371
13535
|
* Other attributes may be specified depending on `type`:
|
13372
13536
|
*
|
13373
13537
|
* {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.add View documentation}
|
13374
|
-
* @returns The
|
13538
|
+
* @returns The GUI element that was added.
|
13375
13539
|
*/
|
13376
13540
|
add<Type extends GuiElementType>(
|
13377
13541
|
element: GuiSpec & {
|
@@ -13460,7 +13624,7 @@ interface BaseGuiElement {
|
|
13460
13624
|
*/
|
13461
13625
|
readonly parent: LuaGuiElement | undefined
|
13462
13626
|
/**
|
13463
|
-
* The name of this element.
|
13627
|
+
* The name of this element. `""` if no name was set.
|
13464
13628
|
*
|
13465
13629
|
* {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.name View documentation}
|
13466
13630
|
* @example
|
@@ -13585,20 +13749,7 @@ interface ChooseElemButtonGuiElementMembers extends BaseGuiElement {
|
|
13585
13749
|
*/
|
13586
13750
|
elem_value: (this["elem_type"] extends "signal" ? SignalID : string) | undefined
|
13587
13751
|
/**
|
13588
|
-
* The elem filters of this choose-elem-button or `nil` if there are no filters.
|
13589
|
-
*
|
13590
|
-
* The compatible type of filter is determined by elem_type:
|
13591
|
-
* - Type `"item"` - {@link ItemPrototypeFilter}
|
13592
|
-
* - Type `"tile"` - {@link TilePrototypeFilter}
|
13593
|
-
* - Type `"entity"` - {@link EntityPrototypeFilter}
|
13594
|
-
* - Type `"signal"` - Does not support filters
|
13595
|
-
* - Type `"fluid"` - {@link FluidPrototypeFilter}
|
13596
|
-
* - Type `"recipe"` - {@link RecipePrototypeFilter}
|
13597
|
-
* - Type `"decorative"` - {@link DecorativePrototypeFilter}
|
13598
|
-
* - Type `"item-group"` - Does not support filters
|
13599
|
-
* - Type `"achievement"` - {@link AchievementPrototypeFilter}
|
13600
|
-
* - Type `"equipment"` - {@link EquipmentPrototypeFilter}
|
13601
|
-
* - Type `"technology"` - {@link TechnologyPrototypeFilter}
|
13752
|
+
* The elem filters of this choose-elem-button, or `nil` if there are no filters. The compatible type of filter is determined by `elem_type`.
|
13602
13753
|
*
|
13603
13754
|
* _Can only be used if this is choose-elem-button_
|
13604
13755
|
*
|
@@ -15223,7 +15374,7 @@ interface LuaItemPrototype {
|
|
15223
15374
|
readonly localised_name: LocalisedString
|
15224
15375
|
readonly localised_description: LocalisedString
|
15225
15376
|
/**
|
15226
|
-
*
|
15377
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
15227
15378
|
*
|
15228
15379
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.order View documentation}
|
15229
15380
|
*/
|
@@ -15461,13 +15612,13 @@ interface LuaItemPrototype {
|
|
15461
15612
|
*/
|
15462
15613
|
readonly speed: float | undefined
|
15463
15614
|
/**
|
15464
|
-
* Effects of this module
|
15615
|
+
* Effects of this module.
|
15465
15616
|
*
|
15466
15617
|
* _Can only be used if this is ModuleItem_
|
15467
15618
|
*
|
15468
15619
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.module_effects View documentation}
|
15469
15620
|
*/
|
15470
|
-
readonly module_effects: ModuleEffects
|
15621
|
+
readonly module_effects: ModuleEffects
|
15471
15622
|
/**
|
15472
15623
|
* The name of a {@link LuaModuleCategoryPrototype}. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.
|
15473
15624
|
*
|
@@ -15816,7 +15967,7 @@ interface BaseItemPrototype {
|
|
15816
15967
|
readonly localised_name: LocalisedString
|
15817
15968
|
readonly localised_description: LocalisedString
|
15818
15969
|
/**
|
15819
|
-
*
|
15970
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
15820
15971
|
*
|
15821
15972
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.order View documentation}
|
15822
15973
|
*/
|
@@ -16078,13 +16229,13 @@ interface ItemWithLabelItemPrototype extends BaseItemPrototype {
|
|
16078
16229
|
|
16079
16230
|
interface ModuleItemPrototype extends BaseItemPrototype {
|
16080
16231
|
/**
|
16081
|
-
* Effects of this module
|
16232
|
+
* Effects of this module.
|
16082
16233
|
*
|
16083
16234
|
* _Can only be used if this is ModuleItem_
|
16084
16235
|
*
|
16085
16236
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.module_effects View documentation}
|
16086
16237
|
*/
|
16087
|
-
readonly module_effects: ModuleEffects
|
16238
|
+
readonly module_effects: ModuleEffects
|
16088
16239
|
/**
|
16089
16240
|
* The name of a {@link LuaModuleCategoryPrototype}. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.
|
16090
16241
|
*
|
@@ -16484,8 +16635,8 @@ interface LuaItemStack {
|
|
16484
16635
|
* Set this item stack to another item stack.
|
16485
16636
|
*
|
16486
16637
|
* {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.set_stack View documentation}
|
16487
|
-
* @param stack Item stack to set
|
16488
|
-
* @returns
|
16638
|
+
* @param stack Item stack to set it to. Omitting this parameter or passing `nil` will clear this item stack, as if {@link LuaItemStack#clear LuaItemStack::clear} was called.
|
16639
|
+
* @returns Whether the stack was set successfully. Returns `false` if this stack was not {@link LuaItemStack#can_set_stack valid for write}.
|
16489
16640
|
*/
|
16490
16641
|
set_stack(stack?: ItemStackIdentification): boolean
|
16491
16642
|
/**
|
@@ -17219,8 +17370,8 @@ interface BaseItemStack {
|
|
17219
17370
|
* Set this item stack to another item stack.
|
17220
17371
|
*
|
17221
17372
|
* {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.set_stack View documentation}
|
17222
|
-
* @param stack Item stack to set
|
17223
|
-
* @returns
|
17373
|
+
* @param stack Item stack to set it to. Omitting this parameter or passing `nil` will clear this item stack, as if {@link LuaItemStack#clear LuaItemStack::clear} was called.
|
17374
|
+
* @returns Whether the stack was set successfully. Returns `false` if this stack was not {@link LuaItemStack#can_set_stack valid for write}.
|
17224
17375
|
*/
|
17225
17376
|
set_stack(stack?: ItemStackIdentification): boolean
|
17226
17377
|
/**
|
@@ -18619,7 +18770,7 @@ interface LuaModSettingPrototype {
|
|
18619
18770
|
*/
|
18620
18771
|
readonly name: string
|
18621
18772
|
/**
|
18622
|
-
*
|
18773
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18623
18774
|
*
|
18624
18775
|
* {@link https://lua-api.factorio.com/latest/LuaModSettingPrototype.html#LuaModSettingPrototype.order View documentation}
|
18625
18776
|
*/
|
@@ -18703,7 +18854,7 @@ interface LuaModuleCategoryPrototype {
|
|
18703
18854
|
*/
|
18704
18855
|
readonly name: string
|
18705
18856
|
/**
|
18706
|
-
*
|
18857
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18707
18858
|
*
|
18708
18859
|
* {@link https://lua-api.factorio.com/latest/LuaModuleCategoryPrototype.html#LuaModuleCategoryPrototype.order View documentation}
|
18709
18860
|
*/
|
@@ -18738,7 +18889,7 @@ interface LuaNamedNoiseExpression {
|
|
18738
18889
|
*/
|
18739
18890
|
readonly name: string
|
18740
18891
|
/**
|
18741
|
-
*
|
18892
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18742
18893
|
*
|
18743
18894
|
* {@link https://lua-api.factorio.com/latest/LuaNamedNoiseExpression.html#LuaNamedNoiseExpression.order View documentation}
|
18744
18895
|
*/
|
@@ -18785,7 +18936,7 @@ interface LuaNoiseLayerPrototype {
|
|
18785
18936
|
*/
|
18786
18937
|
readonly name: string
|
18787
18938
|
/**
|
18788
|
-
*
|
18939
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18789
18940
|
*
|
18790
18941
|
* {@link https://lua-api.factorio.com/latest/LuaNoiseLayerPrototype.html#LuaNoiseLayerPrototype.order View documentation}
|
18791
18942
|
*/
|
@@ -18820,7 +18971,7 @@ interface LuaParticlePrototype {
|
|
18820
18971
|
*/
|
18821
18972
|
readonly name: string
|
18822
18973
|
/**
|
18823
|
-
*
|
18974
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18824
18975
|
*
|
18825
18976
|
* {@link https://lua-api.factorio.com/latest/LuaParticlePrototype.html#LuaParticlePrototype.order View documentation}
|
18826
18977
|
*/
|
@@ -19123,6 +19274,10 @@ interface LuaPlayer extends LuaControl {
|
|
19123
19274
|
/**
|
19124
19275
|
* Invokes the "clear cursor" action on the player as if the user pressed it.
|
19125
19276
|
*
|
19277
|
+
* **Raised events:**
|
19278
|
+
* - {@link OnPlayerCursorStackChangedEvent on_player_cursor_stack_changed}? _current_tick_ Raised when the cursor was successfully cleared.
|
19279
|
+
*
|
19280
|
+
*
|
19126
19281
|
* {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.clear_cursor View documentation}
|
19127
19282
|
* @returns Whether the cursor is now empty.
|
19128
19283
|
*/
|
@@ -19595,7 +19750,7 @@ interface LuaPlayer extends LuaControl {
|
|
19595
19750
|
*/
|
19596
19751
|
readonly cutscene_character: LuaEntity | undefined
|
19597
19752
|
/**
|
19598
|
-
* This player's index in {@link LuaGameScript#players LuaGameScript::players}.
|
19753
|
+
* This player's unique index in {@link LuaGameScript#players LuaGameScript::players}. It is given to them when they are {@link OnPlayerCreatedEvent created} and remains assigned to them until they are {@link OnPlayerRemovedEvent removed}.
|
19599
19754
|
*
|
19600
19755
|
* {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.index View documentation}
|
19601
19756
|
*/
|
@@ -20143,7 +20298,7 @@ interface LuaRecipe {
|
|
20143
20298
|
*/
|
20144
20299
|
readonly energy: double
|
20145
20300
|
/**
|
20146
|
-
*
|
20301
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
20147
20302
|
*
|
20148
20303
|
* {@link https://lua-api.factorio.com/latest/LuaRecipe.html#LuaRecipe.order View documentation}
|
20149
20304
|
*/
|
@@ -20194,7 +20349,7 @@ interface LuaRecipeCategoryPrototype {
|
|
20194
20349
|
*/
|
20195
20350
|
readonly name: string
|
20196
20351
|
/**
|
20197
|
-
*
|
20352
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
20198
20353
|
*
|
20199
20354
|
* {@link https://lua-api.factorio.com/latest/LuaRecipeCategoryPrototype.html#LuaRecipeCategoryPrototype.order View documentation}
|
20200
20355
|
*/
|
@@ -20296,7 +20451,7 @@ interface LuaRecipePrototype {
|
|
20296
20451
|
*/
|
20297
20452
|
readonly energy: double
|
20298
20453
|
/**
|
20299
|
-
*
|
20454
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
20300
20455
|
*
|
20301
20456
|
* {@link https://lua-api.factorio.com/latest/LuaRecipePrototype.html#LuaRecipePrototype.order View documentation}
|
20302
20457
|
*/
|
@@ -20502,11 +20657,11 @@ interface LuaRendering {
|
|
20502
20657
|
*/
|
20503
20658
|
readonly time_to_live?: uint
|
20504
20659
|
/**
|
20505
|
-
* The forces that this object is rendered to.
|
20660
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
20506
20661
|
*/
|
20507
20662
|
readonly forces?: readonly ForceIdentification[]
|
20508
20663
|
/**
|
20509
|
-
* The players that this object is rendered to.
|
20664
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
20510
20665
|
*/
|
20511
20666
|
readonly players?: readonly PlayerIdentification[]
|
20512
20667
|
/**
|
@@ -20551,11 +20706,11 @@ interface LuaRendering {
|
|
20551
20706
|
*/
|
20552
20707
|
readonly time_to_live?: uint
|
20553
20708
|
/**
|
20554
|
-
* The forces that this object is rendered to.
|
20709
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
20555
20710
|
*/
|
20556
20711
|
readonly forces?: readonly ForceIdentification[]
|
20557
20712
|
/**
|
20558
|
-
* The players that this object is rendered to.
|
20713
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
20559
20714
|
*/
|
20560
20715
|
readonly players?: readonly PlayerIdentification[]
|
20561
20716
|
/**
|
@@ -20618,11 +20773,11 @@ interface LuaRendering {
|
|
20618
20773
|
*/
|
20619
20774
|
readonly time_to_live?: uint
|
20620
20775
|
/**
|
20621
|
-
* The forces that this object is rendered to.
|
20776
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
20622
20777
|
*/
|
20623
20778
|
readonly forces?: readonly ForceIdentification[]
|
20624
20779
|
/**
|
20625
|
-
* The players that this object is rendered to.
|
20780
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
20626
20781
|
*/
|
20627
20782
|
readonly players?: readonly PlayerIdentification[]
|
20628
20783
|
/**
|
@@ -20670,11 +20825,11 @@ interface LuaRendering {
|
|
20670
20825
|
*/
|
20671
20826
|
readonly time_to_live?: uint
|
20672
20827
|
/**
|
20673
|
-
* The forces that this object is rendered to.
|
20828
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
20674
20829
|
*/
|
20675
20830
|
readonly forces?: readonly ForceIdentification[]
|
20676
20831
|
/**
|
20677
|
-
* The players that this object is rendered to.
|
20832
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
20678
20833
|
*/
|
20679
20834
|
readonly players?: readonly PlayerIdentification[]
|
20680
20835
|
/**
|
@@ -20725,11 +20880,11 @@ interface LuaRendering {
|
|
20725
20880
|
*/
|
20726
20881
|
readonly time_to_live?: uint
|
20727
20882
|
/**
|
20728
|
-
* The forces that this object is rendered to.
|
20883
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
20729
20884
|
*/
|
20730
20885
|
readonly forces?: readonly ForceIdentification[]
|
20731
20886
|
/**
|
20732
|
-
* The players that this object is rendered to.
|
20887
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
20733
20888
|
*/
|
20734
20889
|
readonly players?: readonly PlayerIdentification[]
|
20735
20890
|
/**
|
@@ -20780,11 +20935,11 @@ interface LuaRendering {
|
|
20780
20935
|
*/
|
20781
20936
|
readonly time_to_live?: uint
|
20782
20937
|
/**
|
20783
|
-
* The forces that this object is rendered to.
|
20938
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
20784
20939
|
*/
|
20785
20940
|
readonly forces?: readonly ForceIdentification[]
|
20786
20941
|
/**
|
20787
|
-
* The players that this object is rendered to.
|
20942
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
20788
20943
|
*/
|
20789
20944
|
readonly players?: readonly PlayerIdentification[]
|
20790
20945
|
/**
|
@@ -20858,11 +21013,11 @@ interface LuaRendering {
|
|
20858
21013
|
*/
|
20859
21014
|
readonly time_to_live?: uint
|
20860
21015
|
/**
|
20861
|
-
* The forces that this object is rendered to.
|
21016
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
20862
21017
|
*/
|
20863
21018
|
readonly forces?: readonly ForceIdentification[]
|
20864
21019
|
/**
|
20865
|
-
* The players that this object is rendered to.
|
21020
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
20866
21021
|
*/
|
20867
21022
|
readonly players?: readonly PlayerIdentification[]
|
20868
21023
|
/**
|
@@ -20921,11 +21076,11 @@ interface LuaRendering {
|
|
20921
21076
|
*/
|
20922
21077
|
readonly time_to_live?: uint
|
20923
21078
|
/**
|
20924
|
-
* The forces that this object is rendered to.
|
21079
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
20925
21080
|
*/
|
20926
21081
|
readonly forces?: readonly ForceIdentification[]
|
20927
21082
|
/**
|
20928
|
-
* The players that this object is rendered to.
|
21083
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
20929
21084
|
*/
|
20930
21085
|
readonly players?: readonly PlayerIdentification[]
|
20931
21086
|
/**
|
@@ -20996,11 +21151,11 @@ interface LuaRendering {
|
|
20996
21151
|
*/
|
20997
21152
|
readonly time_to_live?: uint
|
20998
21153
|
/**
|
20999
|
-
* The forces that this object is rendered to.
|
21154
|
+
* The forces that this object is rendered to. Passing `nil` or an empty table will render it to all forces.
|
21000
21155
|
*/
|
21001
21156
|
readonly forces?: readonly ForceIdentification[]
|
21002
21157
|
/**
|
21003
|
-
* The players that this object is rendered to.
|
21158
|
+
* The players that this object is rendered to. Passing `nil` or an empty table will render it to all players.
|
21004
21159
|
*/
|
21005
21160
|
readonly players?: readonly PlayerIdentification[]
|
21006
21161
|
/**
|
@@ -21793,7 +21948,7 @@ interface LuaResourceCategoryPrototype {
|
|
21793
21948
|
*/
|
21794
21949
|
readonly name: string
|
21795
21950
|
/**
|
21796
|
-
*
|
21951
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
21797
21952
|
*
|
21798
21953
|
* {@link https://lua-api.factorio.com/latest/LuaResourceCategoryPrototype.html#LuaResourceCategoryPrototype.order View documentation}
|
21799
21954
|
*/
|
@@ -21907,7 +22062,7 @@ interface LuaShortcutPrototype {
|
|
21907
22062
|
*/
|
21908
22063
|
readonly name: string
|
21909
22064
|
/**
|
21910
|
-
*
|
22065
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
21911
22066
|
*
|
21912
22067
|
* {@link https://lua-api.factorio.com/latest/LuaShortcutPrototype.html#LuaShortcutPrototype.order View documentation}
|
21913
22068
|
*/
|
@@ -22161,7 +22316,7 @@ interface LuaStyle {
|
|
22161
22316
|
/**
|
22162
22317
|
* Horizontal space between individual cells.
|
22163
22318
|
*
|
22164
|
-
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or
|
22319
|
+
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
|
22165
22320
|
*
|
22166
22321
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
|
22167
22322
|
*/
|
@@ -22336,13 +22491,13 @@ interface LuaStyle {
|
|
22336
22491
|
*/
|
22337
22492
|
set cell_padding(value: int)
|
22338
22493
|
/**
|
22339
|
-
* Sets extra_top/right/bottom/
|
22494
|
+
* Sets `extra_top/right/bottom/left_padding_when_activated` to this value. An array with two values sets top/bottom padding to the first value and left/right padding to the second value. An array with four values sets top, right, bottom, left padding respectively.
|
22340
22495
|
*
|
22341
22496
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_padding_when_activated View documentation}
|
22342
22497
|
*/
|
22343
22498
|
set extra_padding_when_activated(value: int | StyleValuesArray)
|
22344
22499
|
/**
|
22345
|
-
* Sets extra_top/right/bottom/left_margin_when_activated to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
|
22500
|
+
* Sets `extra_top/right/bottom/left_margin_when_activated` to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
|
22346
22501
|
*
|
22347
22502
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_margin_when_activated View documentation}
|
22348
22503
|
*/
|
@@ -22551,7 +22706,7 @@ interface TableStyle extends BaseStyle {
|
|
22551
22706
|
/**
|
22552
22707
|
* Horizontal space between individual cells.
|
22553
22708
|
*
|
22554
|
-
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or
|
22709
|
+
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
|
22555
22710
|
*
|
22556
22711
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
|
22557
22712
|
*/
|
@@ -22725,7 +22880,7 @@ interface FlowStyle extends BaseStyle {
|
|
22725
22880
|
/**
|
22726
22881
|
* Horizontal space between individual cells.
|
22727
22882
|
*
|
22728
|
-
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or
|
22883
|
+
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
|
22729
22884
|
*
|
22730
22885
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
|
22731
22886
|
*/
|
@@ -22744,7 +22899,7 @@ interface HorizontalFlowStyle extends BaseStyle {
|
|
22744
22899
|
/**
|
22745
22900
|
* Horizontal space between individual cells.
|
22746
22901
|
*
|
22747
|
-
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or
|
22902
|
+
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
|
22748
22903
|
*
|
22749
22904
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
|
22750
22905
|
*/
|
@@ -22848,13 +23003,13 @@ interface ScrollPaneStyle extends BaseStyle {
|
|
22848
23003
|
*/
|
22849
23004
|
extra_right_margin_when_activated: int
|
22850
23005
|
/**
|
22851
|
-
* Sets extra_top/right/bottom/
|
23006
|
+
* Sets `extra_top/right/bottom/left_padding_when_activated` to this value. An array with two values sets top/bottom padding to the first value and left/right padding to the second value. An array with four values sets top, right, bottom, left padding respectively.
|
22852
23007
|
*
|
22853
23008
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_padding_when_activated View documentation}
|
22854
23009
|
*/
|
22855
23010
|
set extra_padding_when_activated(value: int | StyleValuesArray)
|
22856
23011
|
/**
|
22857
|
-
* Sets extra_top/right/bottom/left_margin_when_activated to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
|
23012
|
+
* Sets `extra_top/right/bottom/left_margin_when_activated` to this value. An array with two values sets top/bottom margin to the first value and left/right margin to the second value. An array with four values sets top, right, bottom, left margin respectively.
|
22858
23013
|
*
|
22859
23014
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_margin_when_activated View documentation}
|
22860
23015
|
*/
|
@@ -22890,11 +23045,11 @@ interface BaseSurfaceCreateEntity {
|
|
22890
23045
|
/**
|
22891
23046
|
* Entity with health for the new entity to target.
|
22892
23047
|
*/
|
22893
|
-
readonly target?: LuaEntity
|
23048
|
+
readonly target?: LuaEntity | MapPosition
|
22894
23049
|
/**
|
22895
23050
|
* Source entity. Used for beams and highlight-boxes.
|
22896
23051
|
*/
|
22897
|
-
readonly source?: LuaEntity
|
23052
|
+
readonly source?: LuaEntity | MapPosition
|
22898
23053
|
/**
|
22899
23054
|
* If true, building will attempt to simulate fast-replace building.
|
22900
23055
|
*/
|
@@ -23099,7 +23254,7 @@ interface CharacterCorpseSurfaceCreateEntity extends BaseSurfaceCreateEntity {
|
|
23099
23254
|
|
23100
23255
|
interface HighlightBoxSurfaceCreateEntity extends BaseSurfaceCreateEntity {
|
23101
23256
|
/**
|
23102
|
-
* The bounding box defining the highlight box using absolute map coordinates. If specified, the `position` parameter
|
23257
|
+
* The bounding box defining the highlight box using absolute map coordinates. If specified, the general `position` parameter still needs to be present, but will be ignored. If not specified, the game falls back to the `source` parameter first, then the `target` parameter second. One of these three parameters need to be specified.
|
23103
23258
|
*/
|
23104
23259
|
readonly bounding_box?: BoundingBox
|
23105
23260
|
/**
|
@@ -23268,7 +23423,10 @@ interface LuaSurface {
|
|
23268
23423
|
*
|
23269
23424
|
* If no filters (`name`, `type`, `force`, etc.) are given, this returns all entities in the search area. If multiple filters are specified, only entities matching all given filters are returned.
|
23270
23425
|
*
|
23271
|
-
* If no `area` or `position` are given, the entire surface is searched.
|
23426
|
+
* - If no `area` or `position` are given, the entire surface is searched.
|
23427
|
+
* - If `position` is given, this returns the entities colliding with that position (i.e the given position is within the entity's collision box).
|
23428
|
+
* - If `position` and `radius` are given, this returns the entities within the radius of the position. Looks for the center of entities.
|
23429
|
+
* - If `area` is specified, this returns the entities colliding with that area.
|
23272
23430
|
*
|
23273
23431
|
* {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entities_filtered View documentation}
|
23274
23432
|
* @example
|
@@ -23288,9 +23446,6 @@ interface LuaSurface {
|
|
23288
23446
|
* Has precedence over area field.
|
23289
23447
|
*/
|
23290
23448
|
readonly position?: MapPosition
|
23291
|
-
/**
|
23292
|
-
* If given with position, will return all entities within the radius of the position.
|
23293
|
-
*/
|
23294
23449
|
readonly radius?: double
|
23295
23450
|
readonly name?: string | readonly string[]
|
23296
23451
|
readonly type?: string | readonly string[]
|
@@ -23304,7 +23459,7 @@ interface LuaSurface {
|
|
23304
23459
|
readonly limit?: uint
|
23305
23460
|
readonly is_military_target?: boolean
|
23306
23461
|
/**
|
23307
|
-
*
|
23462
|
+
* Whether the filters should be inverted.
|
23308
23463
|
*/
|
23309
23464
|
readonly invert?: boolean
|
23310
23465
|
}): LuaEntity[]
|
@@ -24597,7 +24752,7 @@ interface LuaTechnology {
|
|
24597
24752
|
*/
|
24598
24753
|
readonly research_unit_energy: double
|
24599
24754
|
/**
|
24600
|
-
*
|
24755
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
24601
24756
|
*
|
24602
24757
|
* {@link https://lua-api.factorio.com/latest/LuaTechnology.html#LuaTechnology.order View documentation}
|
24603
24758
|
*/
|
@@ -24711,7 +24866,7 @@ interface LuaTechnologyPrototype {
|
|
24711
24866
|
*/
|
24712
24867
|
readonly research_unit_energy: double
|
24713
24868
|
/**
|
24714
|
-
*
|
24869
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
24715
24870
|
*
|
24716
24871
|
* {@link https://lua-api.factorio.com/latest/LuaTechnologyPrototype.html#LuaTechnologyPrototype.order View documentation}
|
24717
24872
|
*/
|
@@ -24850,7 +25005,7 @@ interface LuaTilePrototype {
|
|
24850
25005
|
*/
|
24851
25006
|
readonly name: string
|
24852
25007
|
/**
|
24853
|
-
*
|
25008
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
24854
25009
|
*
|
24855
25010
|
* {@link https://lua-api.factorio.com/latest/LuaTilePrototype.html#LuaTilePrototype.order View documentation}
|
24856
25011
|
*/
|
@@ -24896,11 +25051,11 @@ interface LuaTilePrototype {
|
|
24896
25051
|
/**
|
24897
25052
|
* Energy required to mine a tile.
|
24898
25053
|
*/
|
24899
|
-
readonly
|
25054
|
+
readonly mining_time: double
|
24900
25055
|
/**
|
24901
25056
|
* Prototype name of the particle produced when mining this tile. Will only be present if this tile produces any particle during mining.
|
24902
25057
|
*/
|
24903
|
-
readonly
|
25058
|
+
readonly mining_particle?: string
|
24904
25059
|
/**
|
24905
25060
|
* Products obtained by mining this tile.
|
24906
25061
|
*/
|
@@ -24913,11 +25068,11 @@ interface LuaTilePrototype {
|
|
24913
25068
|
*/
|
24914
25069
|
readonly next_direction: LuaTilePrototype | undefined
|
24915
25070
|
/**
|
24916
|
-
* Items that when placed will produce this tile. It is a dictionary indexed by the item prototype name.
|
25071
|
+
* Items that when placed will produce this tile. It is a dictionary indexed by the item prototype name. `nil` (instead of an empty table) if no items can place this tile.
|
24917
25072
|
*
|
24918
25073
|
* {@link https://lua-api.factorio.com/latest/LuaTilePrototype.html#LuaTilePrototype.items_to_place_this View documentation}
|
24919
25074
|
*/
|
24920
|
-
readonly items_to_place_this: SimpleItemStack[]
|
25075
|
+
readonly items_to_place_this: SimpleItemStack[] | undefined
|
24921
25076
|
/**
|
24922
25077
|
* False if this tile is not allowed in blueprints regardless of the ability to build it.
|
24923
25078
|
*
|
@@ -25465,7 +25620,7 @@ interface LuaTrivialSmokePrototype {
|
|
25465
25620
|
*/
|
25466
25621
|
readonly name: string
|
25467
25622
|
/**
|
25468
|
-
*
|
25623
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
25469
25624
|
*
|
25470
25625
|
* {@link https://lua-api.factorio.com/latest/LuaTrivialSmokePrototype.html#LuaTrivialSmokePrototype.order View documentation}
|
25471
25626
|
*/
|
@@ -25626,7 +25781,7 @@ interface LuaVirtualSignalPrototype {
|
|
25626
25781
|
*/
|
25627
25782
|
readonly name: string
|
25628
25783
|
/**
|
25629
|
-
*
|
25784
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
25630
25785
|
*
|
25631
25786
|
* {@link https://lua-api.factorio.com/latest/LuaVirtualSignalPrototype.html#LuaVirtualSignalPrototype.order View documentation}
|
25632
25787
|
*/
|