LuaEquipmentPrototype

Prototype of a modular equipment.

Parent

• LuaPrototypeBase

Attributes

shape

• Read: { height: uint32, points?: Array<EquipmentPoint>, width: uint32 }
• Write: unknown
• Optional: false

Shape of this equipment prototype.

take_result

• Read: LuaItemPrototype
• Write: unknown
• Optional: true

The result item when taking this equipment out of an equipment grid, if any.

energy_production

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

The max power generated by this equipment.

energy_per_shield

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

The energy per shield point restored. 0 for non-shield equipment.

logistic_parameters

• Read: { charge_approach_distance: float, charging_distance: float, charging_energy: double, charging_station_count: uint32, charging_station_shift: Vector, charging_threshold_distance: float, construction_radius: float, logistic_radius: float, logistics_connection_distance: float, robot_limit: uint32, robot_vertical_acceleration: float, robots_shrink_when_entering_and_exiting: boolean, spawn_and_station_height: float, spawn_and_station_shadow_height_offset: float, stationing_offset: Vector, stationing_render_layer_swap_height: float }
• Write: unknown
• Optional: true

The logistic parameters for this roboport equipment.

energy_source

• Read: LuaElectricEnergySourcePrototype
• Write: unknown
• Optional: false

The energy source prototype for the equipment.

equipment_categories

• Read: Array<string>
• Write: unknown
• Optional: false

Category names for this equipment. These categories will be used to determine whether this equipment is allowed in a particular equipment grid.

burner_prototype

• Read: LuaBurnerPrototype
• Write: unknown
• Optional: true

The burner energy source prototype this equipment uses, if any.

electric_energy_source_prototype

• Read: LuaElectricEnergySourcePrototype
• Write: unknown
• Optional: true

The electric energy source prototype this equipment uses, if any.

background_color

• Read: Color
• Write: unknown
• Optional: false

The background color of this equipment prototype.

attack_parameters

• Read: AttackParameters
• Write: unknown
• Optional: true

The equipment attack parameters.

automatic

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

Whether this active defense equipment is automatic. Returns false if not active defense equipment.

solar_panel_performance_at_day

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

solar_panel_performance_at_night

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

solar_panel_solar_coefficient_property

• Read: LuaSurfacePropertyPrototype
• Write: unknown
• Optional: false

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.

Methods

get_shield

LuaEquipmentPrototype.get_shield(quality?: QualityID) -> float

Call As

equipmentPrototype.get_shield()

Call Convention

• takes_table: false
• table_optional: false

The shield value of this equipment. 0 for non-shield equipment.

Parameters

• quality?: QualityID

Returns

• float

get_energy_consumption

LuaEquipmentPrototype.get_energy_consumption(quality?: QualityID) -> double

Call As

equipmentPrototype.get_energy_consumption()

Call Convention

• takes_table: false
• table_optional: false

Parameters

• quality?: QualityID

Returns

• double

get_inventory_bonus

LuaEquipmentPrototype.get_inventory_bonus(quality?: QualityID) -> uint32?

Call As

equipmentPrototype.get_inventory_bonus()

Call Convention

• takes_table: false
• table_optional: false

Parameters

• quality?: QualityID

Returns

• uint32?

get_movement_bonus

LuaEquipmentPrototype.get_movement_bonus(quality?: QualityID) -> float?

Call As

equipmentPrototype.get_movement_bonus()

Call Convention

• takes_table: false
• table_optional: false

Parameters

• quality?: QualityID

Returns

• float?