Prototype of a modular equipment.
help() | → string |
All methods and properties that this object supports. |
All methods and properties that this object supports. |
||
name [R] | :: string |
Name of this prototype. |
Name of this prototype. |
||
type [R] | :: string |
Type of this equipment prototype. |
Type of this equipment prototype. |
||
order [R] | :: string |
The string used to alphabetically sort these prototypes. |
The string used to alphabetically sort these prototypes. |
||
localised_name [R] | :: LocalisedString |
|
localised_description [R] | :: LocalisedString |
|
shape [R] | :: table |
Shape of this equipment prototype. |
Shape of this equipment prototype. |
||
take_result [R] | :: LuaItemPrototype? |
The result item when taking this equipment out of an equipment grid, if any. |
The result item when taking this equipment out of an equipment grid, if any. |
||
energy_production [R] | :: double |
The max power generated by this equipment. |
The max power generated by this equipment. |
||
shield [R] | :: float |
The shield value of this equipment. |
The shield value of this equipment. |
||
energy_per_shield [R] | :: double |
The energy per shield point restored. |
The energy per shield point restored. |
||
logistic_parameters [R] | :: table? |
The logistic parameters for this roboport equipment. |
The logistic parameters for this roboport equipment. |
||
energy_consumption [R] | :: double |
|
movement_bonus [R] | :: float? |
|
energy_source [R] | :: LuaElectricEnergySourcePrototype |
The energy source prototype for the equipment. |
The energy source prototype for the equipment. |
||
equipment_categories [R] | :: array[string] |
Category names for this equipment. |
Category names for this equipment. |
||
burner_prototype [R] | :: LuaBurnerPrototype? |
The burner energy source prototype this equipment uses, if any. |
The burner energy source prototype this equipment uses, if any. |
||
electric_energy_source_prototype [R] | :: LuaElectricEnergySourcePrototype? |
The electric energy source prototype this equipment uses, if any. |
The electric energy source prototype this equipment uses, if any. |
||
background_color [R] | :: Color |
The background color of this equipment prototype. |
The background color of this equipment prototype. |
||
attack_parameters [R] | :: AttackParameters? |
The equipment attack parameters. |
The equipment attack parameters. |
||
automatic [R] | :: boolean |
Whether this active defense equipment is automatic. |
Whether this active defense equipment is automatic. |
||
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. |
All methods and properties that this object supports.
Name of this prototype.
Type of this equipment prototype.
The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.
Shape of this equipment prototype.
width | :: uint |
|
height | :: uint |
|
points | :: array[EquipmentPoint]? |
Only set when the shape is "manual" |
Only set when the shape is "manual" |
The result item when taking this equipment out of an equipment grid, if any.
The max power generated by this equipment.
The shield value of this equipment. 0 for non-shield equipment.
The energy per shield point restored. 0 for non-shield equipment.
The logistic parameters for this roboport equipment.
spawn_and_station_height | :: float |
|
spawn_and_station_shadow_height_offset | :: float |
|
charge_approach_distance | :: float |
|
logistic_radius | :: float |
|
construction_radius | :: float |
|
charging_station_count | :: uint |
|
charging_distance | :: float |
|
charging_station_shift | :: Vector |
|
charging_energy | :: double |
|
charging_threshold_distance | :: float |
|
robot_vertical_acceleration | :: float |
|
stationing_offset | :: Vector |
|
robot_limit | :: uint |
|
logistics_connection_distance | :: float |
|
robots_shrink_when_entering_and_exiting | :: boolean |
|
Both the charging_station_shift
and stationing_offset
vectors are tables with x
and y
keys instead of an array.
The energy source prototype for the equipment.
Category names for this equipment. These categories will be used to determine whether this equipment is allowed in a particular equipment grid.
The burner energy source prototype this equipment uses, if any.
The electric energy source prototype this equipment uses, if any.
The background color of this equipment prototype.
The equipment attack parameters.
Whether this active defense equipment is automatic. Returns false if not active defense equipment.
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.
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.