Prototype/LogisticContainer: Difference between revisions

Latest revision as of 10:34, 12 August 2022

Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/Container » Prototype/LogisticContainer

A generic container, such as a chest, that interacts with the logistics network.

Prototype/LogisticContainer — `logistic-container`
logistic_mode	::	string
animation	::	Animation (optional)
animation_sound	::	Sound (optional)
landing_location_offset	::	vector (optional)
max_logistic_slots	::	uint16 (optional)
opened_duration	::	uint8 (optional)
render_not_in_network_icon	::	bool (optional)
use_exact_mode	::	bool (optional)
Inherited from Prototype/Container
inventory_size	::	uint16
picture	::	Sprite
circuit_connector_sprites	::	CircuitConnectorSprites (optional)
circuit_wire_connection_point	::	WireConnectionPoint (optional)
circuit_wire_max_distance	::	double (optional)
draw_circuit_wires	::	bool (optional)
draw_copper_wires	::	bool (optional)
enable_inventory_bar	::	bool (optional)
inventory_type	::	string (optional)
scale_info_icons	::	bool (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)

Extensions

Prototype/InfinityContainer infinity-container

Mandatory properties

This prototype inherits all the properties from Prototype/Container.

logistic_mode

Type: string
The way this chest interacts with the logistic network. Valid values are "passive-provider", "active-provider", "storage", "buffer" and "requester".

Optional properties

max_logistic_slots

Type: uint16
The number of request slots this logistics container has. Requester-type containers must have > 0 slots and can have a maximum of 1000 slots. Storage-type containers must have <= 1 slot.

render_not_in_network_icon

Type: bool
Default: true
Whether the icon should be rendered on this entity if the entity is not within a logistics network.

opened_duration

Type: uint8
Default: 0

animation

Type: Animation
Drawn when a robot brings/takes items from this container.

landing_location_offset

Type: vector
The offset from the center of this container where a robot visually brings/takes items.

use_exact_mode

Type: bool
Default: false
Whether logistic robots have to deliver the exact amount of items requested to this logistic container instead of over-delivering (within their cargo size).

animation_sound

Type: Sound
Played when a robot brings/takes items from this container. Ignored if animation is not defined.

Differing defaults

The defaults of the LogisticsContainerPrototype differ from the defaults of the ContainerPrototype:

picture is not mandatory

@@ Line 1: / Line 1: @@
 {{Prototype parent|Prototype/Container}}
+A generic container, such as a chest, that interacts with the logistics network.
-== Basics ==
+{{Prototype TOC|logistic-container}}
-Prototype type: '''logistic-container'''
-A generic container, such as a chest, that interacts with the logistics network
 == Extensions ==
@@ Line 12: / Line 10: @@
 This prototype inherits all the properties from [[Prototype/Container]].
-=== logistic_mode ===
+{{Prototype property|logistic_mode|[[Types/string|string]]}}
-'''Type''': [[Types/string]]
 The way this chest interacts with the logistic network. Valid values are "passive-provider", "active-provider", "storage", "buffer" and "requester".
 == Optional properties ==
-=== logistic_slots_count ===
+{{Prototype property|max_logistic_slots|[[Types/uint16|uint16]]|optional=true}}
-'''Type''': [[Types/uint32]]
+The number of request slots this logistics container has. Requester-type containers must have > 0 slots and can have a maximum of 1000 slots. Storage-type containers must have <= 1 slot.
-'''Default''': 0
-The number of request slots this logistics container has. Requester-type containers must have > 0 slots. Storage-type containers must have <= 1 slot.
-=== render_not_in_network_icon ===
-'''Type''': [[Types/bool]]
-'''Default''': true
+{{Prototype property|render_not_in_network_icon|[[Types/bool|bool]]|true|optional=true}}
 Whether the [[File:Too-far-from-roboport-icon.png]] icon should be rendered on this entity if the entity is not within a logistics network.
-=== opened_duration ===
+{{Prototype property|opened_duration|[[Types/uint8|uint8]]|0|optional=true}}
-'''Type''': [[Types/uint8]]
-'''Default''': 0
+{{Prototype property|animation|[[Types/Animation|Animation]]|optional=true}}
+Drawn when a robot brings/takes items from this container.
-=== animation ===
+{{Prototype property|landing_location_offset|[[Types/vector|vector]]|optional=true}}
-'''Type''': [[Types/Animation]]
+The offset from the center of this container where a robot visually brings/takes items.
-Used when a robot brings/takes items from this container.
-=== landing_location_offset ===
+{{Prototype property|use_exact_mode|[[Types/bool|bool]]|false|optional=true}}
-'''Type''': [[Types/vector]]
+Whether logistic robots have to deliver the exact amount of items requested to this logistic container instead of over-delivering (within their cargo size).
-The offset from the center of this container where a robot visually brings/takes items.
+{{Prototype property|animation_sound|[[Types/Sound|Sound]]|optional=true}}
+Played when a robot brings/takes items from this container. Ignored if <code>animation</code> is not defined.
 == Differing defaults ==