typed-factorio 0.15.0 → 0.18.0

package/generated/classes.d.ts

@@ -1382,7 +1382,8 @@ interface LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.force View documentation}
    */
-  force: ForceIdentification
+  get force(): LuaForce
+  set force(value: ForceIdentification)
   /**
    * The currently selected entity; `nil` if none. Assigning an entity will select it if selectable otherwise clears selection.
    *
@@ -1532,7 +1533,8 @@ interface LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaControl.html#LuaControl.cursor_ghost View documentation}
    */
-  cursor_ghost: ItemPrototypeIdentification
+  get cursor_ghost(): LuaItemPrototype
+  set cursor_ghost(value: ItemPrototypeIdentification)
   /**
    * `true` if the player is in a vehicle. Writing to this attribute puts the player in or out of a vehicle.
    *
@@ -1939,7 +1941,7 @@ interface LuaCustomInputPrototype {
   help(): string
 }
 
-type CustomTableIndex<K extends keyof any, V>
+type CustomTableIndex<K extends string | number, V>
 /**
  * Access an element of this custom table.
  *
@@ -2012,7 +2014,9 @@ interface LuaCustomTableMembers {
  *   global.p = game.players  -- This has high potential to make the game unsaveable
  *   ```
  */
-type LuaCustomTable<K extends keyof any, V> = LuaCustomTableMembers & CustomTableIndex<K, V>
+type LuaCustomTable<K extends string | number, V> = LuaCustomTableMembers &
+  CustomTableIndex<K, V> &
+  LuaPairsIterable<[number] extends [K] ? number : K, V>
 
 /**
  * Prototype of a damage.
@@ -2314,7 +2318,7 @@ interface LuaEntity extends LuaControl {
    * @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
+  has_flag(flag: keyof EntityPrototypeFlags): boolean
   /**
    * Same as {@link LuaEntity.has_flag LuaEntity::has_flag}, but targets the inner entity on a entity ghost.
    *
@@ -2325,7 +2329,7 @@ interface LuaEntity extends LuaControl {
    * @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
+  ghost_has_flag(flag: keyof EntityPrototypeFlags): boolean
   /**
    * Offer a thing on the market.
    *
@@ -3256,8 +3260,8 @@ interface LuaEntity extends LuaControl {
   is_registered_for_construction(): boolean
   /**
    * Is this entity registered for deconstruction with this force? If false, it means a construction robot has been
-   * dispatched to deconstruct it, or it is not marked for deconstruction. This is worst-case O(N) complexity where N
-   * is the current number of things in the deconstruct queue.
+   * dispatched to deconstruct it, or it is not marked for deconstruction. The complexity is effectively O(1) - it
+   * depends on the number of objects targeting this entity which should be small enough.
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_registered_for_deconstruction View documentation}
    *
@@ -3315,6 +3319,14 @@ interface LuaEntity extends LuaControl {
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.disconnect_linked_belts View documentation}
    */
   disconnect_linked_belts(): void
+  /**
+   * Gets legs of given SpiderVehicle.
+   *
+   * *Can only be used if this is SpiderVehicle*
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_spider_legs View documentation}
+   */
+  get_spider_legs(): LuaEntity[]
   /**
    * Name of the entity prototype. E.g. "inserter" or "filter-inserter".
    *
@@ -3669,6 +3681,8 @@ interface LuaEntity extends LuaControl {
    * - When called on an underground transport belt, this is the other end of the underground belt connection, or `nil` if none.
    * - When called on a wall-connectable entity or reactor, this is a dictionary of all connections indexed by the
    *   connection direction "north", "south", "east", and "west".
+   * - When called on a cliff entity, this is a dictionary of all connections indexed by the connection direction
+   *   "north", "south", "east", and "west".
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.neighbours View documentation}
    */
@@ -4398,7 +4412,8 @@ interface LuaEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_to_forces View documentation}
    */
-  render_to_forces: ForceIdentification[] | undefined
+  get render_to_forces(): LuaForce[] | undefined
+  set render_to_forces(value: ForceIdentification[] | undefined)
   /**
    * The rail target of this pump or `nil`.
    *
@@ -4549,11 +4564,18 @@ interface LuaEntity extends LuaControl {
    */
   trains_limit: uint
   /**
-   * If this entity is EntityWithForce
+   * (deprecated by 1.1.51) If this entity is a MilitaryTarget. Returns same value as LuaEntity::is_military_target
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_entity_with_force View documentation}
    */
   readonly is_entity_with_force: boolean
+  /**
+   * If this entity is a MilitaryTarget. Can be written to if
+   * LuaEntityPrototype::allow_run_time_change_of_is_military_target returns true
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_military_target View documentation}
+   */
+  is_military_target: boolean
   /**
    * If this entity is EntityWithOwner
    *
@@ -4721,7 +4743,7 @@ interface BaseEntity extends LuaControl {
    * @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
+  has_flag(flag: keyof EntityPrototypeFlags): boolean
   /**
    * Connect two devices with a circuit wire or copper cable. Depending on which type of connection should be made,
    * there are different procedures:
@@ -5240,8 +5262,8 @@ interface BaseEntity extends LuaControl {
   is_registered_for_construction(): boolean
   /**
    * Is this entity registered for deconstruction with this force? If false, it means a construction robot has been
-   * dispatched to deconstruct it, or it is not marked for deconstruction. This is worst-case O(N) complexity where N
-   * is the current number of things in the deconstruct queue.
+   * dispatched to deconstruct it, or it is not marked for deconstruction. The complexity is effectively O(1) - it
+   * depends on the number of objects targeting this entity which should be small enough.
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_registered_for_deconstruction View documentation}
    *
@@ -5445,6 +5467,8 @@ interface BaseEntity extends LuaControl {
    * - When called on an underground transport belt, this is the other end of the underground belt connection, or `nil` if none.
    * - When called on a wall-connectable entity or reactor, this is a dictionary of all connections indexed by the
    *   connection direction "north", "south", "east", and "west".
+   * - When called on a cliff entity, this is a dictionary of all connections indexed by the connection direction
+   *   "north", "south", "east", and "west".
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.neighbours View documentation}
    */
@@ -5779,7 +5803,8 @@ interface BaseEntity extends LuaControl {
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.render_to_forces View documentation}
    */
-  render_to_forces: ForceIdentification[] | undefined
+  get render_to_forces(): LuaForce[] | undefined
+  set render_to_forces(value: ForceIdentification[] | undefined)
   /**
    * Returns the id of the electric network that this entity is connected to or `nil`.
    *
@@ -5824,11 +5849,18 @@ interface BaseEntity extends LuaControl {
    */
   tags: Tags | undefined
   /**
-   * If this entity is EntityWithForce
+   * (deprecated by 1.1.51) If this entity is a MilitaryTarget. Returns same value as LuaEntity::is_military_target
    *
    * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_entity_with_force View documentation}
    */
   readonly is_entity_with_force: boolean
+  /**
+   * If this entity is a MilitaryTarget. Can be written to if
+   * LuaEntityPrototype::allow_run_time_change_of_is_military_target returns true
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.is_military_target View documentation}
+   */
+  is_military_target: boolean
   /**
    * If this entity is EntityWithOwner
    *
@@ -5988,7 +6020,7 @@ interface EntityGhostEntity extends BaseEntity {
    * @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
+  ghost_has_flag(flag: keyof EntityPrototypeFlags): boolean
   /**
    * The unit number of the entity contained in this ghost or nil if the entity doesn't have one.
    *
@@ -6685,6 +6717,14 @@ interface SpiderVehicleEntity extends BaseEntity {
    * @param position - The position the spidertron should move to.
    */
   add_autopilot_destination(position: MapPosition): void
+  /**
+   * Gets legs of given SpiderVehicle.
+   *
+   * *Can only be used if this is SpiderVehicle*
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntity.html#LuaEntity.get_spider_legs View documentation}
+   */
+  get_spider_legs(): LuaEntity[]
   /**
    * The torso orientation of this spider vehicle.
    *
@@ -7281,7 +7321,7 @@ interface LuaEntityPrototype {
    * @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
+  has_flag(flag: keyof EntityPrototypeFlags): boolean
   /**
    * Gets the base size of the given inventory on this entity or `nil` if the given inventory doesn't exist.
    *
@@ -8168,6 +8208,12 @@ interface LuaEntityPrototype {
    * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.timeout View documentation}
    */
   readonly timeout: uint
+  /**
+   * Collision mask entity must collide with to make landmine blowup
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.trigger_collision_mask View documentation}
+   */
+  readonly trigger_collision_mask: CollisionMask
   /**
    * The fluidbox prototypes for this entity.
    *
@@ -8468,6 +8514,35 @@ interface LuaEntityPrototype {
    * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.inserter_stack_size_bonus View documentation}
    */
   readonly inserter_stack_size_bonus: double | undefined
+  /**
+   * True if this entity prototype should be included during tile collision checks with
+   * {@link LuaTilePrototype.check_collision_with_entities LuaTilePrototype::check_collision_with_entities} enabled.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.protected_from_tile_building View documentation}
+   */
+  readonly protected_from_tile_building: boolean
+  /**
+   * True if this is entity-with-owner
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.is_entity_with_owner View documentation}
+   */
+  readonly is_entity_with_owner: boolean
+  /**
+   * True if this entity-with-owner is military target
+   *
+   * *Can only be used if this is EntityWithOwnerPrototype*
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.is_military_target View documentation}
+   */
+  readonly is_military_target: boolean
+  /**
+   * True if this entity-with-owner's is_military_target can be changed run-time (on the entity, not on the prototype itself)
+   *
+   * *Can only be used if this is EntityWithOwnerPrototype*
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.allow_run_time_change_of_is_military_target View documentation}
+   */
+  readonly allow_run_time_change_of_is_military_target: boolean
   /**
    * Gets the current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
    *
@@ -8586,7 +8661,7 @@ interface BaseEntityPrototype {
    * @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
+  has_flag(flag: keyof EntityPrototypeFlags): boolean
   /**
    * Gets the base size of the given inventory on this entity or `nil` if the given inventory doesn't exist.
    *
@@ -9473,6 +9548,12 @@ interface BaseEntityPrototype {
    * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.timeout View documentation}
    */
   readonly timeout: uint
+  /**
+   * Collision mask entity must collide with to make landmine blowup
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.trigger_collision_mask View documentation}
+   */
+  readonly trigger_collision_mask: CollisionMask
   /**
    * The fluidbox prototypes for this entity.
    *
@@ -9711,6 +9792,19 @@ interface BaseEntityPrototype {
    * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.inserter_stack_size_bonus View documentation}
    */
   readonly inserter_stack_size_bonus: double | undefined
+  /**
+   * True if this entity prototype should be included during tile collision checks with
+   * {@link LuaTilePrototype.check_collision_with_entities LuaTilePrototype::check_collision_with_entities} enabled.
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.protected_from_tile_building View documentation}
+   */
+  readonly protected_from_tile_building: boolean
+  /**
+   * True if this is entity-with-owner
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.is_entity_with_owner View documentation}
+   */
+  readonly is_entity_with_owner: boolean
   /**
    * 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
@@ -9801,6 +9895,25 @@ interface TransportBeltEntityPrototype extends BaseEntityPrototype {
   readonly related_underground_belt: LuaEntityPrototype
 }
 
+interface EntityWithOwnerEntityPrototype extends BaseEntityPrototype {
+  /**
+   * True if this entity-with-owner is military target
+   *
+   * *Can only be used if this is EntityWithOwnerPrototype*
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.is_military_target View documentation}
+   */
+  readonly is_military_target: boolean
+  /**
+   * True if this entity-with-owner's is_military_target can be changed run-time (on the entity, not on the prototype itself)
+   *
+   * *Can only be used if this is EntityWithOwnerPrototype*
+   *
+   * {@link https://lua-api.factorio.com/latest/LuaEntityPrototype.html#LuaEntityPrototype.allow_run_time_change_of_is_military_target View documentation}
+   */
+  readonly allow_run_time_change_of_is_military_target: boolean
+}
+
 interface CharacterEntityPrototype extends BaseEntityPrototype {
   /**
    * Gets the current movement speed of this character, including effects from exoskeletons, tiles, stickers and shooting.
@@ -15459,7 +15572,7 @@ interface LuaItemPrototype {
    * @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
+  has_flag(flag: keyof ItemPrototypeFlags): boolean
   /**
    * Type of this ammo prototype or `nil` if this is not an ammo prototype.
    *
@@ -15998,7 +16111,7 @@ interface BaseItemPrototype {
    * @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
+  has_flag(flag: keyof ItemPrototypeFlags): boolean
   /**
    * Type of this ammo prototype or `nil` if this is not an ammo prototype.
    *
@@ -23892,12 +24005,12 @@ interface LuaSurface {
     readonly condition: ForceCondition
   }): LuaEntity[]
   /**
-   * Find the enemy entity-with-force ({@link https://wiki.factorio.com/Military_units_and_structures military entity})
+   * Find the enemy military target ({@link https://wiki.factorio.com/Military_units_and_structures military entity})
    * closest to the given position.
    *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.find_nearest_enemy View documentation}
    *
-   * @returns The nearest enemy entity-with-force or `nil` if no enemy could be found within the given area.
+   * @returns The nearest enemy military target or `nil` if no enemy could be found within the given area.
    */
   find_nearest_enemy(params: {
     /** Center of the search area. */
@@ -24654,7 +24767,7 @@ interface LuaSurface {
    */
   calculate_tile_properties(property_names: readonly string[], positions: readonly Position[]): Record<string, double[]>
   /**
-   * Returns all the entities with force on this chunk for the given force.
+   * Returns all the military targets (entities with force) on this chunk for the given force.
    *
    * {@link https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_entities_with_force View documentation}
    *

package/generated/concepts.d.ts

@@ -3227,7 +3227,7 @@ interface TypeItemPrototypeFilter extends BaseItemPrototypeFilter {
 interface FlagItemPrototypeFilter extends BaseItemPrototypeFilter {
   readonly filter: "flag"
   /** One of the values in {@link ItemPrototypeFlags}. */
-  readonly flag: string
+  readonly flag: keyof ItemPrototypeFlags
 }
 
 interface SubgroupItemPrototypeFilter extends BaseItemPrototypeFilter {
@@ -4079,7 +4079,7 @@ interface CollisionMaskEntityPrototypeFilter extends BaseEntityPrototypeFilter {
 interface FlagEntityPrototypeFilter extends BaseEntityPrototypeFilter {
   readonly filter: "flag"
   /** One of the values in {@link EntityPrototypeFlags}. */
-  readonly flag: string
+  readonly flag: keyof EntityPrototypeFlags
 }
 
 interface BuildBaseEvolutionRequirementEntityPrototypeFilter extends BaseEntityPrototypeFilter {