Prototype/TransportBelt: Difference between revisions

Latest revision as of 23:54, 25 January 2021

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/TransportBeltConnectable » Prototype/TransportBelt

A transport belt.

Prototype/TransportBelt — `transport-belt`
connector_frame_sprites	::	TransportBeltConnectorFrame
animations	::	RotatedAnimation (optional)
belt_animation_set	::	table (optional)
circuit_connector_sprites	::	Array of CircuitConnectorSprites (optional)
circuit_wire_connection_point	::	Array of WireConnectionPoint (optional)
circuit_wire_max_distance	::	double (optional)
draw_circuit_wires	::	bool (optional)
draw_copper_wires	::	bool (optional)
related_underground_belt	::	string (optional)
Inherited from Prototype/TransportBeltConnectable
speed	::	double
animation_speed_coefficient	::	double (optional)
belt_animation_set	::	table (optional)
belt_horizontal	::	Animation (optional)
belt_vertical	::	Animation (optional)
ending_bottom	::	Animation (optional)
ending_patch	::	Sprite4Way (optional)
ending_side	::	Animation (optional)
ending_top	::	Animation (optional)
ends_with_stopper	::	bool (optional)
starting_bottom	::	Animation (optional)
starting_side	::	Animation (optional)
starting_top	::	Animation (optional)
Inherited from Prototype/EntityWithOwner
allow_run_time_change_of_is_military_target	::	bool (optional)
is_military_target	::	bool (optional)
Inherited from Prototype/EntityWithHealth
alert_when_damaged	::	bool (optional)
attack_reaction	::	AttackReaction (optional)
corpse	::	string or table of strings (optional)
create_ghost_on_death	::	bool (optional)
damaged_trigger_effect	::	TriggerEffect (optional)
dying_explosion	::	ExplosionDefinition or table of ExplosionDefinition (optional)
dying_trigger_effect	::	TriggerEffect (optional)
healing_per_tick	::	float (optional)
hide_resistances	::	bool (optional)
integration_patch	::	Sprite4Way (optional)
integration_patch_render_layer	::	RenderLayer (optional)
loot	::	Loot (optional)
max_health	::	float (optional)
random_corpse_variation	::	bool (optional)
repair_sound	::	Sound (optional)
repair_speed_modifier	::	float (optional)
resistances	::	Resistances (optional)
Inherited from Prototype/Entity
icons, icon, icon_size (IconSpecification)	::	IconSpecification
additional_pastable_entities	::	table of string (optional)
alert_icon_scale	::	float (optional)
alert_icon_shift	::	vector (optional)
allow_copy_paste	::	bool (optional)
autoplace	::	AutoplaceSpecification (optional)
build_base_evolution_requirement	::	double (optional)
build_grid_size	::	uint8 (optional)
build_sound	::	Sound (optional)
close_sound	::	Sound (optional)
collision_box	::	BoundingBox (optional)
collision_mask	::	CollisionMask (optional)
created_effect	::	Trigger (optional)
created_smoke	::	CreateTrivialSmokeEffectItem (optional)
drawing_box	::	BoundingBox (optional)
emissions_per_second	::	double (optional)
enemy_map_color	::	Color (optional)
fast_replaceable_group	::	string (optional)
flags	::	EntityPrototypeFlags (optional)
friendly_map_color	::	Color (optional)
hit_visualization_box	::	BoundingBox (optional)
map_color	::	Color (optional)
map_generator_bounding_box	::	BoundingBox (optional)
minable	::	MinableProperties (optional)
mined_sound	::	Sound (optional)
mining_sound	::	Sound (optional)
next_upgrade	::	string (optional)
open_sound	::	Sound (optional)
placeable_by	::	ItemToPlace or table of ItemToPlace (optional)
protected_from_tile_building	::	bool (optional)
radius_visualisation_specification	::	RadiusVisualisationSpecification (optional)
remains_when_mined	::	string or table of string (optional)
remove_decoratives	::	string (optional)
rotated_sound	::	Sound (optional)
selectable_in_game	::	bool (optional)
selection_box	::	BoundingBox (optional)
selection_priority	::	uint8 (optional)
shooting_cursor_size	::	double (optional)
sticker_box	::	BoundingBox (optional)
subgroup	::	string (optional)
tile_height	::	uint32 (optional)
tile_width	::	uint32 (optional)
trigger_target_mask	::	TriggerTargetMask (optional)
vehicle_impact_sound	::	Sound (optional)
water_reflection	::	WaterReflectionDefinition (optional)
working_sound	::	WorkingSound (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/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.

related_underground_belt

Type: string
The name of the Prototype/UndergroundBelt which is used in quick-replace fashion when the smart belt dragging behavior is triggered.

@@ Line 1: / Line 1: @@
-== Basics ==
+{{Prototype parent|Prototype/TransportBeltConnectable}}
-A [[transport belt]]. Extends [[Prototype/TransportBeltConnectable]].
+A [[transport belt]].
+{{Prototype TOC|transport-belt}}
 == Mandatory properties ==
 This prototype inherits all the properties from [[Prototype/TransportBeltConnectable]].
-=== animations ===
+{{Prototype property|connector_frame_sprites|[[Types/TransportBeltConnectorFrame|TransportBeltConnectorFrame]]}}
-'''Type''': [[Types/RotatedAnimation]]
-Transport belts must have 12 animations.
+== Optional properties ==
-=== connector_frame_sprites ===
+{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
-'''Type''': [[Types/TransportBeltConnectorFrame]]
+The maximum circuit wire distance for this entity.
-== Optional properties ==
+{{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.
-=== circuit_wire_max_distance ===
+{{Prototype property|circuit_connector_sprites|Array of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
-'''Type''': [[Types/double]]
+The pictures displayed for circuit connections to this transport belt.
-'''Default''': 0
+{{Prototype property|belt_animation_set|[[Types/table|table]]|optional=true}}
+Either this, or <code>animations</code> has to present.
-=== circuit_wire_connection_point ===
+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.
-'''Type''': [[Types/WireConnectionPoint]]
-Defines how wires visually connect to this transport belt.
+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
-=== circuit_connector_sprites ===
+{{Prototype property|animations|[[Types/RotatedAnimation|RotatedAnimation]]|optional=true}}
-'''Type''': [[Types/CircuitConnectorSprites]]
+Transport belts must have 12 animations. Mandatory if <code>belt_animation_set</code> is not present.
-The pictures displayed for circuit connections to this transport belt.
+{{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.