RoboportEquipmentPrototype - Prototype Docs

Home / Prototypes / RoboportEquipmentPrototype><

RoboportEquipmentPrototype 'roboport-equipment' changed

Inherits from EquipmentPrototype « Prototype « PrototypeBase

Properties

recharging_animation optional	:: Animation	The animation played at each charging point when a robot is charging there.
The animation played at each charging point when a robot is charging there.
spawn_and_station_height	:: float	Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.
charge_approach_distance	:: float	Presumably, the distance from the roboport at which robots will wait to charge.
Presumably, the distance from the roboport at which robots will wait to charge.
construction_radius	:: float	Can't be negative.
Can't be negative.
charging_energy	:: Energy
spawn_and_station_shadow_height_offset optional	:: float
stationing_render_layer_swap_heightnew optional	:: float	When robot ascends or descends to this roboport, at which height is should switch between `"air-object"` and `"object"` render layer.
When robot ascends or descends to this roboport, at which height is should switch between `"air-object"` and `"object"` render layer.
draw_logistic_radius_visualization optional	:: bool	Unused, as roboport equipment does not have a logistic radius that could be drawn.
Unused, as roboport equipment does not have a logistic radius that could be drawn.
draw_construction_radius_visualization optional	:: bool
recharging_light optional	:: LightDefinition	The light emitted when charging a robot.
The light emitted when charging a robot.
charging_station_count optional	:: uint32	How many charging points this roboport has. [...]
How many charging points this roboport has. [...]
charging_station_count_affected_by_qualitynew optional	:: bool
charging_distance optional	:: float
charging_station_shift optional	:: Vector
charging_threshold_distance optional	:: float	Distance in tiles. [...]
Distance in tiles. [...]
robot_vertical_acceleration optional	:: float
stationing_offset optional	:: Vector	The offset from the center of the roboport at which robots will enter and exit.
The offset from the center of the roboport at which robots will enter and exit.
robot_limit optional	:: ItemCountType	How many robots can exist in the network (cumulative).
How many robots can exist in the network (cumulative).
robots_shrink_when_entering_and_exiting optional	:: bool
charging_offsets optional	:: array[Vector]	The offsets from the center of the roboport at which robots will charge. [...]
The offsets from the center of the roboport at which robots will charge. [...]
spawn_minimum optional	:: Energy	Minimum amount of energy that needs to available inside the roboport's buffer so that robots can be spawned.
Minimum amount of energy that needs to available inside the roboport's buffer so that robots can be spawned.
burner optional	:: BurnerEnergySource	Add this is if the roboport should be fueled directly instead of using power from the equipment grid.
Add this is if the roboport should be fueled directly instead of using power from the equipment grid.
power optional	:: Energy	Mandatory if `burner` is defined. [...]
Mandatory if `burner` is defined. [...]

Inherited from EquipmentPrototype

sprite	:: Sprite	The graphics to use when this equipment is shown inside an equipment grid.
The graphics to use when this equipment is shown inside an equipment grid.
shape	:: EquipmentShape	How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.
How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.
categories	:: array[EquipmentCategoryID]	Sets the categories of the equipment. [...]
Sets the categories of the equipment. [...]
energy_source	:: ElectricEnergySource
take_result optional	:: ItemID	Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.
Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.
background_color optional	:: Color	The color that the background of this equipment should have when shown inside an equipment grid.
The color that the background of this equipment should have when shown inside an equipment grid.
background_border_color optional	:: Color	The color that the border of the background of this equipment should have when shown inside an equipment grid.
The color that the border of the background of this equipment should have when shown inside an equipment grid.
grabbed_background_color optional	:: Color	The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.
The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.

Inherited from Prototype

factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_descriptionnew optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroupnew optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.
hiddennew optional	:: bool
hidden_in_factoriopedianew optional	:: bool
parameternew optional	:: bool	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulationnew optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

charge_approach_distance	:: float	Presumably, the distance from the roboport at which robots will wait to charge.
Presumably, the distance from the roboport at which robots will wait to charge.
charging_energy	:: Energy
construction_radius	:: float	Can't be negative.
Can't be negative.
spawn_and_station_height	:: float	Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.
burner optional	:: BurnerEnergySource	Add this is if the roboport should be fueled directly instead of using power from the equipment grid.
Add this is if the roboport should be fueled directly instead of using power from the equipment grid.
charging_distance optional	:: float
charging_offsets optional	:: array[Vector]	The offsets from the center of the roboport at which robots will charge. [...]
The offsets from the center of the roboport at which robots will charge. [...]
charging_station_count optional	:: uint32	How many charging points this roboport has. [...]
How many charging points this roboport has. [...]
charging_station_count_affected_by_qualitynew optional	:: bool
charging_station_shift optional	:: Vector
charging_threshold_distance optional	:: float	Distance in tiles. [...]
Distance in tiles. [...]
draw_construction_radius_visualization optional	:: bool
draw_logistic_radius_visualization optional	:: bool	Unused, as roboport equipment does not have a logistic radius that could be drawn.
Unused, as roboport equipment does not have a logistic radius that could be drawn.
power optional	:: Energy	Mandatory if `burner` is defined. [...]
Mandatory if `burner` is defined. [...]
recharging_animation optional	:: Animation	The animation played at each charging point when a robot is charging there.
The animation played at each charging point when a robot is charging there.
recharging_light optional	:: LightDefinition	The light emitted when charging a robot.
The light emitted when charging a robot.
robot_limit optional	:: ItemCountType	How many robots can exist in the network (cumulative).
How many robots can exist in the network (cumulative).
robot_vertical_acceleration optional	:: float
robots_shrink_when_entering_and_exiting optional	:: bool
spawn_and_station_shadow_height_offset optional	:: float
spawn_minimum optional	:: Energy	Minimum amount of energy that needs to available inside the roboport's buffer so that robots can be spawned.
Minimum amount of energy that needs to available inside the roboport's buffer so that robots can be spawned.
stationing_offset optional	:: Vector	The offset from the center of the roboport at which robots will enter and exit.
The offset from the center of the roboport at which robots will enter and exit.
stationing_render_layer_swap_heightnew optional	:: float	When robot ascends or descends to this roboport, at which height is should switch between `"air-object"` and `"object"` render layer.
When robot ascends or descends to this roboport, at which height is should switch between `"air-object"` and `"object"` render layer.

Inherited from EquipmentPrototype

categories	:: array[EquipmentCategoryID]	Sets the categories of the equipment. [...]
Sets the categories of the equipment. [...]
energy_source	:: ElectricEnergySource
shape	:: EquipmentShape	How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.
How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.
sprite	:: Sprite	The graphics to use when this equipment is shown inside an equipment grid.
The graphics to use when this equipment is shown inside an equipment grid.
background_border_color optional	:: Color	The color that the border of the background of this equipment should have when shown inside an equipment grid.
The color that the border of the background of this equipment should have when shown inside an equipment grid.
background_color optional	:: Color	The color that the background of this equipment should have when shown inside an equipment grid.
The color that the background of this equipment should have when shown inside an equipment grid.
grabbed_background_color optional	:: Color	The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.
The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.
take_result optional	:: ItemID	Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.
Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.

Inherited from Prototype

factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
factoriopedia_descriptionnew optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulationnew optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.
hiddennew optional	:: bool
hidden_in_factoriopedianew optional	:: bool
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
parameternew optional	:: bool	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
subgroupnew optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.

Properties

recharging_animation :: Animation optional

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

spawn_and_station_height :: float

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

charge_approach_distance :: float

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

construction_radius :: float

Can't be negative.

charging_energy :: Energy

Example

charging_energy = "1000kW"

spawn_and_station_shadow_height_offset :: float optional

Default: 0

stationing_render_layer_swap_height :: float optional new

Default: 0.87

When robot ascends or descends to this roboport, at which height is should switch between "air-object" and "object" render layer.

draw_logistic_radius_visualization :: bool optional

Default: true

Unused, as roboport equipment does not have a logistic radius that could be drawn.

draw_construction_radius_visualization :: bool optional

Default: true

recharging_light :: LightDefinition optional

The light emitted when charging a robot.

charging_station_count :: uint32 optional

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_station_count_affected_by_quality :: bool optional new

Default: false

charging_distance :: float optional

Default: 0.0

charging_station_shift :: Vector optional

charging_threshold_distance :: float optional

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 :: float optional

Default: 0.01

stationing_offset :: Vector optional

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

robot_limit :: ItemCountType optional

Default: max uint

How many robots can exist in the network (cumulative).

robots_shrink_when_entering_and_exiting :: bool optional

Default: false

charging_offsets :: array[Vector] optional

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 :: Energy optional

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 :: BurnerEnergySource optional

Add this is if the roboport should be fueled directly instead of using power from the equipment grid.

power :: Energy optional

Mandatory if burner is defined.

The size of the buffer of the burner energy source, so effectively the amount of power that the energy source can produce per tick.

Factorio Prototype Docs Version 2.0.19

RoboportEquipmentPrototype 'roboport-equipment' changed

Properties

Properties

recharging_animation :: Animation optional

spawn_and_station_height :: float

charge_approach_distance :: float

construction_radius :: float

charging_energy :: Energy

Example

spawn_and_station_shadow_height_offset :: float optional

stationing_render_layer_swap_height :: float optional new

draw_logistic_radius_visualization :: bool optional

draw_construction_radius_visualization :: bool optional

recharging_light :: LightDefinition optional

charging_station_count :: uint32 optional

charging_station_count_affected_by_quality :: bool optional new

charging_distance :: float optional

charging_station_shift :: Vector optional

charging_threshold_distance :: float optional

robot_vertical_acceleration :: float optional

stationing_offset :: Vector optional

robot_limit :: ItemCountType optional

robots_shrink_when_entering_and_exiting :: bool optional

charging_offsets :: array[Vector] optional

spawn_minimum :: Energy optional

burner :: BurnerEnergySource optional

power :: Energy optional

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.0.19

RoboportEquipmentPrototype 'roboport-equipment' changed

Properties

Properties

recharging_animation :: Animation optional

spawn_and_station_height :: float

charge_approach_distance :: float

construction_radius :: float

charging_energy :: Energy

Example

spawn_and_station_shadow_height_offset :: float optional

stationing_render_layer_swap_height :: float optional new

draw_logistic_radius_visualization :: bool optional

draw_construction_radius_visualization :: bool optional

recharging_light :: LightDefinition optional

charging_station_count :: uint32 optional

charging_station_count_affected_by_quality :: bool optional new

charging_distance :: float optional

charging_station_shift :: Vector optional

charging_threshold_distance :: float optional

robot_vertical_acceleration :: float optional

stationing_offset :: Vector optional

robot_limit :: ItemCountType optional

robots_shrink_when_entering_and_exiting :: bool optional

charging_offsets :: array[Vector] optional

spawn_minimum :: Energy optional

burner :: BurnerEnergySource optional

power :: Energy optional

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.19