Factorio Runtime Docs

Class LuaFluidPrototype

Prototype of a fluid.

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

name [R] :: string

Name of this prototype.

Name of this prototype.

localised_name [R] :: LocalisedString
localised_description [R] :: LocalisedString
default_temperature [R] :: double

Default temperature of this fluid.

Default temperature of this fluid.

max_temperature [R] :: double

Maximum temperature this fluid can reach.

Maximum temperature this fluid can reach.

heat_capacity [R] :: double

The amount of energy in Joules required to heat one unit of this fluid by 1°C.

The amount of energy in Joules required to heat one unit of this fluid by 1°C.

order [R] :: string

The string used to alphabetically sort these prototypes.

The string used to alphabetically sort these prototypes.

group [R] :: LuaGroup

Group of this prototype.

Group of this prototype.

subgroup [R] :: LuaGroup

Subgroup of this prototype.

Subgroup of this prototype.

base_color [R] :: Color
flow_color [R] :: Color
gas_temperature [R] :: double

The temperature above which this fluid will be shown as gaseous inside tanks and pipes.

The temperature above which this fluid will be shown as gaseous inside tanks and pipes.

emissions_multiplier [R] :: double

A multiplier on the amount of emissions produced when this fluid is burnt in a generator.

A multiplier on the amount of emissions produced when this fluid is burnt in a generator.

fuel_value [R] :: double

The amount of energy in Joules one unit of this fluid will produce when burnt in a generator.

The amount of energy in Joules one unit of this fluid will produce when burnt in a generator.

hidden [R] :: boolean

Whether this fluid is hidden from the fluid and signal selectors.

Whether this fluid is hidden from the fluid and signal selectors.

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.

Methods

help()  → string

All methods and properties that this object supports.

Attributes

name :: string Read

Name of this prototype.


localised_name :: LocalisedString Read


localised_description :: LocalisedString Read


default_temperature :: double Read

Default temperature of this fluid.


max_temperature :: double Read

Maximum temperature this fluid can reach.


heat_capacity :: double Read

The amount of energy in Joules required to heat one unit of this fluid by 1°C.


order :: string Read

The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.


group :: LuaGroup Read

Group of this prototype.


subgroup :: LuaGroup Read

Subgroup of this prototype.


base_color :: Color Read


flow_color :: Color Read


gas_temperature :: double Read

The temperature above which this fluid will be shown as gaseous inside tanks and pipes.


emissions_multiplier :: double Read

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.


fuel_value :: double Read

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.


hidden :: boolean Read

Whether this fluid is hidden from the fluid and signal selectors.


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

>|