typed-factorio 0.8.1 → 0.11.0-packagetypes-1

package/Changelog.md

@@ -1,6 +1,21 @@
+# v0.11.0
+
+- Update to factorio version 1.1.46
+
+# v0.10.0
+
+- LuaGuiElement.style and LuaControl.opened now have different get/set types (more specific get type).
+- The array form of LocalizedString is now readonly.
+
+# v0.9.0
+
+- Update to factorio version 1.1.43
+- The `defines.events `_type_ was renamed to `defines.Events`, to reduce confusion between the namespace/type
+
 # v0.8.0
+
 - All event types now explicitly extend `EventData`
-- Variant parameter groups without additional fields now have their own type, instead of all being grouped into `Other<Type>`
+- Variant parameter groups without additional fields now have their own type, instead of all being grouped into `Other`
 
 # v0.7.3
 
@@ -28,8 +43,7 @@
 # v0.5.0
 
 - Updated to factorio version 1.1.39
-- Documentation links now point to the new API docs website. More info
-  here: https://forums.factorio.com/viewtopic.php?f=34&t=99797
+- Documentation links now point to the new API docs website. More info here: https://forums.factorio.com/viewtopic.php?f=34&t=99797
 
 # v0.4.1
 

package/generated/classes.d.ts

@@ -1349,10 +1349,12 @@ interface LuaControl {
    */
   clear_vehicle_logistic_slot(slot_index: uint): void
   /**
-   * Returns whether the player is holding a blueprint, it takes into account a blueprint as an item as well as
-   * blueprint from the blueprint record from the blueprint library. Note that the is_cursor_blueprint and
-   * get_cursor_blueprint_entities refer to the currently selected blueprint, so it returns blueprint related
-   * information also when holding a blueprint book with a blueprint being selected in it.
+   * Returns whether the player is holding a blueprint. This takes both blueprint items as well as blueprint records
+   * from the blueprint library into account.
+   *
+   * **Note**: Both this method and {@link LuaControl.get_blueprint_entities LuaControl::get_blueprint_entities} refer
+   * to the currently selected blueprint, meaning a blueprint book with a selected blueprint will return the
+   * information as well.
    *
    * {@link https://lua-api.factorio.com/next/LuaControl.html#LuaControl.is_cursor_blueprint View documentation}
    */
@@ -1415,15 +1417,18 @@ interface LuaControl {
    *
    * {@link https://lua-api.factorio.com/next/LuaControl.html#LuaControl.opened View documentation}
    */
-  opened:
-    | LuaEntity
-    | LuaItemStack
-    | LuaEquipment
-    | LuaEquipmentGrid
-    | LuaPlayer
-    | LuaGuiElement
-    | defines.gui_type
-    | undefined
+  set opened(
+    value:
+      | LuaEntity
+      | LuaItemStack
+      | LuaEquipment
+      | LuaEquipmentGrid
+      | LuaPlayer
+      | LuaGuiElement
+      | defines.gui_type
+      | undefined
+  )
+  get opened(): LuaEntity | LuaEquipment | LuaEquipmentGrid | LuaPlayer | LuaGuiElement | undefined
   /**
    * Size of the crafting queue.
    *
@@ -2297,24 +2302,24 @@ interface LuaEntity extends LuaControl {
    */
   die(force?: ForceIdentification, cause?: LuaEntity): boolean
   /**
-   * Test whether this entity's prototype has a flag set.
+   * Test whether this entity's prototype has a certain flag set.
    *
    * **Note**: `entity.has_flag(f)` is a shortcut for `entity.prototype.has_flag(f)`.
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.has_flag View documentation}
    *
-   * @param flag - The flag to test
-   * @returns `true` if the entity has the given flag set.
+   * @param flag - The flag to test. See {@link EntityPrototypeFlags} for a list of flags.
+   * @returns `true` if this entity has the given flag set.
    */
   has_flag(flag: string): boolean
   /**
-   * Same as {@link LuaEntity.has_flag LuaEntity::has_flag} but targets the inner entity on a entity ghost.
+   * Same as {@link LuaEntity.has_flag LuaEntity::has_flag}, but targets the inner entity on a entity ghost.
    *
    * *Can only be used if this is EntityGhost*
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.ghost_has_flag View documentation}
    *
-   * @param flag - The flag to test
+   * @param flag - The flag to test. See {@link EntityPrototypeFlags} for a list of flags.
    * @returns `true` if the entity has the given flag set.
    */
   ghost_has_flag(flag: string): boolean
@@ -2556,7 +2561,7 @@ interface LuaEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.get_transport_line View documentation}
    *
-   * @param index - Index of the requested transport line.
+   * @param index - Index of the requested transport line. Transport lines are 1-indexed.
    */
   get_transport_line(index: uint): LuaTransportLine
   /**
@@ -3007,6 +3012,9 @@ interface LuaEntity extends LuaControl {
   /**
    * Get the amount of all or some fluid in this entity.
    *
+   * **Note**: If information about fluid temperatures is required, {@link LuaEntity.fluidbox LuaEntity::fluidbox}
+   * should be used instead.
+   *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.get_fluid_count View documentation}
    *
    * @param fluid - Prototype name of the fluid to count. If not specified, count all fluids.
@@ -3015,6 +3023,9 @@ interface LuaEntity extends LuaControl {
   /**
    * Get amounts of all fluids in this entity.
    *
+   * **Note**: If information about fluid temperatures is required, {@link LuaEntity.fluidbox LuaEntity::fluidbox}
+   * should be used instead.
+   *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.get_fluid_contents View documentation}
    *
    * @returns The amounts, indexed by fluid names.
@@ -3567,21 +3578,26 @@ interface LuaEntity extends LuaControl {
    */
   pickup_position: Position
   /**
-   * The entity this entity is putting its stuff to or `nil` if there is no such entity.
+   * The entity this entity is putting its items to, or `nil` if there is no such entity. If there are multiple
+   * possible entities at the drop-off point, writing to this attribute allows a mod to choose which one to drop off
+   * items to. The entity needs to collide with the tile box under the drop-off position.
    *
-   * **Note**: Meaningful only for entities that put stuff somewhere, such as mining drills or inserters.
+   * **Note**: Meaningful only for entities that put items somewhere, such as mining drills or inserters. Returns
+   * `nil` for any other entity.
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.drop_target View documentation}
    */
   drop_target: LuaEntity | undefined
   /**
-   * The entity the inserter will attempt to pick up from. For example, this can be a transport belt or a storage chest.
+   * The entity this inserter will attempt to pick up items from, or `nil` if there is no such entity. If there are
+   * multiple possible entities at the pick-up point, writing to this attribute allows a mod to choose which one to
+   * pick up items from. The entity needs to collide with the tile box under the pick-up position.
    *
    * *Can only be used if this is Inserter*
    *
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.pickup_target View documentation}
    */
-  pickup_target: LuaEntity
+  pickup_target: LuaEntity | undefined
   /**
    * Index of the currently selected weapon slot of this character, car, or spidertron, or `nil` if the car/spidertron
    * doesn't have guns.
@@ -4290,6 +4306,14 @@ interface LuaEntity extends LuaControl {
    * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.connected_rail View documentation}
    */
   readonly connected_rail: LuaEntity | undefined
+  /**
+   * Rail direction to which this train stop is binding. This returns a value even when no rails are present.
+   *
+   * *Can only be used if this is TrainStop*
+   *
+   * {@link https://lua-api.factorio.com/next/LuaEntity.html#LuaEntity.connected_rail_direction View documentation}
+   */
+  readonly connected_rail_direction: defines.rail_direction
   /**
    * The number of trains in this rail block for this rail entity.
    *
@@ -4614,42 +4638,14 @@ interface LuaEntity extends LuaControl {
  */
 interface LuaEntityPrototype {
   /**
-   * Does this prototype have a flag enabled?
+   * Test whether this entity prototype has a certain flag set.
    *
    * {@link https://lua-api.factorio.com/next/LuaEntityPrototype.html#LuaEntityPrototype.has_flag View documentation}
    *
-   * @param flag - The flag to check. Must be one of - `"not-rotatable"` - `"placeable-neutral"` -
-   *   `"placeable-player"` - `"placeable-enemy"` - `"placeable-off-grid"` - `"player-creation"` -
-   *   `"building-direction-8-way"` - `"filter-directions"` - `"fast-replaceable-no-build-while-moving"` -
-   *   `"breaths-air"` - `"not-repairable"` - `"not-on-map"` - `"not-deconstructable"` - `"not-blueprintable"` -
-   *   `"hide-from-bonus-gui"` - `"hide-alt-info"` - `"fast-replaceable-no-cross-type-while-moving"` -
-   *   `"no-gap-fill-while-building"` - `"not-flammable"` - `"no-automated-item-removal"` -
-   *   `"no-automated-item-insertion"` - `"not-upgradable"`
-   */
-  has_flag(
-    flag:
-      | "not-rotatable"
-      | "placeable-neutral"
-      | "placeable-player"
-      | "placeable-enemy"
-      | "placeable-off-grid"
-      | "player-creation"
-      | "filter-directions"
-      | "fast-replaceable-no-build-while-moving"
-      | "breaths-air"
-      | "not-repairable"
-      | "not-on-map"
-      | "not-deconstructable"
-      | "not-blueprintable"
-      | "hide-from-bonus-gui"
-      | "hide-alt-info"
-      | "fast-replaceable-no-cross-type-while-moving"
-      | "no-gap-fill-while-building"
-      | "not-flammable"
-      | "no-automated-item-removal"
-      | "no-automated-item-insertion"
-      | "not-upgradable"
-  ): boolean
+   * @param flag - The flag to test. See {@link EntityPrototypeFlags} for a list of flags.
+   * @returns `true` if this prototype has the given flag set.
+   */
+  has_flag(flag: string): boolean
   /**
    * Gets the base size of the given inventory on this entity or `nil` if the given inventory doesn't exist.
    *
@@ -4964,7 +4960,7 @@ interface LuaEntityPrototype {
    */
   readonly max_underground_distance: uint8 | undefined
   /**
-   * The entity prototype flags for this entity.
+   * The flags for this entity prototype.
    *
    * {@link https://lua-api.factorio.com/next/LuaEntityPrototype.html#LuaEntityPrototype.flags View documentation}
    */
@@ -9645,6 +9641,15 @@ interface BaseGuiElement {
    * {@link https://lua-api.factorio.com/next/LuaGuiElement.html#LuaGuiElement.get_index_in_parent View documentation}
    */
   get_index_in_parent(): uint
+  /**
+   * Swaps the children at the given indices in this element.
+   *
+   * {@link https://lua-api.factorio.com/next/LuaGuiElement.html#LuaGuiElement.swap_children View documentation}
+   *
+   * @param index_1 - The index of the first child.
+   * @param index_2 - The index of the second child.
+   */
+  swap_children(index_1: uint, index_2: uint): void
   /**
    * Focuses this GUI element if possible.
    *
@@ -9704,7 +9709,8 @@ interface BaseGuiElement {
    *
    * {@link https://lua-api.factorio.com/next/LuaGuiElement.html#LuaGuiElement.style View documentation}
    */
-  style: LuaStyle | string
+  set style(style: LuaStyle | string)
+  get style(): LuaStyle
   /**
    * Sets whether this GUI element is visible or completely hidden, taking no space in the layout.
    *
@@ -11492,13 +11498,12 @@ interface LuaInventory extends ReadonlyArray<LuaItemStack> {
  */
 interface LuaItemPrototype {
   /**
-   * Does this prototype have a flag enabled?
-   *
-   * Any other value will cause an error.
+   * Test whether this item prototype has a certain flag set.
    *
    * {@link https://lua-api.factorio.com/next/LuaItemPrototype.html#LuaItemPrototype.has_flag View documentation}
    *
-   * @param flag - The flag to check. Can be one of {@link ItemPrototypeFlags}
+   * @param flag - The flag to test. See {@link ItemPrototypeFlags} for a list of flags.
+   * @returns `true` if this prototype has the given flag set.
    */
   has_flag(flag: string): boolean
   /**
@@ -11621,7 +11626,7 @@ interface LuaItemPrototype {
    */
   readonly group: LuaGroup
   /**
-   * The item prototype flags for this item prototype.
+   * The flags for this item prototype.
    *
    * {@link https://lua-api.factorio.com/next/LuaItemPrototype.html#LuaItemPrototype.flags View documentation}
    */
@@ -19645,7 +19650,7 @@ interface LuaTrain {
   /**
    * The players killed by this train.
    *
-   * The keys are the player indexes, the values are how often this train killed that player.
+   * The keys are the player indices, the values are how often this train killed that player.
    *
    * {@link https://lua-api.factorio.com/next/LuaTrain.html#LuaTrain.killed_players View documentation}
    */

package/generated/concepts.d.ts

@@ -47,7 +47,7 @@
  *   game.print({"", {"item-name.iron-plate"}, ": ", 60})
  *   ```
  */
-type LocalisedString = [string, ...LocalisedString[]] | string | number
+type LocalisedString = readonly [string, ...LocalisedString[]] | string | number
 
 interface DisplayResolution {
   readonly width: uint
@@ -2111,6 +2111,12 @@ interface TrainScheduleRecord {
   readonly station?: string
   /** Rail to path to. Ignored if `station` is present. */
   readonly rail?: LuaEntity
+  /**
+   * When a train is allowed to reach rail target from any direction it will be `nil`. If rail has to be reached from
+   * specific direction, this value allows to choose the direction. This value corresponds to
+   * {@link LuaEntity.connected_rail_direction LuaEntity::connected_rail_direction} of a TrainStop.
+   */
+  readonly rail_direction?: defines.rail_direction
   readonly wait_conditions?: WaitCondition[]
   /** Only present when the station is temporary, the value is then always `true`. */
   readonly temporary?: boolean
@@ -2366,6 +2372,7 @@ interface EntityPrototypeFlags {
   readonly "no-copy-paste"?: boolean
   readonly "not-selectable-in-game"?: boolean
   readonly "not-upgradable"?: boolean
+  readonly "not-in-kill-statistics"?: boolean
 }
 
 /**
@@ -2386,6 +2393,7 @@ interface ItemPrototypeFlags {
   readonly "primary-place-result"?: boolean
   readonly "mod-openable"?: boolean
   readonly "only-in-cursor"?: boolean
+  readonly spawnable?: boolean
 }
 
 /**
@@ -3014,6 +3022,12 @@ interface VehicleAutomaticTargetingParameters {
   readonly auto_target_with_gunner: boolean
 }
 
+/**
+ * Defines which slider in the game's sound settings affects the volume of this sound. Furthermore, some sound types are
+ * mixed differently than others, e.g. zoom level effects are applied.
+ *
+ * {@link https://lua-api.factorio.com/next/Concepts.html#SoundType View documentation}
+ */
 type SoundType = "game-effect" | "gui-effect" | "ambient" | "environment" | "walking" | "alert" | "wind"
 
 interface BaseItemPrototypeFilter {

package/generated/defines.d.ts

@@ -1087,7 +1087,7 @@ declare namespace defines {
    *
    * {@link https://lua-api.factorio.com/next/defines.html#defines.events View documentation}
    */
-  type events = typeof events[keyof typeof events]
+  type Events = typeof events[keyof typeof events]
   enum flow_precision_index {
     five_seconds,
     one_minute,

package/generated/events.d.ts

@@ -667,6 +667,8 @@ interface OnForcesMergingEvent extends EventData {
  * Called when a game is created from a scenario. This is fired for every mod, even when the scenario's save data
  * already includes it. In those cases however, {@link LuaBootstrap.on_init LuaBootstrap::on_init} is not fired.
  *
+ * **Note**: This event is not fired when the scenario is loaded via the map editor.
+ *
  * {@link https://lua-api.factorio.com/next/Events.html#on_game_created_from_scenario View documentation}
  */
 interface OnGameCreatedFromScenarioEvent extends EventData {
@@ -2968,7 +2970,7 @@ type EventId<T extends table, F = unknown> = uint & {
 }
 
 /**
- * An event id generated by {@link LuaBootstrap.generate_event_name LuaBootstrap::generate_event_name} and raisable via
+ * An event id generated by {@link LuaBootstrap.generate_event_name LuaBootstrap::generate_event_name} and raiseable via
  * {@link LuaBootstrap.raise_event LuaBootstrap::raise_event}.
  */
 type CustomEventId<T extends table> = EventId<T> & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typed-factorio",
-  "version": "0.8.1",
+  "version": "0.11.0-packagetypes-1",
   "description": "Featureful typescript definitions for the the Factorio modding lua api.",
   "keywords": [
     "factorio",
@@ -13,6 +13,7 @@
   "files": [
     "**/*.d.ts"
   ],
+  "types": "runtime/index.d.ts",
   "homepage": "https://github.com/GlassBricks/typed-factorio#readme",
   "scripts": {
     "gen": "ts-node generator/index.ts",