typed-factorio 0.19.1 → 0.20.0-beta.1

package/Changelog.md

@@ -1,3 +1,9 @@
+# v0.20.0
+
+- Updated to factorio version 1.1.56
+- Added custom-index-template.d.ts. You can use this if you would like to make a "custom" modification of the type definitions.
+- **This is an opt-in**: Some numeric types which represent indices/number,e.g. player_index, entity_number, are now branded numbers with their own type, e.g. `PlayerIndex` and `EntityNumber`. See the README for more info.
+
 # v0.19.0
 
 - Updated to factorio version 1.1.53
@@ -33,8 +39,8 @@
 # v0.15.0
 
 - Table or array concepts are now declared in table form wherever it is an "read" position.
-    - This works with setter overloading for applicable properties: `player.color.x; player.color = [1, 1, 1]` is now valid!
-    - This also applies to concepts/complex types which contain table_or_array properties.
+  - This works with setter overloading for applicable properties: `player.color.x; player.color = [1, 1, 1]` is now valid!
+  - This also applies to concepts/complex types which contain table_or_array properties.
 - Some concepts now also have a special form where it is known to be in a "read" position, where all table_or_array concepts are declared in table form. These concepts are suffixed with "Read", e.g. `ScriptAreaRead`.
 - Arrays which are known to be in a "write" only form (e.g. method parameters) now are marked readonly. This means you can now pass readonly arrays to these methods.
 - `MapPosition` is now a table or array concept.
@@ -50,17 +56,17 @@
 - LuaStyle size, margin/padding setters now have more specific array types. These array types are `SizeArray` and `StyleValuesArray` for size and margin/padding, respectively.
 - `@noSelf` annotation is now only present when necessary.
 - For classes with subclasses:
-    - The original class name (e.g. `LuaItemStack`) still contains attributes of all subclasses (same as before).
-    - There is now a `Base` type (e.g. `BaseItemStack`) which only includes attributes common to all subclasses.
-    - There is a separate type definition for each subclass, e.g. `BlueprintItem`. Note that one instance may still belong to multiple subclasses (the subclasses are not mutually exclusive).
-    - The above two can be optionally used for stricter types.
+  - The original class name (e.g. `LuaItemStack`) still contains attributes of all subclasses (same as before).
+  - There is now a `Base` type (e.g. `BaseItemStack`) which only includes attributes common to all subclasses.
+  - There is a separate type definition for each subclass, e.g. `BlueprintItem`. Note that one instance may still belong to multiple subclasses (the subclasses are not mutually exclusive).
+  - The above two can be optionally used for stricter types.
 
 # v0.13.2
 
 - Fix: resize_to_sprite property should not be on subclass sprite-button
 - Fix: ChooseElemButtonSpec filters should be named elem_filters
 - Switch back to `/latest` api docs link
-    - New version of web api docs is now active
+  - New version of web api docs is now active
 
 # v0.13.0
 
@@ -96,7 +102,7 @@
 # v0.7.3
 
 - Update to factorio version 1.1.42
-    - No api changes, but improvements to descriptions
+  - No api changes, but improvements to descriptions
 
 # v0.7.2
 

package/README.md

@@ -2,7 +2,7 @@
 
 Complete and featureful typescript definitions for the Factorio modding lua api. This is intended to be used with [TypescriptToLua](https://typescripttolua.github.io/).
 
-This project aims to provide type definitions for the Factorio lua API that are as complete as possible. This means no `any`s or `unknown`s, correct nullability, and smart types where possible. The generator integrates both the Factorio JSON api docs and manually defined additions and overrides.
+This project aims to provide type definitions for the Factorio lua API that are as complete as possible. This means no `any`s or `unknown`s, correct nullability, and lots of smart type features. The generator integrates both the Factorio JSON api docs and manually defined additions and overrides.
 
 ## Installation
 
@@ -30,7 +30,10 @@ yarn add typed-factorio
 
 This will add the types for the runtime stage to your entire project.
 
-Note: When types are updated, or released for a new factorio version, you will need update your package version to get the types.
+Notes:
+> When types are updated, or released for a new factorio version, you will need update your package version to get the types.
+> 
+> There is an opt-in feature for stricter index types, see [Strict index types](#Strict index types) for more details.
 
 ### Settings and data stage
 
@@ -42,7 +45,7 @@ Example:
 
 ```ts
 import { Data, Mods } from "typed-factorio/data/types"
-// or 
+// or
 import { Data, Mods } from "typed-factorio/settings/types"
 
 declare const data: Data
@@ -93,15 +96,6 @@ Variant parameter types (types with "additional fields can be specified dependin
 
 The type for a specific variant is prefixed with the variant name, or with "Other" for variants without additional fields (e.g. `AmmoDamageTechnologyModifier`, `OtherTechnologyModifier`).
 
-### Types with subclasses
-
-Some classes have attributes that are documented to only work on particular subclasses. For these classes, e.g. `LuaEntity`, there are also these other types that you can _optionally_ use:
-
-- a "Base" type, e.g. `BaseEntity`, which only contains members usable by all subclasses
-- individual subclass types, e.g. `CraftingMachineEntity`, which extends the base type with members specific to that subclass
-
-The simple class name, `LuaEntity` in this example, still contains attributes for _all_ subclasses.
-
 ### Events
 
 `script.on_event()`, `script.get/set_filters()`, and `script.raise_event()` all have type checking on the event data/filter type, inferred from what is passed as the event name/id.
@@ -120,14 +114,31 @@ Table-or-array types will appear in the Table form when known to be in a read po
 
 For some concepts, there is also a special form for when the concept is used in a "read" position, where all table-or-array types are in Table form. These types are suffixed with `Read`, e.g. `ScriptPositionRead`.
 
+
+### Types with subclasses
+
+Some classes have attributes that are documented to only work on particular subclasses. For these classes, e.g. `LuaEntity`, there are specific types that you can _optionally_ use:
+
+- a "Base" type, e.g. `BaseEntity`, which only contains members usable by all subclasses
+- individual subclass types, e.g. `CraftingMachineEntity`, which extends the base type with members specific to that subclass
+
+The simple class name, `LuaEntity` in this example, contains attributes for _all_ subclasses.
+
 ### LuaGuiElement
 
 `LuaGuiElement` is broken up into a [discriminated union](https://basarat.gitbook.io/typescript/type-system/discriminated-unions), with a separate type for each gui element type. Individual gui element types can be referred to by `<Type>GuiElement`, e.g. `ButtonGuiElement`.
 
-Similarly, the table passed to `LuaGuiElement.add`, referred to as `GuiSpec`, is also broken up into a discriminated union for each gui element type. The type for a specific GuiSpec type is `<Type>GuiSpec`, e.g. `ListBoxGuiSpec`. `LuaGuiElement.add` will return the appropriate gui element type corresponding to the gui spec type received.
+Similarly, the table passed to `LuaGuiElement.add`, referred to as `GuiSpec`, is also broken up into a discriminated union. The type for a specific GuiSpec is `<Type>GuiSpec`, e.g. `ListBoxGuiSpec`. `LuaGuiElement.add` will return the appropriate gui element type corresponding to the gui spec type received.
 
 This is done both to provide more accurate types, and for possible integration with [JSX](https://typescripttolua.github.io/docs/jsx/).
 
-### Examples
+### Strict index types
+
+This feature is recommended, but currently is a **opt-in**. To opt in, use `typed-factorio/runtime/strict-index-types` instead of `typed-factorio/runtime` in your `tsconfig.json`.
+
+Some `uint` types which represent indices, e.g. player_index, entity_number, are now "branded" numbers with their own type, e.g. `PlayerIndex` and `EntityNumber`. These are assignable to `number`, but `number` is not assignable to them.
+These are indices that do not index into an array-like structure, and otherwise should usually not have arithmetic done to them. So, using a separate type helps ensure correctness.
+You can still use these types as keys in an index signature, e.g. `{ [index: PlayerIndex]: "foo" }`.
+You can cast "plain" numbers to these types, e.g. `2 as PlayerIndex`, only do this with some care.
 
-Check out the `test` directory on GitHub for more examples on particular type features.
+- `player_index` and `surface_index` still allow the numeric constant 1 as a valid index, representing the first player or the default surface, respectively. This is allowed as this is a common enough use case.

package/custom-index-template.d.ts

@@ -0,0 +1,24 @@
+// This references the same files as "typed-factorio/runtime".
+// For example, if you want to modify a file, copy the file you want to modify to your project and make the changes. Then, copy this template file into your project and remove the line corresponding to modified file.
+// If you think your modification will be useful to others, please consider making a change suggestion by creating an issue on GitHub.
+
+// Replace "index-types.d.ts" with "index-types-strict.d.ts" below if you want strict index types.
+
+/// <reference types="lua-types/5.2" />
+
+// generated
+/// <reference types="typed-factorio/generated/builtin-types.d.ts" />
+/// <reference types="typed-factorio/generated/global-objects.d.ts" />
+/// <reference types="typed-factorio/generated/defines.d.ts" />
+/// <reference types="typed-factorio/generated/events.d.ts" />
+/// <reference types="typed-factorio/generated/classes.d.ts" />
+/// <reference types="typed-factorio/generated/concepts.d.ts" />
+/// <reference types="typed-factorio/generated/index-types.d.ts" />
+
+// other runtime
+/// <reference types="typed-factorio/runtime/librariesAndFunctions.d.ts" />
+/// <reference types="typed-factorio/runtime/pairs.d.ts" />
+
+// lualib
+/// <reference types="typed-factorio/runtime/util.d.ts" />
+/// <reference types="typed-factorio/runtime/mod-gui.d.ts" />

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.
      */
@@ -1171,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.
    *
@@ -1938,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.
  *
@@ -1999,7 +1999,7 @@ interface LuaCustomTableMembers {
  * ```
  */
 type LuaCustomTable<K extends string | number, V> = LuaCustomTableMembers &
-  CustomTableIndex<K, V> &
+  CustomTableIndexer<K, V> &
   LuaPairsIterable<[number] extends [K] ? number : K, V>
 
 /**
@@ -2467,13 +2467,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_
    *
@@ -3793,7 +3793,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`.
    *
@@ -3801,7 +3801,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]
    *
@@ -5355,7 +5355,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]
    *
@@ -5772,7 +5772,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
 }
 
 /**
@@ -5831,13 +5831,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.
    *
@@ -11954,7 +11954,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.
    *
@@ -11962,7 +11962,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.
    *
@@ -12155,7 +12155,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.
    *
@@ -12422,7 +12422,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.
    *
@@ -12966,7 +12966,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`.
    */
@@ -13136,7 +13136,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.
    */
@@ -13218,7 +13218,7 @@ type GuiSpec =
   | TabbedPaneGuiSpec
   | LabelGuiSpec
 
-interface GuiElementIndex {
+interface GuiElementIndexer {
   /**
    * The indexing operator. Gets children by name.
    *
@@ -13312,7 +13312,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.
    *
@@ -13367,7 +13367,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.
@@ -13497,7 +13497,7 @@ interface ChooseElemButtonGuiElementMembers extends BaseGuiElement {
   locked: boolean
 }
 
-type ChooseElemButtonGuiElement = ChooseElemButtonGuiElementMembers & GuiElementIndex
+type ChooseElemButtonGuiElement = ChooseElemButtonGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13559,7 +13559,7 @@ interface DropDownGuiElementMembers extends BaseGuiElement {
   selected_index: uint
 }
 
-type DropDownGuiElement = DropDownGuiElementMembers & GuiElementIndex
+type DropDownGuiElement = DropDownGuiElementMembers & GuiElementIndexer
 
 interface EmptyWidgetGuiElementMembers extends BaseGuiElement {
   /**
@@ -13587,7 +13587,7 @@ interface EmptyWidgetGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type EmptyWidgetGuiElement = EmptyWidgetGuiElementMembers & GuiElementIndex
+type EmptyWidgetGuiElement = EmptyWidgetGuiElementMembers & GuiElementIndexer
 
 interface EntityPreviewGuiElementMembers extends BaseGuiElement {
   /**
@@ -13604,7 +13604,7 @@ interface EntityPreviewGuiElementMembers extends BaseGuiElement {
   entity: LuaEntity | undefined
 }
 
-type EntityPreviewGuiElement = EntityPreviewGuiElementMembers & GuiElementIndex
+type EntityPreviewGuiElement = EntityPreviewGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13676,7 +13676,7 @@ interface ListBoxGuiElementMembers extends BaseGuiElement {
   selected_index: uint
 }
 
-type ListBoxGuiElement = ListBoxGuiElementMembers & GuiElementIndex
+type ListBoxGuiElement = ListBoxGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13748,7 +13748,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 {
   /**
@@ -13798,7 +13798,7 @@ interface SpriteButtonGuiElementMembers extends BaseGuiElement {
   set mouse_button_filter(value: MouseButtonFlags)
 }
 
-type SpriteButtonGuiElement = SpriteButtonGuiElementMembers & GuiElementIndex
+type SpriteButtonGuiElement = SpriteButtonGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13846,7 +13846,7 @@ interface TabbedPaneGuiElementMembers extends BaseGuiElement {
   readonly tabs: TabAndContent[]
 }
 
-type TabbedPaneGuiElement = TabbedPaneGuiElementMembers & GuiElementIndex
+type TabbedPaneGuiElement = TabbedPaneGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -13960,7 +13960,7 @@ interface TextBoxGuiElementMembers extends BaseGuiElement {
   clear_and_focus_on_right_click: boolean
 }
 
-type TextBoxGuiElement = TextBoxGuiElementMembers & GuiElementIndex
+type TextBoxGuiElement = TextBoxGuiElementMembers & GuiElementIndexer
 
 interface ButtonGuiElementMembers extends BaseGuiElement {
   /**
@@ -13978,7 +13978,7 @@ interface ButtonGuiElementMembers extends BaseGuiElement {
   set mouse_button_filter(value: MouseButtonFlags)
 }
 
-type ButtonGuiElement = ButtonGuiElementMembers & GuiElementIndex
+type ButtonGuiElement = ButtonGuiElementMembers & GuiElementIndexer
 
 interface CameraGuiElementMembers extends BaseGuiElement {
   /**
@@ -13999,7 +13999,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.
    *
@@ -14014,7 +14014,7 @@ interface CameraGuiElementMembers extends BaseGuiElement {
   entity: LuaEntity | undefined
 }
 
-type CameraGuiElement = CameraGuiElementMembers & GuiElementIndex
+type CameraGuiElement = CameraGuiElementMembers & GuiElementIndexer
 
 interface CheckboxGuiElementMembers extends BaseGuiElement {
   /**
@@ -14033,7 +14033,7 @@ interface CheckboxGuiElementMembers extends BaseGuiElement {
   state: boolean
 }
 
-type CheckboxGuiElement = CheckboxGuiElementMembers & GuiElementIndex
+type CheckboxGuiElement = CheckboxGuiElementMembers & GuiElementIndexer
 
 interface FlowGuiElementMembers extends BaseGuiElement {
   /**
@@ -14069,7 +14069,7 @@ interface FlowGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type FlowGuiElement = FlowGuiElementMembers & GuiElementIndex
+type FlowGuiElement = FlowGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -14127,7 +14127,7 @@ interface FrameGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type FrameGuiElement = FrameGuiElementMembers & GuiElementIndex
+type FrameGuiElement = FrameGuiElementMembers & GuiElementIndexer
 
 interface LabelGuiElementMembers extends BaseGuiElement {
   /**
@@ -14155,7 +14155,7 @@ interface LabelGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type LabelGuiElement = LabelGuiElementMembers & GuiElementIndex
+type LabelGuiElement = LabelGuiElementMembers & GuiElementIndexer
 
 interface LineGuiElementMembers extends BaseGuiElement {
   /**
@@ -14174,7 +14174,7 @@ interface LineGuiElementMembers extends BaseGuiElement {
   readonly direction: "horizontal" | "vertical"
 }
 
-type LineGuiElement = LineGuiElementMembers & GuiElementIndex
+type LineGuiElement = LineGuiElementMembers & GuiElementIndexer
 
 interface MinimapGuiElementMembers extends BaseGuiElement {
   /**
@@ -14195,7 +14195,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.
    *
@@ -14224,7 +14224,7 @@ interface MinimapGuiElementMembers extends BaseGuiElement {
   entity: LuaEntity | undefined
 }
 
-type MinimapGuiElement = MinimapGuiElementMembers & GuiElementIndex
+type MinimapGuiElement = MinimapGuiElementMembers & GuiElementIndexer
 
 interface ProgressBarGuiElementMembers extends BaseGuiElement {
   /**
@@ -14243,7 +14243,7 @@ interface ProgressBarGuiElementMembers extends BaseGuiElement {
   value: double
 }
 
-type ProgressBarGuiElement = ProgressBarGuiElementMembers & GuiElementIndex
+type ProgressBarGuiElement = ProgressBarGuiElementMembers & GuiElementIndexer
 
 interface RadioButtonGuiElementMembers extends BaseGuiElement {
   /**
@@ -14262,7 +14262,7 @@ interface RadioButtonGuiElementMembers extends BaseGuiElement {
   state: boolean
 }
 
-type RadioButtonGuiElement = RadioButtonGuiElementMembers & GuiElementIndex
+type RadioButtonGuiElement = RadioButtonGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -14340,7 +14340,7 @@ interface SliderGuiElementMembers extends BaseGuiElement {
   slider_value: double
 }
 
-type SliderGuiElement = SliderGuiElementMembers & GuiElementIndex
+type SliderGuiElement = SliderGuiElementMembers & GuiElementIndexer
 
 interface SpriteGuiElementMembers extends BaseGuiElement {
   /**
@@ -14363,7 +14363,7 @@ interface SpriteGuiElementMembers extends BaseGuiElement {
   resize_to_sprite: boolean
 }
 
-type SpriteGuiElement = SpriteGuiElementMembers & GuiElementIndex
+type SpriteGuiElement = SpriteGuiElementMembers & GuiElementIndexer
 
 interface SwitchGuiElementMembers extends BaseGuiElement {
   /**
@@ -14424,7 +14424,7 @@ interface SwitchGuiElementMembers extends BaseGuiElement {
   right_label_tooltip: LocalisedString
 }
 
-type SwitchGuiElement = SwitchGuiElementMembers & GuiElementIndex
+type SwitchGuiElement = SwitchGuiElementMembers & GuiElementIndexer
 
 interface TabGuiElementMembers extends BaseGuiElement {
   /**
@@ -14443,7 +14443,7 @@ interface TabGuiElementMembers extends BaseGuiElement {
   badge_text: LocalisedString
 }
 
-type TabGuiElement = TabGuiElementMembers & GuiElementIndex
+type TabGuiElement = TabGuiElementMembers & GuiElementIndexer
 
 interface TableGuiElementMembers extends BaseGuiElement {
   /**
@@ -14511,7 +14511,7 @@ interface TableGuiElementMembers extends BaseGuiElement {
   drag_target: LuaGuiElement | undefined
 }
 
-type TableGuiElement = TableGuiElementMembers & GuiElementIndex
+type TableGuiElement = TableGuiElementMembers & GuiElementIndexer
 
 /**
  * @noSelf
@@ -14609,7 +14609,7 @@ interface TextFieldGuiElementMembers extends BaseGuiElement {
   clear_and_focus_on_right_click: boolean
 }
 
-type TextFieldGuiElement = TextFieldGuiElementMembers & GuiElementIndex
+type TextFieldGuiElement = TextFieldGuiElementMembers & GuiElementIndexer
 
 type GuiElementMembers =
   | ChooseElemButtonGuiElementMembers
@@ -14691,7 +14691,7 @@ type GuiElementMembers =
  * tabbed_pane.add_tab(tab2, label2)
  * ```
  */
-type LuaGuiElement = GuiElementMembers & GuiElementIndex
+type LuaGuiElement = GuiElementMembers & GuiElementIndexer
 
 /**
  * Prototype of a heat energy source.
@@ -19309,7 +19309,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.
@@ -22804,7 +22804,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 {
@@ -23855,7 +23855,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}.
    *
@@ -24071,7 +24071,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.
    *