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.

Attributes

name

• Read: string
• Write: unknown
• Optional: false

Name of this equipment.

ghost_name

• Read: string
• Write: unknown
• Optional: false

Name of the equipment contained in this ghost

type

• Read: string
• Write: unknown
• Optional: false

Type of this equipment.

ghost_type

• Read: string
• Write: unknown
• Optional: false

Type of the equipment contained in this ghost.

quality

• Read: LuaQualityPrototype
• Write: unknown
• Optional: false

Quality of this equipment.

position

• Read: EquipmentPosition
• Write: unknown
• Optional: false

Position of this equipment in the equipment grid.

shape

• Read: { height: uint32, width: uint32 }
• Write: unknown
• Optional: false

Shape of this equipment.

shield

• Read: double
• Write: double
• Optional: false

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
• Write: unknown
• Optional: false

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

max_solar_power

• Read: double
• Write: unknown
• Optional: false

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

inventory_bonus

• Read: uint32
• Write: unknown
• Optional: false

Inventory size bonus.

movement_bonus

• Read: double
• Write: unknown
• Optional: false

Movement speed bonus.

generator_power

• Read: double
• Write: unknown
• Optional: false

Energy generated per tick.

energy

• Read: double
• Write: double
• Optional: false

Current available energy.

max_energy

• Read: double
• Write: unknown
• Optional: false

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

prototype

• Read: LuaEquipmentPrototype
• Write: unknown
• Optional: false

ghost_prototype

• Read: LuaEquipmentPrototype
• Write: unknown
• Optional: false

The prototype of the equipment contained in this ghost.

burner

• Read: LuaBurner
• Write: unknown
• Optional: true

The burner energy source for this equipment, if any.

to_be_removed

• Read: boolean
• Write: unknown
• Optional: false

If this equipment is marked to be removed.

valid

• Read: boolean
• Write: unknown
• Optional: false

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
• Write: unknown
• Optional: false

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.