Prototype/Roboport: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Capitalization and spaces after '.' and ',')
(Removed old prototype docs)
Tag: Replaced
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/EntityWithHealth}}
<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]
A [[roboport]].


{{Prototype TOC|roboport}}
</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]].
 
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
The roboport's energy source. Must be an electric or void energy source.
 
{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
The amount of energy the roboport uses when idle.
 
{{Prototype property|recharge_minimum|[[Types/Energy|Energy]]}}
 
{{Prototype property|robot_slots_count|[[Types/ItemStackIndex|ItemStackIndex]]}}
The number of robot slots in the roboport.
 
{{Prototype property|material_slots_count|[[Types/ItemStackIndex|ItemStackIndex]]}}
The number of repair pack slots in the roboport.
 
{{Prototype property|base|[[Types/Sprite|Sprite]]}}
 
{{Prototype property|base_patch|[[Types/Sprite|Sprite]]}}
 
{{Prototype property|base_animation|[[Types/Animation|Animation]]}}
The animation played when the roboport is idle.
 
{{Prototype property|door_animation_up|[[Types/Animation|Animation]]}}
 
{{Prototype property|door_animation_down|[[Types/Animation|Animation]]}}
 
{{Prototype property|request_to_open_door_timeout|[[Types/uint32|uint32]]}}
 
{{Prototype property|recharging_animation|[[Types/Animation|Animation]]}}
The animation played at each charging point when a robot is charging there.
 
{{Prototype property|spawn_and_station_height|[[Types/float|float]]}}
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.
 
{{Prototype property|charge_approach_distance|[[Types/float|float]]}}
The distance from the roboport at which robots will wait to charge.
Notablely, if robots are already in range, then it will simplely wait at spot.
 
{{Prototype property|logistics_radius|[[Types/float|float]]}}
Can't be negative.
 
{{Prototype property|construction_radius|[[Types/float|float]]}}
Can't be negative.
 
{{Prototype property|charging_energy|[[Types/Energy|Energy]]}}
The amount of energy that is given to a robot per tick.
 
== Optional properties ==
 
{{Prototype property|open_door_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}
 
{{Prototype property|close_door_trigger_effect|[[Types/TriggerEffect|TriggerEffect]]|optional=true}}
 
{{Prototype property|default_available_logistic_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
 
{{Prototype property|default_total_logistic_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
 
{{Prototype property|default_available_construction_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
 
{{Prototype property|default_total_construction_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
 
{{Prototype property|circuit_wire_connection_point|[[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
 
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
The maximum circuit wire distance for this entity.
 
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|circuit_connector_sprites|[[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
 
{{Prototype property|spawn_and_station_shadow_height_offset|[[Types/float|float]]|0|optional=true}}
 
{{Prototype property|draw_logistic_radius_visualization|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|draw_construction_radius_visualization|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|recharging_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
The light emitted when charging a robot.
 
{{Prototype property|charging_station_count|[[Types/uint32|uint32]]|0|optional=true}}
How many charging point this roboport has, if value is 0, roboport will try to use charging_offsets to know charging point instead.
(in vanilla game, roboport charging point is defined by charging_offsets)
 
{{Prototype property|charging_distance|[[Types/float|float]]|0.0|optional=true}}
 
{{Prototype property|charging_station_shift|[[Types/vector|vector]]|optional=true}}
 
{{Prototype property|charging_threshold_distance|[[Types/float|float]]|1.0|optional=true}}
Unused. (only used in [[Prototype/RoboportEquipment|personal roboport]])
 
{{Prototype property|robot_vertical_acceleration|[[Types/float|float]]|0.01|optional=true}}
 
{{Prototype property|stationing_offset|[[Types/vector|vector]]|optional=true}}
The offset from the centre of the roboport at which robots will enter and exit.
 
{{Prototype property|robot_limit|[[Types/ItemCountType|ItemCountType]]|max uint|optional=true}}
Unused. (only used in [[Prototype/RoboportEquipment|personal roboport]])
 
{{Prototype property|robots_shrink_when_entering_and_exiting|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|charging_offsets|[[Types/table|table]] of [[Types/vector|vector]]|optional=true}}
The offsets from the centre of the roboport at which robots will charge. Only used if charging_station_count is equal to zero.
 
{{Prototype property|logistics_connection_distance|[[Types/float|float]]|optional=true}}
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.