mirror of
https://github.com/Xevion/project-cybersyn.git
synced 2025-12-08 02:08:12 -06:00
78 lines
3.5 KiB
Lua
78 lines
3.5 KiB
Lua
---@meta
|
|
---@diagnostic disable
|
|
|
|
--$Factorio 1.1.72
|
|
--$Overlay 5
|
|
--$Section LuaBurner
|
|
-- This file is automatically generated. Edits will be overwritten.
|
|
|
|
---A reference to the burner energy source owned by a specific [LuaEntity](https://lua-api.factorio.com/latest/LuaEntity.html) or [LuaEquipment](https://lua-api.factorio.com/latest/LuaEquipment.html).
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html)
|
|
---@class LuaBurner:LuaObject
|
|
---[R]
|
|
---The burnt result inventory.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.burnt_result_inventory)
|
|
---@field burnt_result_inventory LuaInventory
|
|
---[RW]
|
|
---The currently burning item.
|
|
---
|
|
---**Note:** Writing to this automatically handles correcting [LuaBurner::remaining_burning_fuel](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.remaining_burning_fuel).
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.currently_burning)
|
|
---@field currently_burning? LuaItemPrototype
|
|
---[R]
|
|
---The fuel categories this burner uses.
|
|
---
|
|
---**Note:** The value in the dictionary is meaningless and exists just to allow for easy lookup.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.fuel_categories)
|
|
---@field fuel_categories {[string]: boolean}
|
|
---[RW]
|
|
---The current heat (energy) stored in this burner.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.heat)
|
|
---@field heat double
|
|
---[R]
|
|
---The maximum heat (maximum energy) that this burner can store.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.heat_capacity)
|
|
---@field heat_capacity double
|
|
---[R]
|
|
---The fuel inventory.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.inventory)
|
|
---@field inventory LuaInventory
|
|
---[R]
|
|
---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.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.object_name)
|
|
---@field object_name string
|
|
---[R]
|
|
---The owner of this burner energy source
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.owner)
|
|
---@field owner LuaEntity|LuaEquipment
|
|
---[RW]
|
|
---The amount of energy left in the currently-burning fuel item.
|
|
---
|
|
---**Note:** Writing to this will silently do nothing if there's no [LuaBurner::currently_burning](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.currently_burning) set.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.remaining_burning_fuel)
|
|
---@field remaining_burning_fuel double
|
|
---[R]
|
|
---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.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.valid)
|
|
---@field valid boolean
|
|
local LuaBurner={
|
|
---All methods and properties that this object supports.
|
|
---
|
|
---[View documentation](https://lua-api.factorio.com/latest/LuaBurner.html#LuaBurner.help)
|
|
---@return string
|
|
help=function()end,
|
|
}
|
|
|
|
|