typed-factorio 1.3.2 → 1.4.0

package/Changelog.md

@@ -1,6 +1,18 @@
+# v1.4.0
+
+- Improve doc comments for enum concepts
+- Improve doc comment formatting
+- Improve types of concepts with literal union types
+- Add read-specific types to AutoplaceControl and ComparatorString
+
+# v1.3.2
+
+- Move "notes" comment into the main body of doc comment, instead of in @remarks. This works around #13.
+- Add manually defined overload for LuaControl::teleport().
+
 # v1.3.1
 
-- Use @linkplain instead of @link for web links. This works around issue #13
+- Use @linkplain instead of @link for web links. This hopefully works around issue #13
 
 # v1.3.0
 

package/generated/classes.d.ts

@@ -403,7 +403,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link OnConsoleChatEvent on_console_chat} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_console_chat View documentation}
    */
   raise_console_chat(params: {
@@ -420,7 +419,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link OnPlayerCraftedItemEvent on_player_crafted_item} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_player_crafted_item View documentation}
    */
   raise_player_crafted_item(params: {
@@ -441,7 +439,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link OnPlayerFastTransferredEvent on_player_fast_transferred} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_player_fast_transferred View documentation}
    */
   raise_player_fast_transferred(params: {
@@ -462,7 +459,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link OnBiterBaseBuiltEvent on_biter_base_built} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_biter_base_built View documentation}
    */
   raise_biter_base_built(params: {
@@ -475,7 +471,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link OnMarketItemPurchasedEvent on_market_item_purchased} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_market_item_purchased View documentation}
    */
   raise_market_item_purchased(params: {
@@ -500,7 +495,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link ScriptRaisedBuiltEvent script_raised_built} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_script_built View documentation}
    */
   raise_script_built(params: {
@@ -513,7 +507,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link ScriptRaisedDestroyEvent script_raised_destroy} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_script_destroy View documentation}
    */
   raise_script_destroy(params: {
@@ -526,7 +519,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link ScriptRaisedReviveEvent script_raised_revive} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_script_revive View documentation}
    */
   raise_script_revive(params: {
@@ -543,7 +535,6 @@ interface LuaBootstrap {
    * **Raised events:**
    * - {@link ScriptRaisedSetTilesEvent script_raised_set_tiles} _instantly_ Raised with the provided arguments.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaBootstrap.html#LuaBootstrap.raise_script_set_tiles View documentation}
    */
   raise_script_set_tiles(params: {
@@ -1179,7 +1170,6 @@ interface LuaControl {
    * **Raised events:**
    * - {@link OnSelectedEntityChangedEvent on_selected_entity_changed}? _instantly_ Raised if there is an entity at the given position to select.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.update_selected_entity View documentation}
    * @param position Position of the entity to select.
    */
@@ -1190,7 +1180,6 @@ interface LuaControl {
    * **Raised events:**
    * - {@link OnSelectedEntityChangedEvent on_selected_entity_changed}? _instantly_ Raised if there is a currently selected entity.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.clear_selected_entity View documentation}
    */
   clear_selected_entity(): void
@@ -1227,7 +1216,6 @@ interface LuaControl {
    * - {@link OnPrePlayerCraftedItemEvent on_pre_player_crafted_item}? _instantly_ Raised if crafting was able to be started.
    * - {@link OnPlayerMainInventoryChangedEvent on_player_main_inventory_changed}? _current_tick_ Raised if crafting was able to be started.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.begin_crafting View documentation}
    * @returns The count that was actually started crafting.
    */
@@ -1252,7 +1240,6 @@ interface LuaControl {
    * - {@link OnPlayerCancelledCraftingEvent on_player_cancelled_crafting}? _instantly_ Raised if crafting was able to be cancelled.
    * - {@link OnPlayerMainInventoryChangedEvent on_player_main_inventory_changed}? _current_tick_ Raised if crafting was able to be cancelled.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.cancel_crafting View documentation}
    */
   cancel_crafting(params: {
@@ -1273,7 +1260,6 @@ interface LuaControl {
    * - {@link OnPlayerMinedEntityEvent on_player_mined_entity}? _instantly_ Raised if mining is successful.
    * - {@link OnPlayerMinedItemEvent on_player_mined_item}? _instantly_ Raised if mining is successful.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.mine_entity View documentation}
    * @param entity The entity to mine
    * @param force Forces mining the entity even if the items can't fit in the player.
@@ -1287,7 +1273,6 @@ interface LuaControl {
    * - {@link OnPlayerMinedItemEvent on_player_mined_item}? _instantly_ Raised if mining is successful.
    * - {@link OnPlayerMinedTileEvent on_player_mined_tile}? _instantly_ Raised if mining is successful.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.mine_tile View documentation}
    * @param tile The tile to mine.
    * @returns Whether the mining succeeded.
@@ -1328,7 +1313,6 @@ interface LuaControl {
    * **Raised events:**
    * - {@link OnEntityLogisticSlotChangedEvent on_entity_logistic_slot_changed}? _instantly_ Raised if setting of logistic slot was successful.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.set_vehicle_logistic_slot View documentation}
    * @param slot_index The slot to set.
    * @param value The logistic request parameters.
@@ -1427,7 +1411,6 @@ interface LuaControl {
    * **Raised events:**
    * - {@link OnSelectedEntityChangedEvent on_selected_entity_changed}? _instantly_ Raised when a selectable entity is written to this attribute.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.selected View documentation}
    */
   selected: LuaEntity | undefined
@@ -1608,7 +1591,6 @@ interface LuaControl {
    * **Raised events:**
    * - {@link OnPlayerDrivingChangedStateEvent on_player_driving_changed_state}? _instantly_ Raised if the driving state successfully changed.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.driving View documentation}
    */
   driving: boolean
@@ -2144,7 +2126,8 @@ interface LuaDeciderCombinatorControlBehavior extends LuaCombinatorControlBehavi
    *
    * {@link https://lua-api.factorio.com/latest/LuaDeciderCombinatorControlBehavior.html#LuaDeciderCombinatorControlBehavior.parameters View documentation}
    */
-  parameters: DeciderCombinatorParameters
+  get parameters(): DeciderCombinatorParametersRead
+  set parameters(value: DeciderCombinatorParameters)
   /**
    * 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.
    */
@@ -2355,7 +2338,6 @@ interface LuaEntity extends LuaControl {
    * - {@link OnEntityDiedEvent on_entity_died}? _instantly_ Raised if the entity was successfully killed. If `force` is not specified, the event will blame the `"neutral"` force.
    * - {@link OnPostEntityDiedEvent on_post_entity_died}? _instantly_ Raised if the entity was successfully killed.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.die View documentation}
    * @param force The force to attribute the kill to.
    * @param cause The cause to attribute the kill to.
@@ -2466,7 +2448,6 @@ interface LuaEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnMarkedForDeconstructionEvent on_marked_for_deconstruction}? _instantly_ Raised if the entity way successfully marked for deconstruction.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.order_deconstruction View documentation}
    * @param force The force whose robots are supposed to do the deconstruction.
    * @param player The player to set the `last_user` to if any.
@@ -2479,7 +2460,6 @@ interface LuaEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnCancelledDeconstructionEvent on_cancelled_deconstruction}? _instantly_ Raised if the entity's deconstruction was successfully cancelled.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.cancel_deconstruction View documentation}
    * @param force The force who did the deconstruction order.
    * @param player The player to set the `last_user` to if any.
@@ -2497,7 +2477,6 @@ interface LuaEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnMarkedForUpgradeEvent on_marked_for_upgrade}? _instantly_ Raised if the entity way successfully marked for upgrade.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.order_upgrade View documentation}
    * @returns Whether the entity was marked for upgrade.
    */
@@ -2522,7 +2501,6 @@ interface LuaEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnCancelledUpgradeEvent on_cancelled_upgrade}? _instantly_ Raised if the entity way previously marked for upgrade.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.cancel_upgrade View documentation}
    * @param force The force who did the upgrade order.
    * @param player The player to set the last_user to if any.
@@ -2656,7 +2634,6 @@ interface LuaEntity extends LuaControl {
    * - {@link ScriptRaisedReviveEvent script_raised_revive}? _instantly_ Raised if this was an entity ghost and the `raise_revive` flag was set and the entity was successfully revived.
    * - {@link ScriptRaisedSetTilesEvent script_raised_set_tiles}? _instantly_ Raised if this was a tile ghost and the `raise_revive` flag was set and the tile was successfully revived.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.revive View documentation}
    * @returns Any items the new real entity collided with or `nil` if the ghost could not be revived.
    * @returns The revived entity if an entity ghost was successfully revived.
@@ -2679,7 +2656,6 @@ interface LuaEntity extends LuaControl {
    * - {@link ScriptRaisedReviveEvent script_raised_revive}? _instantly_ Raised if this was an entity ghost and the `raise_revive` flag was set and the entity was successfully revived.
    * - {@link ScriptRaisedSetTilesEvent script_raised_set_tiles}? _instantly_ Raised if this was a tile ghost and the `raise_revive` flag was set and the tile was successfully revived.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.silent_revive View documentation}
    * @returns Any items the new real entity collided with or `nil` if the ghost could not be revived.
    * @returns The revived entity if an entity ghost was successfully revived.
@@ -2964,7 +2940,6 @@ interface LuaEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnPlayerRotatedEntityEvent on_player_rotated_entity}? _instantly_ Raised if the `by_player` argument was given and the rotation was successful.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.rotate View documentation}
    * @returns Whether the rotation was successful.
    * @returns Count of spilled items indexed by their prototype names if `spill_items` was `true`.
@@ -3072,7 +3047,6 @@ interface LuaEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnEntityClonedEvent on_entity_cloned}? _instantly_ Raised if the entity was successfully cloned.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.clone View documentation}
    * @returns The cloned entity or `nil` if this entity can't be cloned/can't be cloned to the given location.
    */
@@ -4796,7 +4770,6 @@ interface BaseEntity extends LuaControl {
    * - {@link OnEntityDiedEvent on_entity_died}? _instantly_ Raised if the entity was successfully killed. If `force` is not specified, the event will blame the `"neutral"` force.
    * - {@link OnPostEntityDiedEvent on_post_entity_died}? _instantly_ Raised if the entity was successfully killed.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.die View documentation}
    * @param force The force to attribute the kill to.
    * @param cause The cause to attribute the kill to.
@@ -4849,7 +4822,6 @@ interface BaseEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnMarkedForDeconstructionEvent on_marked_for_deconstruction}? _instantly_ Raised if the entity way successfully marked for deconstruction.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.order_deconstruction View documentation}
    * @param force The force whose robots are supposed to do the deconstruction.
    * @param player The player to set the `last_user` to if any.
@@ -4862,7 +4834,6 @@ interface BaseEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnCancelledDeconstructionEvent on_cancelled_deconstruction}? _instantly_ Raised if the entity's deconstruction was successfully cancelled.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.cancel_deconstruction View documentation}
    * @param force The force who did the deconstruction order.
    * @param player The player to set the `last_user` to if any.
@@ -4880,7 +4851,6 @@ interface BaseEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnMarkedForUpgradeEvent on_marked_for_upgrade}? _instantly_ Raised if the entity way successfully marked for upgrade.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.order_upgrade View documentation}
    * @returns Whether the entity was marked for upgrade.
    */
@@ -4905,7 +4875,6 @@ interface BaseEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnCancelledUpgradeEvent on_cancelled_upgrade}? _instantly_ Raised if the entity way previously marked for upgrade.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.cancel_upgrade View documentation}
    * @param force The force who did the upgrade order.
    * @param player The player to set the last_user to if any.
@@ -4961,7 +4930,6 @@ interface BaseEntity extends LuaControl {
    * - {@link ScriptRaisedReviveEvent script_raised_revive}? _instantly_ Raised if this was an entity ghost and the `raise_revive` flag was set and the entity was successfully revived.
    * - {@link ScriptRaisedSetTilesEvent script_raised_set_tiles}? _instantly_ Raised if this was a tile ghost and the `raise_revive` flag was set and the tile was successfully revived.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.revive View documentation}
    * @returns Any items the new real entity collided with or `nil` if the ghost could not be revived.
    * @returns The revived entity if an entity ghost was successfully revived.
@@ -4984,7 +4952,6 @@ interface BaseEntity extends LuaControl {
    * - {@link ScriptRaisedReviveEvent script_raised_revive}? _instantly_ Raised if this was an entity ghost and the `raise_revive` flag was set and the entity was successfully revived.
    * - {@link ScriptRaisedSetTilesEvent script_raised_set_tiles}? _instantly_ Raised if this was a tile ghost and the `raise_revive` flag was set and the tile was successfully revived.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.silent_revive View documentation}
    * @returns Any items the new real entity collided with or `nil` if the ghost could not be revived.
    * @returns The revived entity if an entity ghost was successfully revived.
@@ -5118,7 +5085,6 @@ interface BaseEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnPlayerRotatedEntityEvent on_player_rotated_entity}? _instantly_ Raised if the `by_player` argument was given and the rotation was successful.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.rotate View documentation}
    * @returns Whether the rotation was successful.
    * @returns Count of spilled items indexed by their prototype names if `spill_items` was `true`.
@@ -5157,7 +5123,6 @@ interface BaseEntity extends LuaControl {
    * **Raised events:**
    * - {@link OnEntityClonedEvent on_entity_cloned}? _instantly_ Raised if the entity was successfully cloned.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.clone View documentation}
    * @returns The cloned entity or `nil` if this entity can't be cloned/can't be cloned to the given location.
    */
@@ -11473,7 +11438,6 @@ interface LuaForce {
    * **Raised events:**
    * - {@link OnResearchFinishedEvent on_research_finished} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.research_all_technologies View documentation}
    * @param include_disabled_prototypes Whether technologies that are explicitly disabled in the prototype should also be researched. Defaults to `false`.
    */
@@ -11490,7 +11454,6 @@ interface LuaForce {
    * **Raised events:**
    * - {@link OnForceResetEvent on_force_reset} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.reset View documentation}
    */
   reset(): void
@@ -11500,7 +11463,6 @@ interface LuaForce {
    * **Raised events:**
    * - {@link OnTechnologyEffectsResetEvent on_technology_effects_reset} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.reset_technology_effects View documentation}
    */
   reset_technology_effects(): void
@@ -11603,7 +11565,6 @@ interface LuaForce {
    * **Raised events:**
    * - {@link OnForceCeaseFireChangedEvent on_force_cease_fire_changed} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.set_cease_fire View documentation}
    */
   set_cease_fire(other: ForceIdentification, cease_fire: boolean): void
@@ -11619,7 +11580,6 @@ interface LuaForce {
    * **Raised events:**
    * - {@link OnForceFriendsChangedEvent on_force_friends_changed} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.set_friend View documentation}
    */
   set_friend(other: ForceIdentification, friend: boolean): void
@@ -11796,7 +11756,6 @@ interface LuaForce {
    * **Raised events:**
    * - {@link OnResearchStartedEvent on_research_started}? _instantly_ Raised if the technology was successfully added.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaForce.html#LuaForce.add_research View documentation}
    * @returns Whether the technology was successfully added.
    */
@@ -12441,7 +12400,6 @@ interface LuaGameScript {
    * - {@link OnPrePlayerRemovedEvent on_pre_player_removed} _instantly_
    * - {@link OnPlayerRemovedEvent on_player_removed} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.remove_offline_players View documentation}
    * @param players List of players to remove. If not specified, remove all offline players.
    */
@@ -12524,7 +12482,6 @@ interface LuaGameScript {
    * - {@link OnPreSurfaceDeletedEvent on_pre_surface_deleted} _future_tick_
    * - {@link OnSurfaceDeletedEvent on_surface_deleted} _future_tick_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.delete_surface View documentation}
    * @param surface The surface to be deleted. Currently the primary surface (1, 'nauvis') cannot be deleted.
    */
@@ -12621,7 +12578,6 @@ interface LuaGameScript {
    * - {@link OnPlayerKickedEvent on_player_kicked} _instantly_
    * - {@link OnConsoleCommandEvent on_console_command} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.kick_player View documentation}
    * @param player The player to kick.
    * @param reason The reason given if any.
@@ -12634,7 +12590,6 @@ interface LuaGameScript {
    * - {@link OnPlayerBannedEvent on_player_banned} _instantly_
    * - {@link OnConsoleCommandEvent on_console_command} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.ban_player View documentation}
    * @param player The player to ban.
    * @param reason The reason given if any.
@@ -12647,7 +12602,6 @@ interface LuaGameScript {
    * - {@link OnPlayerUnbannedEvent on_player_unbanned} _instantly_
    * - {@link OnConsoleCommandEvent on_console_command} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.unban_player View documentation}
    * @param player The player to unban.
    */
@@ -12658,7 +12612,6 @@ interface LuaGameScript {
    * **Raised events:**
    * - {@link OnConsoleCommandEvent on_console_command} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.purge_player View documentation}
    * @param player The player to purge.
    */
@@ -12670,7 +12623,6 @@ interface LuaGameScript {
    * - {@link OnPlayerMutedEvent on_player_muted} _instantly_
    * - {@link OnConsoleCommandEvent on_console_command} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.mute_player View documentation}
    * @param player The player to mute.
    */
@@ -12682,7 +12634,6 @@ interface LuaGameScript {
    * - {@link OnPlayerUnmutedEvent on_player_unmuted} _instantly_
    * - {@link OnConsoleCommandEvent on_console_command} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.unmute_player View documentation}
    * @param player The player to unmute.
    */
@@ -13343,7 +13294,8 @@ interface LuaGenericOnOffControlBehavior extends LuaControlBehavior {
    *                                            constant=4}}
    * ```
    */
-  circuit_condition: CircuitConditionDefinition
+  get circuit_condition(): CircuitConditionDefinitionRead
+  set circuit_condition(value: CircuitConditionDefinition)
   /**
    * The logistic condition.
    *
@@ -13360,7 +13312,8 @@ interface LuaGenericOnOffControlBehavior extends LuaControlBehavior {
    *                                             constant=4}}
    * ```
    */
-  logistic_condition: CircuitConditionDefinition
+  get logistic_condition(): CircuitConditionDefinitionRead
+  set logistic_condition(value: CircuitConditionDefinition)
   /**
    * `true` if this should connect to the logistic network.
    *
@@ -19934,7 +19887,6 @@ interface LuaPlayer extends LuaControl {
    * **Raised events:**
    * - {@link OnPlayerCursorStackChangedEvent on_player_cursor_stack_changed}? _current_tick_ Raised when the cursor was successfully cleared.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.clear_cursor View documentation}
    * @returns Whether the cursor is now empty.
    */
@@ -20037,7 +19989,6 @@ interface LuaPlayer extends LuaControl {
    * **Raised events:**
    * - {@link OnPlayerPipetteEvent on_player_pipette}? _instantly_ Raised if the entity was successfully pipetted.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.pipette_entity View documentation}
    * @returns Whether the smart pipette found something to place.
    */
@@ -20068,7 +20019,6 @@ interface LuaPlayer extends LuaControl {
    * - {@link OnPreBuildEvent on_pre_build}? _instantly_ Raised if the cursor was successfully built.
    * - {@link OnBuiltEntityEvent on_built_entity}? _instantly_ Raised if the cursor was successfully built.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.can_build_from_cursor View documentation}
    */
   can_build_from_cursor(params: {
@@ -20341,7 +20291,6 @@ interface LuaPlayer extends LuaControl {
    * - {@link OnPrePlayerToggledMapEditorEvent on_pre_player_toggled_map_editor}? _instantly_ Raised if the map editor was successfully toggled.
    * - {@link OnPlayerToggledMapEditorEvent on_player_toggled_map_editor}? _instantly_ Raised if the map editor was successfully toggled.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.toggle_map_editor View documentation}
    */
   toggle_map_editor(): void
@@ -20733,7 +20682,8 @@ interface LuaProfiler {
  */
 interface LuaProgrammableSpeakerControlBehavior extends LuaControlBehavior {
   circuit_parameters: ProgrammableSpeakerCircuitParameters
-  circuit_condition: CircuitConditionDefinition
+  get circuit_condition(): CircuitConditionDefinitionRead
+  set circuit_condition(value: CircuitConditionDefinition)
   /**
    * 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.
    */
@@ -20870,7 +20820,8 @@ interface LuaRailSignalControlBehavior extends LuaControlBehavior {
    *
    * {@link https://lua-api.factorio.com/latest/LuaRailSignalControlBehavior.html#LuaRailSignalControlBehavior.circuit_condition View documentation}
    */
-  circuit_condition: CircuitConditionDefinition
+  get circuit_condition(): CircuitConditionDefinitionRead
+  set circuit_condition(value: CircuitConditionDefinition)
   /**
    * 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.
    */
@@ -24494,7 +24445,6 @@ interface LuaSurface {
    * **Raised events:**
    * - {@link ScriptRaisedBuiltEvent script_raised_built}? _instantly_ Raised if the `raise_built` flag was set and the entity was successfully created.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity View documentation}
    * @returns The created entity or `nil` if the creation failed.
    * @example
@@ -24569,7 +24519,6 @@ interface LuaSurface {
    * **Raised events:**
    * - {@link OnUnitGroupCreatedEvent on_unit_group_created} _instantly_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_unit_group View documentation}
    */
   create_unit_group(params: {
@@ -24694,7 +24643,6 @@ interface LuaSurface {
    * **Raised events:**
    * - {@link OnMarkedForDeconstructionEvent on_marked_for_deconstruction}? _instantly_ Raised for every entity that has been successfully marked for deconstruction.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.deconstruct_area View documentation}
    */
   deconstruct_area(params: {
@@ -24725,7 +24673,6 @@ interface LuaSurface {
    * **Raised events:**
    * - {@link OnCancelledDeconstructionEvent on_cancelled_deconstruction}? _instantly_ Raised for every entity whose deconstruction has been successfully cancelled.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.cancel_deconstruct_area View documentation}
    */
   cancel_deconstruct_area(params: {
@@ -24756,7 +24703,6 @@ interface LuaSurface {
    * **Raised events:**
    * - {@link OnMarkedForUpgradeEvent on_marked_for_upgrade}? _instantly_ Raised for every entity that has been successfully marked for upgrade.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.upgrade_area View documentation}
    */
   upgrade_area(params: {
@@ -24787,7 +24733,6 @@ interface LuaSurface {
    * **Raised events:**
    * - {@link OnCancelledUpgradeEvent on_cancelled_upgrade}? _instantly_ Raised for every entity whose upgrade has been successfully cancelled.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.cancel_upgrade_area View documentation}
    */
   cancel_upgrade_area(params: {
@@ -24846,7 +24791,6 @@ interface LuaSurface {
    * - {@link OnPreChunkDeletedEvent on_pre_chunk_deleted} _future_tick_
    * - {@link OnChunkDeletedEvent on_chunk_deleted} _future_tick_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.delete_chunk View documentation}
    * @param position The chunk position to delete
    */
@@ -25126,7 +25070,6 @@ interface LuaSurface {
    * - {@link OnPreSurfaceClearedEvent on_pre_surface_cleared} _future_tick_
    * - {@link OnSurfaceClearedEvent on_surface_cleared} _future_tick_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.clear View documentation}
    * @param ignore_characters Whether characters on this surface that are connected to or associated with players should be ignored (not destroyed).
    */
@@ -25139,7 +25082,6 @@ interface LuaSurface {
    * **Raised events:**
    * - {@link OnScriptPathRequestFinishedEvent on_script_path_request_finished} _future_tick_
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.request_path View documentation}
    * @returns A unique handle to identify this call when {@link OnScriptPathRequestFinishedEvent on_script_path_request_finished} fires.
    */
@@ -25784,7 +25726,6 @@ interface LuaTile {
    * **Raised events:**
    * - {@link OnMarkedForDeconstructionEvent on_marked_for_deconstruction}? _instantly_ Raised if the tile was successfully marked for deconstruction.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaTile.html#LuaTile.order_deconstruction View documentation}
    * @param force The force whose robots are supposed to do the deconstruction.
    * @param player The player to set the last_user to if any.
@@ -25797,7 +25738,6 @@ interface LuaTile {
    * **Raised events:**
    * - {@link OnCancelledDeconstructionEvent on_cancelled_deconstruction}? _instantly_ Raised if the tile's deconstruction was successfully cancelled.
    *
-   *
    * {@link https://lua-api.factorio.com/latest/LuaTile.html#LuaTile.cancel_deconstruction View documentation}
    * @param force The force who did the deconstruction order.
    * @param player The player to set the last_user to if any.
@@ -26725,7 +26665,8 @@ interface LuaWallControlBehavior extends LuaControlBehavior {
    *
    * {@link https://lua-api.factorio.com/latest/LuaWallControlBehavior.html#LuaWallControlBehavior.circuit_condition View documentation}
    */
-  circuit_condition: CircuitConditionDefinition
+  get circuit_condition(): CircuitConditionDefinitionRead
+  set circuit_condition(value: CircuitConditionDefinition)
   open_gate: boolean
   read_sensor: boolean
   output_signal: SignalID

package/generated/concepts.d.ts

@@ -1635,6 +1635,21 @@ interface AutoplaceControl {
   readonly richness: MapGenSize
 }
 
+interface AutoplaceControlRead extends AutoplaceControl {
+  /**
+   * For things that are placed as spots such as ores and enemy bases, frequency is generally proportional to number of spots placed per unit area. For continuous features such as forests, frequency is how compressed the probability function is over distance, i.e. the inverse of 'scale' (similar to terrain_segmentation). When the {@link LuaAutoplaceControlPrototype} is of the category `"terrain"`, then scale is shown in the map generator GUI instead of frequency.
+   */
+  readonly frequency: number
+  /**
+   * For things that are placed as spots, size is proportional to the area of each spot. For continuous features, size affects how much of the map is covered with the thing, and is called 'coverage' in the GUI.
+   */
+  readonly size: number
+  /**
+   * Has different effects for different things, but generally affects the 'health' or density of a thing that is placed without affecting where it is placed. For trees, richness affects tree health. For ores, richness multiplies the amount of ore at any given tile in a patch. Metadata about autoplace controls (such as whether or not 'richness' does anything for them) can be found in the {@link LuaAutoplaceControlPrototype} by looking up `game.autoplace_control_prototypes[(control prototype name)]`, e.g. `game.autoplace_control_prototypes["enemy-base"].richness` is false, because enemy base autoplacement doesn't use richness.
+   */
+  readonly richness: number
+}
+
 interface AutoplaceSettings {
   /**
    * Whether missing autoplace names for this type should be default enabled.
@@ -1643,6 +1658,10 @@ interface AutoplaceSettings {
   readonly settings: Record<string, AutoplaceControl>
 }
 
+interface AutoplaceSettingsRead extends AutoplaceSettings {
+  readonly settings: Record<string, AutoplaceControlRead>
+}
+
 interface CliffPlacementSettings {
   /**
    * Name of the cliff prototype.
@@ -1662,6 +1681,13 @@ interface CliffPlacementSettings {
   readonly richness: MapGenSize
 }
 
+interface CliffPlacementSettingsRead extends CliffPlacementSettings {
+  /**
+   * Corresponds to 'continuity' in the GUI. This value is not used directly, but is used by the 'cliffiness' noise expression, which in combination with elevation and the two cliff elevation properties drives cliff placement (cliffs are placed when elevation crosses the elevation contours defined by `cliff_elevation_0` and `cliff_elevation_interval` when 'cliffiness' is greater than `0.5`). The default 'cliffiness' expression interprets this value such that larger values result in longer unbroken walls of cliffs, and smaller values (between `0` and `1`) result in larger gaps in cliff walls.
+   */
+  readonly richness: number
+}
+
 /**
  * The 'map type' dropdown in the map generation GUI is actually a selector for elevation generator. The base game sets `property_expression_names.elevation` to `"0_16-elevation"` to reproduce terrain from 0.16 or to `"0_17-island"` for the island preset. If generators are available for other properties, the 'map type' dropdown in the GUI will be renamed to 'elevation' and shown along with selectors for the other selectable properties.
  *
@@ -1755,6 +1781,30 @@ interface MapGenSettings {
 }
 
 interface MapGenSettingsRead extends MapGenSettings {
+  /**
+   * The inverse of 'water scale' in the map generator GUI. Lower `terrain_segmentation` increases the scale of elevation features (lakes, continents, etc). This behavior can be overridden with alternate elevation generators (see `property_expression_names`, below).
+   */
+  readonly terrain_segmentation: number
+  /**
+   * The equivalent to 'water coverage' in the map generator GUI. Specifically, when this value is non-zero, `water_level = 10 * log2` (the value of this field), and the elevation generator subtracts water level from elevation before adding starting lakes. If water is set to 'none', elevation is clamped to a small positive value before adding starting lakes. This behavior can be overridden with alternate elevation generators (see `property_expression_names`, below).
+   */
+  readonly water: number
+  /**
+   * Indexed by autoplace control prototype name.
+   */
+  readonly autoplace_controls: Record<string, AutoplaceControlRead>
+  /**
+   * Each setting in this dictionary maps the string type to the settings for that type. Valid types are `"entity"`, `"tile"` and `"decorative"`.
+   */
+  readonly autoplace_settings: Record<string, AutoplaceSettingsRead>
+  /**
+   * Map generation settings for entities of the type "cliff".
+   */
+  readonly cliff_settings: CliffPlacementSettingsRead
+  /**
+   * Size of the starting area.
+   */
+  readonly starting_area: number
   /**
    * Positions of the starting areas.
    */
@@ -1985,49 +2035,34 @@ interface ConstantCombinatorParameters {
 }
 
 /**
+ *  - `"="`: "equal to"
+ *
+ *  - `">"`: "greater than"
+ *
+ *  - `"<"`: "lesser than"
+ *
+ *  - `"≥"`: "greater than or equal to"
+ *
+ *  - `">="`: "greater than or equal to"
+ *
+ *  - `"≤"`: "lesser than or equal to"
+ *
+ *  - `"<="`: "lesser than or equal to"
+ *
+ *  - `"≠"`: "not equal to"
+ *
+ *  - `"!="`: "not equal to"
+ *
  * **Note**
  *
  * While the API accepts both versions for `"less/greater than or equal to"` and `"not equal"`, it'll always return `"≥"`, `"≤"` or `"≠"` respectively when reading them back.
  *
  * {@link https://lua-api.factorio.com/latest/Concepts.html#ComparatorString View documentation}
  */
-type ComparatorString
-/**
- * "equal to"
- */ =
-  | "="
-  /**
-   * "greater than"
-   */
-  | ">"
-  /**
-   * "lesser than"
-   */
-  | "<"
-  /**
-   * "greater than or equal to"
-   */
-  | "\u2265"
-  /**
-   * "greater than or equal to"
-   */
-  | ">="
-  /**
-   * "lesser than or equal to"
-   */
-  | "\u2264"
-  /**
-   * "lesser than or equal to"
-   */
-  | "<="
-  /**
-   * "not equal to"
-   */
-  | "\u2260"
-  /**
-   * "not equal to"
-   */
-  | "!="
+type ComparatorString = "=" | ">" | "<" | "≥" | ">=" | "≤" | "<=" | "≠" | "!="
+
+/** @see ComparatorString */
+type ComparatorStringRead = "=" | ">" | "<" | "≥" | "≤" | "≠"
 
 interface DeciderCombinatorParameters {
   /**
@@ -2056,6 +2091,13 @@ interface DeciderCombinatorParameters {
   readonly copy_count_from_input?: boolean
 }
 
+interface DeciderCombinatorParametersRead extends DeciderCombinatorParameters {
+  /**
+   * Specifies how the inputs should be compared. If not specified, defaults to `"<"`.
+   */
+  readonly comparator?: ComparatorStringRead
+}
+
 interface InserterCircuitConditions {
   readonly circuit?: CircuitCondition
   readonly logistics?: CircuitCondition
@@ -2080,6 +2122,13 @@ interface CircuitCondition {
   readonly constant?: int
 }
 
+interface CircuitConditionRead extends CircuitCondition {
+  /**
+   * Specifies how the inputs should be compared. If not specified, defaults to `"<"`.
+   */
+  readonly comparator?: ComparatorStringRead
+}
+
 interface CircuitConditionDefinition {
   readonly condition: CircuitCondition
   /**
@@ -2088,6 +2137,10 @@ interface CircuitConditionDefinition {
   readonly fulfilled?: boolean
 }
 
+interface CircuitConditionDefinitionRead extends CircuitConditionDefinition {
+  readonly condition: CircuitConditionRead
+}
+
 interface CircuitConnectionDefinition {
   /**
    * Wire color, either {@link defines.wire_type.red} or {@link defines.wire_type.green}.
@@ -2568,6 +2621,13 @@ interface WaitCondition {
   readonly condition?: CircuitCondition
 }
 
+interface WaitConditionRead extends WaitCondition {
+  /**
+   * Only present when `type` is `"item_count"`, `"circuit"` or `"fluid_count"`.
+   */
+  readonly condition?: CircuitConditionRead
+}
+
 interface TrainScheduleRecord {
   /**
    * Name of the station.
@@ -2749,7 +2809,11 @@ type SpriteType =
  *
  * {@link https://lua-api.factorio.com/latest/Concepts.html#SpritePath View documentation}
  */
-type SpritePath = string | `${SpriteType}/${string}`
+type SpritePath =
+  | (string & {
+      _?: never
+    })
+  | `${SpriteType}/${string}`
 
 /**
  * A sound defined by a {@link string}. It can be either the name of a {@linkplain https://wiki.factorio.com/Prototype/Sound sound prototype} defined in the data stage or a path in the form `"type/name"`. The latter option can be sorted into three categories.
@@ -2782,7 +2846,11 @@ type SpritePath = string | `${SpriteType}/${string}`
  *
  * {@link https://lua-api.factorio.com/latest/Concepts.html#SoundPath View documentation}
  */
-type SoundPath = string | `${SoundType}/${string}`
+type SoundPath =
+  | (string & {
+      _?: never
+    })
+  | `${SoundType}/${string}`
 
 interface ModuleEffectValue {
   /**
@@ -3012,7 +3080,7 @@ type CollisionMaskLayer =
   | "rail-layer"
   | "transport-belt-layer"
   | "not-setup"
-  | `layer-${number}`
+  | `layer-${bigint}`
 
 /**
  * This is a set of masks given as a dictionary[{@link CollisionMaskLayer} &rarr; {@link boolean}]. Only set masks are present in the dictionary and they have the value `true`. Unset flags aren't present at all.
@@ -3375,27 +3443,24 @@ interface ProgrammableSpeakerInstrument {
 /**
  * A {@link string} that specifies where a GUI element should be.
  *
+ *  - `"left"`: The same as `"middle-left"`
+ *
+ *  - `"center"`: The same as `"middle-center"`
+ *
+ *  - `"right"`: The same as `"middle-right"`
+ *
  * {@link https://lua-api.factorio.com/latest/Concepts.html#Alignment View documentation}
  */
 type Alignment =
   | "top-left"
   | "middle-left"
-  /**
-   * The same as `"middle-left"`
-   */
   | "left"
   | "bottom-left"
   | "top-center"
   | "middle-center"
-  /**
-   * The same as `"middle-center"`
-   */
   | "center"
   | "bottom-center"
   | "top-right"
-  /**
-   * The same as `"middle-right"`
-   */
   | "right"
   | "bottom-right"
 
@@ -3543,69 +3608,53 @@ type MouseButtonFlagsArray = readonly (MouseButtonFlag | "left-and-right")[]
  */
 type MouseButtonFlags = MouseButtonFlagsTable | MouseButtonFlagsArray
 
-type CursorBoxRenderType
 /**
- * Yellow box.
- */ =
+ *  - `"entity"`: Yellow box.
+ *
+ *  - `"not-allowed"`: Red box.
+ *
+ *  - `"electricity"`: Light blue box.
+ *
+ *  - `"pair"`: Light blue box.
+ *
+ *  - `"copy"`: Green box.
+ *
+ *  - `"train-visualization"`: White box.
+ *
+ *  - `"logistics"`: Light blue box.
+ *
+ *  - `"blueprint-snap-rectangle"`: Green box.
+ *
+ * {@link https://lua-api.factorio.com/latest/Concepts.html#CursorBoxRenderType View documentation}
+ */
+type CursorBoxRenderType =
   | "entity"
-  /**
-   * Red box.
-   */
   | "not-allowed"
-  /**
-   * Light blue box.
-   */
   | "electricity"
-  /**
-   * Light blue box.
-   */
   | "pair"
-  /**
-   * Green box.
-   */
   | "copy"
-  /**
-   * White box.
-   */
   | "train-visualization"
-  /**
-   * Light blue box.
-   */
   | "logistics"
-  /**
-   * Green box.
-   */
   | "blueprint-snap-rectangle"
 
-type ForceCondition
 /**
- * All forces pass.
- */ =
-  | "all"
-  /**
-   * Forces which will attack pass.
-   */
-  | "enemy"
-  /**
-   * Forces which won't attack pass.
-   */
-  | "ally"
-  /**
-   * Forces which are friends pass.
-   */
-  | "friend"
-  /**
-   * Forces which are not friends pass.
-   */
-  | "not-friend"
-  /**
-   * The same force pass.
-   */
-  | "same"
-  /**
-   * The non-same forces pass.
-   */
-  | "not-same"
+ *  - `"all"`: All forces pass.
+ *
+ *  - `"enemy"`: Forces which will attack pass.
+ *
+ *  - `"ally"`: Forces which won't attack pass.
+ *
+ *  - `"friend"`: Forces which are friends pass.
+ *
+ *  - `"not-friend"`: Forces which are not friends pass.
+ *
+ *  - `"same"`: The same force pass.
+ *
+ *  - `"not-same"`: The non-same forces pass.
+ *
+ * {@link https://lua-api.factorio.com/latest/Concepts.html#ForceCondition View documentation}
+ */
+type ForceCondition = "all" | "enemy" | "ally" | "friend" | "not-friend" | "same" | "not-same"
 
 /**
  * A value between 0 and 255 inclusive represented by one of the following named {@link string} or string version of the value (for example `"27"` and `"decals"` are both valid). Higher values are rendered on top of lower values.
@@ -3658,7 +3707,7 @@ type ForceCondition
  */
 type RenderLayer =
   | number
-  | `${number}`
+  | `${bigint}`
   | "water-tile"
   | "ground-tile"
   | "tile-transition"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",