factorio-types 1.2.24 → 1.2.26

package/dist/classes.d.ts

@@ -2,7 +2,7 @@
 // Factorio API reference https://lua-api.factorio.com/latest/index.html
 // Generated from JSON source https://lua-api.factorio.com/latest/runtime-api.json
 // Definition source https://github.com/sguest/factorio-types
-// Factorio version 2.0.33
+// Factorio version 2.0.38
 // API version 6
 
 declare namespace runtime {
@@ -196,6 +196,10 @@ interface LuaAirbornePollutantPrototype extends LuaPrototypeBase {
  */
 interface LuaAmmoCategoryPrototype extends LuaPrototypeBase {
     readonly bonus_gui_order: string;
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaAmmoCategoryPrototype;
     /**
      * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
      */
@@ -292,6 +296,10 @@ interface LuaAssemblingMachineControlBehavior extends LuaGenericOnOffControlBeha
  * Prototype of an asteroid chunk.
  */
 interface LuaAsteroidChunkPrototype extends LuaPrototypeBase {
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaAsteroidChunkPrototype;
     readonly hide_from_signal_gui: boolean;
     readonly item_signal_alias?: LuaItemPrototype;
     readonly mineable_properties: MineableProperties;
@@ -563,6 +571,24 @@ interface LuaBootstrap {
     script.on_event(defines.events.on_built_entity,
     function(event) game.print("Gotta go fast!") end,
     {{filter = "name", name = "fast-inserter"}})
+    ```
+     */
+    on_event(this: void, event: defines.events.on_cargo_pod_delivered_cargo, handler: ((this: void, arg0: runtime.on_cargo_pod_delivered_cargo) => any) | nil, filters?: EventFilter): void;
+    /**
+     * Register a handler to run on the specified event(s). Each mod can only register once for every event, as any additional registration will overwrite the previous one. This holds true even if different filters are used for subsequent registrations.
+     * @param event The event(s) or custom-input to invoke the handler on.
+     * @param handler The handler for this event. Passing `nil` will unregister it.
+     * @param filters The filters for this event. Can only be used when registering for individual events.
+     * @example ```
+    -- Register for the on_tick event to print the current tick to console each tick
+    script.on_event(defines.events.on_tick,
+    function(event) game.print(event.tick) end)
+    ```
+     * @example ```
+    -- Register for the on_built_entity event, limiting it to only be received when a `"fast-inserter"` is built
+    script.on_event(defines.events.on_built_entity,
+    function(event) game.print("Gotta go fast!") end,
+    {{filter = "name", name = "fast-inserter"}})
     ```
      */
     on_event(this: void, event: defines.events.on_cargo_pod_finished_ascending, handler: ((this: void, arg0: runtime.on_cargo_pod_finished_ascending) => any) | nil, filters?: EventFilter): void;
@@ -581,6 +607,24 @@ interface LuaBootstrap {
     script.on_event(defines.events.on_built_entity,
     function(event) game.print("Gotta go fast!") end,
     {{filter = "name", name = "fast-inserter"}})
+    ```
+     */
+    on_event(this: void, event: defines.events.on_cargo_pod_finished_descending, handler: ((this: void, arg0: runtime.on_cargo_pod_finished_descending) => any) | nil, filters?: EventFilter): void;
+    /**
+     * Register a handler to run on the specified event(s). Each mod can only register once for every event, as any additional registration will overwrite the previous one. This holds true even if different filters are used for subsequent registrations.
+     * @param event The event(s) or custom-input to invoke the handler on.
+     * @param handler The handler for this event. Passing `nil` will unregister it.
+     * @param filters The filters for this event. Can only be used when registering for individual events.
+     * @example ```
+    -- Register for the on_tick event to print the current tick to console each tick
+    script.on_event(defines.events.on_tick,
+    function(event) game.print(event.tick) end)
+    ```
+     * @example ```
+    -- Register for the on_built_entity event, limiting it to only be received when a `"fast-inserter"` is built
+    script.on_event(defines.events.on_built_entity,
+    function(event) game.print("Gotta go fast!") end,
+    {{filter = "name", name = "fast-inserter"}})
     ```
      */
     on_event(this: void, event: defines.events.on_character_corpse_expired, handler: ((this: void, arg0: runtime.on_character_corpse_expired) => any) | nil, filters?: EventFilter): void;
@@ -1499,6 +1543,24 @@ interface LuaBootstrap {
     script.on_event(defines.events.on_built_entity,
     function(event) game.print("Gotta go fast!") end,
     {{filter = "name", name = "fast-inserter"}})
+    ```
+     */
+    on_event(this: void, event: defines.events.on_multiplayer_init, handler: ((this: void, arg0: runtime.on_multiplayer_init) => any) | nil, filters?: EventFilter): void;
+    /**
+     * Register a handler to run on the specified event(s). Each mod can only register once for every event, as any additional registration will overwrite the previous one. This holds true even if different filters are used for subsequent registrations.
+     * @param event The event(s) or custom-input to invoke the handler on.
+     * @param handler The handler for this event. Passing `nil` will unregister it.
+     * @param filters The filters for this event. Can only be used when registering for individual events.
+     * @example ```
+    -- Register for the on_tick event to print the current tick to console each tick
+    script.on_event(defines.events.on_tick,
+    function(event) game.print(event.tick) end)
+    ```
+     * @example ```
+    -- Register for the on_built_entity event, limiting it to only be received when a `"fast-inserter"` is built
+    script.on_event(defines.events.on_built_entity,
+    function(event) game.print("Gotta go fast!") end,
+    {{filter = "name", name = "fast-inserter"}})
     ```
      */
     on_event(this: void, event: defines.events.on_object_destroyed, handler: ((this: void, arg0: runtime.on_object_destroyed) => any) | nil, filters?: EventFilter): void;
@@ -3425,6 +3487,24 @@ interface LuaBootstrap {
     script.on_event(defines.events.on_built_entity,
     function(event) game.print("Gotta go fast!") end,
     {{filter = "name", name = "fast-inserter"}})
+    ```
+     */
+    on_event(this: void, event: defines.events.on_singleplayer_init, handler: ((this: void, arg0: runtime.on_singleplayer_init) => any) | nil, filters?: EventFilter): void;
+    /**
+     * Register a handler to run on the specified event(s). Each mod can only register once for every event, as any additional registration will overwrite the previous one. This holds true even if different filters are used for subsequent registrations.
+     * @param event The event(s) or custom-input to invoke the handler on.
+     * @param handler The handler for this event. Passing `nil` will unregister it.
+     * @param filters The filters for this event. Can only be used when registering for individual events.
+     * @example ```
+    -- Register for the on_tick event to print the current tick to console each tick
+    script.on_event(defines.events.on_tick,
+    function(event) game.print(event.tick) end)
+    ```
+     * @example ```
+    -- Register for the on_built_entity event, limiting it to only be received when a `"fast-inserter"` is built
+    script.on_event(defines.events.on_built_entity,
+    function(event) game.print("Gotta go fast!") end,
+    {{filter = "name", name = "fast-inserter"}})
     ```
      */
     on_event(this: void, event: defines.events.on_space_platform_built_entity, handler: ((this: void, arg0: runtime.on_space_platform_built_entity) => any) | nil, filters?: EventFilter): void;
@@ -4163,7 +4243,8 @@ interface LuaBootstrap {
      * The metatable first needs to be defined in the mod's root scope, then registered using this method. From then on, it will be properly restored for tables in {@link storage | runtime:storage}.
      *
      * ```
-     * local metatable = {
+     * local metatable =
+     * {
      *   __index = function(key)
      *     return "no value for key " .. key
      *   end
@@ -4393,6 +4474,28 @@ interface LuaBurnerUsagePrototype extends LuaPrototypeBase {
      */
     readonly valid: boolean;
 }
+/**
+ * A cargo hatch.
+ */
+interface LuaCargoHatch {
+    /**
+     * Creates a cargo pod for output at the owning entity hatch location.
+     */
+    create_cargo_pod(this: void): LuaEntity;
+    readonly busy: boolean;
+    readonly is_input_compatible: boolean;
+    readonly is_output_compatible: boolean;
+    /**
+     * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
+     */
+    readonly object_name: string;
+    readonly owner: LuaEntity;
+    readonly reserved: 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 object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
+     */
+    readonly valid: boolean;
+}
 /**
  * Control behavior for cargo landing pad.
  */
@@ -5664,6 +5767,13 @@ interface LuaEntity extends LuaControl {
      * You can play the building sound to go with it by using {@link LuaSurface::play_sound | runtime:LuaSurface::play_sound}, eg: `entity.surface.play_sound{path="entity-build/"..entity.prototype.name, position=entity.position}`
      */
     create_build_effect_smoke(this: void): void;
+    /**
+     * Creates a cargo pod if possible.
+     *
+     * Cargo pod will be created with {@link invalid | runtime:defines.cargo_destination.invalid} destination type. Setting {@link cargo_pod_destination | runtime:LuaEntity::cargo_pod_destination} will cause it to launch.
+     * @param cargo_hatch The hatch to create the pod at. A random (available) one is picked if not provided.
+     */
+    create_cargo_pod(this: void, cargo_hatch?: LuaCargoHatch): LuaEntity | null;
     /**
      * Damages the entity.
      * @param damage The amount of damage to be done.
@@ -5746,6 +5856,10 @@ interface LuaEntity extends LuaControl {
      * The burnt result inventory for this entity or `nil` if this entity doesn't have a burnt result inventory.
      */
     get_burnt_result_inventory(this: void): LuaInventory | null;
+    /**
+     * Gets the cargo bays connected to this cargo landing pad or space platform hub.
+     */
+    get_cargo_bays(this: void): LuaEntity[];
     /**
      * Returns all child signals. Child signals can be either RailSignal or RailChainSignal. Child signals are signals which are checked by this signal to determine a chain state.
      */
@@ -6159,7 +6273,7 @@ interface LuaEntity extends LuaControl {
      * Plays a note with the given instrument and note.
      * @returns Whether the request is valid. The sound may or may not be played depending on polyphony settings.
      */
-    play_note(this: void, instrument: uint, note: uint): boolean;
+    play_note(this: void, instrument: uint, note: uint, stop_playing_sounds?: boolean): boolean;
     /**
      * Release the unit from the spawner which spawned it. This allows the spawner to continue spawning additional units.
      */
@@ -6381,6 +6495,10 @@ interface LuaEntity extends LuaControl {
      * A character associated with a player is not directly controlled by any player.
      */
     associated_player?: LuaPlayer | PlayerIdentification;
+    /**
+     * The cargo pod attached to this rocket silo rocket if any.
+     */
+    readonly attached_cargo_pod?: LuaEntity;
     /**
      * Destination of this spidertron's autopilot, if any. Writing `nil` clears all destinations.
      */
@@ -6438,6 +6556,20 @@ interface LuaEntity extends LuaControl {
      * The burner energy source for this entity, if any.
      */
     readonly burner?: LuaBurner;
+    /**
+     * The cargo hatches owned by this entity if any.
+     */
+    readonly cargo_hatches: LuaCargoHatch[];
+    /**
+     * The destination of this cargo pod entity.
+     *
+     * Use {@link force_finish_ascending | runtime:LuaEntity::force_finish_ascending} if you want it to only descend from orbit.
+     */
+    cargo_pod_destination: CargoDestination;
+    /**
+     * The state of this cargo pod entity.
+     */
+    readonly cargo_pod_state: 'awaiting_launch' | 'ascending' | 'surface_transition' | 'descending' | 'parking';
     /**
      * The state of this chain signal.
      */
@@ -6826,6 +6958,10 @@ interface LuaEntity extends LuaControl {
      * Can also be used on entity ghost if it contains linked-belt.
      */
     linked_belt_type: 'input' | 'output';
+    /**
+     * The belt stack size override for this loader. Set to `0` to disable. Writing this value requires {@link LoaderPrototype::adjustable_belt_stack_size | prototype:LoaderPrototype::adjustable_belt_stack_size} to be `true`.
+     */
+    loader_belt_stack_size_override: uint8;
     /**
      * The container entity this loader is pointing at/pulling from depending on the {@link LuaEntity::loader_type | runtime:LuaEntity::loader_type}, if any.
      */
@@ -6974,6 +7110,14 @@ interface LuaEntity extends LuaControl {
      * The target entity for this item-request-proxy, if any.
      */
     readonly proxy_target?: LuaEntity;
+    /**
+     * Entity of which inventory is exposed by this ProxyContainer
+     */
+    proxy_target_entity?: LuaEntity;
+    /**
+     * Inventory index of the inventory that is exposed by this ProxyContainer
+     */
+    proxy_target_inventory: defines.inventory;
     /**
      * The rail target of this pump, if any.
      */
@@ -7045,6 +7189,10 @@ interface LuaEntity extends LuaControl {
      * Get the current queue of robot orders.
      */
     readonly robot_order_queue: WorkerRobotOrder[];
+    /**
+     * The rocket silo rocket this cargo pod is attached to, or rocket silo rocket attached to this rocket silo - if any.
+     */
+    readonly rocket?: LuaEntity;
     /**
      * Number of rocket parts in the silo.
      */
@@ -7150,7 +7298,7 @@ interface LuaEntity extends LuaControl {
      */
     readonly supports_direction: boolean;
     /**
-     * The tags associated with this entity ghost. `nil` if this is not an entity ghost.
+     * The tags associated with this entity ghost. `nil` if this is not an entity ghost or when the ghost has no tags.
      */
     tags?: Tags;
     /**
@@ -7678,6 +7826,10 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * Whether this explosion rotates.
      */
     readonly explosion_rotate?: double;
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaEntityPrototype;
     /**
      * The group of mutually fast-replaceable entities, if any.
      */
@@ -7887,6 +8039,14 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * The light blinking speed for this rocket silo prototype.
      */
     readonly light_blinking_speed?: double;
+    /**
+     * True if this loader supports a runtime-adjustable belt stack size.
+     */
+    readonly loader_adjustable_belt_stack_size?: boolean;
+    /**
+     * The max belt stack size for this loader.
+     */
+    readonly loader_max_belt_stack_size?: uint8;
     /**
      * The logistic mode of this logistic container.
      */
@@ -7953,6 +8113,10 @@ interface LuaEntityPrototype extends LuaPrototypeBase {
      * How many friendly units are required within the spawning_radius of this spawner for it to stop producing more units.
      */
     readonly max_friends_around_to_spawn?: double;
+    /**
+     * The max number of item products this crafting machine prototype supports.
+     */
+    readonly max_item_product_count?: uint;
     /**
      * The max payload size of this logistics or construction robot.
      */
@@ -8986,6 +9150,10 @@ interface LuaFluidPrototype extends LuaPrototypeBase {
      * A multiplier on the amount of emissions produced when this fluid is burnt in a generator. A value above `1.0` increases emissions and vice versa. The multiplier can't be negative.
      */
     readonly emissions_multiplier: double;
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaFluidPrototype;
     readonly flow_color: Color;
     /**
      * The amount of energy in Joules one unit of this fluid will produce when burnt in a generator. A value of `0` means this fluid can't be used for energy generation. The value can't be negative.
@@ -9282,7 +9450,7 @@ interface LuaForce {
      *
      * The sound is not played if its location is not {@link charted | runtime:LuaForce::chart} for this force.
      * @param table.path The sound to play.
-     * @param table.position Where the sound should be played. If not given, it's played at the current position of each player.
+     * @param table.position Where the sound should be played. If not given, it's played globally on each player's controller's surface.
      * @param table.volume_modifier The volume of the sound to play. Must be between 0 and 1 inclusive.
      * @param table.override_sound_type The volume mixer to play the sound through. Defaults to the default mixer for the given sound type.
      */
@@ -9624,6 +9792,51 @@ interface LuaFuelCategoryPrototype extends LuaPrototypeBase {
      */
     readonly valid: boolean;
 }
+/**
+ * Control behavior for furnaces.
+ */
+interface LuaFurnaceControlBehavior extends LuaGenericOnOffControlBehavior {
+    /**
+     * `true` if the furnace reads its ingredients contents, product contents and materials in crafting.
+     */
+    circuit_read_contents: boolean;
+    /**
+     * `true` if the furnace outputs ingredients of current recipe as a signals to circuit network.
+     */
+    circuit_read_ingredients: boolean;
+    /**
+     * `true` if the the furnace sends a signal when the recipe finishes.
+     */
+    circuit_read_recipe_finished: boolean;
+    /**
+     * `true` if the the furnace sends a signal when it is working.
+     */
+    circuit_read_working: boolean;
+    /**
+     * The signal sent when the furnace finishes a recipe.
+     */
+    circuit_recipe_finished_signal?: SignalID;
+    /**
+     * The signal sent when the furnace is working.
+     */
+    circuit_working_signal?: SignalID;
+    /**
+     * `true` if the read contents should include fuel (content of energy source)
+     */
+    include_fuel: boolean;
+    /**
+     * `true` if the read contents should include items in crafting.
+     */
+    include_in_crafting: boolean;
+    /**
+     * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
+     */
+    readonly object_name: string;
+    /**
+     * Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
+     */
+    readonly valid: boolean;
+}
 /**
  * Main toplevel type, provides access to most of the API though its members. An instance of LuaGameScript is available as the global object named `game`.
  */
@@ -9783,7 +9996,7 @@ interface LuaGameScript {
      *
      * The sound is not played if its location is not {@link charted | runtime:LuaForce::chart} for that player.
      * @param table.path The sound to play.
-     * @param table.position Where the sound should be played. If not given, it's played at the current position of each player.
+     * @param table.position Where the sound should be played. If not given, it's played globally on each player's controller's surface.
      * @param table.volume_modifier The volume of the sound to play. Must be between 0 and 1 inclusive.
      * @param table.override_sound_type The volume mixer to play the sound through. Defaults to the default mixer for the given sound type.
      */
@@ -12206,6 +12419,10 @@ interface LuaItemPrototype extends LuaPrototypeBase {
      * The prototype of this armor's equipment grid, if any.
      */
     readonly equipment_grid?: LuaEquipmentGridPrototype;
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaItemPrototype;
     /**
      * The durability message key used when displaying the durability of this tool in Factoriopedia.
      */
@@ -12352,7 +12569,7 @@ interface LuaItemPrototype extends LuaPrototypeBase {
      */
     readonly valid: boolean;
     /**
-     * Weight of this item
+     * Weight of this item. More information on how item weight is determined can be found on its {@link auxiliary page | runtime:item-weight}.
      */
     readonly weight: double;
 }
@@ -13316,6 +13533,19 @@ interface LuaPlayer extends LuaControl {
      * @param entity If the alert is clicked, the map will open at the position of this entity.
      */
     add_custom_alert(this: void, entity: LuaEntity, icon: SignalID, message: LocalisedString, show_on_map: boolean): void;
+    /**
+     * Adds a pin to this player for the given pin specification. Either entity, player, or surface and position must be defined.
+     * @param table.entity The entity to pin.
+     * @param table.player The player to pin.
+     * @param table.surface The surface to create the pin on.
+     * @param table.position Where to create the pin. Required when surface is defined.
+     */
+    add_pin(this: void, table: {
+        entity?: LuaEntity;
+        player?: PlayerIdentification;
+        surface?: SurfaceIdentification;
+        position?: MapPosition;
+    }): void;
     /**
      * Adds the given recipe to the list of recipe notifications for this player.
      * @param recipe Recipe to add.
@@ -13590,7 +13820,7 @@ interface LuaPlayer extends LuaControl {
      *
      * The sound is not played if its location is not {@link charted | runtime:LuaForce::chart} for this player.
      * @param table.path The sound to play.
-     * @param table.position Where the sound should be played. If not given, it's played at the current position of the player.
+     * @param table.position Where the sound should be played. If not given, it's played globally on the player's controller's surface.
      * @param table.volume_modifier The volume of the sound to play. Must be between 0 and 1 inclusive.
      * @param table.override_sound_type The volume mixer to play the sound through. Defaults to the default mixer for the given sound type.
      */
@@ -14038,6 +14268,10 @@ interface LuaProgrammableSpeakerControlBehavior extends LuaControlBehavior {
  * Base for all prototype classes.
  */
 interface LuaPrototypeBase {
+    /**
+     * Provides additional description used in factoriopedia.
+     */
+    readonly factoriopedia_description: LocalisedString;
     /**
      * Group of this prototype.
      */
@@ -14334,6 +14568,23 @@ interface LuaPrototypes {
      */
     readonly virtual_signal: Record<string, LuaVirtualSignalPrototype>;
 }
+/**
+ * Control behavior for proxy container.
+ */
+interface LuaProxyContainerControlBehavior extends LuaControlBehavior {
+    /**
+     * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
+     */
+    readonly object_name: string;
+    /**
+     * `true` if this proxy container is sending inventory contents to a circuit network
+     */
+    read_contents: 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 object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
+     */
+    readonly valid: boolean;
+}
 /**
  * Control behavior for pumps.
  */
@@ -14754,6 +15005,10 @@ interface LuaRecipePrototype extends LuaPrototypeBase {
      * Energy required to execute this recipe. This directly affects the crafting time: Recipe's energy is exactly its crafting time in seconds, when crafted in an assembling machine with crafting speed exactly equal to one.
      */
     readonly energy: double;
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaRecipePrototype;
     /**
      * Is the recipe hidden from flow statistics (item/fluid production statistics)?
      */
@@ -15027,9 +15282,13 @@ interface LuaRecord {
      */
     blueprint_snap_to_grid?: TilePosition;
     /**
-     * The contents of this BlueprintBookRecord.
+     * The contents of this BlueprintBookRecord. This is sparse array - it may have gaps, so using `#` will not be reliable. Use {@link LuaRecord::contents_size | runtime:LuaRecord::contents_size} or `pairs()` to iterate this table.
+     */
+    readonly contents: LuaTable<ItemStackIndex, LuaRecord>;
+    /**
+     * The highest populated index in the contents of this BlueprintBookRecord.
      */
-    readonly contents: LuaRecord[];
+    readonly contents_size: ItemStackIndex;
     /**
      * List of raw materials required to build this blueprint.
      */
@@ -15062,6 +15321,10 @@ interface LuaRecord {
      * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
      */
     readonly object_name: string;
+    /**
+     * The preview icons for this record.
+     */
+    preview_icons: BlueprintSignalIcon[];
     /**
      * The number of tile filters this deconstruction planner supports.
      */
@@ -15752,6 +16015,141 @@ interface LuaRocketSiloControlBehavior extends LuaControlBehavior {
      */
     readonly valid: boolean;
 }
+/**
+ * The schedule of a particular {@link LuaTrain | runtime:LuaTrain} or {@link LuaSpacePlatform | runtime:LuaSpacePlatform}.
+ */
+interface LuaSchedule {
+    /**
+     * Activates the interrupt at the given index, if the index is valid.
+     */
+    activate_interrupt(this: void, index: uint): void;
+    /**
+     * Adds the given interrupt to the schedule if an interrupt with the given name does not already exist.
+     */
+    add_interrupt(this: void, interrupt: ScheduleInterrupt): void;
+    /**
+     * Adds the given record to the end of the current schedule or at the given index using the provided data.
+     * @returns The index the record was added at.
+     */
+    add_record(this: void, data: AddRecordData): uint | null;
+    /**
+     * Adds the given wait condition to the given record.
+     */
+    add_wait_condition(this: void, record_index: ScheduleRecordPosition, condition_index: uint, type: WaitConditionType): void;
+    /**
+     * Changes the interrupt at the given index to the provided values. Note, the names must match.
+     */
+    change_interrupt(this: void, index: uint, interrupt: ScheduleInterrupt): void;
+    /**
+     * Changes the wait condition on the given record to the new values.
+     */
+    change_wait_condition(this: void, record_index: ScheduleRecordPosition, condition_index: uint, wait_condition: WaitCondition): void;
+    /**
+     * Removes all interrupts.
+     */
+    clear_interrupts(this: void): void;
+    /**
+     * @param uint If provided, clears the records for this interrupt.
+     */
+    clear_records(this: void, interrupt_index?: uint): void;
+    /**
+     * Copies the record from the given schedule at the given index into this schedule at the given index.
+     */
+    copy_record(this: void, source_schedule: LuaSchedule, source_index: uint, destination_index: uint): void;
+    drag_interrupt(this: void, from: uint, to: uint): void;
+    /**
+     * @param interrupt_index The interrupt to operate on, if any.
+     */
+    drag_record(this: void, from: uint, to: uint, interrupt_index?: uint): void;
+    /**
+     * @param index The record to change.
+     */
+    drag_wait_condition(this: void, index: ScheduleRecordPosition, from: uint, to: uint): void;
+    get_interrupt(this: void, index: uint): ScheduleInterrupt | null;
+    get_interrupts(this: void): ScheduleInterrupt[];
+    get_record(this: void, index: ScheduleRecordPosition): ScheduleRecord | null;
+    /**
+     * If the given index is invalid, `nil` is returned.
+     * @param interrupt_index If provided, the record count in this interrupt is read.
+     */
+    get_record_count(this: void, interrupt_index?: uint): uint | null;
+    /**
+     * @param uint If provided, gets the records for this interrupt.
+     */
+    get_records(this: void, interrupt_index?: uint): ScheduleRecord[] | null;
+    /**
+     * Gets the wait condition at the given index if one exists.
+     */
+    get_wait_condition(this: void, schedule_index: ScheduleRecordPosition, condition_index: uint): WaitCondition | null;
+    /**
+     * The number of wait conditions in the given schedule record.
+     */
+    get_wait_condition_count(this: void, index: ScheduleRecordPosition): uint | null;
+    /**
+     * Gets the wait conditions at the given index if they exist.
+     */
+    get_wait_conditions(this: void, schedule_index: ScheduleRecordPosition): WaitCondition[] | null;
+    /**
+     * @param schedule_index The schedule index
+     */
+    go_to_station(this: void, schedule_index: uint): void;
+    /**
+     * Removes the interrupt at the given index, if the index is valid.
+     */
+    remove_interrupt(this: void, index: uint): void;
+    /**
+     * Removes the record at the given index, if the index is valid.
+     */
+    remove_record(this: void, index: ScheduleRecordPosition): void;
+    /**
+     * Removes the given wait condition from the given record.
+     */
+    remove_wait_condition(this: void, record_index: ScheduleRecordPosition, condition_index: uint): void;
+    /**
+     * @param old_name The interrupt to rename
+     * @param new_name The new name - if it already exists, does nothing.
+     */
+    rename_interrupt(this: void, old_name: string, new_name: string): void;
+    /**
+     * Sets if unloading is allowed at the given schedule index.
+     */
+    set_allow_unloading(this: void, index: ScheduleRecordPosition, allow: boolean): void;
+    set_interrupts(this: void, interrupts: ScheduleInterrupt[]): void;
+    /**
+     * @param uint If provided, the records will be set on this interrupt.
+     */
+    set_records(this: void, records: ScheduleRecord[], interrupt_index?: uint): void;
+    set_stopped(this: void, stopped: boolean): void;
+    /**
+     * Sets the comparison on the given wait condition.
+     * @param mode `"and"`, or `"or"`
+     */
+    set_wait_condition_mode(this: void, record_index: ScheduleRecordPosition, condition_index: uint, mode: string): void;
+    readonly current: uint;
+    /**
+     * The group this schedule is part of, if any.
+     */
+    group?: string;
+    readonly interrupt_count: uint;
+    /**
+     * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
+     */
+    readonly object_name: string;
+    /**
+     * The owner of this schedule.
+     */
+    readonly owner?: LuaTrain | LuaSpacePlatform;
+    /**
+     * Note: when writing, value must not be larger than LuaGameScript::tick
+     */
+    tick_of_last_activity: MapTick;
+    readonly tick_of_last_schedule_change: MapTick;
+    readonly ticks_in_station: MapTick;
+    /**
+     * Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.
+     */
+    readonly valid: boolean;
+}
 /**
  * Control behavior for selector combinators.
  */
@@ -15961,6 +16359,10 @@ interface LuaSimulation {
  */
 interface LuaSpaceConnectionPrototype extends LuaPrototypeBase {
     readonly asteroid_spawn_definitions?: SpaceConnectionAsteroidSpawnDefinition[];
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaSpaceConnectionPrototype;
     readonly from: LuaSpaceLocationPrototype;
     readonly length: uint;
     /**
@@ -15980,6 +16382,10 @@ interface LuaSpaceLocationPrototype extends LuaPrototypeBase {
     readonly asteroid_spawn_definitions?: SpaceLocationAsteroidSpawnDefinition[];
     readonly asteroid_spawn_influence: double;
     readonly entities_require_heating?: boolean;
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaSpaceLocationPrototype;
     readonly map_gen_settings?: MapGenSettings;
     readonly map_seed_offset?: uint;
     /**
@@ -16009,6 +16415,10 @@ interface LuaSpacePlatform {
      * @returns The platform hub.
      */
     apply_starter_pack(this: void): LuaEntity | null;
+    /**
+     * Returns `true` when the space platform isn't waiting on any delivery from the planet.
+     */
+    can_leave_current_location(this: void): boolean;
     /**
      * Cancels deletion of this space platform if it was scheduled for deletion.
      */
@@ -16058,6 +16468,7 @@ interface LuaSpacePlatform {
         limit?: uint;
         invert?: boolean;
     }): AsteroidChunk[];
+    get_schedule(this: void): LuaSchedule;
     /**
      * Repairs the given tile if it's damaged.
      */
@@ -16069,6 +16480,12 @@ interface LuaSpacePlatform {
         position: TilePosition;
         damage: float;
     }[];
+    /**
+     * The point on space connection this platform is at or `nil`.
+     *
+     * It is represented as a number in range `[0, 1]`, with 0 being {@link LuaSpaceConnectionPrototype::from | runtime:LuaSpaceConnectionPrototype::from} and 1 being {@link LuaSpaceConnectionPrototype::to | runtime:LuaSpaceConnectionPrototype::to}.
+     */
+    distance?: double;
     /**
      * The force of this space platform.
      */
@@ -16111,10 +16528,18 @@ interface LuaSpacePlatform {
      * Returns how many ticks are left before the platform will be deleted. 0 if not scheduled for deletion.
      */
     readonly scheduled_for_deletion: uint;
+    /**
+     * The space connection this space platform is traveling through or `nil`.
+     *
+     * Write operation requires a valid space connection and it sets the distance to 0.5.
+     */
+    space_connection?: LuaSpaceConnectionPrototype;
     /**
      * The space location this space platform is stopped at or `nil`.
+     *
+     * Write operation requires a valid space location and will cancel pending item requests.
      */
-    readonly space_location?: LuaSpaceLocationPrototype;
+    space_location?: LuaSpaceLocationPrototype;
     speed: double;
     /**
      * The starter pack used to create this space platform.
@@ -17016,7 +17441,7 @@ interface LuaSurface {
      *
      * The sound is not played if its location is not {@link charted | runtime:LuaForce::chart} for that player.
      * @param table.path The sound to play.
-     * @param table.position Where the sound should be played. If not given, it's played at the current position of each player.
+     * @param table.position Where the sound should be played. If not given, it's played globally on this surface.
      * @param table.volume_modifier The volume of the sound to play. Must be between 0 and 1 inclusive.
      * @param table.override_sound_type The volume mixer to play the sound through. Defaults to the default mixer for the given sound type.
      */
@@ -17815,6 +18240,10 @@ interface LuaSurfacePropertyPrototype extends LuaPrototypeBase {
  * Prototype of a surface.
  */
 interface LuaSurfacePrototype extends LuaPrototypeBase {
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaSurfacePrototype;
     /**
      * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
      */
@@ -17934,6 +18363,10 @@ interface LuaTechnologyPrototype extends LuaPrototypeBase {
      * If this technology prototype is essential, meaning it is shown in the condensed technology graph.
      */
     readonly essential: boolean;
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaTechnologyPrototype;
     /**
      * If this technology ignores the technology cost multiplier setting.
      *
@@ -18109,6 +18542,10 @@ interface LuaTilePrototype extends LuaPrototypeBase {
     readonly default_cover_tile?: LuaTilePrototype;
     readonly default_destroyed_dropped_item_trigger?: TriggerItem[];
     readonly destroys_dropped_items?: boolean;
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaTilePrototype;
     /**
      * The fluid offshore pump produces on this tile, if any.
      */
@@ -18207,6 +18644,7 @@ interface LuaTrain {
      * Gets all rails under the train.
      */
     get_rails(this: void): LuaEntity[];
+    get_schedule(this: void): LuaSchedule;
     /**
      * Go to the station specified by the index in the train's schedule.
      */
@@ -18522,6 +18960,13 @@ interface LuaTransportLine {
      * Remove all items from this transport line.
      */
     clear(this: void): void;
+    /**
+     * Force insert item at a given position. Inserts item onto a transport line. If a position is out of range, it is clamped to a closest valid position on the transport line. Item will be inserted regardless of other items nearby, possibly forcing items to become squashed.
+     * @param position Where on the line to insert the items.
+     * @param items Items to insert.
+     * @param belt_stack_size Maximum size of stack created on belt
+     */
+    force_insert_at(this: void, position: float, items: ItemStackIdentification, belt_stack_size?: uint8): void;
     /**
      * Get counts of all items on this line, similar to how {@link LuaInventory::get_contents | runtime:LuaInventory::get_contents} does.
      * @returns List of all items on this line.
@@ -18779,6 +19224,10 @@ interface LuaUndoRedoStack {
  * Prototype of a virtual signal.
  */
 interface LuaVirtualSignalPrototype extends LuaPrototypeBase {
+    /**
+     * An alternative prototype that will be used to display info about this prototype in Factoriopedia.
+     */
+    readonly factoriopedia_alternative?: LuaVirtualSignalPrototype;
     /**
      * The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.
      */