api update

This commit is contained in:
Monica Moniot
2022-10-28 14:40:49 -04:00
parent 4887e3925d
commit d2bb9e2523
113 changed files with 432 additions and 222 deletions

View File

@@ -1,7 +1,7 @@
---@meta
---@diagnostic disable
--$Factorio 1.1.69
--$Factorio 1.1.70
--$Overlay 5
--$Section LuaSurface
-- This file is automatically generated. Edits will be overwritten.
@@ -175,19 +175,19 @@ build_enemy_base=function(position,unit_count,force)end,
calculate_tile_properties=function(property_names,positions)end,
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_fast_replace)
---@class LuaSurface.can_fast_replace_param
---Name of the entity to check
---Name of the entity to check.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_fast_replace)
---@field name string
---Where the entity would be placed
---Where the entity would be placed.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_fast_replace)
---@field position MapPosition
---Direction the entity would be placed
---Direction the entity would be placed. Defaults to `north`.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_fast_replace)
---@field direction? defines.direction
---The force that would place the entity. If not specified, the enemy force is assumed.
---The force that would place the entity. Defaults to the `"neutral"` force.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_fast_replace)
---@field force? ForceIdentification
@@ -209,19 +209,19 @@ can_fast_replace=function(param)end,
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_place_entity)
---@field position MapPosition
---Direction of the placed entity.
---Direction of the placed entity. Defaults to `north`.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_place_entity)
---@field direction? defines.direction
---The force that would place the entity. If not specified, the enemy force is assumed.
---The force that would place the entity. Defaults to the `"neutral"` force.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_place_entity)
---@field force? ForceIdentification
---Which type of check should be carried out.
---Which type of check should be carried out. Defaults to `ghost_revive`.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_place_entity)
---@field build_check_type? defines.build_check_type
---If `true`, entities that can be marked for deconstruction are ignored. Only used if `build_check_type` is either `manual_ghost`, `script_ghost` or `blueprint_ghost`.
---If `true`, entities that can be marked for deconstruction are ignored. Only used if `build_check_type` is either `manual_ghost`, `script_ghost` or `blueprint_ghost`. Defaults to `false`.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.can_place_entity)
---@field forced? boolean
@@ -630,11 +630,17 @@ create_decoratives=function(param)end,
---Applies to **"beam"**: (optional)
---Absolute target position that can be used instead of target entity (entity has precedence if both entity and position are defined).
---
---Applies to **"stream"**: (optional)
---Absolute target position that can be used instead of target entity (entity has precedence if both entity and position are defined).
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity)
---@field target_position? MapPosition
---Applies to **"beam"**: (optional)
---Absolute source position that can be used instead of source entity (entity has precedence if both entity and position are defined).
---
---Applies to **"stream"**: (optional)
---Absolute source position that can be used instead of source entity (entity has precedence if both entity and position are defined).
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity)
---@field source_position? MapPosition
---Applies to **"beam"**: (optional)
@@ -650,6 +656,9 @@ create_decoratives=function(param)end,
---Applies to **"beam"**: (optional)
---Source position will be offset by this value when rendering the beam.
---
---Applies to **"stream"**: (optional)
---Source position will be offset by this value when rendering the stream.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity)
---@field source_offset? Vector
---Applies to **"container"**: (optional)
@@ -761,12 +770,16 @@ create_decoratives=function(param)end,
---@field frame_speed float
---Applies to **"projectile"**: (required)
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity)
---@field speed double
---Applies to **"projectile"**: (required)
---Applies to **"artillery-projectile"**: (required)
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity)
---@field max_range double
---@field speed double
---Applies to **"projectile"**: (optional)
---
---Applies to **"artillery-projectile"**: (optional)
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity)
---@field max_range? double
---Applies to **"resource"**: (required)
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.create_entity)
@@ -1435,9 +1448,9 @@ get_script_positions=function(name)end,
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_starting_area_radius)
---@return double
get_starting_area_radius=function()end,
---Get the tile at a given position.
---Get the tile at a given position. An alternative call signature for this method is passing it a single [TilePosition](https://lua-api.factorio.com/latest/Concepts.html#TilePosition).
---
---**Note:** The input position params can also be a single tile position.
---**Note:** Non-integer values will result in them being rounded down.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_tile)
---@param x int
@@ -1451,8 +1464,12 @@ get_tile=function(x,y)end,
get_total_pollution=function()end,
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_train_stops)
---@class LuaSurface.get_train_stops_param
---The name(s) of the train stops. Not providing names will match any stop.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_train_stops)
---@field name? string|string[]
---The force to search. Not providing a force will match stops in any force.
---
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_train_stops)
---@field force? ForceIdentification
@@ -1464,7 +1481,7 @@ get_total_pollution=function()end,
---@return LuaEntity[]
get_train_stops=function(param)end,
---[View documentation](https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.get_trains)
---@param force ForceIdentification?@If given only trains matching this force are returned.
---@param force ForceIdentification?@The force to search. Not providing a force will match trains in any force.
---@return LuaTrain[]
get_trains=function(force)end,
---All methods and properties that this object supports.