Prototype/Module: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎Mandatory properties: expanded descriptions)
(0.18.32: hr beacon)
Line 16: Line 16:


== Optional properties ==
== Optional properties ==
{{Prototype property|requires_beacon_alt_mode|[[Types/bool|bool]]|true|optional=true}}


{{Prototype property|limitation|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
{{Prototype property|limitation|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Line 22: Line 24:
{{Prototype property|limitation_message_key|[[Types/string|string]]|optional=true}}
{{Prototype property|limitation_message_key|[[Types/string|string]]|optional=true}}
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.
{{Prototype property|art_style|[[Types/string|string]]|optional=true}}
Chooses with what art style the module is shown inside beacons. See [[Types/BeaconModuleVisualizations#art_style]]. Vanilla uses "vanilla" here.
{{Prototype property|beacon_tint|[[Types/table|table]] of [[Types/Color|Color]]|optional=true}}
Format:
<syntaxhighlight lang="lua">beacon_tint = { primary = {r=1,g=1,b=1,a=1}, secondary = {r=1,g=1,b=1,a=1}, tertiary = {r=1,g=1,b=1,a=1}, quaternary = {r=1,g=1,b=1,a=1}}</syntaxhighlight>
Each key/value pair is optional and defaults to no color.

Revision as of 11:01, 23 July 2020

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 Prototype/ModuleCategory. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.

tier

Type: uint32
Tier of the module inside its category. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules with higher tier modules if they have the same category.

effect

Type: Effect

Optional properties

requires_beacon_alt_mode

Type: bool
Default: true

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.

art_style

Type: string
Chooses with what art style the module is shown inside beacons. See Types/BeaconModuleVisualizations#art_style. Vanilla uses "vanilla" here.

beacon_tint

Type: table of Color
Format:

beacon_tint = { primary = {r=1,g=1,b=1,a=1}, secondary = {r=1,g=1,b=1,a=1}, tertiary = {r=1,g=1,b=1,a=1}, quaternary = {r=1,g=1,b=1,a=1}}

Each key/value pair is optional and defaults to no color.