Prototype/Container: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(added extensions)
m (words)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/EntityWithOwner}}
A generic container, such as a chest. Based on [[Prototype/EntityWithHealth]]. Can not be rotated.
A generic container, such as a chest. Can not be rotated.
 
{{Prototype TOC|container}}


== Extensions ==
== Extensions ==
Line 6: Line 8:
** [[Prototype/InfinityContainer]] '''infinity-container'''
** [[Prototype/InfinityContainer]] '''infinity-container'''


== Properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
 
=== inventory_size ===
'''Type''': [[Types/uint16]]


{{Prototype property|inventory_size|[[Types/uint16|uint16]]}}
The number of slots in this container.
The number of slots in this container.


=== enable_inventory_bar ===
{{Prototype property|picture|[[Types/Sprite|Sprite]]}}
'''Type''': [[Types/bool]]
The picture displayed for this entity.
 
'''Default''': true


If the red inventory limiter bar is enabled.
== Optional properties ==


=== scale_info_icons ===
{{Prototype property|inventory_type|[[Types/string|string]]|"with_bar"|optional=true}}
'''Type''': [[Types/bool]]
One of "with_bar" and "with_filters_and_bar". Whether the inventory of this container can be filtered (like cargo wagons) or not.


'''Default''': false
{{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).


{{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.


=== picture ===
{{Prototype property|circuit_wire_connection_point|[[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
'''Type''': [[Types/Sprite]]
 
The picture displayed for this entity.
 
=== circuit_wire_connection_point ===
'''Type''': [[Types/WireConnectionPoint]]
 
Defines how wires visually connect to this container.
Defines how wires visually connect to this container.


=== circuit_wire_max_distance ===
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
'''Type''': [[Types/double]]
The maximum circuit wire distance for this container.


'''Default''': 0
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
 
The maximum circuit wire distance for this container.


=== circuit_connector_sprites ===
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}
'''Type''': [[Types/CircuitConnectorSprites]]


{{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 15:17, 21 October 2022

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


A generic container, such as a chest. Can not be rotated.


Prototype/Container — 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

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.