Prototype/Container: Difference between revisions
(0.17) |
(Updated styling of prototype doc migration note) |
||
(9 intermediate revisions by 3 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/ContainerPrototype.html https://lua-api.factorio.com/latest/prototypes/ContainerPrototype.html] | ||
A generic container, such as a chest | </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/EntityWithOwner}} | |||
A generic container, such as a chest. Can not be rotated. | |||
{{Prototype TOC|container}} | |||
== Extensions == | == Extensions == | ||
Line 9: | Line 15: | ||
== Mandatory properties == | == Mandatory properties == | ||
This prototype inherits all the properties from [[Prototype/ | This prototype inherits all the properties from [[Prototype/EntityWithOwner]]. | ||
{{Prototype property|inventory_size|[[Types/uint16|uint16]]}} | |||
The number of slots in this container. | |||
The | {{Prototype property|picture|[[Types/Sprite|Sprite]]}} | ||
The picture displayed for this entity. | |||
== Optional properties == | == Optional properties == | ||
{{Prototype property|inventory_type|[[Types/string|string]]|"with_bar"|optional=true}} | |||
One of "with_bar" and "with_filters_and_bar". Whether the inventory of this container can be filtered (like cargo wagons) or not. | |||
{{Prototype property|enable_inventory_bar|[[Types/bool|bool]]|true|optional=true}} | |||
If the inventory limiter (red X) is visible in the chest's GUI. This does not change the inventory itself ([https://lua-api.factorio.com/latest/LuaInventory.html#LuaInventory.supports_bar LuaInventory.supports_bar()] will not change and the bar can still be modified by script). | |||
If the | |||
{{Prototype property|scale_info_icons|[[Types/bool|bool]]|false|optional=true}} | |||
If the icons of items shown in alt-mode should be scaled to the containers size. | If the icons of items shown in alt-mode should be scaled to the containers size. | ||
{{Prototype property|circuit_wire_connection_point|[[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}} | |||
Defines how wires visually connect to this container. | Defines how wires visually connect to this container. | ||
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}} | |||
The maximum circuit wire distance for this container. | The maximum circuit wire distance for this container. | ||
{{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_connector_sprites|[[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}} | |||
The pictures displayed for circuit connections to this container. | The pictures displayed for circuit connections to this container. |
Latest revision as of 10:42, 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/ContainerPrototype.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
A generic container, such as a chest. Can not be rotated.
Extensions
- Prototype/LogisticContainer logistic-container
- Prototype/InfinityContainer infinity-container
Mandatory properties
This prototype inherits all the properties from Prototype/EntityWithOwner.
inventory_size
Type: uint16
The number of slots in this container.
picture
Type: Sprite
The picture displayed for this entity.
Optional properties
inventory_type
Type: string
Default: "with_bar"
One of "with_bar" and "with_filters_and_bar". Whether the inventory of this container can be filtered (like cargo wagons) or not.
enable_inventory_bar
Type: bool
Default: true
If the inventory limiter (red X) is visible in the chest's GUI. This does not change the inventory itself (LuaInventory.supports_bar() will not change and the bar can still be modified by script).
scale_info_icons
Type: bool
Default: false
If the icons of items shown in alt-mode should be scaled to the containers size.
circuit_wire_connection_point
Type: WireConnectionPoint
Defines how wires visually connect to this container.
circuit_wire_max_distance
Type: double
Default: 0
The maximum circuit wire distance for this container.
draw_copper_wires
Type: bool
Default: true
draw_circuit_wires
Type: bool
Default: true
circuit_connector_sprites
Type: CircuitConnectorSprites
The pictures displayed for circuit connections to this container.