Factorio Runtime DocsVersion 2.0.55

ClassLuaEquipment

An item in a LuaEquipmentGrid, for example a fusion reactor placed in one's power armor.

An equipment reference becomes invalid once the equipment is removed or the equipment grid it resides in is destroyed.

Members

name :: R string

Name of this equipment.

Name of this equipment.

ghost_name :: R string

Name of the equipment contained in this ghost

Name of the equipment contained in this ghost

type :: R string

Type of this equipment.

Type of this equipment.

ghost_type :: R string

Type of the equipment contained in this ghost.

Type of the equipment contained in this ghost.

quality :: R LuaQualityPrototype

Quality of this equipment.

Quality of this equipment.

position :: R EquipmentPosition

Position of this equipment in the equipment grid.

Position of this equipment in the equipment grid.

shape :: R table

Shape of this equipment.

Shape of this equipment.

shield :: RW double

Current shield value of the equipment. [...]

Current shield value of the equipment. [...]

max_shield :: R double

Maximum shield value. [...]

Maximum shield value. [...]

max_solar_power :: R double

Maximum energy per tick crated by this equipment on the current surface. [...]

Maximum energy per tick crated by this equipment on the current surface. [...]

inventory_bonus :: R uint

Inventory size bonus.

Inventory size bonus.

movement_bonus :: R double

Movement speed bonus.

Movement speed bonus.

generator_power :: R double

Energy generated per tick.

Energy generated per tick.

energy :: RW double

Current available energy.

Current available energy.

max_energy :: R double

Maximum amount of energy that can be stored in this equipment.

Maximum amount of energy that can be stored in this equipment.

prototype :: R LuaEquipmentPrototype
ghost_prototype :: R LuaEquipmentPrototype

The prototype of the equipment contained in this ghost.

The prototype of the equipment contained in this ghost.

burner :: R LuaBurner?

The burner energy source for this equipment, if any.

The burner energy source for this equipment, if any.

to_be_removed :: R boolean

If this equipment is marked to be removed.

If this equipment is marked to be removed.

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

name :: Read string  

Name of this equipment.


ghost_name :: Read string  

Name of the equipment contained in this ghost

Can only be used if this is Ghost

type :: Read string  

Type of this equipment.


ghost_type :: Read string  

Type of the equipment contained in this ghost.

Can only be used if this is Ghost

quality :: Read LuaQualityPrototype  

Quality of this equipment.


position :: Read EquipmentPosition  

Position of this equipment in the equipment grid.


shape :: Read table  

Shape of this equipment.

Table fields

width :: uint
height :: uint


shield :: Read|Write double  

Current shield value of the equipment. Can't be set higher than LuaEquipment::max_shield.

Trying to write this value on non-shield equipment will throw an error.


max_shield :: Read double  

Maximum shield value. 0 if this equipment doesn't have a shield.


max_solar_power :: Read double  

Maximum energy per tick crated by this equipment on the current surface. Actual generated energy varies depending on the daylight levels.


inventory_bonus :: Read uint  

Inventory size bonus.


movement_bonus :: Read double  

Movement speed bonus.


generator_power :: Read double  

Energy generated per tick.


energy :: Read|Write double  

Current available energy.


max_energy :: Read double  

Maximum amount of energy that can be stored in this equipment.


prototype :: Read LuaEquipmentPrototype  


ghost_prototype :: Read LuaEquipmentPrototype  

The prototype of the equipment contained in this ghost.

Can only be used if this is Ghost

burner :: Read LuaBurner  ?

The burner energy source for this equipment, if any.


to_be_removed :: Read boolean  

If this equipment is marked to be removed.


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.

Classes

Concepts

Events

Defines