Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaBurner - Runtime Docs

## Class LuaBurner

A reference to the burner energy source owned by a specific LuaEntity or LuaEquipment.

## Members

owner | :: R LuaEntity or LuaEquipment | The owner of this burner energy source
The owner of this burner energy source
inventory | :: R LuaInventory | The fuel inventory.
The fuel inventory.
burnt_result_inventory | :: R LuaInventory | The burnt result inventory.
The burnt result inventory.
heat | :: RW double | The current heat (energy) stored in this burner.
The current heat (energy) stored in this burner.
heat_capacity | :: R double | The maximum heat (maximum energy) that this burner can store.
The maximum heat (maximum energy) that this burner can store.
remaining_burning_fuel | :: RW double | The amount of energy left in the currently-burning fuel item. [...]
The amount of energy left in the currently-burning fuel item. [...]
currently_burning | :: R ItemIDAndQualityIDPair| W ItemWithQualityID? | The currently burning item. [...]
The currently burning item. [...]
fuel_categories | :: R dictionary[string → `true`] | The fuel categories this burner uses. [...]
The fuel categories this burner uses. [...]
valid | :: R boolean | Is this object valid? [...]
Is this object valid? [...]
object_name | :: R string | The class name of this object. [...]
The class name of this object. [...]

## Attributes

### owner :: Read LuaEntity or LuaEquipment

The owner of this burner energy source

### inventory :: Read LuaInventory

The fuel inventory.

### burnt_result_inventory :: Read LuaInventory

The burnt result inventory.

### heat :: Read|Write double

The current heat (energy) stored in this burner.

### heat_capacity :: Read double

The maximum heat (maximum energy) that this burner can store.

### remaining_burning_fuel :: Read|Write double

The amount of energy left in the currently-burning fuel item.

Writing to this will silently do nothing if there's no LuaBurner::currently_burning set.

### currently_burning :: Read ItemIDAndQualityIDPair| Write ItemWithQualityID?

The currently burning item. Writing `nil` will void the currently burning item without producing a LuaBurner::burnt_result.

Writing to this automatically handles correcting LuaBurner::remaining_burning_fuel.

### fuel_categories :: Read dictionary[string → `true`]

The fuel categories this burner uses.

The value in the dictionary is meaningless and exists just to allow for easy lookup.

### valid :: Read 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.

### object_name :: Read string

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.

Class used in

- LuaEntity::burner
- LuaEquipment::burner