Prototype/RoboportEquipment

Prototype definitions » PrototypeBase » Prototype/Equipment » Prototype/RoboportEquipment

Prototype/RoboportEquipment — `roboport-equipment`
charge_approach_distance	::	float
charging_energy	::	Energy
construction_radius	::	float
recharging_animation	::	Animation
spawn_and_station_height	::	float
burner	::	EnergySource (optional)
charging_distance	::	float (optional)
charging_offsets	::	table of vector (optional)
charging_station_count	::	uint32 (optional)
charging_station_shift	::	vector (optional)
charging_threshold_distance	::	float (optional)
draw_construction_radius_visualization	::	bool (optional)
draw_logistic_radius_visualization	::	bool (optional)
power	::	Energy (optional)
recharging_light	::	LightDefinition (optional)
robot_limit	::	ItemCountType (optional)
robot_vertical_acceleration	::	float (optional)
robots_shrink_when_entering_and_exiting	::	bool (optional)
spawn_and_station_shadow_height_offset	::	float (optional)
spawn_minimum	::	Energy (optional)
stationing_offset	::	vector (optional)
Inherited from Prototype/Equipment
categories	::	table of string
energy_source	::	EnergySource
shape	::	EquipmentShape
sprite	::	Sprite
background_border_color	::	Color (optional)
background_color	::	Color (optional)
grabbed_background_color	::	Color (optional)
take_result	::	string (optional)
Inherited from PrototypeBase
name	::	string
type	::	string
localised_description	::	LocalisedString (optional)
localised_name	::	LocalisedString (optional)
order	::	Order (optional)

Mandatory properties

This prototype inherits all the properties from Prototype/Equipment.

recharging_animation

Type: Animation
The animation played at each charging point when a robot is charging there.

spawn_and_station_height

Type: float
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.

charge_approach_distance

Type: float
Presumably, the distance from the roboport at which robots will wait to charge.

construction_radius

Type: float
Can't be negative.

charging_energy

Type: Energy

Optional properties

spawn_and_station_shadow_height_offset

Type: float
Default: 0

draw_logistic_radius_visualization

Type: bool
Default: true

draw_construction_radius_visualization

Type: bool
Default: true

recharging_light

Type: LightDefinition
The light emitted when charging a robot.

charging_station_count

Type: uint32
Default: 0
How many charging points this roboport has. If this is 0, the length of the charging_offsets table is used to calculate the charging station count.

charging_distance

Type: float
Default: 0.0

charging_station_shift

Type: vector

charging_threshold_distance

Type: float
Default: 1.0
Distance in tiles. This defines how far away a robot can be from the charging spot and still be charged, however the bot is still required to reach a charging spot in the first place.

robot_vertical_acceleration

Type: float
Default: 0.01

stationing_offset

Type: vector
The offset from the center of the roboport at which robots will enter and exit.

robot_limit

Type: ItemCountType
Default: max uint
How many robots can exist in the network (cumulative).

robots_shrink_when_entering_and_exiting

Type: bool
Default: false

charging_offsets

Type: table of vector
The offsets from the center of the roboport at which robots will charge. Only used if charging_station_count is equal to 0.

spawn_minimum

Type: Energy
Default: 0.2 * energy_source.buffer_capacity
Minimum amount of energy that needs to available inside the roboport's buffer so that robots can be spawned.

burner

Type: EnergySource
Must be a burner energy source. Add this is if the roboport should be fueled directly instead of using power from the equipment grid.

power

Type: Energy
Mandatory if burner is present. The size of the buffer of the burner energy source, so effectively the amount of power that the energy source can produce per tick.