Prototype/Module: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Converted to SMW format)
Line 1: Line 1:
{{Prototype parent|Prototype/Item}}
{{Prototype parent|Prototype/Item}}
A [[module]].


== Basics ==
{{Prototype TOC|module}}
Prototype type: '''module'''
 
A [[module]]. Extends [[Prototype/Item]].


== Mandatory properties ==
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/Item]].
This prototype inherits all the properties from [[Prototype/Item]].


=== category ===
{{Prototype property|category|[[Types/string|string]]}}
'''Type''': [[Types/string]]
 
The name of a module category.
The name of a module category.


=== tier ===
{{Prototype property|tier|[[Types/uint32|uint32]]}}
'''Type''': [[Types/uint32]]


=== effect ===
{{Prototype property|effect|[[Types/Effect|Effect]]}}
'''Type''': [[Types/Effect]]


== Optional properties ==
== Optional properties ==


=== limitation ===
{{Prototype property|limitation|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
'''Type''': [[Types/table]] of [[Types/string]]
 
Array of recipe names this module can be used on. If empty, the module can be used on all recipes.
Array of recipe names this module can be used on. If empty, the module can be used on all recipes.


=== limitation_message_key ===
{{Prototype property|limitation_message_key|[[Types/string|string]]|optional=true}}
'''Type''': [[Types/string]]
 
Mandatory when <code>limitation</code> is present. The locale key of the message that is shown when the player attempts to use the module on a recipe it can't be used on. The locale key will be prefixed with <code>item-limitation.</code> (the "category" of the locale) by the game.
Mandatory when <code>limitation</code> is present. The locale key of the message that is shown when the player attempts to use the module on a recipe it can't be used on. The locale key will be prefixed with <code>item-limitation.</code> (the "category" of the locale) by the game.

Revision as of 16:01, 26 July 2019

Prototype definitions » PrototypeBase » Prototype/Item » Prototype/Module


A module.


Prototype/Module — module
category::string
effect::Effect
tier::uint32
art_style::string (optional)
beacon_tint::table of Color (optional)
limitation::table of string (optional)
limitation_blacklist::table of string (optional)
limitation_message_key::string (optional)
requires_beacon_alt_mode::bool (optional)
Inherited from Prototype/Item
icons, icon, icon_size (IconSpecification)::IconSpecification
stack_size::ItemCountType
burnt_result::string (optional)
close_sound::Sound (optional)
dark_background_icons, dark_background_icon, icon_size (IconSpecification)::IconSpecification (optional)
default_request_amount::ItemCountType (optional)
flags::ItemPrototypeFlags (optional)
fuel_acceleration_multiplier::double (optional)
fuel_category::string (optional)
fuel_emissions_multiplier::double (optional)
fuel_glow_color::Color (optional)
fuel_top_speed_multiplier::double (optional)
fuel_value::Energy (optional)
open_sound::Sound (optional)
pictures::SpriteVariations (optional)
place_as_tile::PlaceAsTile (optional)
place_result::string (optional)
placed_as_equipment_result::string (optional)
rocket_launch_product::ItemProductPrototype (optional)
rocket_launch_products::table (array) of ItemProductPrototype (optional)
subgroup::string (optional)
wire_count::ItemCountType (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/Item.

category

Type: string
The name of a module category.

tier

Type: uint32

effect

Type: Effect

Optional properties

limitation

Type: table of string
Array of recipe names this module can be used on. If empty, the module can be used on all recipes.

limitation_message_key

Type: string
Mandatory when limitation is present. The locale key of the message that is shown when the player attempts to use the module on a recipe it can't be used on. The locale key will be prefixed with item-limitation. (the "category" of the locale) by the game.