Factorio API Docs

1.1.65 <>

Class LuaFluidPrototype

Prototype of a fluid.

help()
string

All methods and properties that this object supports.


:: string
[R]

Name of this prototype.




:: double
[R]

Default temperature of this fluid.


:: double
[R]

Maximum temperature this fluid can reach.


:: double
[R]

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


:: string
[R]

The string used to alphabetically sort these prototypes.


[R]

Group of this prototype.


[R]

Subgroup of this prototype.


:: Color
[R]

:: Color
[R]

:: double
[R]

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


:: double
[R]

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


:: double
[R]

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


:: boolean
[R]

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


:: 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

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

>|