Prototype/RoboportEquipment: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Converted to SMW format)
Line 1: Line 1:
{{Prototype parent|Prototype/Equipment}}
{{Prototype parent|Prototype/Equipment}}
Used by [[personal roboport]].


== Basics ==
{{Prototype TOC|roboport-equipment}}
Prototype type: '''roboport-equipment'''
 
Extends [[Prototype/Equipment]].


== Mandatory properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/Equipment]]. requiresLogisticsRadius = false
This prototype inherits all the properties from [[Prototype/Equipment]].
 
=== recharging_animation ===
'''Type''': [[Types/Animation]]


{{Prototype property|recharging_animation|[[Types/Animation|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 ===
{{Prototype property|spawn_and_station_height|[[Types/float|float]]}}
'''Type''': [[Types/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 ===
{{Prototype property|charge_approach_distance|[[Types/float|float]]}}
'''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.


=== construction_radius ===
{{Prototype property|construction_radius|[[Types/float|float]]}}
'''Type''': [[Types/float]]
 
Can't be negative.
Can't be negative.


=== charging_energy ===
{{Prototype property|charging_energy|[[Types/Energy|Energy]]}}
'''Type''': [[Types/Energy]]
 
== Optional properties ==
== Optional properties ==


=== spawn_and_station_shadow_height_offset ===
{{Prototype property|spawn_and_station_shadow_height_offset|[[Types/float|float]]|0|optional=true}}
'''Type''': [[Types/float]]


'''Default''': 0
{{Prototype property|draw_logistic_radius_visualization|[[Types/bool|bool]]|true|optional=true}}


=== draw_logistic_radius_visualization ===
{{Prototype property|draw_construction_radius_visualization|[[Types/bool|bool]]|true|optional=true}}
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== draw_construction_radius_visualization ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== recharging_light ===
'''Type''': [[Types/LightDefinition]]


{{Prototype property|recharging_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
The light emitted when charging a robot.
The light emitted when charging a robot.


=== charging_station_count ===
{{Prototype property|charging_station_count|[[Types/uint32|uint32]]|0|optional=true}}
'''Type''': [[Types/uint32]]


'''Default''': 0
{{Prototype property|charging_distance|[[Types/float|float]]|0.0|optional=true}}


=== charging_distance ===
{{Prototype property|charging_station_shift|[[Types/vector|vector]]|optional=true}}
'''Type''': [[Types/float]]


'''Default''': 0.0
{{Prototype property|charging_threshold_distance|[[Types/float|float]]|1.0|optional=true}}


=== charging_station_shift ===
{{Prototype property|robot_vertical_acceleration|[[Types/float|float]]|0.01|optional=true}}
'''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]]


{{Prototype property|stationing_offset|[[Types/vector|vector]]||optional=true}}
The offset from the centre of the roboport at which robots will enter and exit.
The offset from the centre of the roboport at which robots will enter and exit.


=== robot_limit ===
{{Prototype property|robot_limit|[[Types/ItemCountType|ItemCountType]]|max uint|optional=true}}
'''Type''': [[Types/ItemCountType]]
 
'''Default''': max uint
 
How many robots can exist in the network (cumulative).
How many robots can exist in the network (cumulative).


=== robots_shrink_when_entering_and_exiting ===
{{Prototype property|robots_shrink_when_entering_and_exiting|[[Types/bool|bool]]|false|optional=true}}
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== charging_offsets ===
'''Type''': [[Types/table]] of [[Types/vector]]


{{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.
The offsets from the centre of the roboport at which robots will charge.

Revision as of 21:08, 27 July 2019

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


Used by personal roboport.


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

charging_distance

Type: float
Default: 0.0

charging_station_shift

Type: vector

charging_threshold_distance

Type: float
Default: 1.0

robot_vertical_acceleration

Type: float
Default: 0.01

stationing_offset

Type: vector
The offset from the centre 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 centre of the roboport at which robots will charge.