Prototype/Roboport: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.17.51)
(Removed old prototype docs)
Tag: Replaced
 
(19 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Basics ==
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/RoboportPrototype.html https://lua-api.factorio.com/latest/prototypes/RoboportPrototype.html]
Prototype type: '''roboport'''


A [[roboport]]. Based on [[Prototype/EntityWithHealth]].
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
 
=== energy_source ===
'''Type''': [[Types/EnergySource]]
 
The roboport's energy source. Must be an electric or void energy source.
 
=== energy_usage ===
'''Type''': [[Types/Energy]]
 
The amount of energy the roboport uses when idle.
 
=== recharge_minimum ===
'''Type''': [[Types/Energy]]
 
=== robot_slots_count ===
'''Type''': [[Types/ItemStackIndex]]
 
The number of robot slots in the roboport.
 
=== material_slots_count ===
'''Type''': [[Types/ItemStackIndex]]
 
The number of repair pack slots in the roboport.
 
=== base ===
'''Type''': [[Types/Sprite]]
 
=== base_patch ===
'''Type''': [[Types/Sprite]]
 
=== base_animation ===
'''Type''': [[Types/Animation]]
 
The animation played when the roboport is idle.
 
=== door_animation_up ===
'''Type''': [[Types/Animation]]
 
=== door_animation_down ===
'''Type''': [[Types/Animation]]
 
=== request_to_open_door_timeout ===
'''Type''': [[Types/uint32]]
 
=== recharging_animation ===
'''Type''': [[Types/Animation]]
 
The animation played at each charging point when a robot is charging there.
 
=== spawn_and_station_height ===
'''Type''': [[Types/float]]
 
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.
 
=== charge_approach_distance ===
'''Type''': [[Types/float]]
 
Presumably, the distance from the roboport at which robots will wait to charge.
 
=== logistics_radius ===
'''Type''': [[Types/float]]
 
Can't be negative.
 
=== construction_radius ===
'''Type''': [[Types/float]]
 
Can't be negative.
 
=== charging_energy ===
'''Type''': [[Types/Energy]]
 
The amount of energy that is given to a robot per tick.
 
== Optional properties ==
 
=== open_door_trigger_effect ===
'''Type''': [[Types/TriggerEffect]]
 
=== close_door_trigger_effect ===
'''Type''': [[Types/TriggerEffect]]
 
=== default_available_logistic_output_signal ===
'''Type''': [[Types/SignalIDConnector]]
 
=== default_total_logistic_output_signal ===
'''Type''': [[Types/SignalIDConnector]]
 
=== default_available_construction_output_signal ===
'''Type''': [[Types/SignalIDConnector]]
 
=== default_total_construction_output_signal ===
'''Type''': [[Types/SignalIDConnector]]
 
=== circuit_wire_connection_point ===
'''Type''': [[Types/WireConnectionPoint]]
 
=== circuit_wire_max_distance ===
'''Type''': [[Types/double]]
 
'''Default''': 0
 
The maximum circuit wire distance for this entity.
 
=== draw_copper_wires ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== draw_circuit_wires ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== circuit_connector_sprites ===
'''Type''': [[Types/CircuitConnectorSprites]]
 
=== spawn_and_station_shadow_height_offset ===
'''Type''': [[Types/float]]
 
'''Default''': 0
 
=== draw_logistic_radius_visualization ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== draw_construction_radius_visualization ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== recharging_light ===
'''Type''': [[Types/LightDefinition]]
 
The light emitted when charging a robot.
 
=== charging_station_count ===
'''Type''': [[Types/uint32]]
 
'''Default''': 0
 
=== charging_distance ===
'''Type''': [[Types/float]]
 
'''Default''': 0.0
 
=== charging_station_shift ===
'''Type''': [[Types/vector]]
 
=== charging_threshold_distance ===
'''Type''': [[Types/float]]
 
'''Default''': 1.0
 
=== robot_vertical_acceleration ===
'''Type''': [[Types/float]]
 
'''Default''': 0.01
 
=== stationing_offset ===
'''Type''': [[Types/vector]]
 
The offset from the centre of the roboport at which robots will enter and exit.
 
=== robot_limit ===
'''Type''': [[Types/ItemCountType]]
 
'''Default''': max uint
 
How many robots can exist in the network (cumulative).
 
=== robots_shrink_when_entering_and_exiting ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== charging_offsets ===
'''Type''': [[Types/table]] of [[Types/vector]]
 
The offsets from the centre of the roboport at which robots will charge.
 
=== logistics_connection_distance ===
'''Type''': [[Types/float]]
 
Must be >= <code>logistics_radius</code>.

Latest revision as of 14:33, 25 October 2024

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/RoboportPrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.