Prototype/LogisticContainer: Difference between revisions
(0.17.21) |
(Updated styling of prototype doc migration note) |
||
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
= | <div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/LogisticContainerPrototype.html https://lua-api.factorio.com/latest/prototypes/LogisticContainerPrototype.html] | ||
A generic container, such as a chest, that interacts with the logistics network | </p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | ||
{{Prototype parent|Prototype/Container}} | |||
A generic container, such as a chest, that interacts with the logistics network. | |||
{{Prototype TOC|logistic-container}} | |||
== Extensions == | == Extensions == | ||
Line 10: | Line 16: | ||
This prototype inherits all the properties from [[Prototype/Container]]. | This prototype inherits all the properties from [[Prototype/Container]]. | ||
{{Prototype property|logistic_mode|[[Types/string|string]]}} | |||
The way this chest interacts with the logistic network. Valid values are "passive-provider", "active-provider", "storage", "buffer" and "requester". | The way this chest interacts with the logistic network. Valid values are "passive-provider", "active-provider", "storage", "buffer" and "requester". | ||
== Optional properties == | == Optional properties == | ||
{{Prototype property|max_logistic_slots|[[Types/uint16|uint16]]|optional=true}} | |||
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. | |||
{{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. | |||
{{Prototype property|opened_duration|[[Types/uint8|uint8]]|0|optional=true}} | |||
{{Prototype property|animation|[[Types/Animation|Animation]]|optional=true}} | |||
Drawn when a robot brings/takes items from this container. | |||
{{Prototype property|landing_location_offset|[[Types/vector|vector]]|optional=true}} | |||
The offset from the center of this container where a robot visually brings/takes items. | |||
{{Prototype property|use_exact_mode|[[Types/bool|bool]]|false|optional=true}} | |||
Whether logistic robots have to deliver the exact amount of items requested to this logistic container instead of over-delivering (within their cargo size). | |||
{{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 == | |||
The defaults of the LogisticsContainerPrototype differ from the defaults of the ContainerPrototype: | |||
* picture is not mandatory | |||
Latest revision as of 10:43, 21 September 2023
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/LogisticContainerPrototype.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
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.
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