Prototype/Roboport: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎working_sound: inherited from entity)
(0.16)
Line 2: Line 2:
A [[roboport]]. Based on [[Prototype/EntityWithHealth]].
A [[roboport]]. Based on [[Prototype/EntityWithHealth]].


== Properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].


=== energy_source ===
=== energy_source ===
Type: [[Types/EnergySource]]
'''Type''': [[Types/EnergySource]]


The roboport's electric energy source. Normal roboports have a buffer_capacity of 100MJ and an input_flow_limit of 5MW.
The roboport's electric energy source. Must be an electric energy source.
 
=== energy_usage ===
'''Type''': [[Types/Energy]]
 
The amount of energy the roboport uses when idle.


=== recharge_minimum ===
=== recharge_minimum ===
Type: [[Types/EnergyAmount]]
'''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.


Unknown.
=== door_animation_up ===
'''Type''': [[Types/Animation]]


=== energy_usage ===
=== door_animation_down ===
Type: [[Types/EnergyPower]]
'''Type''': [[Types/Animation]]
 
=== request_to_open_door_timeout ===
'''Type''': [[Types/uint]]


The amount of energy the roboport uses when idle.
=== recharging_animation ===
'''Type''': [[Types/Animation]]


=== charging_energy ===
The animation played at each charging point when a robot is charging there.
Type: [[Types/EnergyPower]]


The amount of energy that is given to a robot per tick.
=== spawn_and_station_height ===
=== radius ===
'''Type''': [[Types/float]]
Type: [[Types/unsigned]]


The "radius" of the area the roboport covers. If this is 25, the roboport will cover a 50X50 area.
Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.


=== charge_approach_distance ===
=== charge_approach_distance ===
Type: [[Types/double]]
'''Type''': [[Types/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.


=== robot_slots_count ===
=== logistics_radius ===
Type: [[Types/unsigned]]
'''Type''': [[Types/float]]
 
=== construction_radius ===
'''Type''': [[Types/float]]
 
=== 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]]


The number of robot slots in the roboport.
=== close_door_trigger_effect ===
'''Type''': [[Types/TriggerEffect]]


=== material_slots_count ===
=== default_available_logistic_output_signal ===
Type: [[Types/unsigned]]
'''Type''': [[Types/SignalIDConnector]]


The number of repair pack slots in the roboport.
=== default_total_logistic_output_signal ===
'''Type''': [[Types/SignalIDConnector]]


=== stationing_offset ===
=== default_available_construction_output_signal ===
Type: [[Types/vector]]
'''Type''': [[Types/SignalIDConnector]]


The offset from the centre of the roboport at which robots will enter and exit.
=== default_total_construction_output_signal ===
'''Type''': [[Types/SignalIDConnector]]


=== charging_offsets ===
=== circuit_wire_connection_point ===
Type: List of [[Types/vector]]
'''Type''': [[Types/WireConnectionPoint]]


The offsets from the centre of the roboport at which robots will charge.
=== circuit_wire_max_distance ===
'''Type''': [[Types/double]]


=== base_animation ===
'''Default''': 0
Type: [[Types/Animation]]


The animation played when the roboport is idle.
=== circuit_connector_sprites ===
'''Type''': [[Types/CircuitConnectorSprites]]


=== door_animation ===
=== draw_logistic_radius_visualization ===
Type: [[Types/Animation]]
'''Type''': [[Types/bool]]


The animation played when robots enter or leave the roboport. It plays forwards to open the door, and backwards to close the door.
'''Default''': true


=== recharging_animation ===
=== draw_construction_radius_visualization ===
Type: [[Types/Animation]]
'''Type''': [[Types/bool]]


The animation played at each charging point when a robot is charging there.
'''Default''': true


=== recharging_light ===
=== recharging_light ===
Type: [[Types/Light]]
'''Type''': [[Types/LightDefinition]]


The light emitted when charging a robot.
The light emitted when charging a robot.


=== request_to_open_door_timeout ===
=== charging_station_count ===
Type: [[Types/double]]
'''Type''': [[Types/uint]]
 
'''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]]


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


=== spawn_and_station_height ===
=== robot_limit ===
Type: [[Types/double]]
'''Type''': [[Types/ItemCountType]]


Presumably states the height of the charging stations and thus an additive offset for the charging_offsets.
'''Default''': max uint


=== draw_logistic_radius_visualization ===
=== allow_dispatching_robots ===
Type: [[Types/bool]]
'''Type''': [[Types/bool]]


Whether to display the radius_visualisation_picture for this roboport. Optional, default is true.
'''Default''': true


=== draw_construction_radius_visualization ===
=== charging_offsets ===
Type: [[Types/bool]]
'''Type''': [[Types/table]] of [[Types/vector]]


Whether to display the construction_radius_visualisation_picture for this roboport. Optional, default is true.
The offsets from the centre of the roboport at which robots will charge.

Revision as of 18:56, 21 May 2018

Basics

A roboport. Based on Prototype/EntityWithHealth.

Mandatory properties

This prototype inherits all the properties from Prototype/EntityWithHealth.

energy_source

Type: Types/EnergySource

The roboport's electric energy source. Must be an electric 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/uint

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

construction_radius

Type: Types/float

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

circuit_connector_sprites

Type: Types/CircuitConnectorSprites

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/uint

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

allow_dispatching_robots

Type: Types/bool

Default: true

charging_offsets

Type: Types/table of Types/vector

The offsets from the centre of the roboport at which robots will charge.