LuaEquipmentPrototype
Prototype of a modular equipment.
The result item when taking this equipment out of an equipment grid.
The max power generated by this equipment.
The energy per shield point restored.
The logistic parameters for this roboport equipment.
The energy source prototype for the equipment.
Category names for this equipment.
The burner energy source prototype this equipment uses or nil
.
The electric energy source prototype this equipment uses or nil
.
The background color of this equipment prototype.
The equipment attack parameters or nil
.
The class name of this object.
help
()
→ string
All methods and properties that this object supports.
name
:: string
[Read]
Name of this prototype.
type
:: string
[Read]
Type of this equipment prototype.
order
:: string
[Read]
Order string of this prototype.
localised_name
:: LocalisedString
[Read]
localised_description
:: LocalisedString
[Read]
shape
:: table
[Read]
Shape of this equipment prototype.
Only set when the shape is "manual"
take_result
:: LuaItemPrototype
[Read]
The result item when taking this equipment out of an equipment grid. nil
if there is no result item.
energy_production
:: double
[Read]
The max power generated by this equipment.
shield
:: float
[Read]
The shield value of this equipment. 0 for non-shield equipment.
energy_per_shield
:: double
[Read]
The energy per shield point restored. 0 for non-shield equipment.
logistic_parameters
:: table
[Read]
The logistic parameters for this roboport equipment.
Both the charging_station_shift
and stationing_offset
vectors are tables with x
and y
keys instead of an array.
energy_consumption
:: double
[Read]
movement_bonus
:: float
[Read]
energy_source
:: LuaElectricEnergySourcePrototype
[Read]
The energy source prototype for the equipment.
equipment_categories
:: array[string]
[Read]
Category names for this equipment. These categories will be used to determine whether this equipment is allowed in a particular equipment grid.
burner_prototype
:: LuaBurnerPrototype
[Read]
The burner energy source prototype this equipment uses or nil
.
electric_energy_source_prototype
:: LuaElectricEnergySourcePrototype
[Read]
The electric energy source prototype this equipment uses or nil
.
background_color
:: Color
[Read]
The background color of this equipment prototype.
attack_parameters
:: AttackParameters
[Read]
The equipment attack parameters or nil
.
automatic
:: boolean
[Read]
Is this active defense equipment automatic. Returns false if not active defense equipment.
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.