Prototype/TransportBelt: Difference between revisions
(Added prototype type to page) |
(Add circuit_connector_sprites. Requesting verification of added property. Sorry for misclick-saving twice) |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Prototype parent|Prototype/TransportBeltConnectable}} | |||
A [[transport belt]]. | |||
{{Prototype TOC|transport-belt}} | |||
== Mandatory properties == | == Mandatory properties == | ||
This prototype inherits all the properties from [[Prototype/TransportBeltConnectable]]. | This prototype inherits all the properties from [[Prototype/TransportBeltConnectable]]. | ||
{{Prototype property|connector_frame_sprites|[[Types/TransportBeltConnectorFrame|TransportBeltConnectorFrame]]}} | |||
== Optional properties == | |||
{{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_wire_connection_point|Array of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}} | ||
Defines how wires visually connect to this transport belt. | |||
{{Prototype property|circuit_connector_sprites|Array of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}} | |||
The pictures displayed for circuit connections to this transport belt. | |||
{{Prototype property|belt_animation_set|[[Types/table|table]]|optional=true}} | |||
Either this, or <code>animations</code> has to present. | |||
This is the same table as the one used by [[Prototype/TransportBeltConnectable]], with additional properties. If this is present, the belt_animation_set will used for all graphics. | |||
Table with the following additional optional properties: | |||
* east_to_north_index - [[Types/uint8|uint8]] - Default: 5 | |||
* north_to_east_index - [[Types/uint8|uint8]] - Default: 6 | |||
* west_to_north_index - [[Types/uint8|uint8]] - Default: 7 | |||
* north_to_west_index - [[Types/uint8|uint8]] - Default: 8 | |||
* south_to_east_index - [[Types/uint8|uint8]] - Default: 9 | |||
* east_to_south_index - [[Types/uint8|uint8]] - Default: 10 | |||
* south_to_west_index - [[Types/uint8|uint8]] - Default: 11 | |||
* west_to_south_index - [[Types/uint8|uint8]] - Default: 12 | |||
{{Prototype property|animations|[[Types/RotatedAnimation|RotatedAnimation]]|optional=true}} | |||
Transport belts must have 12 animations. Mandatory if <code>belt_animation_set</code> is not present. | |||
The | {{Prototype property|related_underground_belt|[[Types/string|string]]|optional=true}} | ||
The name of the [[Prototype/UndergroundBelt]] which is used in quick-replace fashion when the smart belt dragging behavior is triggered. |
Latest revision as of 23:54, 25 January 2021
Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/TransportBeltConnectable » Prototype/TransportBelt
Mandatory properties
This prototype inherits all the properties from Prototype/TransportBeltConnectable.
connector_frame_sprites
Type: TransportBeltConnectorFrame
Optional properties
circuit_wire_max_distance
Type: double
Default: 0
The maximum circuit wire distance for this entity.
draw_copper_wires
Type: bool
Default: true
draw_circuit_wires
Type: bool
Default: true
circuit_wire_connection_point
Type: Array of WireConnectionPoint
Defines how wires visually connect to this transport belt.
circuit_connector_sprites
Type: Array of CircuitConnectorSprites
The pictures displayed for circuit connections to this transport belt.
belt_animation_set
Type: table
Either this, or animations
has to present.
This is the same table as the one used by Prototype/TransportBeltConnectable, with additional properties. If this is present, the belt_animation_set will used for all graphics.
Table with the following additional optional properties:
- east_to_north_index - uint8 - Default: 5
- north_to_east_index - uint8 - Default: 6
- west_to_north_index - uint8 - Default: 7
- north_to_west_index - uint8 - Default: 8
- south_to_east_index - uint8 - Default: 9
- east_to_south_index - uint8 - Default: 10
- south_to_west_index - uint8 - Default: 11
- west_to_south_index - uint8 - Default: 12
animations
Type: RotatedAnimation
Transport belts must have 12 animations. Mandatory if belt_animation_set
is not present.
Type: string
The name of the Prototype/UndergroundBelt which is used in quick-replace fashion when the smart belt dragging behavior is triggered.