Factorio API Docs

1.1.64 <>

Class LuaBurner

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

help()
string

All methods and properties that this object supports.


[R]

The owner of this burner energy source


[R]

The fuel inventory.


[R]

The burnt result inventory.


:: double
[RW]

The current heat (energy) stored in this burner.


:: double
[R]

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


:: double
[RW]

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


[RW]

The currently burning item.


:: dictionary[stringboolean]
[R]

The fuel categories this burner uses.


:: boolean
[R]

Is this object valid?


:: string
[R]

The class name of this object.

Methods

help() → string

All methods and properties that this object supports.

Attributes

owner :: LuaEntity or LuaEquipment [Read]

The owner of this burner energy source


inventory :: LuaInventory [Read]

The fuel inventory.


burnt_result_inventory :: LuaInventory [Read]

The burnt result inventory.


heat :: double [Read/Write]

The current heat (energy) stored in this burner.


heat_capacity :: double [Read]

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


remaining_burning_fuel :: double [Read/Write]

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 set.


currently_burning :: LuaItemPrototype? [Read/Write]

The currently burning item.

Note

Writing to this automatically handles correcting LuaBurner::remaining_burning_fuel.


fuel_categories :: dictionary[stringboolean] [Read]

The fuel categories this burner uses.

Note

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


valid :: boolean [Read]

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 :: string [Read]

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.

|<

Classes

Events

Concepts

Defines

Builtin types

>|