typed-factorio 0.19.0 → 0.20.0

package/generated/classes.d.ts

@@ -300,7 +300,7 @@ interface LuaBootstrap {
    * @returns The registration number. It is used to identify the entity in the {@link OnEntityDestroyedEvent on_entity_destroyed} event.
    * @remarks Depending on when a given entity is destroyed, {@link OnEntityDestroyedEvent on_entity_destroyed} will either be fired at the end of the current tick or at the end of the next tick.
    */
-  register_on_entity_destroyed(entity: LuaEntity): uint64
+  register_on_entity_destroyed(entity: LuaEntity): RegistrationNumber
   /**
    * Generate a new, unique event ID that can be used to raise custom events with {@link LuaBootstrap#raise_event LuaBootstrap::raise_event}.
    *
@@ -392,7 +392,7 @@ interface LuaBootstrap {
     /**
      * The player doing the chatting.
      */
-    readonly player_index: uint
+    readonly player_index: PlayerIndex
     /**
      * The chat message to send.
      */
@@ -413,7 +413,7 @@ interface LuaBootstrap {
     /**
      * The player doing the crafting.
      */
-    readonly player_index: uint
+    readonly player_index: PlayerIndex
     /**
      * The recipe used to craft this item.
      */
@@ -430,7 +430,7 @@ interface LuaBootstrap {
     /**
      * The player transferred from or to.
      */
-    readonly player_index: uint
+    readonly player_index: PlayerIndex
     /**
      * The entity transferred from or to.
      */
@@ -464,7 +464,7 @@ interface LuaBootstrap {
     /**
      * The player who did the purchasing.
      */
-    readonly player_index: uint
+    readonly player_index: PlayerIndex
     /**
      * The market entity.
      */
@@ -532,7 +532,7 @@ interface LuaBootstrap {
     /**
      * The surface whose tiles have been changed.
      */
-    readonly surface_index: uint
+    readonly surface_index: SurfaceIndex
     /**
      * The tiles that have been changed.
      */
@@ -725,7 +725,8 @@ interface LuaBurnerPrototype {
  * {@link https://lua-api.factorio.com/latest/LuaChunkIterator.html View documentation}
  * @noSelf
  * @example
-```
+ *
+ * ```
  * for chunk in some_surface.get_chunks() do
  *   game.player.print("x: " .. chunk.x .. ", y: " .. chunk.y)
  *   game.player.print("area: " .. serpent.line(chunk.area))
@@ -1170,7 +1171,7 @@ interface LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.is_flashlight_enabled View documentation}
    */
-  is_flashlight_enabled(): void
+  is_flashlight_enabled(): boolean
   /**
    * Gets the count of the given recipe that can be crafted.
    *
@@ -1529,14 +1530,15 @@ interface LuaControl {
     readonly position: MapPosition
   })
   /**
-     * The player's cursor stack, or `nil` if the player controller is a spectator. Even though this property is marked as read-only, it returns a {@link LuaItemStack}, meaning it can be manipulated like so:
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.cursor_stack View documentation}
-     * @example
-    ```
-     * player.cursor_stack.clear()
-     * ```
-     */
+   * The player's cursor stack, or `nil` if the player controller is a spectator. Even though this property is marked as read-only, it returns a {@link LuaItemStack}, meaning it can be manipulated like so:
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.cursor_stack View documentation}
+   * @example
+   *
+   * ```
+   * player.cursor_stack.clear()
+   * ```
+   */
   readonly cursor_stack: LuaItemStack | undefined
   /**
    * The ghost prototype in the player's cursor.
@@ -1936,7 +1938,7 @@ interface LuaCustomInputPrototype {
   help(): string
 }
 
-type CustomTableIndex<K extends string | number, V>
+type CustomTableIndexer<K extends string | number, V>
 /**
  * Access an element of this custom table.
  *
@@ -1997,8 +1999,13 @@ interface LuaCustomTableMembers {
  * ```
  */
 type LuaCustomTable<K extends string | number, V> = LuaCustomTableMembers &
-  CustomTableIndex<K, V> &
-  LuaPairsIterable<[number] extends [K] ? number : K, V>
+  CustomTableIndexer<K, V> &
+  LuaPairsIterable<
+    // this convoluted expression gives a number type if K includes a number, even if it includes a string, and K otherwise.
+    // it also preserves number branding
+    [number] extends [K extends number & IndexBrand<infer A> ? number : K] ? (K extends string ? never : K) : K,
+    V
+  >
 
 /**
  * Prototype of a damage.
@@ -2465,13 +2472,13 @@ interface LuaEntity extends LuaControl {
    */
   clear_request_slot(slot: uint): void
   /**
-   * Returns whether a craft is currently in process. It does not indicate whether progress is currently being made, but whether any crafting action has made progress in this machine.
+   * Returns whether a craft is currently in process. It does not indicate whether progress is currently being made, but whether a crafting process has been started in this machine.
    *
    * _Can only be used if this is CraftingMachine_
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_crafting View documentation}
    */
-  is_crafting(): void
+  is_crafting(): boolean
   /**
    * _Can only be used if this is Gate_
    *
@@ -3487,15 +3494,16 @@ interface LuaEntity extends LuaControl {
    */
   selected_gun_index: uint | undefined
   /**
-     * Energy stored in the entity (heat in furnace, energy stored in electrical devices etc.). always 0 for entities that don't have the concept of energy stored inside.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.energy View documentation}
-     * @example
-    ```
-     * game.player.print("Machine energy: " .. game.player.selected.energy .. "J")
-     * game.player.selected.energy = 3000
-     * ```
-     */
+   * Energy stored in the entity (heat in furnace, energy stored in electrical devices etc.). always 0 for entities that don't have the concept of energy stored inside.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.energy View documentation}
+   * @example
+   *
+   * ```
+   * game.player.print("Machine energy: " .. game.player.selected.energy .. "J")
+   * game.player.selected.energy = 3000
+   * ```
+   */
   energy: double
   /**
    * The temperature of this entities heat energy source if this entity uses a heat energy source or `nil`.
@@ -3790,7 +3798,7 @@ interface LuaEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.unit_number View documentation}
    */
-  readonly unit_number: uint | undefined
+  readonly unit_number: UnitNumber | undefined
   /**
    * The {@link LuaEntity#unit_number unit_number} of the entity contained in this ghost. It is the same as the unit number of the {@link https://wiki.factorio.com/Prototype/EntityWithOwner EntityWithOwner} that was destroyed to create this ghost. If it was created by other means, or if the inner entity doesn not support unit numbers, this property is `nil`.
    *
@@ -3798,7 +3806,7 @@ interface LuaEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.ghost_unit_number View documentation}
    */
-  readonly ghost_unit_number: uint | undefined
+  readonly ghost_unit_number: UnitNumber | undefined
   /**
    * The mining progress for this mining drill or `nil` if this isn't a mining drill. Is a number in range [0, mining_target.prototype.mineable_properties.mining_time]
    *
@@ -5200,15 +5208,16 @@ interface BaseEntity extends LuaControl {
    */
   drop_target: LuaEntity | undefined
   /**
-     * Energy stored in the entity (heat in furnace, energy stored in electrical devices etc.). always 0 for entities that don't have the concept of energy stored inside.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.energy View documentation}
-     * @example
-    ```
-     * game.player.print("Machine energy: " .. game.player.selected.energy .. "J")
-     * game.player.selected.energy = 3000
-     * ```
-     */
+   * Energy stored in the entity (heat in furnace, energy stored in electrical devices etc.). always 0 for entities that don't have the concept of energy stored inside.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.energy View documentation}
+   * @example
+   *
+   * ```
+   * game.player.print("Machine energy: " .. game.player.selected.energy .. "J")
+   * game.player.selected.energy = 3000
+   * ```
+   */
   energy: double
   /**
    * The temperature of this entities heat energy source if this entity uses a heat energy source or `nil`.
@@ -5351,7 +5360,7 @@ interface BaseEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.unit_number View documentation}
    */
-  readonly unit_number: uint | undefined
+  readonly unit_number: UnitNumber | undefined
   /**
    * The mining progress for this mining drill or `nil` if this isn't a mining drill. Is a number in range [0, mining_target.prototype.mineable_properties.mining_time]
    *
@@ -5768,7 +5777,7 @@ interface EntityGhostEntity extends BaseEntity {
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.ghost_unit_number View documentation}
    */
-  readonly ghost_unit_number: uint | undefined
+  readonly ghost_unit_number: UnitNumber | undefined
 }
 
 /**
@@ -5827,13 +5836,13 @@ interface MarketEntity extends BaseEntity {
  */
 interface CraftingMachineEntity extends BaseEntity {
   /**
-   * Returns whether a craft is currently in process. It does not indicate whether progress is currently being made, but whether any crafting action has made progress in this machine.
+   * Returns whether a craft is currently in process. It does not indicate whether progress is currently being made, but whether a crafting process has been started in this machine.
    *
    * _Can only be used if this is CraftingMachine_
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_crafting View documentation}
    */
-  is_crafting(): void
+  is_crafting(): boolean
   /**
    * Current recipe being assembled by this machine or `nil` if no recipe is set.
    *
@@ -11950,7 +11959,7 @@ interface LuaGameScript {
    * @param player The player index or name.
    * @remarks This is a shortcut for game.players[...]
    */
-  get_player(player: uint | string): LuaPlayer | undefined
+  get_player(index: PlayerIndex | string): LuaPlayer | undefined
   /**
    * Gets the given surface or returns `nil` if no surface is found.
    *
@@ -11958,7 +11967,7 @@ interface LuaGameScript {
    * @param surface The surface index or name.
    * @remarks This is a shortcut for game.surfaces[...]
    */
-  get_surface(surface: uint | string): LuaSurface | undefined
+  get_surface(index: SurfaceIndex | string): LuaSurface | undefined
   /**
    * Creates a {@link LuaProfiler}, which is used for measuring script performance.
    *
@@ -12151,7 +12160,7 @@ interface LuaGameScript {
    *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.players View documentation}
    */
-  readonly players: LuaCustomTable<uint | string, LuaPlayer>
+  readonly players: LuaCustomTable<PlayerIndex | string, LuaPlayer>
   /**
    * The currently active set of map settings. Even though this property is marked as read-only, the members of the dictionary that is returned can be modified mid-game.
    *
@@ -12418,7 +12427,7 @@ interface LuaGameScript {
    *
    * {@link https://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.surfaces View documentation}
    */
-  readonly surfaces: LuaCustomTable<uint | string, LuaSurface>
+  readonly surfaces: LuaCustomTable<SurfaceIndex | string, LuaSurface>
   /**
    * The active mods versions. The keys are mod names, the values are the versions.
    *
@@ -12962,7 +12971,7 @@ interface CameraGuiSpec extends BaseGuiSpec {
   /**
    * The surface that the camera will render. Defaults to the player's current surface.
    */
-  readonly surface_index?: uint
+  readonly surface_index?: SurfaceIndex
   /**
    * The initial camera zoom. Defaults to `0.75`.
    */
@@ -13132,7 +13141,7 @@ interface MinimapGuiSpec extends BaseGuiSpec {
   /**
    * The surface the camera will render. Defaults to the player's current surface.
    */
-  readonly surface_index?: uint
+  readonly surface_index?: SurfaceIndex
   /**
    * The player index the map should use. Defaults to the current player.
    */
@@ -13214,7 +13223,7 @@ type GuiSpec =
   | TabbedPaneGuiSpec
   | LabelGuiSpec
 
-interface GuiElementIndex {
+interface GuiElementIndexer {
   /**
    * The indexing operator. Gets children by name.
    *
@@ -13246,25 +13255,27 @@ interface BaseGuiElement {
     }
   >
   /**
-     * Remove children of this element. Any {@link LuaGuiElement} objects referring to the destroyed elements become invalid after this operation.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.clear View documentation}
-     * @example
-    ```
-     * game.player.gui.top.clear()
-     * ```
-     */
+   * Remove children of this element. Any {@link LuaGuiElement} objects referring to the destroyed elements become invalid after this operation.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.clear View documentation}
+   * @example
+   *
+   * ```
+   * game.player.gui.top.clear()
+   * ```
+   */
   clear(): void
   /**
-     * Remove this element, along with its children. Any {@link LuaGuiElement} objects referring to the destroyed elements become invalid after this operation.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.destroy View documentation}
-     * @remarks The top-level GUI elements - {@link LuaGui#top LuaGui::top}, {@link LuaGui#left LuaGui::left}, {@link LuaGui#center LuaGui::center} and {@link LuaGui#screen LuaGui::screen} - can't be destroyed.
-     * @example
-    ```
-     * game.player.gui.top.greeting.destroy()
-     * ```
-     */
+   * Remove this element, along with its children. Any {@link LuaGuiElement} objects referring to the destroyed elements become invalid after this operation.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.destroy View documentation}
+   * @remarks The top-level GUI elements - {@link LuaGui#top LuaGui::top}, {@link LuaGui#left LuaGui::left}, {@link LuaGui#center LuaGui::center} and {@link LuaGui#screen LuaGui::screen} - can't be destroyed.
+   * @example
+   *
+   * ```
+   * game.player.gui.top.greeting.destroy()
+   * ```
+   */
   destroy(): void
   /**
    * The mod that owns this Gui element or `nil` if it's owned by the scenario script.
@@ -13306,7 +13317,7 @@ interface BaseGuiElement {
    *
    * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.index View documentation}
    */
-  readonly index: uint
+  readonly index: GuiElementIndex
   /**
    * The GUI this element is a child of.
    *
@@ -13320,14 +13331,15 @@ interface BaseGuiElement {
    */
   readonly parent: LuaGuiElement | undefined
   /**
-     * The name of this element.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.name View documentation}
-     * @example
-    ```
-     * game.player.gui.top.greeting.name == "greeting"
-     * ```
-     */
+   * The name of this element.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.name View documentation}
+   * @example
+   *
+   * ```
+   * game.player.gui.top.greeting.name == "greeting"
+   * ```
+   */
   name: string
   /**
    * The text displayed on this element. For frames, this is the "heading". For other elements, like buttons or labels, this is the content.
@@ -13360,7 +13372,7 @@ interface BaseGuiElement {
    *
    * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.player_index View documentation}
    */
-  readonly player_index: uint
+  readonly player_index: PlayerIndex
   tooltip: LocalisedString
   /**
    * The type of this GUI element.
@@ -13490,7 +13502,7 @@ interface ChooseElemButtonGuiElementMembers extends BaseGuiElement {
   locked: boolean
 }
 
-type ChooseElemButtonGuiElement = ChooseElemButtonGuiElementMembers & GuiElementIndex
+type ChooseElemButtonGuiElement = ChooseElemButtonGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13552,7 +13564,7 @@ interface DropDownGuiElementMembers extends BaseGuiElement {
   selected_index: uint
 }
 
-type DropDownGuiElement = DropDownGuiElementMembers & GuiElementIndex
+type DropDownGuiElement = DropDownGuiElementMembers & GuiElementIndexer
 
 interface EmptyWidgetGuiElementMembers extends BaseGuiElement {
   /**
@@ -13580,7 +13592,7 @@ interface EmptyWidgetGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type EmptyWidgetGuiElement = EmptyWidgetGuiElementMembers & GuiElementIndex
+type EmptyWidgetGuiElement = EmptyWidgetGuiElementMembers & GuiElementIndexer
 
 interface EntityPreviewGuiElementMembers extends BaseGuiElement {
   /**
@@ -13597,7 +13609,7 @@ interface EntityPreviewGuiElementMembers extends BaseGuiElement {
   entity: LuaEntity | undefined
 }
 
-type EntityPreviewGuiElement = EntityPreviewGuiElementMembers & GuiElementIndex
+type EntityPreviewGuiElement = EntityPreviewGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13669,7 +13681,7 @@ interface ListBoxGuiElementMembers extends BaseGuiElement {
   selected_index: uint
 }
 
-type ListBoxGuiElement = ListBoxGuiElementMembers & GuiElementIndex
+type ListBoxGuiElement = ListBoxGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13741,7 +13753,7 @@ interface ScrollPaneGuiElementMembers extends BaseGuiElement {
   vertical_scroll_policy: "auto" | "never" | "always" | "auto-and-reserve-space" | "dont-show-but-allow-scrolling"
 }
 
-type ScrollPaneGuiElement = ScrollPaneGuiElementMembers & GuiElementIndex
+type ScrollPaneGuiElement = ScrollPaneGuiElementMembers & GuiElementIndexer
 
 interface SpriteButtonGuiElementMembers extends BaseGuiElement {
   /**
@@ -13791,7 +13803,7 @@ interface SpriteButtonGuiElementMembers extends BaseGuiElement {
   set mouse_button_filter(value: MouseButtonFlags)
 }
 
-type SpriteButtonGuiElement = SpriteButtonGuiElementMembers & GuiElementIndex
+type SpriteButtonGuiElement = SpriteButtonGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13839,7 +13851,7 @@ interface TabbedPaneGuiElementMembers extends BaseGuiElement {
   readonly tabs: TabAndContent[]
 }
 
-type TabbedPaneGuiElement = TabbedPaneGuiElementMembers & GuiElementIndex
+type TabbedPaneGuiElement = TabbedPaneGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13953,7 +13965,7 @@ interface TextBoxGuiElementMembers extends BaseGuiElement {
   clear_and_focus_on_right_click: boolean
 }
 
-type TextBoxGuiElement = TextBoxGuiElementMembers & GuiElementIndex
+type TextBoxGuiElement = TextBoxGuiElementMembers & GuiElementIndexer
 
 interface ButtonGuiElementMembers extends BaseGuiElement {
   /**
@@ -13971,7 +13983,7 @@ interface ButtonGuiElementMembers extends BaseGuiElement {
   set mouse_button_filter(value: MouseButtonFlags)
 }
 
-type ButtonGuiElement = ButtonGuiElementMembers & GuiElementIndex
+type ButtonGuiElement = ButtonGuiElementMembers & GuiElementIndexer
 
 interface CameraGuiElementMembers extends BaseGuiElement {
   /**
@@ -13992,7 +14004,7 @@ interface CameraGuiElementMembers extends BaseGuiElement {
    *
    * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.surface_index View documentation}
    */
-  surface_index: uint
+  surface_index: SurfaceIndex
   /**
    * The zoom this camera or minimap is using.
    *
@@ -14007,7 +14019,7 @@ interface CameraGuiElementMembers extends BaseGuiElement {
   entity: LuaEntity | undefined
 }
 
-type CameraGuiElement = CameraGuiElementMembers & GuiElementIndex
+type CameraGuiElement = CameraGuiElementMembers & GuiElementIndexer
 
 interface CheckboxGuiElementMembers extends BaseGuiElement {
   /**
@@ -14026,7 +14038,7 @@ interface CheckboxGuiElementMembers extends BaseGuiElement {
   state: boolean
 }
 
-type CheckboxGuiElement = CheckboxGuiElementMembers & GuiElementIndex
+type CheckboxGuiElement = CheckboxGuiElementMembers & GuiElementIndexer
 
 interface FlowGuiElementMembers extends BaseGuiElement {
   /**
@@ -14062,7 +14074,7 @@ interface FlowGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type FlowGuiElement = FlowGuiElementMembers & GuiElementIndex
+type FlowGuiElement = FlowGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -14120,7 +14132,7 @@ interface FrameGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type FrameGuiElement = FrameGuiElementMembers & GuiElementIndex
+type FrameGuiElement = FrameGuiElementMembers & GuiElementIndexer
 
 interface LabelGuiElementMembers extends BaseGuiElement {
   /**
@@ -14148,7 +14160,7 @@ interface LabelGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type LabelGuiElement = LabelGuiElementMembers & GuiElementIndex
+type LabelGuiElement = LabelGuiElementMembers & GuiElementIndexer
 
 interface LineGuiElementMembers extends BaseGuiElement {
   /**
@@ -14167,7 +14179,7 @@ interface LineGuiElementMembers extends BaseGuiElement {
   readonly direction: "horizontal" | "vertical"
 }
 
-type LineGuiElement = LineGuiElementMembers & GuiElementIndex
+type LineGuiElement = LineGuiElementMembers & GuiElementIndexer
 
 interface MinimapGuiElementMembers extends BaseGuiElement {
   /**
@@ -14188,7 +14200,7 @@ interface MinimapGuiElementMembers extends BaseGuiElement {
    *
    * {@link https://lua-api.factorio.com/latest/LuaGuiElement.html#LuaGuiElement.surface_index View documentation}
    */
-  surface_index: uint
+  surface_index: SurfaceIndex
   /**
    * The zoom this camera or minimap is using.
    *
@@ -14217,7 +14229,7 @@ interface MinimapGuiElementMembers extends BaseGuiElement {
   entity: LuaEntity | undefined
 }
 
-type MinimapGuiElement = MinimapGuiElementMembers & GuiElementIndex
+type MinimapGuiElement = MinimapGuiElementMembers & GuiElementIndexer
 
 interface ProgressBarGuiElementMembers extends BaseGuiElement {
   /**
@@ -14236,7 +14248,7 @@ interface ProgressBarGuiElementMembers extends BaseGuiElement {
   value: double
 }
 
-type ProgressBarGuiElement = ProgressBarGuiElementMembers & GuiElementIndex
+type ProgressBarGuiElement = ProgressBarGuiElementMembers & GuiElementIndexer
 
 interface RadioButtonGuiElementMembers extends BaseGuiElement {
   /**
@@ -14255,7 +14267,7 @@ interface RadioButtonGuiElementMembers extends BaseGuiElement {
   state: boolean
 }
 
-type RadioButtonGuiElement = RadioButtonGuiElementMembers & GuiElementIndex
+type RadioButtonGuiElement = RadioButtonGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -14333,7 +14345,7 @@ interface SliderGuiElementMembers extends BaseGuiElement {
   slider_value: double
 }
 
-type SliderGuiElement = SliderGuiElementMembers & GuiElementIndex
+type SliderGuiElement = SliderGuiElementMembers & GuiElementIndexer
 
 interface SpriteGuiElementMembers extends BaseGuiElement {
   /**
@@ -14356,7 +14368,7 @@ interface SpriteGuiElementMembers extends BaseGuiElement {
   resize_to_sprite: boolean
 }
 
-type SpriteGuiElement = SpriteGuiElementMembers & GuiElementIndex
+type SpriteGuiElement = SpriteGuiElementMembers & GuiElementIndexer
 
 interface SwitchGuiElementMembers extends BaseGuiElement {
   /**
@@ -14417,7 +14429,7 @@ interface SwitchGuiElementMembers extends BaseGuiElement {
   right_label_tooltip: LocalisedString
 }
 
-type SwitchGuiElement = SwitchGuiElementMembers & GuiElementIndex
+type SwitchGuiElement = SwitchGuiElementMembers & GuiElementIndexer
 
 interface TabGuiElementMembers extends BaseGuiElement {
   /**
@@ -14436,7 +14448,7 @@ interface TabGuiElementMembers extends BaseGuiElement {
   badge_text: LocalisedString
 }
 
-type TabGuiElement = TabGuiElementMembers & GuiElementIndex
+type TabGuiElement = TabGuiElementMembers & GuiElementIndexer
 
 interface TableGuiElementMembers extends BaseGuiElement {
   /**
@@ -14504,7 +14516,7 @@ interface TableGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type TableGuiElement = TableGuiElementMembers & GuiElementIndex
+type TableGuiElement = TableGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -14602,7 +14614,7 @@ interface TextFieldGuiElementMembers extends BaseGuiElement {
   clear_and_focus_on_right_click: boolean
 }
 
-type TextFieldGuiElement = TextFieldGuiElementMembers & GuiElementIndex
+type TextFieldGuiElement = TextFieldGuiElementMembers & GuiElementIndexer
 
 type GuiElementMembers =
   | ChooseElemButtonGuiElementMembers
@@ -14684,7 +14696,7 @@ type GuiElementMembers =
  * tabbed_pane.add_tab(tab2, label2)
  * ```
  */
-type LuaGuiElement = GuiElementMembers & GuiElementIndex
+type LuaGuiElement = GuiElementMembers & GuiElementIndexer
 
 /**
  * Prototype of a heat energy source.
@@ -15017,7 +15029,8 @@ interface LuaInventory extends ReadonlyArray<LuaItemStack> {
  * {@link https://lua-api.factorio.com/latest/LuaItemPrototype.html View documentation}
  * @noSelf
  * @example
-```
+ *
+ * ```
  * game.item_prototypes["iron-plate"]
  * ```
  */
@@ -19301,7 +19314,7 @@ interface LuaPlayer extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.index View documentation}
    */
-  readonly index: uint
+  readonly index: PlayerIndex
   readonly gui: LuaGui
   /**
    * `true` if the player opened itself. I.e. if they opened the character or god-controller GUI.
@@ -21896,14 +21909,15 @@ interface LuaStyle {
   get color(): ColorTable
   set color(value: Color)
   /**
-     * Array containing the alignment for every column of this table element. Even though this property is marked as read-only, the alignment can be changed by indexing the LuaCustomTable, like so:
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.column_alignments View documentation}
-     * @example
-    ```
-     * table_element.style.column_alignments[1] = "center"
-     * ```
-     */
+   * Array containing the alignment for every column of this table element. Even though this property is marked as read-only, the alignment can be changed by indexing the LuaCustomTable, like so:
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.column_alignments View documentation}
+   * @example
+   *
+   * ```
+   * table_element.style.column_alignments[1] = "center"
+   * ```
+   */
   readonly column_alignments: LuaCustomTable<uint, Alignment>
   /**
    * _Can only be used if this is LabelStyle_
@@ -22162,14 +22176,15 @@ interface BaseStyle {
    */
   vertically_squashable: boolean
   /**
-     * Array containing the alignment for every column of this table element. Even though this property is marked as read-only, the alignment can be changed by indexing the LuaCustomTable, like so:
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.column_alignments View documentation}
-     * @example
-    ```
-     * table_element.style.column_alignments[1] = "center"
-     * ```
-     */
+   * Array containing the alignment for every column of this table element. Even though this property is marked as read-only, the alignment can be changed by indexing the LuaCustomTable, like so:
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaStyle.html#LuaStyle.column_alignments View documentation}
+   * @example
+   *
+   * ```
+   * table_element.style.column_alignments[1] = "center"
+   * ```
+   */
   readonly column_alignments: LuaCustomTable<uint, Alignment>
   /**
    * Sets both minimal and maximal width to the given value.
@@ -22794,7 +22809,7 @@ interface ProgrammableSpeakerSurfaceCreateEntity extends BaseSurfaceCreateEntity
 
 interface CharacterCorpseSurfaceCreateEntity extends BaseSurfaceCreateEntity {
   readonly inventory_size?: uint
-  readonly player_index?: uint
+  readonly player_index?: PlayerIndex
 }
 
 interface HighlightBoxSurfaceCreateEntity extends BaseSurfaceCreateEntity {
@@ -22867,15 +22882,16 @@ type SurfaceCreateEntity =
  */
 interface LuaSurface {
   /**
-     * Get the pollution for a given position.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_pollution View documentation}
-     * @remarks Pollution is stored per chunk, so this will return the same value for all positions in one chunk.
-     * @example
-    ```
-     * game.surfaces[1].get_pollution({1,2})
-     * ```
-     */
+   * Get the pollution for a given position.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_pollution View documentation}
+   * @remarks Pollution is stored per chunk, so this will return the same value for all positions in one chunk.
+   * @example
+   *
+   * ```
+   * game.surfaces[1].get_pollution({1,2})
+   * ```
+   */
   get_pollution(position: MapPosition): double
   /**
    * Check for collisions with terrain or other entities.
@@ -22936,17 +22952,18 @@ interface LuaSurface {
     readonly force?: ForceIdentification
   }): boolean
   /**
-     * Find a specific entity at a specific position.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entity View documentation}
-     * @param entity Entity to look for.
-     * @param position Coordinates to look at.
-     * @returns `nil` if no such entity is found.
-     * @example
-    ```
-     * game.player.selected.surface.find_entity('filter-inserter', {0,0})
-     * ```
-     */
+   * Find a specific entity at a specific position.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entity View documentation}
+   * @param entity Entity to look for.
+   * @param position Coordinates to look at.
+   * @returns `nil` if no such entity is found.
+   * @example
+   *
+   * ```
+   * game.player.selected.surface.find_entity('filter-inserter', {0,0})
+   * ```
+   */
   find_entity(entity: string, position: MapPosition): LuaEntity | undefined
   /**
    * Find entities in a given area.
@@ -22962,23 +22979,24 @@ interface LuaSurface {
    */
   find_entities(area?: BoundingBox): LuaEntity[]
   /**
-     * Find all entities of the given type or name in the given area.
-     *
-     * 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.
-     *
-     * If no `area` or `position` are given, the entire surface is searched. If `position` is given, this returns the entities colliding with that position (i.e the given position is within the entity's collision box). If `position` and `radius` are given, this returns the entities within the radius of the position. If `area` is specified, this returns the entities colliding with that area.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entities_filtered View documentation}
-     * @example
-    ```
-     * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, type = "resource"} -- gets all resources in the rectangle
-     * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, name = "iron-ore"} -- gets all iron ores in the rectangle
-     * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, name = {"iron-ore", "copper-ore"}} -- gets all iron ore and copper ore in the rectangle
-     * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, force = "player"}  -- gets player owned entities in the rectangle
-     * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, limit = 5}  -- gets the first 5 entities in the rectangle
-     * game.surfaces[1].find_entities_filtered{position = {0, 0}, radius = 10}  -- gets all entities within 10 tiles of the position [0,0].
-     * ```
-     */
+   * Find all entities of the given type or name in the given area.
+   *
+   * 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.
+   *
+   * If no `area` or `position` are given, the entire surface is searched. If `position` is given, this returns the entities colliding with that position (i.e the given position is within the entity's collision box). If `position` and `radius` are given, this returns the entities within the radius of the position. If `area` is specified, this returns the entities colliding with that area.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_entities_filtered View documentation}
+   * @example
+   *
+   * ```
+   * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, type = "resource"} -- gets all resources in the rectangle
+   * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, name = "iron-ore"} -- gets all iron ores in the rectangle
+   * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, name = {"iron-ore", "copper-ore"}} -- gets all iron ore and copper ore in the rectangle
+   * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, force = "player"}  -- gets player owned entities in the rectangle
+   * game.surfaces[1].find_entities_filtered{area = {{-10, -10}, {10, 10}}, limit = 5}  -- gets the first 5 entities in the rectangle
+   * game.surfaces[1].find_entities_filtered{position = {0, 0}, radius = 10}  -- gets all entities within 10 tiles of the position [0,0].
+   * ```
+   */
   find_entities_filtered(params: {
     readonly area?: BoundingBox
     /**
@@ -23241,50 +23259,52 @@ interface LuaSurface {
     readonly unit_search_distance?: uint
   }): uint
   /**
-     * Create an entity on this surface.
-     *
-     * Other attributes may be specified depending on the type of entity:
-     *
-     * **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
-    ```
-     * asm = game.surfaces[1].create_entity{name = "assembling-machine-1", position = {15, 3}, force = game.forces.player, recipe = "iron-stick"}
-     * ```
-     * @example Creates a filter inserter with circuit conditions and a filter
-     *
-     * ```
-     * game.surfaces[1].create_entity{
-     *   name = "filter-inserter", position = {20, 15}, force = game.player.force,
-     *   conditions = {red = {name = "wood", count = 3, operator = ">"},
-     *               green = {name = "iron-ore", count = 1, operator = "<"},
-     *   logistics = {name = "wood", count = 3, operator = "="}},
-     *   filters = {{index = 1, name = "iron-ore"}}
-     * }
-     * ```
-     * @example Creates a requester chest already set to request 128 iron plates.
-     *
-     * ```
-     * game.surfaces[1].create_entity{
-     *   name = "logistic-chest-requester", position = {game.player.position.x+3, game.player.position.y},
-     *   force = game.player.force, request_filters = {{index = 1, name = "iron-plate", count = 128}}
-     * }
-     * ```
-     * @example
-    ```
-     * game.surfaces[1].create_entity{name = "big-biter", position = {15, 3}, force = game.forces.player} -- Friendly biter
-     * game.surfaces[1].create_entity{name = "medium-biter", position = {15, 3}, force = game.forces.enemy} -- Enemy biter
-     * ```
-     * @example Creates a basic inserter at the player's location facing north
-     *
-     * ```
-     * game.surfaces[1].create_entity{name = "inserter", position = game.player.position, direction = defines.direction.north}
-     * ```
-     */
+   * Create an entity on this surface.
+   *
+   * Other attributes may be specified depending on the type of entity:
+   *
+   * **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
+   *
+   * ```
+   * asm = game.surfaces[1].create_entity{name = "assembling-machine-1", position = {15, 3}, force = game.forces.player, recipe = "iron-stick"}
+   * ```
+   * @example Creates a filter inserter with circuit conditions and a filter
+   *
+   * ```
+   * game.surfaces[1].create_entity{
+   *   name = "filter-inserter", position = {20, 15}, force = game.player.force,
+   *   conditions = {red = {name = "wood", count = 3, operator = ">"},
+   *               green = {name = "iron-ore", count = 1, operator = "<"},
+   *   logistics = {name = "wood", count = 3, operator = "="}},
+   *   filters = {{index = 1, name = "iron-ore"}}
+   * }
+   * ```
+   * @example Creates a requester chest already set to request 128 iron plates.
+   *
+   * ```
+   * game.surfaces[1].create_entity{
+   *   name = "logistic-chest-requester", position = {game.player.position.x+3, game.player.position.y},
+   *   force = game.player.force, request_filters = {{index = 1, name = "iron-plate", count = 128}}
+   * }
+   * ```
+   * @example
+   *
+   * ```
+   * game.surfaces[1].create_entity{name = "big-biter", position = {15, 3}, force = game.forces.player} -- Friendly biter
+   * game.surfaces[1].create_entity{name = "medium-biter", position = {15, 3}, force = game.forces.enemy} -- Enemy biter
+   * ```
+   * @example Creates a basic inserter at the player's location facing north
+   *
+   * ```
+   * game.surfaces[1].create_entity{name = "inserter", position = game.player.position, direction = defines.direction.north}
+   * ```
+   */
   create_entity(params: SurfaceCreateEntity): LuaEntity | undefined
   create_trivial_smoke(params: {
     /**
@@ -23646,17 +23666,18 @@ interface LuaSurface {
     readonly decoratives: readonly Decorative[]
   }): void
   /**
-     * Find decoratives of a given name in a given area.
-     *
-     * If no filters are given, returns all decoratives in the search area. If multiple filters are specified, returns only decoratives matching every given filter. If no area and no position are given, the entire surface is searched.
-     *
-     * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_decoratives_filtered View documentation}
-     * @example
-    ```
-     * game.surfaces[1].find_decoratives_filtered{area = {{-10, -10}, {10, 10}}, name = "sand-decal"} -- gets all sand-decals in the rectangle
-     * game.surfaces[1].find_decoratives_filtered{area = {{-10, -10}, {10, 10}}, limit = 5}  -- gets the first 5 decoratives in the rectangle
-     * ```
-     */
+   * Find decoratives of a given name in a given area.
+   *
+   * If no filters are given, returns all decoratives in the search area. If multiple filters are specified, returns only decoratives matching every given filter. If no area and no position are given, the entire surface is searched.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_decoratives_filtered View documentation}
+   * @example
+   *
+   * ```
+   * game.surfaces[1].find_decoratives_filtered{area = {{-10, -10}, {10, 10}}, name = "sand-decal"} -- gets all sand-decals in the rectangle
+   * game.surfaces[1].find_decoratives_filtered{area = {{-10, -10}, {10, 10}}, limit = 5}  -- gets the first 5 decoratives in the rectangle
+   * ```
+   */
   find_decoratives_filtered(params: {
     readonly area?: BoundingBox
     readonly position?: TilePosition
@@ -23839,7 +23860,7 @@ interface LuaSurface {
    */
   clear(ignore_characters?: boolean): void
   /**
-   * Generates a path with the specified constraints (as an array of {@link PathfinderWaypoint PathfinderWaypoints}) using the unit pathfinding algorithm. This path can be used to emulate pathing behavior by script for non-unit entities. If you want to command actual units to move, use the {@link LuaEntity#set_command LuaEntity::set_command} functionality instead.
+   * Generates a path with the specified constraints (as an array of {@link PathfinderWaypoint PathfinderWaypoints}) using the unit pathfinding algorithm. This path can be used to emulate pathing behavior by script for non-unit entities, such as vehicles. If you want to command actual units (such as biters or spitters) to move, use {@link LuaEntity#set_command LuaEntity::set_command} instead.
    *
    * The resulting path is ultimately returned asynchronously via {@link OnScriptPathRequestFinishedEvent on_script_path_request_finished}.
    *
@@ -24055,7 +24076,7 @@ interface LuaSurface {
    *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.index View documentation}
    */
-  readonly index: uint
+  readonly index: SurfaceIndex
   /**
    * The generation settings for this surface. These can be modified to after surface generation, but note that this will not retroactively update the surface. To manually adjust it, {@link LuaSurface#regenerate_entity LuaSurface::regenerate_entity}, {@link LuaSurface#regenerate_decorative LuaSurface::regenerate_decorative} and {@link LuaSurface#delete_chunk LuaSurface::delete_chunk} can be used.
    *