Factorio Runtime Docs

Class LuaEquipment

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

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

name [R] :: string

Name of this equipment.

Name of this equipment.

type [R] :: string

Type of this equipment.

Type 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 solar power generated.

Maximum solar power generated.

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
burner [R] :: LuaBurner?

The burner energy source for this equipment, if any.

The burner energy source for this equipment, if any.

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


type :: string Read

Type of this equipment.


position :: EquipmentPosition Read

Position of this equipment in the equipment grid.


shape :: table Read

Shape of this equipment.

Table fields

width :: uint
height :: uint

shield :: double Read/Write

Current shield value of the equipment.

Note

Can't be set higher than LuaEquipment::max_shield.


max_shield :: double Read

Maximum shield value.


max_solar_power :: double Read

Maximum solar power generated.


movement_bonus :: double Read

Movement speed bonus.


generator_power :: double Read

Energy generated per tick.


energy :: double Read/Write

Current available energy.


max_energy :: double Read

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


prototype :: LuaEquipmentPrototype Read


burner :: LuaBurner? Read

The burner energy source for this equipment, if any.


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

>|