typed-factorio 0.20.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- package/Changelog.md +17 -8
- package/generated/classes.d.ts +422 -118
- package/generated/concepts.d.ts +178 -84
- package/generated/defines.d.ts +9 -0
- package/generated/events.d.ts +65 -1
- 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.
|
@@ -1857,7 +1860,7 @@ interface LuaCustomInputPrototype {
|
|
1857
1860
|
*/
|
1858
1861
|
readonly name: string
|
1859
1862
|
/**
|
1860
|
-
*
|
1863
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
1861
1864
|
*
|
1862
1865
|
* {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.order View documentation}
|
1863
1866
|
*/
|
@@ -1895,25 +1898,25 @@ interface LuaCustomInputPrototype {
|
|
1895
1898
|
*/
|
1896
1899
|
readonly action: string
|
1897
1900
|
/**
|
1898
|
-
*
|
1901
|
+
* Whether this custom input is enabled. Disabled custom inputs exist but are not used by the game.
|
1899
1902
|
*
|
1900
1903
|
* {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.enabled View documentation}
|
1901
1904
|
*/
|
1902
1905
|
readonly enabled: boolean
|
1903
1906
|
/**
|
1904
|
-
*
|
1907
|
+
* Whether this custom input is enabled while using the spectator controller.
|
1905
1908
|
*
|
1906
1909
|
* {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.enabled_while_spectating View documentation}
|
1907
1910
|
*/
|
1908
1911
|
readonly enabled_while_spectating: boolean
|
1909
1912
|
/**
|
1910
|
-
*
|
1913
|
+
* Whether this custom input is enabled while using the cutscene controller.
|
1911
1914
|
*
|
1912
1915
|
* {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.enabled_while_in_cutscene View documentation}
|
1913
1916
|
*/
|
1914
1917
|
readonly enabled_while_in_cutscene: boolean
|
1915
1918
|
/**
|
1916
|
-
*
|
1919
|
+
* Whether this custom input will include the selected prototype (if any) when triggered.
|
1917
1920
|
*
|
1918
1921
|
* {@link https://lua-api.factorio.com/latest/LuaCustomInputPrototype.html#LuaCustomInputPrototype.include_selected_prototype View documentation}
|
1919
1922
|
*/
|
@@ -2021,7 +2024,7 @@ interface LuaDamagePrototype {
|
|
2021
2024
|
*/
|
2022
2025
|
readonly name: string
|
2023
2026
|
/**
|
2024
|
-
*
|
2027
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
2025
2028
|
*
|
2026
2029
|
* {@link https://lua-api.factorio.com/latest/LuaDamagePrototype.html#LuaDamagePrototype.order View documentation}
|
2027
2030
|
*/
|
@@ -2056,10 +2059,10 @@ interface LuaDamagePrototype {
|
|
2056
2059
|
*/
|
2057
2060
|
interface LuaDeciderCombinatorControlBehavior extends LuaCombinatorControlBehavior {
|
2058
2061
|
/**
|
2059
|
-
*
|
2062
|
+
* This decider combinator's parameters.
|
2060
2063
|
*
|
2061
2064
|
* {@link https://lua-api.factorio.com/latest/LuaDeciderCombinatorControlBehavior.html#LuaDeciderCombinatorControlBehavior.parameters View documentation}
|
2062
|
-
* @remarks
|
2065
|
+
* @remarks Writing `nil` clears the combinator's parameters.
|
2063
2066
|
*/
|
2064
2067
|
parameters: DeciderCombinatorParameters
|
2065
2068
|
/**
|
@@ -2090,7 +2093,7 @@ interface LuaDecorativePrototype {
|
|
2090
2093
|
*/
|
2091
2094
|
readonly name: string
|
2092
2095
|
/**
|
2093
|
-
*
|
2096
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
2094
2097
|
*
|
2095
2098
|
* {@link https://lua-api.factorio.com/latest/LuaDecorativePrototype.html#LuaDecorativePrototype.order View documentation}
|
2096
2099
|
*/
|
@@ -2169,7 +2172,7 @@ interface LuaElectricEnergySourcePrototype {
|
|
2169
2172
|
*/
|
2170
2173
|
interface LuaEntity extends LuaControl {
|
2171
2174
|
/**
|
2172
|
-
* Gets the
|
2175
|
+
* Gets the entity's output inventory if it has one.
|
2173
2176
|
*
|
2174
2177
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_output_inventory View documentation}
|
2175
2178
|
* @returns A reference to the entity's output inventory.
|
@@ -2909,7 +2912,7 @@ interface LuaEntity extends LuaControl {
|
|
2909
2912
|
*/
|
2910
2913
|
set_passenger(passenger: LuaEntity | PlayerIdentification): void
|
2911
2914
|
/**
|
2912
|
-
* Returns true if this entity is connected to an electric network.
|
2915
|
+
* 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
2916
|
*
|
2914
2917
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_connected_to_electric_network View documentation}
|
2915
2918
|
*/
|
@@ -3755,13 +3758,16 @@ interface LuaEntity extends LuaControl {
|
|
3755
3758
|
*/
|
3756
3759
|
kills: uint
|
3757
3760
|
/**
|
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.
|
3761
|
+
* 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.
|
3762
|
+
*
|
3763
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
3759
3764
|
*
|
3760
3765
|
* _Can only be used if this is EntityWithOwner_
|
3761
3766
|
*
|
3762
3767
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.last_user View documentation}
|
3763
3768
|
*/
|
3764
|
-
last_user: LuaPlayer | undefined
|
3769
|
+
get last_user(): LuaPlayer | LuaPlayer | undefined
|
3770
|
+
set last_user(value: LuaPlayer | PlayerIdentification | undefined)
|
3765
3771
|
/**
|
3766
3772
|
* The buffer size for the electric energy source or nil if the entity doesn't have an electric energy source.
|
3767
3773
|
*
|
@@ -4087,14 +4093,19 @@ interface LuaEntity extends LuaControl {
|
|
4087
4093
|
*/
|
4088
4094
|
character_corpse_death_cause: LocalisedString
|
4089
4095
|
/**
|
4090
|
-
* The player this character is associated with or `nil` if
|
4096
|
+
* The player this character is associated with, or `nil` if there isn't one. Set to `nil` to clear.
|
4097
|
+
*
|
4098
|
+
* 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.
|
4099
|
+
*
|
4100
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
4091
4101
|
*
|
4092
4102
|
* _Can only be used if this is Character_
|
4093
4103
|
*
|
4094
4104
|
* {@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
|
4105
|
+
* @remarks A character associated with a player is not directly controlled by any player.
|
4096
4106
|
*/
|
4097
|
-
associated_player: LuaPlayer | undefined
|
4107
|
+
get associated_player(): LuaPlayer | LuaPlayer | undefined
|
4108
|
+
set associated_player(value: LuaPlayer | PlayerIdentification | undefined)
|
4098
4109
|
/**
|
4099
4110
|
* The last tick this character entity was attacked.
|
4100
4111
|
*
|
@@ -4240,9 +4251,12 @@ interface LuaEntity extends LuaControl {
|
|
4240
4251
|
/**
|
4241
4252
|
* 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
4253
|
*
|
4254
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
4255
|
+
*
|
4243
4256
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_player View documentation}
|
4244
4257
|
*/
|
4245
|
-
render_player: LuaPlayer | undefined
|
4258
|
+
get render_player(): LuaPlayer | LuaPlayer | undefined
|
4259
|
+
set render_player(value: LuaPlayer | PlayerIdentification | undefined)
|
4246
4260
|
/**
|
4247
4261
|
* 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
4262
|
*
|
@@ -4459,6 +4473,14 @@ interface LuaEntity extends LuaControl {
|
|
4459
4473
|
* @remarks Can also be used on entity ghost if it contains linked-belt<br>May return entity ghost which contains linked belt to which connection is made
|
4460
4474
|
*/
|
4461
4475
|
readonly linked_belt_neighbour: LuaEntity | undefined
|
4476
|
+
/**
|
4477
|
+
* The current radar scan progress, as a number in range [0, 1].
|
4478
|
+
*
|
4479
|
+
* _Can only be used if this is Radar_
|
4480
|
+
*
|
4481
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.radar_scan_progress View documentation}
|
4482
|
+
*/
|
4483
|
+
readonly radar_scan_progress: float
|
4462
4484
|
/**
|
4463
4485
|
* 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.
|
4464
4486
|
*/
|
@@ -4478,7 +4500,7 @@ interface LuaEntity extends LuaControl {
|
|
4478
4500
|
*/
|
4479
4501
|
interface BaseEntity extends LuaControl {
|
4480
4502
|
/**
|
4481
|
-
* Gets the
|
4503
|
+
* Gets the entity's output inventory if it has one.
|
4482
4504
|
*
|
4483
4505
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_output_inventory View documentation}
|
4484
4506
|
* @returns A reference to the entity's output inventory.
|
@@ -4868,7 +4890,7 @@ interface BaseEntity extends LuaControl {
|
|
4868
4890
|
readonly force?: LuaForce | string
|
4869
4891
|
}): LuaMultiReturn<[boolean, Record<string, uint> | undefined]>
|
4870
4892
|
/**
|
4871
|
-
* Returns true if this entity is connected to an electric network.
|
4893
|
+
* 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.
|
4872
4894
|
*
|
4873
4895
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_connected_to_electric_network View documentation}
|
4874
4896
|
*/
|
@@ -5548,9 +5570,12 @@ interface BaseEntity extends LuaControl {
|
|
5548
5570
|
/**
|
5549
5571
|
* 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.
|
5550
5572
|
*
|
5573
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
5574
|
+
*
|
5551
5575
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_player View documentation}
|
5552
5576
|
*/
|
5553
|
-
render_player: LuaPlayer | undefined
|
5577
|
+
get render_player(): LuaPlayer | LuaPlayer | undefined
|
5578
|
+
set render_player(value: LuaPlayer | PlayerIdentification | undefined)
|
5554
5579
|
/**
|
5555
5580
|
* 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.
|
5556
5581
|
*
|
@@ -6710,14 +6735,19 @@ interface CharacterEntity extends BaseEntity {
|
|
6710
6735
|
*/
|
6711
6736
|
readonly player: LuaPlayer | undefined
|
6712
6737
|
/**
|
6713
|
-
* The player this character is associated with or `nil` if
|
6738
|
+
* The player this character is associated with, or `nil` if there isn't one. Set to `nil` to clear.
|
6739
|
+
*
|
6740
|
+
* 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.
|
6741
|
+
*
|
6742
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
6714
6743
|
*
|
6715
6744
|
* _Can only be used if this is Character_
|
6716
6745
|
*
|
6717
6746
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.associated_player View documentation}
|
6718
|
-
* @remarks A character associated with a player is not directly controlled by any player
|
6747
|
+
* @remarks A character associated with a player is not directly controlled by any player.
|
6719
6748
|
*/
|
6720
|
-
associated_player: LuaPlayer | undefined
|
6749
|
+
get associated_player(): LuaPlayer | LuaPlayer | undefined
|
6750
|
+
set associated_player(value: LuaPlayer | PlayerIdentification | undefined)
|
6721
6751
|
/**
|
6722
6752
|
* The last tick this character entity was attacked.
|
6723
6753
|
*
|
@@ -6817,13 +6847,16 @@ interface TurretEntity extends BaseEntity {
|
|
6817
6847
|
|
6818
6848
|
interface EntityWithOwnerEntity extends BaseEntity {
|
6819
6849
|
/**
|
6820
|
-
* 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.
|
6850
|
+
* 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.
|
6851
|
+
*
|
6852
|
+
* Reading this property will return a {@link LuaPlayer}, while {@link PlayerIdentification} can be used when writing.
|
6821
6853
|
*
|
6822
6854
|
* _Can only be used if this is EntityWithOwner_
|
6823
6855
|
*
|
6824
6856
|
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.last_user View documentation}
|
6825
6857
|
*/
|
6826
|
-
last_user: LuaPlayer | undefined
|
6858
|
+
get last_user(): LuaPlayer | LuaPlayer | undefined
|
6859
|
+
set last_user(value: LuaPlayer | PlayerIdentification | undefined)
|
6827
6860
|
}
|
6828
6861
|
|
6829
6862
|
interface ElectricEnergyInterfaceEntity extends BaseEntity {
|
@@ -7004,6 +7037,17 @@ interface SmokeWithTriggerEntity extends BaseEntity {
|
|
7004
7037
|
time_to_next_effect: uint
|
7005
7038
|
}
|
7006
7039
|
|
7040
|
+
interface RadarEntity extends BaseEntity {
|
7041
|
+
/**
|
7042
|
+
* The current radar scan progress, as a number in range [0, 1].
|
7043
|
+
*
|
7044
|
+
* _Can only be used if this is Radar_
|
7045
|
+
*
|
7046
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.radar_scan_progress View documentation}
|
7047
|
+
*/
|
7048
|
+
readonly radar_scan_progress: float
|
7049
|
+
}
|
7050
|
+
|
7007
7051
|
/**
|
7008
7052
|
* Prototype of an entity.
|
7009
7053
|
*
|
@@ -7167,7 +7211,7 @@ interface LuaEntityPrototype {
|
|
7167
7211
|
*/
|
7168
7212
|
readonly default_collision_mask_with_flags: CollisionMaskWithFlags
|
7169
7213
|
/**
|
7170
|
-
*
|
7214
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
7171
7215
|
*
|
7172
7216
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.order View documentation}
|
7173
7217
|
*/
|
@@ -7636,6 +7680,12 @@ interface LuaEntityPrototype {
|
|
7636
7680
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.void_energy_source_prototype View documentation}
|
7637
7681
|
*/
|
7638
7682
|
readonly void_energy_source_prototype: LuaVoidEnergySourcePrototype | undefined
|
7683
|
+
/**
|
7684
|
+
* The heat buffer prototype this entity uses or `nil`.
|
7685
|
+
*
|
7686
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.heat_buffer_prototype View documentation}
|
7687
|
+
*/
|
7688
|
+
readonly heat_buffer_prototype: LuaHeatBufferPrototype | undefined
|
7639
7689
|
/**
|
7640
7690
|
* The log2 of grid size of the building
|
7641
7691
|
*
|
@@ -7654,6 +7704,30 @@ interface LuaEntityPrototype {
|
|
7654
7704
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.maximum_temperature View documentation}
|
7655
7705
|
*/
|
7656
7706
|
readonly maximum_temperature: double | undefined
|
7707
|
+
/**
|
7708
|
+
* If this generator prototype burns fluid.
|
7709
|
+
*
|
7710
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.burns_fluid View documentation}
|
7711
|
+
*/
|
7712
|
+
readonly burns_fluid: boolean
|
7713
|
+
/**
|
7714
|
+
* If this generator prototype scales fluid usage.
|
7715
|
+
*
|
7716
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.scale_fluid_usage View documentation}
|
7717
|
+
*/
|
7718
|
+
readonly scale_fluid_usage: boolean
|
7719
|
+
/**
|
7720
|
+
* If this generator prototype destroys non fuel fluids.
|
7721
|
+
*
|
7722
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.destroy_non_fuel_fluid View documentation}
|
7723
|
+
*/
|
7724
|
+
readonly destroy_non_fuel_fluid: boolean
|
7725
|
+
/**
|
7726
|
+
* The default maximum power output of this generator prototype or `nil`.
|
7727
|
+
*
|
7728
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.max_power_output View documentation}
|
7729
|
+
*/
|
7730
|
+
readonly max_power_output: double | undefined
|
7657
7731
|
/**
|
7658
7732
|
* The target temperature of this boiler prototype or `nil`.
|
7659
7733
|
*
|
@@ -8235,6 +8309,31 @@ interface LuaEntityPrototype {
|
|
8235
8309
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.allow_run_time_change_of_is_military_target View documentation}
|
8236
8310
|
*/
|
8237
8311
|
readonly allow_run_time_change_of_is_military_target: boolean
|
8312
|
+
/**
|
8313
|
+
* The logistic parameters for this roboport. or `nil`.
|
8314
|
+
*
|
8315
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.logistic_parameters View documentation}
|
8316
|
+
* @remarks Both the `charging_station_shift` and `stationing_offset` vectors are tables with `x` and `y` keys instead of an array.
|
8317
|
+
*/
|
8318
|
+
readonly logistic_parameters:
|
8319
|
+
| {
|
8320
|
+
readonly spawn_and_station_height: float
|
8321
|
+
readonly spawn_and_station_shadow_height_offset: float
|
8322
|
+
readonly charge_approach_distance: float
|
8323
|
+
readonly logistic_radius: float
|
8324
|
+
readonly construction_radius: float
|
8325
|
+
readonly charging_station_count: uint
|
8326
|
+
readonly charging_distance: float
|
8327
|
+
readonly charging_station_shift: Vector
|
8328
|
+
readonly charging_energy: double
|
8329
|
+
readonly charging_threshold_distance: float
|
8330
|
+
readonly robot_vertical_acceleration: float
|
8331
|
+
readonly stationing_offset: Vector
|
8332
|
+
readonly robot_limit: uint
|
8333
|
+
readonly logistics_connection_distance: float
|
8334
|
+
readonly robots_shrink_when_entering_and_exiting: boolean
|
8335
|
+
}
|
8336
|
+
| undefined
|
8238
8337
|
/**
|
8239
8338
|
* Gets the current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
|
8240
8339
|
*
|
@@ -8501,7 +8600,7 @@ interface BaseEntityPrototype {
|
|
8501
8600
|
*/
|
8502
8601
|
readonly default_collision_mask_with_flags: CollisionMaskWithFlags
|
8503
8602
|
/**
|
8504
|
-
*
|
8603
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
8505
8604
|
*
|
8506
8605
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.order View documentation}
|
8507
8606
|
*/
|
@@ -8970,6 +9069,12 @@ interface BaseEntityPrototype {
|
|
8970
9069
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.void_energy_source_prototype View documentation}
|
8971
9070
|
*/
|
8972
9071
|
readonly void_energy_source_prototype: LuaVoidEnergySourcePrototype | undefined
|
9072
|
+
/**
|
9073
|
+
* The heat buffer prototype this entity uses or `nil`.
|
9074
|
+
*
|
9075
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.heat_buffer_prototype View documentation}
|
9076
|
+
*/
|
9077
|
+
readonly heat_buffer_prototype: LuaHeatBufferPrototype | undefined
|
8973
9078
|
/**
|
8974
9079
|
* The log2 of grid size of the building
|
8975
9080
|
*
|
@@ -8988,6 +9093,30 @@ interface BaseEntityPrototype {
|
|
8988
9093
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.maximum_temperature View documentation}
|
8989
9094
|
*/
|
8990
9095
|
readonly maximum_temperature: double | undefined
|
9096
|
+
/**
|
9097
|
+
* If this generator prototype burns fluid.
|
9098
|
+
*
|
9099
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.burns_fluid View documentation}
|
9100
|
+
*/
|
9101
|
+
readonly burns_fluid: boolean
|
9102
|
+
/**
|
9103
|
+
* If this generator prototype scales fluid usage.
|
9104
|
+
*
|
9105
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.scale_fluid_usage View documentation}
|
9106
|
+
*/
|
9107
|
+
readonly scale_fluid_usage: boolean
|
9108
|
+
/**
|
9109
|
+
* If this generator prototype destroys non fuel fluids.
|
9110
|
+
*
|
9111
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.destroy_non_fuel_fluid View documentation}
|
9112
|
+
*/
|
9113
|
+
readonly destroy_non_fuel_fluid: boolean
|
9114
|
+
/**
|
9115
|
+
* The default maximum power output of this generator prototype or `nil`.
|
9116
|
+
*
|
9117
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.max_power_output View documentation}
|
9118
|
+
*/
|
9119
|
+
readonly max_power_output: double | undefined
|
8991
9120
|
/**
|
8992
9121
|
* The target temperature of this boiler prototype or `nil`.
|
8993
9122
|
*
|
@@ -9491,6 +9620,31 @@ interface BaseEntityPrototype {
|
|
9491
9620
|
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.is_entity_with_owner View documentation}
|
9492
9621
|
*/
|
9493
9622
|
readonly is_entity_with_owner: boolean
|
9623
|
+
/**
|
9624
|
+
* The logistic parameters for this roboport. or `nil`.
|
9625
|
+
*
|
9626
|
+
* {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.logistic_parameters View documentation}
|
9627
|
+
* @remarks Both the `charging_station_shift` and `stationing_offset` vectors are tables with `x` and `y` keys instead of an array.
|
9628
|
+
*/
|
9629
|
+
readonly logistic_parameters:
|
9630
|
+
| {
|
9631
|
+
readonly spawn_and_station_height: float
|
9632
|
+
readonly spawn_and_station_shadow_height_offset: float
|
9633
|
+
readonly charge_approach_distance: float
|
9634
|
+
readonly logistic_radius: float
|
9635
|
+
readonly construction_radius: float
|
9636
|
+
readonly charging_station_count: uint
|
9637
|
+
readonly charging_distance: float
|
9638
|
+
readonly charging_station_shift: Vector
|
9639
|
+
readonly charging_energy: double
|
9640
|
+
readonly charging_threshold_distance: float
|
9641
|
+
readonly robot_vertical_acceleration: float
|
9642
|
+
readonly stationing_offset: Vector
|
9643
|
+
readonly robot_limit: uint
|
9644
|
+
readonly logistics_connection_distance: float
|
9645
|
+
readonly robots_shrink_when_entering_and_exiting: boolean
|
9646
|
+
}
|
9647
|
+
| undefined
|
9494
9648
|
/**
|
9495
9649
|
* 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.
|
9496
9650
|
*/
|
@@ -9807,7 +9961,7 @@ interface LuaEquipmentCategoryPrototype {
|
|
9807
9961
|
*/
|
9808
9962
|
readonly name: string
|
9809
9963
|
/**
|
9810
|
-
*
|
9964
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
9811
9965
|
*
|
9812
9966
|
* {@link https://lua-api.factorio.com/latest/LuaEquipmentCategoryPrototype.html#LuaEquipmentCategoryPrototype.order View documentation}
|
9813
9967
|
*/
|
@@ -10025,7 +10179,7 @@ interface LuaEquipmentGridPrototype {
|
|
10025
10179
|
*/
|
10026
10180
|
readonly name: string
|
10027
10181
|
/**
|
10028
|
-
*
|
10182
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
10029
10183
|
*
|
10030
10184
|
* {@link https://lua-api.factorio.com/latest/LuaEquipmentGridPrototype.html#LuaEquipmentGridPrototype.order View documentation}
|
10031
10185
|
*/
|
@@ -10080,7 +10234,7 @@ interface LuaEquipmentPrototype {
|
|
10080
10234
|
*/
|
10081
10235
|
readonly type: string
|
10082
10236
|
/**
|
10083
|
-
*
|
10237
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
10084
10238
|
*
|
10085
10239
|
* {@link https://lua-api.factorio.com/latest/LuaEquipmentPrototype.html#LuaEquipmentPrototype.order View documentation}
|
10086
10240
|
*/
|
@@ -10590,7 +10744,7 @@ interface LuaFluidPrototype {
|
|
10590
10744
|
*/
|
10591
10745
|
readonly heat_capacity: double
|
10592
10746
|
/**
|
10593
|
-
*
|
10747
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
10594
10748
|
*
|
10595
10749
|
* {@link https://lua-api.factorio.com/latest/LuaFluidPrototype.html#LuaFluidPrototype.order View documentation}
|
10596
10750
|
*/
|
@@ -11417,7 +11571,7 @@ interface LuaFuelCategoryPrototype {
|
|
11417
11571
|
*/
|
11418
11572
|
readonly name: string
|
11419
11573
|
/**
|
11420
|
-
*
|
11574
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
11421
11575
|
*
|
11422
11576
|
* {@link https://lua-api.factorio.com/latest/LuaFuelCategoryPrototype.html#LuaFuelCategoryPrototype.order View documentation}
|
11423
11577
|
*/
|
@@ -11535,7 +11689,7 @@ interface LuaGameScript {
|
|
11535
11689
|
*/
|
11536
11690
|
regenerate_entity(entities: string | readonly string[]): void
|
11537
11691
|
/**
|
11538
|
-
* Take a screenshot and save it to
|
11692
|
+
* Take a screenshot of the game and save it to the `script-output` folder, located in the game's {@link https://wiki.factorio.com/User_data_directory user data directory}. The name of the image file can be specified via the `path` parameter.
|
11539
11693
|
*
|
11540
11694
|
* {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.take_screenshot View documentation}
|
11541
11695
|
* @remarks If Factorio is running headless, this function will do nothing.
|
@@ -11566,7 +11720,7 @@ interface LuaGameScript {
|
|
11566
11720
|
*/
|
11567
11721
|
readonly zoom?: double
|
11568
11722
|
/**
|
11569
|
-
* The
|
11723
|
+
* The name of the image file. It should include a file extension indicating the desired format. Supports `.png`, `.jpg` /`.jpeg`, `.tga` and `.bmp`. Providing a directory path (ex. `"save/here/screenshot.png"`) will create the necessary folder structure in `script-output`. Defaults to `"screenshot.png"`.
|
11570
11724
|
*/
|
11571
11725
|
readonly path?: string
|
11572
11726
|
/**
|
@@ -11613,7 +11767,7 @@ interface LuaGameScript {
|
|
11613
11767
|
*/
|
11614
11768
|
set_wait_for_screenshots_to_finish(): void
|
11615
11769
|
/**
|
11616
|
-
* Take a screenshot of the technology screen and save it to
|
11770
|
+
* Take a screenshot of the technology screen and save it to the `script-output` folder, located in the game's {@link https://wiki.factorio.com/User_data_directory user data directory}. The name of the image file can be specified via the `path` parameter.
|
11617
11771
|
*
|
11618
11772
|
* {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.take_technology_screenshot View documentation}
|
11619
11773
|
*/
|
@@ -11623,7 +11777,7 @@ interface LuaGameScript {
|
|
11623
11777
|
*/
|
11624
11778
|
readonly force?: ForceIdentification
|
11625
11779
|
/**
|
11626
|
-
* The
|
11780
|
+
* The name of the image file. It should include a file extension indicating the desired format. Supports `.png`, `.jpg` /`.jpeg`, `.tga` and `.bmp`. Providing a directory path (ex. `"save/here/screenshot.png"`) will create the necessary folder structure in `script-output`. Defaults to `"technology-screenshot.png"`.
|
11627
11781
|
*/
|
11628
11782
|
readonly path?: string
|
11629
11783
|
/**
|
@@ -11658,20 +11812,20 @@ interface LuaGameScript {
|
|
11658
11812
|
*/
|
11659
11813
|
json_to_table(json: string): AnyBasic | undefined
|
11660
11814
|
/**
|
11661
|
-
* Write a
|
11815
|
+
* Write a file to the `script-output` folder, located in the game's {@link https://wiki.factorio.com/User_data_directory user data directory}. The name and file extension of the file can be specified via the `filename` parameter.
|
11662
11816
|
*
|
11663
11817
|
* {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.write_file View documentation}
|
11664
|
-
* @param filename
|
11665
|
-
* @param data
|
11666
|
-
* @param append
|
11667
|
-
* @param for_player If given, the file will only be written for this player_index
|
11818
|
+
* @param filename The name of the file. Providing a directory path (ex. `"save/here/example.txt"`) will create the necessary folder structure in `script-output`.
|
11819
|
+
* @param data The content to write to the file.
|
11820
|
+
* @param append If `true`, `data` will be appended to the end of the file. Defaults to `false`, which will overwrite any pre-existing file with the new `data`.
|
11821
|
+
* @param for_player If given, the file will only be written for this `player_index`. Providing `0` will only write to the server's output if present.
|
11668
11822
|
*/
|
11669
11823
|
write_file(filename: string, data: LocalisedString, append?: boolean, for_player?: uint): void
|
11670
11824
|
/**
|
11671
|
-
* Remove file or directory
|
11825
|
+
* Remove a file or directory in the `script-output` folder, located in the game's {@link https://wiki.factorio.com/User_data_directory user data directory}. Can be used to remove files created by {@link LuaGameScript#write_file LuaGameScript::write_file}.
|
11672
11826
|
*
|
11673
11827
|
* {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.remove_path View documentation}
|
11674
|
-
* @param path
|
11828
|
+
* @param path The path to the file or directory to remove, relative to `script-output`.
|
11675
11829
|
*/
|
11676
11830
|
remove_path(path: string): void
|
11677
11831
|
/**
|
@@ -12150,7 +12304,9 @@ interface LuaGameScript {
|
|
12150
12304
|
*/
|
12151
12305
|
decode_string(string: string): string | undefined
|
12152
12306
|
/**
|
12153
|
-
*
|
12307
|
+
* 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.
|
12308
|
+
*
|
12309
|
+
* See {@link LuaGameScript#players LuaGameScript::players} for accessing all players.
|
12154
12310
|
*
|
12155
12311
|
* {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.player View documentation}
|
12156
12312
|
*/
|
@@ -12598,6 +12754,11 @@ interface LuaGroup {
|
|
12598
12754
|
* @remarks Can only be used on groups, not on subgroups.
|
12599
12755
|
*/
|
12600
12756
|
readonly order_in_recipe: string
|
12757
|
+
/**
|
12758
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
12759
|
+
*
|
12760
|
+
* {@link https://lua-api.factorio.com/latest/LuaGroup.html#LuaGroup.order View documentation}
|
12761
|
+
*/
|
12601
12762
|
readonly order: string
|
12602
12763
|
/**
|
12603
12764
|
* 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.
|
@@ -13456,20 +13617,7 @@ interface ChooseElemButtonGuiElementMembers extends BaseGuiElement {
|
|
13456
13617
|
*/
|
13457
13618
|
elem_value: (this["elem_type"] extends "signal" ? SignalID : string) | undefined
|
13458
13619
|
/**
|
13459
|
-
* The elem filters of this choose-elem-button or `nil` if there are no filters.
|
13460
|
-
*
|
13461
|
-
* The compatible type of filter is determined by elem_type:
|
13462
|
-
* - Type `"item"` - {@link ItemPrototypeFilter}
|
13463
|
-
* - Type `"tile"` - {@link TilePrototypeFilter}
|
13464
|
-
* - Type `"entity"` - {@link EntityPrototypeFilter}
|
13465
|
-
* - Type `"signal"` - Does not support filters
|
13466
|
-
* - Type `"fluid"` - {@link FluidPrototypeFilter}
|
13467
|
-
* - Type `"recipe"` - {@link RecipePrototypeFilter}
|
13468
|
-
* - Type `"decorative"` - {@link DecorativePrototypeFilter}
|
13469
|
-
* - Type `"item-group"` - Does not support filters
|
13470
|
-
* - Type `"achievement"` - {@link AchievementPrototypeFilter}
|
13471
|
-
* - Type `"equipment"` - {@link EquipmentPrototypeFilter}
|
13472
|
-
* - Type `"technology"` - {@link TechnologyPrototypeFilter}
|
13620
|
+
* 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`.
|
13473
13621
|
*
|
13474
13622
|
* _Can only be used if this is choose-elem-button_
|
13475
13623
|
*
|
@@ -14006,7 +14154,7 @@ interface CameraGuiElementMembers extends BaseGuiElement {
|
|
14006
14154
|
*/
|
14007
14155
|
surface_index: SurfaceIndex
|
14008
14156
|
/**
|
14009
|
-
* The zoom this camera or minimap is using.
|
14157
|
+
* The zoom this camera or minimap is using. This value must be positive.
|
14010
14158
|
*
|
14011
14159
|
* {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.zoom View documentation}
|
14012
14160
|
*/
|
@@ -14202,7 +14350,7 @@ interface MinimapGuiElementMembers extends BaseGuiElement {
|
|
14202
14350
|
*/
|
14203
14351
|
surface_index: SurfaceIndex
|
14204
14352
|
/**
|
14205
|
-
* The zoom this camera or minimap is using.
|
14353
|
+
* The zoom this camera or minimap is using. This value must be positive.
|
14206
14354
|
*
|
14207
14355
|
* {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.zoom View documentation}
|
14208
14356
|
*/
|
@@ -14698,6 +14846,35 @@ type GuiElementMembers =
|
|
14698
14846
|
*/
|
14699
14847
|
type LuaGuiElement = GuiElementMembers & GuiElementIndexer
|
14700
14848
|
|
14849
|
+
/**
|
14850
|
+
* Prototype of a heat buffer.
|
14851
|
+
*
|
14852
|
+
* {@link https://lua-api.factorio.com/latest/LuaHeatBufferPrototype.html View documentation}
|
14853
|
+
* @noSelf
|
14854
|
+
*/
|
14855
|
+
interface LuaHeatBufferPrototype {
|
14856
|
+
readonly max_temperature: double
|
14857
|
+
readonly default_temperature: double
|
14858
|
+
readonly specific_heat: double
|
14859
|
+
readonly max_transfer: double
|
14860
|
+
readonly min_temperature_gradient: double
|
14861
|
+
readonly min_working_temperature: double
|
14862
|
+
readonly minimum_glow_temperature: double
|
14863
|
+
readonly connections: HeatConnection[]
|
14864
|
+
/**
|
14865
|
+
* 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.
|
14866
|
+
*/
|
14867
|
+
readonly valid: boolean
|
14868
|
+
/**
|
14869
|
+
* The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
|
14870
|
+
*/
|
14871
|
+
readonly object_name: "LuaHeatBufferPrototype"
|
14872
|
+
/**
|
14873
|
+
* All methods and properties that this object supports.
|
14874
|
+
*/
|
14875
|
+
help(): string
|
14876
|
+
}
|
14877
|
+
|
14701
14878
|
/**
|
14702
14879
|
* Prototype of a heat energy source.
|
14703
14880
|
*
|
@@ -14716,6 +14893,7 @@ interface LuaHeatEnergySourcePrototype {
|
|
14716
14893
|
readonly min_working_temperature: double
|
14717
14894
|
readonly minimum_glow_temperature: double
|
14718
14895
|
readonly connections: HeatConnection[]
|
14896
|
+
readonly heat_buffer_prototype: LuaHeatBufferPrototype
|
14719
14897
|
/**
|
14720
14898
|
* 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.
|
14721
14899
|
*/
|
@@ -15064,7 +15242,7 @@ interface LuaItemPrototype {
|
|
15064
15242
|
readonly localised_name: LocalisedString
|
15065
15243
|
readonly localised_description: LocalisedString
|
15066
15244
|
/**
|
15067
|
-
*
|
15245
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
15068
15246
|
*
|
15069
15247
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.order View documentation}
|
15070
15248
|
*/
|
@@ -15302,13 +15480,13 @@ interface LuaItemPrototype {
|
|
15302
15480
|
*/
|
15303
15481
|
readonly speed: float | undefined
|
15304
15482
|
/**
|
15305
|
-
* Effects of this module
|
15483
|
+
* Effects of this module.
|
15306
15484
|
*
|
15307
15485
|
* _Can only be used if this is ModuleItem_
|
15308
15486
|
*
|
15309
15487
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.module_effects View documentation}
|
15310
15488
|
*/
|
15311
|
-
readonly module_effects: ModuleEffects
|
15489
|
+
readonly module_effects: ModuleEffects
|
15312
15490
|
/**
|
15313
15491
|
* 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.
|
15314
15492
|
*
|
@@ -15381,6 +15559,14 @@ interface LuaItemPrototype {
|
|
15381
15559
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_selection_border_color View documentation}
|
15382
15560
|
*/
|
15383
15561
|
readonly alt_selection_border_color: ColorTable
|
15562
|
+
/**
|
15563
|
+
* The color used when doing reverse selection with this selection tool prototype.
|
15564
|
+
*
|
15565
|
+
* _Can only be used if this is SelectionTool_
|
15566
|
+
*
|
15567
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_selection_border_color View documentation}
|
15568
|
+
*/
|
15569
|
+
readonly reverse_selection_border_color: ColorTable
|
15384
15570
|
/**
|
15385
15571
|
* Flags that affect which entities will be selected.
|
15386
15572
|
*
|
@@ -15397,6 +15583,14 @@ interface LuaItemPrototype {
|
|
15397
15583
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_selection_mode_flags View documentation}
|
15398
15584
|
*/
|
15399
15585
|
readonly alt_selection_mode_flags: SelectionModeFlags
|
15586
|
+
/**
|
15587
|
+
* Flags that affect which entities will be selected during reverse selection.
|
15588
|
+
*
|
15589
|
+
* _Can only be used if this is SelectionTool_
|
15590
|
+
*
|
15591
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_selection_mode_flags View documentation}
|
15592
|
+
*/
|
15593
|
+
readonly reverse_selection_mode_flags: SelectionModeFlags
|
15400
15594
|
/**
|
15401
15595
|
* _Can only be used if this is SelectionTool_
|
15402
15596
|
*
|
@@ -15409,6 +15603,12 @@ interface LuaItemPrototype {
|
|
15409
15603
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_selection_cursor_box_type View documentation}
|
15410
15604
|
*/
|
15411
15605
|
readonly alt_selection_cursor_box_type: string
|
15606
|
+
/**
|
15607
|
+
* _Can only be used if this is SelectionTool_
|
15608
|
+
*
|
15609
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_selection_cursor_box_type View documentation}
|
15610
|
+
*/
|
15611
|
+
readonly reverse_selection_cursor_box_type: string
|
15412
15612
|
/**
|
15413
15613
|
* If tiles area always included when doing selection with this selection tool prototype.
|
15414
15614
|
*
|
@@ -15433,6 +15633,14 @@ interface LuaItemPrototype {
|
|
15433
15633
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_entity_filter_mode View documentation}
|
15434
15634
|
*/
|
15435
15635
|
readonly alt_entity_filter_mode: string
|
15636
|
+
/**
|
15637
|
+
* The reverse entity filter mode used by this selection tool.
|
15638
|
+
*
|
15639
|
+
* _Can only be used if this is SelectionTool_
|
15640
|
+
*
|
15641
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_alt_entity_filter_mode View documentation}
|
15642
|
+
*/
|
15643
|
+
readonly reverse_alt_entity_filter_mode: string
|
15436
15644
|
/**
|
15437
15645
|
* The tile filter mode used by this selection tool.
|
15438
15646
|
*
|
@@ -15449,6 +15657,14 @@ interface LuaItemPrototype {
|
|
15449
15657
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_tile_filter_mode View documentation}
|
15450
15658
|
*/
|
15451
15659
|
readonly alt_tile_filter_mode: string
|
15660
|
+
/**
|
15661
|
+
* The reverse tile filter mode used by this selection tool.
|
15662
|
+
*
|
15663
|
+
* _Can only be used if this is SelectionTool_
|
15664
|
+
*
|
15665
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_tile_filter_mode View documentation}
|
15666
|
+
*/
|
15667
|
+
readonly reverse_tile_filter_mode: string
|
15452
15668
|
/**
|
15453
15669
|
* The entity filters used by this selection tool indexed by entity name.
|
15454
15670
|
*
|
@@ -15465,6 +15681,14 @@ interface LuaItemPrototype {
|
|
15465
15681
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_entity_filters View documentation}
|
15466
15682
|
*/
|
15467
15683
|
readonly alt_entity_filters: Record<string, LuaEntityPrototype>
|
15684
|
+
/**
|
15685
|
+
* The reverse entity filters used by this selection tool indexed by entity name.
|
15686
|
+
*
|
15687
|
+
* _Can only be used if this is SelectionTool_
|
15688
|
+
*
|
15689
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_entity_filters View documentation}
|
15690
|
+
*/
|
15691
|
+
readonly reverse_entity_filters: Record<string, LuaEntityPrototype>
|
15468
15692
|
/**
|
15469
15693
|
* The entity type filters used by this selection tool indexed by entity type.
|
15470
15694
|
*
|
@@ -15483,6 +15707,15 @@ interface LuaItemPrototype {
|
|
15483
15707
|
* @remarks The boolean value is meaningless and is used to allow easy lookup if a type exists in the dictionary.
|
15484
15708
|
*/
|
15485
15709
|
readonly alt_entity_type_filters: Record<string, boolean>
|
15710
|
+
/**
|
15711
|
+
* The reverse entity type filters used by this selection tool indexed by entity type.
|
15712
|
+
*
|
15713
|
+
* _Can only be used if this is SelectionTool_
|
15714
|
+
*
|
15715
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_entity_type_filters View documentation}
|
15716
|
+
* @remarks The boolean value is meaningless and is used to allow easy lookup if a type exists in the dictionary.
|
15717
|
+
*/
|
15718
|
+
readonly reverse_entity_type_filters: Record<string, boolean>
|
15486
15719
|
/**
|
15487
15720
|
* The tile filters used by this selection tool indexed by tile name.
|
15488
15721
|
*
|
@@ -15499,6 +15732,14 @@ interface LuaItemPrototype {
|
|
15499
15732
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_tile_filters View documentation}
|
15500
15733
|
*/
|
15501
15734
|
readonly alt_tile_filters: Record<string, LuaTilePrototype>
|
15735
|
+
/**
|
15736
|
+
* The reverse tile filters used by this selection tool indexed by tile name.
|
15737
|
+
*
|
15738
|
+
* _Can only be used if this is SelectionTool_
|
15739
|
+
*
|
15740
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_tile_filters View documentation}
|
15741
|
+
*/
|
15742
|
+
readonly reverse_tile_filters: Record<string, LuaTilePrototype>
|
15502
15743
|
/**
|
15503
15744
|
* The number of entity filters this deconstruction item has or `nil` if this isn't a deconstruction item prototype.
|
15504
15745
|
*
|
@@ -15594,7 +15835,7 @@ interface BaseItemPrototype {
|
|
15594
15835
|
readonly localised_name: LocalisedString
|
15595
15836
|
readonly localised_description: LocalisedString
|
15596
15837
|
/**
|
15597
|
-
*
|
15838
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
15598
15839
|
*
|
15599
15840
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.order View documentation}
|
15600
15841
|
*/
|
@@ -15856,13 +16097,13 @@ interface ItemWithLabelItemPrototype extends BaseItemPrototype {
|
|
15856
16097
|
|
15857
16098
|
interface ModuleItemPrototype extends BaseItemPrototype {
|
15858
16099
|
/**
|
15859
|
-
* Effects of this module
|
16100
|
+
* Effects of this module.
|
15860
16101
|
*
|
15861
16102
|
* _Can only be used if this is ModuleItem_
|
15862
16103
|
*
|
15863
16104
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.module_effects View documentation}
|
15864
16105
|
*/
|
15865
|
-
readonly module_effects: ModuleEffects
|
16106
|
+
readonly module_effects: ModuleEffects
|
15866
16107
|
/**
|
15867
16108
|
* 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.
|
15868
16109
|
*
|
@@ -15944,6 +16185,14 @@ interface SelectionToolItemPrototype extends BaseItemPrototype {
|
|
15944
16185
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_selection_border_color View documentation}
|
15945
16186
|
*/
|
15946
16187
|
readonly alt_selection_border_color: ColorTable
|
16188
|
+
/**
|
16189
|
+
* The color used when doing reverse selection with this selection tool prototype.
|
16190
|
+
*
|
16191
|
+
* _Can only be used if this is SelectionTool_
|
16192
|
+
*
|
16193
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_selection_border_color View documentation}
|
16194
|
+
*/
|
16195
|
+
readonly reverse_selection_border_color: ColorTable
|
15947
16196
|
/**
|
15948
16197
|
* Flags that affect which entities will be selected.
|
15949
16198
|
*
|
@@ -15960,6 +16209,14 @@ interface SelectionToolItemPrototype extends BaseItemPrototype {
|
|
15960
16209
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_selection_mode_flags View documentation}
|
15961
16210
|
*/
|
15962
16211
|
readonly alt_selection_mode_flags: SelectionModeFlags
|
16212
|
+
/**
|
16213
|
+
* Flags that affect which entities will be selected during reverse selection.
|
16214
|
+
*
|
16215
|
+
* _Can only be used if this is SelectionTool_
|
16216
|
+
*
|
16217
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_selection_mode_flags View documentation}
|
16218
|
+
*/
|
16219
|
+
readonly reverse_selection_mode_flags: SelectionModeFlags
|
15963
16220
|
/**
|
15964
16221
|
* _Can only be used if this is SelectionTool_
|
15965
16222
|
*
|
@@ -15972,6 +16229,12 @@ interface SelectionToolItemPrototype extends BaseItemPrototype {
|
|
15972
16229
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_selection_cursor_box_type View documentation}
|
15973
16230
|
*/
|
15974
16231
|
readonly alt_selection_cursor_box_type: string
|
16232
|
+
/**
|
16233
|
+
* _Can only be used if this is SelectionTool_
|
16234
|
+
*
|
16235
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_selection_cursor_box_type View documentation}
|
16236
|
+
*/
|
16237
|
+
readonly reverse_selection_cursor_box_type: string
|
15975
16238
|
/**
|
15976
16239
|
* If tiles area always included when doing selection with this selection tool prototype.
|
15977
16240
|
*
|
@@ -15996,6 +16259,14 @@ interface SelectionToolItemPrototype extends BaseItemPrototype {
|
|
15996
16259
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_entity_filter_mode View documentation}
|
15997
16260
|
*/
|
15998
16261
|
readonly alt_entity_filter_mode: string
|
16262
|
+
/**
|
16263
|
+
* The reverse entity filter mode used by this selection tool.
|
16264
|
+
*
|
16265
|
+
* _Can only be used if this is SelectionTool_
|
16266
|
+
*
|
16267
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_alt_entity_filter_mode View documentation}
|
16268
|
+
*/
|
16269
|
+
readonly reverse_alt_entity_filter_mode: string
|
15999
16270
|
/**
|
16000
16271
|
* The tile filter mode used by this selection tool.
|
16001
16272
|
*
|
@@ -16012,6 +16283,14 @@ interface SelectionToolItemPrototype extends BaseItemPrototype {
|
|
16012
16283
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_tile_filter_mode View documentation}
|
16013
16284
|
*/
|
16014
16285
|
readonly alt_tile_filter_mode: string
|
16286
|
+
/**
|
16287
|
+
* The reverse tile filter mode used by this selection tool.
|
16288
|
+
*
|
16289
|
+
* _Can only be used if this is SelectionTool_
|
16290
|
+
*
|
16291
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_tile_filter_mode View documentation}
|
16292
|
+
*/
|
16293
|
+
readonly reverse_tile_filter_mode: string
|
16015
16294
|
/**
|
16016
16295
|
* The entity filters used by this selection tool indexed by entity name.
|
16017
16296
|
*
|
@@ -16028,6 +16307,14 @@ interface SelectionToolItemPrototype extends BaseItemPrototype {
|
|
16028
16307
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_entity_filters View documentation}
|
16029
16308
|
*/
|
16030
16309
|
readonly alt_entity_filters: Record<string, LuaEntityPrototype>
|
16310
|
+
/**
|
16311
|
+
* The reverse entity filters used by this selection tool indexed by entity name.
|
16312
|
+
*
|
16313
|
+
* _Can only be used if this is SelectionTool_
|
16314
|
+
*
|
16315
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_entity_filters View documentation}
|
16316
|
+
*/
|
16317
|
+
readonly reverse_entity_filters: Record<string, LuaEntityPrototype>
|
16031
16318
|
/**
|
16032
16319
|
* The entity type filters used by this selection tool indexed by entity type.
|
16033
16320
|
*
|
@@ -16046,6 +16333,15 @@ interface SelectionToolItemPrototype extends BaseItemPrototype {
|
|
16046
16333
|
* @remarks The boolean value is meaningless and is used to allow easy lookup if a type exists in the dictionary.
|
16047
16334
|
*/
|
16048
16335
|
readonly alt_entity_type_filters: Record<string, boolean>
|
16336
|
+
/**
|
16337
|
+
* The reverse entity type filters used by this selection tool indexed by entity type.
|
16338
|
+
*
|
16339
|
+
* _Can only be used if this is SelectionTool_
|
16340
|
+
*
|
16341
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_entity_type_filters View documentation}
|
16342
|
+
* @remarks The boolean value is meaningless and is used to allow easy lookup if a type exists in the dictionary.
|
16343
|
+
*/
|
16344
|
+
readonly reverse_entity_type_filters: Record<string, boolean>
|
16049
16345
|
/**
|
16050
16346
|
* The tile filters used by this selection tool indexed by tile name.
|
16051
16347
|
*
|
@@ -16062,6 +16358,14 @@ interface SelectionToolItemPrototype extends BaseItemPrototype {
|
|
16062
16358
|
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.alt_tile_filters View documentation}
|
16063
16359
|
*/
|
16064
16360
|
readonly alt_tile_filters: Record<string, LuaTilePrototype>
|
16361
|
+
/**
|
16362
|
+
* The reverse tile filters used by this selection tool indexed by tile name.
|
16363
|
+
*
|
16364
|
+
* _Can only be used if this is SelectionTool_
|
16365
|
+
*
|
16366
|
+
* {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.reverse_tile_filters View documentation}
|
16367
|
+
*/
|
16368
|
+
readonly reverse_tile_filters: Record<string, LuaTilePrototype>
|
16065
16369
|
}
|
16066
16370
|
|
16067
16371
|
interface DeconstructionItemPrototype extends BaseItemPrototype {
|
@@ -16199,8 +16503,8 @@ interface LuaItemStack {
|
|
16199
16503
|
* Set this item stack to another item stack.
|
16200
16504
|
*
|
16201
16505
|
* {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.set_stack View documentation}
|
16202
|
-
* @param stack Item stack to set
|
16203
|
-
* @returns
|
16506
|
+
* @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.
|
16507
|
+
* @returns Whether the stack was set successfully. Returns `false` if this stack was not {@link LuaItemStack#can_set_stack valid for write}.
|
16204
16508
|
*/
|
16205
16509
|
set_stack(stack?: ItemStackIdentification): boolean
|
16206
16510
|
/**
|
@@ -16934,8 +17238,8 @@ interface BaseItemStack {
|
|
16934
17238
|
* Set this item stack to another item stack.
|
16935
17239
|
*
|
16936
17240
|
* {@link https://lua-api.factorio.com/latest/LuaItemStack.html#LuaItemStack.set_stack View documentation}
|
16937
|
-
* @param stack Item stack to set
|
16938
|
-
* @returns
|
17241
|
+
* @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.
|
17242
|
+
* @returns Whether the stack was set successfully. Returns `false` if this stack was not {@link LuaItemStack#can_set_stack valid for write}.
|
16939
17243
|
*/
|
16940
17244
|
set_stack(stack?: ItemStackIdentification): boolean
|
16941
17245
|
/**
|
@@ -18334,7 +18638,7 @@ interface LuaModSettingPrototype {
|
|
18334
18638
|
*/
|
18335
18639
|
readonly name: string
|
18336
18640
|
/**
|
18337
|
-
*
|
18641
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18338
18642
|
*
|
18339
18643
|
* {@link https://lua-api.factorio.com/latest/LuaModSettingPrototype.html#LuaModSettingPrototype.order View documentation}
|
18340
18644
|
*/
|
@@ -18418,7 +18722,7 @@ interface LuaModuleCategoryPrototype {
|
|
18418
18722
|
*/
|
18419
18723
|
readonly name: string
|
18420
18724
|
/**
|
18421
|
-
*
|
18725
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18422
18726
|
*
|
18423
18727
|
* {@link https://lua-api.factorio.com/latest/LuaModuleCategoryPrototype.html#LuaModuleCategoryPrototype.order View documentation}
|
18424
18728
|
*/
|
@@ -18453,7 +18757,7 @@ interface LuaNamedNoiseExpression {
|
|
18453
18757
|
*/
|
18454
18758
|
readonly name: string
|
18455
18759
|
/**
|
18456
|
-
*
|
18760
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18457
18761
|
*
|
18458
18762
|
* {@link https://lua-api.factorio.com/latest/LuaNamedNoiseExpression.html#LuaNamedNoiseExpression.order View documentation}
|
18459
18763
|
*/
|
@@ -18500,7 +18804,7 @@ interface LuaNoiseLayerPrototype {
|
|
18500
18804
|
*/
|
18501
18805
|
readonly name: string
|
18502
18806
|
/**
|
18503
|
-
*
|
18807
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18504
18808
|
*
|
18505
18809
|
* {@link https://lua-api.factorio.com/latest/LuaNoiseLayerPrototype.html#LuaNoiseLayerPrototype.order View documentation}
|
18506
18810
|
*/
|
@@ -18535,7 +18839,7 @@ interface LuaParticlePrototype {
|
|
18535
18839
|
*/
|
18536
18840
|
readonly name: string
|
18537
18841
|
/**
|
18538
|
-
*
|
18842
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
18539
18843
|
*
|
18540
18844
|
* {@link https://lua-api.factorio.com/latest/LuaParticlePrototype.html#LuaParticlePrototype.order View documentation}
|
18541
18845
|
*/
|
@@ -19310,7 +19614,7 @@ interface LuaPlayer extends LuaControl {
|
|
19310
19614
|
*/
|
19311
19615
|
readonly cutscene_character: LuaEntity | undefined
|
19312
19616
|
/**
|
19313
|
-
* This player's index in {@link LuaGameScript#players LuaGameScript::players}.
|
19617
|
+
* 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}.
|
19314
19618
|
*
|
19315
19619
|
* {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.index View documentation}
|
19316
19620
|
*/
|
@@ -19858,7 +20162,7 @@ interface LuaRecipe {
|
|
19858
20162
|
*/
|
19859
20163
|
readonly energy: double
|
19860
20164
|
/**
|
19861
|
-
*
|
20165
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
19862
20166
|
*
|
19863
20167
|
* {@link https://lua-api.factorio.com/latest/LuaRecipe.html#LuaRecipe.order View documentation}
|
19864
20168
|
*/
|
@@ -19909,7 +20213,7 @@ interface LuaRecipeCategoryPrototype {
|
|
19909
20213
|
*/
|
19910
20214
|
readonly name: string
|
19911
20215
|
/**
|
19912
|
-
*
|
20216
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
19913
20217
|
*
|
19914
20218
|
* {@link https://lua-api.factorio.com/latest/LuaRecipeCategoryPrototype.html#LuaRecipeCategoryPrototype.order View documentation}
|
19915
20219
|
*/
|
@@ -20011,7 +20315,7 @@ interface LuaRecipePrototype {
|
|
20011
20315
|
*/
|
20012
20316
|
readonly energy: double
|
20013
20317
|
/**
|
20014
|
-
*
|
20318
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
20015
20319
|
*
|
20016
20320
|
* {@link https://lua-api.factorio.com/latest/LuaRecipePrototype.html#LuaRecipePrototype.order View documentation}
|
20017
20321
|
*/
|
@@ -21508,7 +21812,7 @@ interface LuaResourceCategoryPrototype {
|
|
21508
21812
|
*/
|
21509
21813
|
readonly name: string
|
21510
21814
|
/**
|
21511
|
-
*
|
21815
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
21512
21816
|
*
|
21513
21817
|
* {@link https://lua-api.factorio.com/latest/LuaResourceCategoryPrototype.html#LuaResourceCategoryPrototype.order View documentation}
|
21514
21818
|
*/
|
@@ -21622,7 +21926,7 @@ interface LuaShortcutPrototype {
|
|
21622
21926
|
*/
|
21623
21927
|
readonly name: string
|
21624
21928
|
/**
|
21625
|
-
*
|
21929
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
21626
21930
|
*
|
21627
21931
|
* {@link https://lua-api.factorio.com/latest/LuaShortcutPrototype.html#LuaShortcutPrototype.order View documentation}
|
21628
21932
|
*/
|
@@ -21876,7 +22180,7 @@ interface LuaStyle {
|
|
21876
22180
|
/**
|
21877
22181
|
* Horizontal space between individual cells.
|
21878
22182
|
*
|
21879
|
-
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or
|
22183
|
+
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
|
21880
22184
|
*
|
21881
22185
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
|
21882
22186
|
*/
|
@@ -22051,13 +22355,13 @@ interface LuaStyle {
|
|
22051
22355
|
*/
|
22052
22356
|
set cell_padding(value: int)
|
22053
22357
|
/**
|
22054
|
-
* Sets extra_top/right/bottom/
|
22358
|
+
* 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.
|
22055
22359
|
*
|
22056
22360
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_padding_when_activated View documentation}
|
22057
22361
|
*/
|
22058
22362
|
set extra_padding_when_activated(value: int | StyleValuesArray)
|
22059
22363
|
/**
|
22060
|
-
* 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.
|
22364
|
+
* 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.
|
22061
22365
|
*
|
22062
22366
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_margin_when_activated View documentation}
|
22063
22367
|
*/
|
@@ -22266,7 +22570,7 @@ interface TableStyle extends BaseStyle {
|
|
22266
22570
|
/**
|
22267
22571
|
* Horizontal space between individual cells.
|
22268
22572
|
*
|
22269
|
-
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or
|
22573
|
+
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
|
22270
22574
|
*
|
22271
22575
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
|
22272
22576
|
*/
|
@@ -22440,7 +22744,7 @@ interface FlowStyle extends BaseStyle {
|
|
22440
22744
|
/**
|
22441
22745
|
* Horizontal space between individual cells.
|
22442
22746
|
*
|
22443
|
-
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or
|
22747
|
+
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
|
22444
22748
|
*
|
22445
22749
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
|
22446
22750
|
*/
|
@@ -22459,7 +22763,7 @@ interface HorizontalFlowStyle extends BaseStyle {
|
|
22459
22763
|
/**
|
22460
22764
|
* Horizontal space between individual cells.
|
22461
22765
|
*
|
22462
|
-
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or
|
22766
|
+
* _Can only be used if this is LuaTableStyle, LuaFlowStyle or LuaHorizontalFlowStyle_
|
22463
22767
|
*
|
22464
22768
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.horizontal_spacing View documentation}
|
22465
22769
|
*/
|
@@ -22563,13 +22867,13 @@ interface ScrollPaneStyle extends BaseStyle {
|
|
22563
22867
|
*/
|
22564
22868
|
extra_right_margin_when_activated: int
|
22565
22869
|
/**
|
22566
|
-
* Sets extra_top/right/bottom/
|
22870
|
+
* 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.
|
22567
22871
|
*
|
22568
22872
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_padding_when_activated View documentation}
|
22569
22873
|
*/
|
22570
22874
|
set extra_padding_when_activated(value: int | StyleValuesArray)
|
22571
22875
|
/**
|
22572
|
-
* 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.
|
22876
|
+
* 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.
|
22573
22877
|
*
|
22574
22878
|
* {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.extra_margin_when_activated View documentation}
|
22575
22879
|
*/
|
@@ -22605,11 +22909,11 @@ interface BaseSurfaceCreateEntity {
|
|
22605
22909
|
/**
|
22606
22910
|
* Entity with health for the new entity to target.
|
22607
22911
|
*/
|
22608
|
-
readonly target?: LuaEntity
|
22912
|
+
readonly target?: LuaEntity | MapPosition
|
22609
22913
|
/**
|
22610
22914
|
* Source entity. Used for beams and highlight-boxes.
|
22611
22915
|
*/
|
22612
|
-
readonly source?: LuaEntity
|
22916
|
+
readonly source?: LuaEntity | MapPosition
|
22613
22917
|
/**
|
22614
22918
|
* If true, building will attempt to simulate fast-replace building.
|
22615
22919
|
*/
|
@@ -22983,7 +23287,10 @@ interface LuaSurface {
|
|
22983
23287
|
*
|
22984
23288
|
* 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.
|
22985
23289
|
*
|
22986
|
-
* If no `area` or `position` are given, the entire surface is searched.
|
23290
|
+
* - If no `area` or `position` are given, the entire surface is searched.
|
23291
|
+
* - If `position` is given, this returns the entities colliding with that position (i.e the given position is within the entity's collision box).
|
23292
|
+
* - If `position` and `radius` are given, this returns the entities within the radius of the position. Looks for the center of entities.
|
23293
|
+
* - If `area` is specified, this returns the entities colliding with that area.
|
22987
23294
|
*
|
22988
23295
|
* {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entities_filtered View documentation}
|
22989
23296
|
* @example
|
@@ -23003,9 +23310,6 @@ interface LuaSurface {
|
|
23003
23310
|
* Has precedence over area field.
|
23004
23311
|
*/
|
23005
23312
|
readonly position?: MapPosition
|
23006
|
-
/**
|
23007
|
-
* If given with position, will return all entities within the radius of the position.
|
23008
|
-
*/
|
23009
23313
|
readonly radius?: double
|
23010
23314
|
readonly name?: string | readonly string[]
|
23011
23315
|
readonly type?: string | readonly string[]
|
@@ -23019,7 +23323,7 @@ interface LuaSurface {
|
|
23019
23323
|
readonly limit?: uint
|
23020
23324
|
readonly is_military_target?: boolean
|
23021
23325
|
/**
|
23022
|
-
*
|
23326
|
+
* Whether the filters should be inverted.
|
23023
23327
|
*/
|
23024
23328
|
readonly invert?: boolean
|
23025
23329
|
}): LuaEntity[]
|
@@ -24312,7 +24616,7 @@ interface LuaTechnology {
|
|
24312
24616
|
*/
|
24313
24617
|
readonly research_unit_energy: double
|
24314
24618
|
/**
|
24315
|
-
*
|
24619
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
24316
24620
|
*
|
24317
24621
|
* {@link https://lua-api.factorio.com/latest/LuaTechnology.html#LuaTechnology.order View documentation}
|
24318
24622
|
*/
|
@@ -24426,7 +24730,7 @@ interface LuaTechnologyPrototype {
|
|
24426
24730
|
*/
|
24427
24731
|
readonly research_unit_energy: double
|
24428
24732
|
/**
|
24429
|
-
*
|
24733
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
24430
24734
|
*
|
24431
24735
|
* {@link https://lua-api.factorio.com/latest/LuaTechnologyPrototype.html#LuaTechnologyPrototype.order View documentation}
|
24432
24736
|
*/
|
@@ -24565,7 +24869,7 @@ interface LuaTilePrototype {
|
|
24565
24869
|
*/
|
24566
24870
|
readonly name: string
|
24567
24871
|
/**
|
24568
|
-
*
|
24872
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
24569
24873
|
*
|
24570
24874
|
* {@link https://lua-api.factorio.com/latest/LuaTilePrototype.html#LuaTilePrototype.order View documentation}
|
24571
24875
|
*/
|
@@ -25180,7 +25484,7 @@ interface LuaTrivialSmokePrototype {
|
|
25180
25484
|
*/
|
25181
25485
|
readonly name: string
|
25182
25486
|
/**
|
25183
|
-
*
|
25487
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
25184
25488
|
*
|
25185
25489
|
* {@link https://lua-api.factorio.com/latest/LuaTrivialSmokePrototype.html#LuaTrivialSmokePrototype.order View documentation}
|
25186
25490
|
*/
|
@@ -25341,7 +25645,7 @@ interface LuaVirtualSignalPrototype {
|
|
25341
25645
|
*/
|
25342
25646
|
readonly name: string
|
25343
25647
|
/**
|
25344
|
-
*
|
25648
|
+
* The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
|
25345
25649
|
*
|
25346
25650
|
* {@link https://lua-api.factorio.com/latest/LuaVirtualSignalPrototype.html#LuaVirtualSignalPrototype.order View documentation}
|
25347
25651
|
*/
|