Official Factorio Wiki - User contributions [en]

Prototype/FireFlame

2023-04-05T02:49:49Z

Raspberrypuppies: Added description of initial_flame_count and uses_alternative_behavior

{{Prototype parent|Prototype/Entity}}
A fire.

{{Prototype TOC|fire}}

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

{{Prototype property|damage_per_tick|[[Types/DamagePrototype|DamagePrototype]]}}

{{Prototype property|spread_delay|[[Types/uint32|uint32]]}}

{{Prototype property|spread_delay_deviation|[[Types/uint32|uint32]]}}

== Optional properties ==

{{Prototype property|render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}}

{{Prototype property|initial_render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}}

{{Prototype property|secondary_render_layer|[[Types/RenderLayer|RenderLayer]]|"object"|optional=true}}

{{Prototype property|small_tree_fire_pictures|[[Types/AnimationVariations|AnimationVariations]]|optional=true}}

{{Prototype property|pictures|[[Types/AnimationVariations|AnimationVariations]]|optional=true}}

{{Prototype property|smoke_source_pictures|[[Types/AnimationVariations|AnimationVariations]]|optional=true}}

{{Prototype property|secondary_pictures|[[Types/AnimationVariations|AnimationVariations]]|optional=true}}

{{Prototype property|burnt_patch_pictures|[[Types/SpriteVariations|SpriteVariations]]|optional=true}}

{{Prototype property|secondary_picture_fade_out_start|[[Types/uint32|uint32]]|0|optional=true}}

{{Prototype property|secondary_picture_fade_out_duration|[[Types/uint32|uint32]]|30|optional=true}}

{{Prototype property|spawn_entity|[[Types/string|string]]|optional=true}}
The name of an entity.

{{Prototype property|smoke|[[Types/table|Array]] of [[Types/SmokeSource|SmokeSource]]|optional=true}}

{{Prototype property|maximum_spread_count|[[Types/uint16|uint16]]|200|optional=true}}

{{Prototype property|initial_flame_count|[[Types/uint8|uint8]]|0|optional=true}}
Spawns <code>initial_flame_count</code> <code>secondary_pictures</code> around the entity when it first spawns. It waits <code>delay_between_initial_flames</code> between each spawned <code>secondary_pictures</code>. This can be used to make fires look less repetitive.

Ex: Spitters use this to make several smaller splashes around the main one.

{{Prototype property|uses_alternative_behavior|[[Types/bool|bool]]|false|optional=true}}
If false, then all animations loop. If true, they run once and stay on the final frame. Also changes the behavior of several other fire properties as mentioned in their descriptions.

Ex: Spitters use alternate behavior, flamethrower flames don't.

{{Prototype property|limit_overlapping_particles|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|tree_dying_factor|[[Types/float|float]]|0|optional=true}}

{{Prototype property|fade_in_duration|[[Types/uint32|uint32]]|30|optional=true}}

{{Prototype property|fade_out_duration|[[Types/uint32|uint32]]|30|optional=true}}

{{Prototype property|initial_lifetime|[[Types/uint32|uint32]]|300|optional=true}}

{{Prototype property|damage_multiplier_decrease_per_tick|[[Types/float|float]]|0.0|optional=true}}

{{Prototype property|damage_multiplier_increase_per_added_fuel|[[Types/float|float]]|0.0|optional=true}}

{{Prototype property|maximum_damage_multiplier|[[Types/float|float]]|1.0|optional=true}}

{{Prototype property|lifetime_increase_by|[[Types/uint32|uint32]]|20|optional=true}}

{{Prototype property|lifetime_increase_cooldown|[[Types/uint32|uint32]]|10|optional=true}}

{{Prototype property|maximum_lifetime|[[Types/uint32|uint32]]|Max uint32|optional=true}}

{{Prototype property|add_fuel_cooldown|[[Types/uint32|uint32]]|10|optional=true}}

{{Prototype property|delay_between_initial_flames|[[Types/uint32|uint32]]|10|optional=true}}

{{Prototype property|smoke_fade_in_duration|[[Types/uint32|uint32]]|30|optional=true}}

{{Prototype property|smoke_fade_out_duration|[[Types/uint32|uint32]]|30|optional=true}}

{{Prototype property|on_fuel_added_action|[[Types/Trigger|Trigger]]|optional=true}}

{{Prototype property|on_damage_tick_effect|[[Types/Trigger|Trigger]]|optional=true}}

{{Prototype property|light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

{{Prototype property|particle_alpha_blend_duration|[[Types/uint16|uint16]]|0|optional=true}}

{{Prototype property|burnt_patch_lifetime|[[Types/uint32|uint32]]|1800|optional=true}}

{{Prototype property|burnt_patch_alpha_default|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_alpha|[[Types/float|float]]|1|optional=true}}
Only loaded if <code>uses_alternative_behavior</code> is true.

{{Prototype property|particle_alpha_deviation|[[Types/float|float]]|0|optional=true}}
Only loaded if <code>uses_alternative_behavior</code> is true.

{{Prototype property|flame_alpha|[[Types/float|float]]|1|optional=true}}
Only loaded if <code>uses_alternative_behavior</code> is false.

{{Prototype property|flame_alpha_deviation|[[Types/float|float]]|0|optional=true}}
Only loaded if <code>uses_alternative_behavior</code> is false.

{{Prototype property|burnt_patch_alpha_variations|[[Types/table|table]]|optional=true}}
Array of tables with the following mandatory members:
* tile - [[Types/string|string]] - Name of a tile.
* alpha - [[Types/float|float]]

Tutorial:Localisation

2023-02-10T05:05:14Z

Raspberrypuppies: Adding [string-mod-setting] to the list of built-in locale categories

{{Languages}}Mods should define human readable names for prototypes that they add. They can also define descriptions for items or custom strings for usage in GUIs etc. This is called '''localisation'''.

== File format ==
Translations are stored as .cfg files, with the following format:

<pre>welcome-message=Hello world
[category]
title=Category related title
# Comment
; Another comment</pre>
Any whitespace after or before <code>=</code> is included in the key or string, so <code>title =Category related title</code> will give an unknown key error if you are looking for the <code>title</code> key, since it is the <code>title </code> key.

<code>category</code> can be one of the existing locale categories, which permits implicit search mechanisms to find translations, but may also be another key, such as <code>[my-mod-messages]</code>. These are accessible the same as other translations, e.g. <code>{"my-mod-messages.hello"}</code>

These files are located within the language code of the language in the locale folder of the mod, so as an English example <code>__mod__/locale/en/any_name_here.cfg</code>. There can be more than 1 file per language, all of them will be read.

== Localising simple strings ==
The simplest localisation is of items, entities etc. If we say the item is <code>iron-plate</code>, the game will then search all loaded locale files for <code>item-name.iron-plate</code> and <code>item-description.iron-plate</code>, which in the locale file looks like this:

<pre>[item-name]
iron-plate=Iron plate
[item-description]
iron-plate=A plate made of iron.</pre>
If found in the locale, the label is set to this string. If not found, the game will instead show: <code>Unknown key: "item-name.iron-plate"</code>

In script, the localised string is formatted as <code>{"category.name"}</code>, so <code>game.print({"item-name.iron-plate"})</code> prints ''Iron plate''.

It is possible to use [[rich text]] features in the localised text if the location where the text is shown supports it, e.g. in the chat, prototype names and prototype tooltips.

<code>\n</code> can be used for line breaks if the location where the text is shown supports multiline text.

The list of all localization categories used by the base game is:

<pre>[achievement-description] [achievement-name] [ammo-category-name] [autoplace-control-names] [controls] [damage-type-name] [decorative-name] [entity-description] [entity-name] [equipment-name] [fluid-name] [fuel-category-name] [item-description] [item-group-name] [item-limitation] [item-name] [map-gen-preset-description] [map-gen-preset-name] [mod-description] [mod-name] [modifier-description] [programmable-speaker-instrument] [programmable-speaker-note] [recipe-name] [shortcut] [story] [string-mod-setting] [technology-description] [technology-name] [tile-name] [tips-and-tricks-item-description] [tips-and-tricks-item-name] [virtual-signal-description] [virtual-signal-name]</pre>

== Localising with parameters ==
For more complex strings, localisation parameters can be used. For instance we want to show ''Time left: 10 minutes.''

So a key with a placeholder is defined, which is replaced by the first parameter after the locale key.:

<pre>time-left=Time left: __1__ minutes.</pre>
So it is used like this:

<syntaxhighlight lang="lua">game.print({"time-left", 10})</syntaxhighlight>
It also works with multiple parameters:

<syntaxhighlight lang="lua">game.print({"time-left", 10, 45})</syntaxhighlight>
<pre>time-left=Time left: __1__ minutes and __2__ seconds.</pre>
Which results in ''Time left: 10 minutes and 45 seconds.''

=== Built-in parameters ===
For some situations, we use localisation to show control schemes. For instance we want to say:

<pre>technology-prompt=Use T to open the technology screen</pre>
However the player may have rebound the key, but we can’t figure out which key as it would not be deterministic. So instead we use the built-in replacement functionality

<pre>technology-prompt=Use __CONTROL__open-technology-gui__ to open the technology screen.</pre>
We can also use this for items and entities:

<pre>big-iron-plate=Big __ITEM__iron-plate__</pre>
<pre>tiny-gun-turret=Tiny __ENTITY__gun-turret__</pre>

==== List of built-in parameters ====
<code>name</code> is the name of an internal game control or a prototype name, depending on context. <code>n</code> can be 1 or 2, it's used in parameters that control [[#Localising_alternate_input_names|alternate input names]]. For a list of internal game control names, see [[Prototype/CustomInput#linked_game_control]].
* <code>__CONTROL__name__</code> - The combination of modifiers and input, such as "Control + Alt + Left-click", or "Not set".
* <code>__CONTROL_MODIFIER__name__</code> - The modifiers, such as "ControlShift", or, "No modifier selected."
* <code>__CONTROL_STYLE_BEGIN__</code>
* <code>__CONTROL_STYLE_END__</code>
* <code>__CONTROL_LEFT_CLICK__</code> is replaced with <code>control-keys.mouse-button-1</code> or <code>control-keys.controller-b</code>[https://crowdin.com/project/factorio/discussions/214]
* <code>__CONTROL_RIGHT_CLICK__</code> is replaced with <code>control-keys.mouse-button-2</code> or <code>control-keys.controller-x</code>
* <code>__CONTROL_KEY_SHIFT__</code> is replaced with <code>control-keys.shift</code> or <code>control-keys.controller-leftshoulder</code>
* <code>__CONTROL_KEY_CTRL__</code> is replaced with <code>control-keys.control</code> or <code>control-keys.controller-rightshoulder</code>
* <code>__ALT_CONTROL_LEFT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-1-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-b</code>)
* <code>__ALT_CONTROL_RIGHT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-2-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-x</code>)
* <code>__REMARK_COLOR_BEGIN__</code>
* <code>__REMARK_COLOR_END__</code>
* <code>__ALT_CONTROL__n__name__</code>
* <code>__CONTROL_MOVE__</code> - The Movement keys, squished together. Example: "WASD", from a conventional QWERTY English keyboard.
* <code>__ENTITY__name__</code> - The localised_name of the [[Prototype/Entity]] extension.
* <code>__ITEM__name__</code> - The localised_name of the [[Prototype/Item]] or extension.
* <code>__TILE__name__</code> - The localised_name of the [[Prototype/Tile]].
* <code>__FLUID__name__</code> - The localised_name of the [[Prototype/Fluid]].

=== Plurals ===
Pluralization can be used in any string that uses a parameter (e.g. __1__) that is numeric, so something like an amount of minutes. It can be used multiple times per string.

<pre>format-days=__1__ __plural_for_parameter_1_{1=day|rest=days}__</pre>
This results in "1 day" and "2 days" / "500 days" etc.

The number after <code>__plural_for_parameter_</code> denotes which parameter is used to determine the plural. This is the parameter 1 in the above example. Anything inside the {} is used to make the plural. Each plural form is separated by a |.
The text in front of the = determines for what the plural form is used. Options for this are:
* a simple number, e.g. "1".
* Multiple numbers, e.g. "2,3,4".
* What the number ends with, e.g. "ends in 11" or "ends in 1"
* Multiple ends with, e.g. "ends in 1,ends in 2,ends in 12".
* "rest" to give the default plural.

Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:

<pre>__plural_for_parameter_1_{1=__1__ player is|rest=__1__ players are}__ connecting</pre>

The system chooses the first fitting plural that it encounters when multiple would fit:
<pre>__plural_for_parameter_1_{ends in 12=option 1|ends in 2=option 2|rest=option 3}__</pre>
This will result in "option 1" for 12 and in "option 2" for 22 and in "option 3" for numbers not ending with 2.

=== Concatenating localised strings ===
The special locale key: <code>""</code> is used to concatenate, as the table format does not support concatenation:

<syntaxhighlight lang="lua">game.print({"", {"item-name.iron-plate"}, ": ", 60})</syntaxhighlight>
Will result in: ''Iron plate: 60''

=== Localising alternate input names ===

In the introduction campaign, a special locale system is used for informing players how to do certain actions with their mouse.
The normal form is to use eg:
<pre>how-to-build=Use __CONTROL__build__ to place a building</pre>
which results in "Use Left mouse button to place a building". A more natural phrasing would be "Left-click to place a building", which can be achieved by using the following:
<pre>how-to-build=__ALT_CONTROL__1__build__ to place a building</pre>

These "alt" versions are controlled by a few special locale keys, mouse-button-X-alt-1 and mouse-button-X-alt-2. In English, form 1 produces eg "Left-click", and form 2 produces eg "Left-clicking". Only two alt forms ("1" and "2") are available at the moment, but if this a problem for some languages, more forms may be added in the future.
Extra mouse buttons, mouse scroll and keyboard keys are handled through the mouse-button-n-alt-1/2, mouse-wheel-alt-1/2 and keyboard-alt-1/2 keys, which just take the normal name and prepend something like "Press/Pressing", or "Scroll/Scrolling".

When translating to another language, you can use whatever forms you want here, but the important part is that you are consistent when you use the alt-forms everywhere else. It does not necessarily make sense to just copy the usages of alt forms from the English locale, and for some languages it may be more natural to simply not use this system at all.

== Accessing the localised result in code ==
While usually unneeded, it is possible to read the resulting localised text in code, for example to search in localised names. See [https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.request_translation LuaPlayer::request_translation] and [https://lua-api.factorio.com/latest/events.html#on_string_translated on_string_translated event].

== Default Behavior(s) for finding an Unspecified Localised String ==
If a localised_string is not defined in the prototype for certain prototype classes, e.g. entity, item, Factorio may have a default search behavior.

Determining an item's localised name:
Note: the angle brackets are meant to mean a generic term, they are not part of the actual string. Also, place_result and placed_as_equipment_result are strings, and Factorio fetches the matching prototype to examine.

# if localised_name is provided in the item prototype and it is not empty {}, use the provided value
# else if there is place_result and it has localised_name that is not an empty table: {}, use the localised_name of place_result
# else if there is place_result with an empty localised_name, use {"entity-name.<entity prototype name>"}
# else if there is placed_as_equipment_result and it has a localised_name that is not an empty table: {}, use the localised_name of placed_as_equipment_result
# else if there is placed_as_equipment_result with empty localised_name, use {"equipment-name.<equipment name>"}
# else use default {"item-name.<item name>"}

Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243]

Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}

Such defaults often include a "leading key" using [<group>-name] or [<group>-description] (such as [recipe-name], [mod-setting-description]). However, each prototype may have a distinct search behavior before using those, based on presence/absence of values in the prototype. [[Prototype/Recipe]] for example may use the first product's localised_name, or the main_product's localised_name, or the localised string found in {"recipe-name.<recipe name>"], depending on values provided (and lacking) in the prototype.

== See also ==
* [[Types/LocalisedString|LocalisedString data stage doc]]
* [https://lua-api.factorio.com/latest/Concepts.html#LocalisedString LocalisedString control stage doc]

Tutorial:Localisation

2023-02-10T04:01:51Z

Raspberrypuppies: Add list of all locale categories used in the base game

{{Languages}}Mods should define human readable names for prototypes that they add. They can also define descriptions for items or custom strings for usage in GUIs etc. This is called '''localisation'''.

== File format ==
Translations are stored as .cfg files, with the following format:

<pre>welcome-message=Hello world
[category]
title=Category related title
# Comment
; Another comment</pre>
Any whitespace after or before <code>=</code> is included in the key or string, so <code>title =Category related title</code> will give an unknown key error if you are looking for the <code>title</code> key, since it is the <code>title </code> key.

<code>category</code> can be one of the existing locale categories, which permits implicit search mechanisms to find translations, but may also be another key, such as <code>[my-mod-messages]</code>. These are accessible the same as other translations, e.g. <code>{"my-mod-messages.hello"}</code>

These files are located within the language code of the language in the locale folder of the mod, so as an English example <code>__mod__/locale/en/any_name_here.cfg</code>. There can be more than 1 file per language, all of them will be read.

== Localising simple strings ==
The simplest localisation is of items, entities etc. If we say the item is <code>iron-plate</code>, the game will then search all loaded locale files for <code>item-name.iron-plate</code> and <code>item-description.iron-plate</code>, which in the locale file looks like this:

<pre>[item-name]
iron-plate=Iron plate
[item-description]
iron-plate=A plate made of iron.</pre>
If found in the locale, the label is set to this string. If not found, the game will instead show: <code>Unknown key: "item-name.iron-plate"</code>

In script, the localised string is formatted as <code>{"category.name"}</code>, so <code>game.print({"item-name.iron-plate"})</code> prints ''Iron plate''.

It is possible to use [[rich text]] features in the localised text if the location where the text is shown supports it, e.g. in the chat, prototype names and prototype tooltips.

<code>\n</code> can be used for line breaks if the location where the text is shown supports multiline text.

The list of all localization categories used by the base game is:

<pre>[achievement-description] [achievement-name] [ammo-category-name] [autoplace-control-names] [controls] [damage-type-name] [decorative-name] [entity-description] [entity-name] [equipment-name] [fluid-name] [fuel-category-name] [item-description] [item-group-name] [item-limitation] [item-name] [map-gen-preset-description] [map-gen-preset-name] [mod-description] [mod-name] [modifier-description] [programmable-speaker-instrument] [programmable-speaker-note] [recipe-name] [shortcut] [story] [technology-description] [technology-name] [tile-name] [tips-and-tricks-item-description] [tips-and-tricks-item-name] [virtual-signal-description] [virtual-signal-name]</pre>

== Localising with parameters ==
For more complex strings, localisation parameters can be used. For instance we want to show ''Time left: 10 minutes.''

So a key with a placeholder is defined, which is replaced by the first parameter after the locale key.:

<pre>time-left=Time left: __1__ minutes.</pre>
So it is used like this:

<syntaxhighlight lang="lua">game.print({"time-left", 10})</syntaxhighlight>
It also works with multiple parameters:

<syntaxhighlight lang="lua">game.print({"time-left", 10, 45})</syntaxhighlight>
<pre>time-left=Time left: __1__ minutes and __2__ seconds.</pre>
Which results in ''Time left: 10 minutes and 45 seconds.''

=== Built-in parameters ===
For some situations, we use localisation to show control schemes. For instance we want to say:

<pre>technology-prompt=Use T to open the technology screen</pre>
However the player may have rebound the key, but we can’t figure out which key as it would not be deterministic. So instead we use the built-in replacement functionality

<pre>technology-prompt=Use __CONTROL__open-technology-gui__ to open the technology screen.</pre>
We can also use this for items and entities:

<pre>big-iron-plate=Big __ITEM__iron-plate__</pre>
<pre>tiny-gun-turret=Tiny __ENTITY__gun-turret__</pre>

==== List of built-in parameters ====
<code>name</code> is the name of an internal game control or a prototype name, depending on context. <code>n</code> can be 1 or 2, it's used in parameters that control [[#Localising_alternate_input_names|alternate input names]]. For a list of internal game control names, see [[Prototype/CustomInput#linked_game_control]].
* <code>__CONTROL__name__</code> - The combination of modifiers and input, such as "Control + Alt + Left-click", or "Not set".
* <code>__CONTROL_MODIFIER__name__</code> - The modifiers, such as "ControlShift", or, "No modifier selected."
* <code>__CONTROL_STYLE_BEGIN__</code>
* <code>__CONTROL_STYLE_END__</code>
* <code>__CONTROL_LEFT_CLICK__</code> is replaced with <code>control-keys.mouse-button-1</code> or <code>control-keys.controller-b</code>[https://crowdin.com/project/factorio/discussions/214]
* <code>__CONTROL_RIGHT_CLICK__</code> is replaced with <code>control-keys.mouse-button-2</code> or <code>control-keys.controller-x</code>
* <code>__CONTROL_KEY_SHIFT__</code> is replaced with <code>control-keys.shift</code> or <code>control-keys.controller-leftshoulder</code>
* <code>__CONTROL_KEY_CTRL__</code> is replaced with <code>control-keys.control</code> or <code>control-keys.controller-rightshoulder</code>
* <code>__ALT_CONTROL_LEFT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-1-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-b</code>)
* <code>__ALT_CONTROL_RIGHT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-2-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-x</code>)
* <code>__REMARK_COLOR_BEGIN__</code>
* <code>__REMARK_COLOR_END__</code>
* <code>__ALT_CONTROL__n__name__</code>
* <code>__CONTROL_MOVE__</code> - The Movement keys, squished together. Example: "WASD", from a conventional QWERTY English keyboard.
* <code>__ENTITY__name__</code> - The localised_name of the [[Prototype/Entity]] extension.
* <code>__ITEM__name__</code> - The localised_name of the [[Prototype/Item]] or extension.
* <code>__TILE__name__</code> - The localised_name of the [[Prototype/Tile]].
* <code>__FLUID__name__</code> - The localised_name of the [[Prototype/Fluid]].

=== Plurals ===
Pluralization can be used in any string that uses a parameter (e.g. __1__) that is numeric, so something like an amount of minutes. It can be used multiple times per string.

<pre>format-days=__1__ __plural_for_parameter_1_{1=day|rest=days}__</pre>
This results in "1 day" and "2 days" / "500 days" etc.

The number after <code>__plural_for_parameter_</code> denotes which parameter is used to determine the plural. This is the parameter 1 in the above example. Anything inside the {} is used to make the plural. Each plural form is separated by a |.
The text in front of the = determines for what the plural form is used. Options for this are:
* a simple number, e.g. "1".
* Multiple numbers, e.g. "2,3,4".
* What the number ends with, e.g. "ends in 11" or "ends in 1"
* Multiple ends with, e.g. "ends in 1,ends in 2,ends in 12".
* "rest" to give the default plural.

Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:

<pre>__plural_for_parameter_1_{1=__1__ player is|rest=__1__ players are}__ connecting</pre>

The system chooses the first fitting plural that it encounters when multiple would fit:
<pre>__plural_for_parameter_1_{ends in 12=option 1|ends in 2=option 2|rest=option 3}__</pre>
This will result in "option 1" for 12 and in "option 2" for 22 and in "option 3" for numbers not ending with 2.

=== Concatenating localised strings ===
The special locale key: <code>""</code> is used to concatenate, as the table format does not support concatenation:

<syntaxhighlight lang="lua">game.print({"", {"item-name.iron-plate"}, ": ", 60})</syntaxhighlight>
Will result in: ''Iron plate: 60''

=== Localising alternate input names ===

In the introduction campaign, a special locale system is used for informing players how to do certain actions with their mouse.
The normal form is to use eg:
<pre>how-to-build=Use __CONTROL__build__ to place a building</pre>
which results in "Use Left mouse button to place a building". A more natural phrasing would be "Left-click to place a building", which can be achieved by using the following:
<pre>how-to-build=__ALT_CONTROL__1__build__ to place a building</pre>

These "alt" versions are controlled by a few special locale keys, mouse-button-X-alt-1 and mouse-button-X-alt-2. In English, form 1 produces eg "Left-click", and form 2 produces eg "Left-clicking". Only two alt forms ("1" and "2") are available at the moment, but if this a problem for some languages, more forms may be added in the future.
Extra mouse buttons, mouse scroll and keyboard keys are handled through the mouse-button-n-alt-1/2, mouse-wheel-alt-1/2 and keyboard-alt-1/2 keys, which just take the normal name and prepend something like "Press/Pressing", or "Scroll/Scrolling".

When translating to another language, you can use whatever forms you want here, but the important part is that you are consistent when you use the alt-forms everywhere else. It does not necessarily make sense to just copy the usages of alt forms from the English locale, and for some languages it may be more natural to simply not use this system at all.

== Accessing the localised result in code ==
While usually unneeded, it is possible to read the resulting localised text in code, for example to search in localised names. See [https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.request_translation LuaPlayer::request_translation] and [https://lua-api.factorio.com/latest/events.html#on_string_translated on_string_translated event].

== Default Behavior(s) for finding an Unspecified Localised String ==
If a localised_string is not defined in the prototype for certain prototype classes, e.g. entity, item, Factorio may have a default search behavior.

Determining an item's localised name:
Note: the angle brackets are meant to mean a generic term, they are not part of the actual string. Also, place_result and placed_as_equipment_result are strings, and Factorio fetches the matching prototype to examine.

# if localised_name is provided in the item prototype and it is not empty {}, use the provided value
# else if there is place_result and it has localised_name that is not an empty table: {}, use the localised_name of place_result
# else if there is place_result with an empty localised_name, use {"entity-name.<entity prototype name>"}
# else if there is placed_as_equipment_result and it has a localised_name that is not an empty table: {}, use the localised_name of placed_as_equipment_result
# else if there is placed_as_equipment_result with empty localised_name, use {"equipment-name.<equipment name>"}
# else use default {"item-name.<item name>"}

Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243]

Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}

Such defaults often include a "leading key" using [<group>-name] or [<group>-description] (such as [recipe-name], [mod-setting-description]). However, each prototype may have a distinct search behavior before using those, based on presence/absence of values in the prototype. [[Prototype/Recipe]] for example may use the first product's localised_name, or the main_product's localised_name, or the localised string found in {"recipe-name.<recipe name>"], depending on values provided (and lacking) in the prototype.

== See also ==
* [[Types/LocalisedString|LocalisedString data stage doc]]
* [https://lua-api.factorio.com/latest/Concepts.html#LocalisedString LocalisedString control stage doc]

Types/ProjectileAttackParameters

2023-01-25T03:14:59Z

Raspberrypuppies: Add projectile_center disclaimer based on further experimentation

Extends [[Types/BaseAttackParameters]].

== Optional properties ==
Inherits all properties from [[Types/BaseAttackParameters]].

=== projectile_center ===
'''Type''': [[Types/vector]]

'''Default''': {0, 0}

When used with projectile_creation_parameters, this offsets what the turret's sprite looks at. Setting to {0,1} will cause the turret to aim one tile up from the target but the projectile will still aim for the entity. Can be used to give the illusion of height but can also confuse aim logic when set too high.

When used without projectile_creation_parameters, this sets the turret's rotation axis.

=== projectile_creation_distance ===
'''Type''': [[Types/float]]

'''Default''': 0

=== shell_particle ===
'''Type''': [[Types/CircularParticleCreationSpecification]]

Used to show bullet shells/casings being ejected from the gun, e.g. [https://factorio.com/blog/post/fff-345 artillery shell casings].

=== projectile_creation_parameters ===
'''Type''': [[Types/CircularProjectileCreationSpecification]]

Used to shoot projectiles from arbitrary points. Used by worms and multi-barreled weapons. Use multiple points with the same angle to cause the turret to shoot from multiple barrels. If not set then the launch positions are calculated using projectile_center and projectile_creation_distance.

=== projectile_orientation_offset ===
'''Type''': [[Types/float]]

'''Default''': 0

Used to shoot from different sides of the turret. Setting to 0.25 shoots from the right side, 0.5 shoots from the back, and 0.75 shoots from the left. The turret will look at the enemy as normal but the bullet will spawn from the offset position. Can be used to create right-handed weapons.

Types/ProjectileAttackParameters

2023-01-09T04:41:57Z

Raspberrypuppies: Add description for projectile_center, projectile_creation_parameters, and projectile_orientation_offset based on experimentation

Extends [[Types/BaseAttackParameters]].

== Optional properties ==
Inherits all properties from [[Types/BaseAttackParameters]].

=== projectile_center ===
'''Type''': [[Types/vector]]

'''Default''': {0, 0}

Offsets what the turret's sprite looks at. Setting to {0,1} will cause the turret to aim one tile up from the target but the projectile will still aim for the entity. Can be used to give the illusion of height but can also confuse aim logic when set too high.

=== projectile_creation_distance ===
'''Type''': [[Types/float]]

'''Default''': 0

=== shell_particle ===
'''Type''': [[Types/CircularParticleCreationSpecification]]

Used to show bullet shells/casings being ejected from the gun, e.g. [https://factorio.com/blog/post/fff-345 artillery shell casings].

=== projectile_creation_parameters ===
'''Type''': [[Types/CircularProjectileCreationSpecification]]

[Optional] Used to shoot projectiles from arbitrary points. Used by worms and multi-barreled weapons. Use multiple points with the same angle to cause the turret to shoot from multiple barrels. If not set then the launch positions are calculated using projectile_center and projectile_creation_distance.

=== projectile_orientation_offset ===
'''Type''': [[Types/float]]

'''Default''': 0

Used to shoot from different sides of the turret. Setting to 0.25 shoots from the right side, 0.5 shoots from the back, and 0.75 shoots from the left. The turret will look at the enemy as normal but the bullet will spawn from the offset position. Can be used to create right-handed weapons.

Types/TurretAttackModifierPrototype

2022-10-15T02:12:29Z

Raspberrypuppies: /* turret_id */

Extends [[Types/ModifierPrototype]].

== Mandatory properties ==
Inherits all properties from [[Types/ModifierPrototype]].

=== turret_id ===
'''Type''': [[Types/string]]

Prototype name of the [[Prototype/Entity|entity]] that is affected. This also works for non-turrets such as tanks, however, the bonus does not appear in the entity's tooltips.

=== modifier ===
'''Type''': [[Types/double]]

Modification value. This will be added to the current turret attack modifier upon researching.

Types/AmmoType

2022-10-15T01:53:37Z

Raspberrypuppies: /* range_modifier */

==Basics==
Definition of actual parameters used in attack.

== Mandatory properties ==

=== category ===
'''Type''': [[Types/string]]

Name of a [[Prototype/AmmoCategory]]. Defines whether the attack will be affected by upgrades.

== Optional properties ==

=== action ===
'''Type''': [[Types/Trigger]]

Describes actions taken upon attack happening.

=== clamp_position ===
'''Type''': [[Types/bool]]

'''Default''': false

When true, the gun will be able to shoot even when the target is out of range. Only applies when target_type is position. The gun will fire at the maximum range in the direction of the target position. Defaults to false.

=== energy_consumption ===
'''Type''': [[Types/Energy]]

Energy consumption of a single shot, if applicable.

=== range_modifier ===
'''Type''': [[Types/double]]

'''Default''': 1

Affects the <code>range</code> value of the shooting gun prototype's [[Types/BaseAttackParameters]] to give a modified maximum range. The <code>min_range</code> value of the gun is unaffected.

[https://forums.factorio.com/viewtopic.php?f=23&t=103658 This has no effect on artillery turrets and wagons even though the bonus appears in the GUI]

=== cooldown_modifier ===
'''Type''': [[Types/double]]

'''Default''': 1

=== consumption_modifier ===
'''Type''': [[Types/float]]

'''Default''': 1

=== target_type ===
'''Type''': [[Types/string]]

'''Default''': "entity"

Either "entity", "position" or "direction". If this is "entity", <code>clamp_position</code> is forced to be false.
"entity" fires at an entity, "position" fires directly at a position, "direction" fires in a direction.

Types/BaseAttackParameters

2022-10-15T01:39:15Z

Raspberrypuppies: /* lead_target_for_projectile_speed */

The abstract base of all [[Types/AttackParameters|attack parameters]].

== Extensions ==
* [[Types/ProjectileAttackParameters]]
* [[Types/BeamAttackParameters]]
* [[Types/StreamAttackParameters]]

== Mandatory properties ==
=== range ===
'''Type''': [[Types/float]]

Before an entity can attack, the distance (in tiles) between the entity and target must be less than or equal to this.

=== cooldown ===
'''Type''': [[Types/float]]

Number of ticks in which it will be possible to shoot again. If < 1, multiple shots can be performed in one tick.

== Optional properties ==
=== min_range ===
'''Type''': [[Types/float]]

'''Default''': 0

The minimum distance (in tiles) between an entity and target. If a unit's target is less than this, the unit will attempt to move away before attacking. A [[Flamethrower turret]] does not move, but has a minimum range. Less than this, it is unable to target an enemy.

=== turn_range ===
'''Type''': [[Types/float]]

'''Default''': 1

If this is <= 0, it is set to 1. Arc from 0 to 1, so for example 0.25 is 90°. Used by the [[flamethrower turret]] in the base game. Arcs greater than 0.5 but less than 1 will be clamped to 0.5 as targeting in arcs larger than half circle is not implemented.[https://forums.factorio.com/94654]

=== fire_penalty ===
'''Type''': [[Types/float]]

'''Default''': 0

Used when searching for the nearest enemy, when this is > 0, enemies that aren't burning are preferred over burning enemies. Definition of "burning" for this: Entity has sticker attached to it, and the sticker has a [[Prototype/Sticker#spread_fire_entity|spread_fire_entity]] set.

=== rotate_penalty ===
'''Type''': [[Types/float]]

'''Default''': 0

A higher penalty will discourage turrets from targeting units that would take longer to turn to face.

=== health_penalty ===
'''Type''': [[Types/float]]

'''Default''': 0

A higher penalty will discourage turrets from targeting units with higher health. A negative penalty will encourage turrets to target units with higher health.

=== range_mode ===
'''Type''': [[Types/string]]

'''Default''': "center-to-center"

Either "center-to-center" or "bounding-box-to-bounding-box".

=== min_attack_distance ===
'''Type''': [[Types/float]]

'''Default''': <code>range</code>

If less than <code>range</code>, the entity will choose a random distance between <code>range</code> and <code>min_attack_distance</code> and attack from that distance.

=== damage_modifier ===
'''Type''': [[Types/float]]

'''Default''': 1

=== ammo_consumption_modifier ===
'''Type''': [[Types/float]]

'''Default''': 1

Must be greater than or equal to 0.

=== cooldown_deviation ===
'''Type''': [[Types/float]]

'''Default''': 0

Must be between 0 and 1.

=== warmup ===
'''Type''': [[Types/uint32]]

'''Default''': 0

Number of ticks it takes for the weapon to actually shoot after the order for shooting has been made. This also allows to "adjust" the shooting animation to the effect of shooting.

[[Types/CapsuleAction]]s cannot have attack_parameters with non-zero warmup.

=== lead_target_for_projectile_speed ===
'''Type''': [[Types/float]]

'''Default''': 0

Base game uses
<syntaxhighlight lang="lua">lead_target_for_projectile_speed = 0.2* 0.75 * 1.5, -- this is same as particle horizontal speed of flamethrower fire stream</syntaxhighlight>
Presumably this should be set to the projectile speed to make the unit/turret lead their projectiles.

Setting this to anything but zero causes homing projectiles to aim for the target point instead of the entity.

=== movement_slow_down_cooldown ===
'''Type''': [[Types/float]]

'''Default''': <code>cooldown</code>

=== movement_slow_down_factor ===
'''Type''': [[Types/double]]

'''Default''': 1

=== ammo_type ===
'''Type''': [[Types/AmmoType]]

Can be mandatory.

=== activation_type ===
'''Type''': [[Types/string]]

'''Default''': "shoot"

One of "shoot", "throw", "consume" or "activate". Used in tooltips to set the tooltip category. It is also used to get the locale keys for activation instructions and speed of the action for the tooltip.

For example, an activation_type of "throw" will result in the tooltip category "thrown" and the tooltip locale keys "gui.instruction-to-throw" and "description.throwing-speed".

=== sound ===
'''Type''': [[Types/LayeredSound]]

Played once at the start of the attack if this is a [[Types/ProjectileAttackParameters]].

=== animation ===
'''Type''': [[Types/RotatedAnimation]]

=== cyclic_sound ===
'''Type''': [[Types/CyclicSound]]

Played during the attack.

=== use_shooter_direction ===
'''Type''': [[Types/bool]]

'''Default''': false

=== ammo_categories ===
'''Type''': [[Types/table]] (array) [[Types/string]]

Names of [[Prototype/AmmoCategory|Prototype/AmmoCategories]].

=== ammo_category ===
'''Type''': [[Types/string]]

The name of a [[Prototype/AmmoCategory]]. Mandatory if <code>ammo_type</code> and <code>ammo_categories</code> is not given, otherwise ignored.

Tutorial:Mod structure

2022-09-29T22:55:10Z

Raspberrypuppies: /* Files */ Fixed missing link description

{{Languages}}Mods are expected to have a certain structure in order to be loaded by the game. This page aims to explain that file structure and what each file is used for.

== Mod folder and file structure ==

The mod must either be in a folder, or in a folder inside a zip file. The mod folder (no zip file) must either be named in the pattern of <code>{mod-name}_{version-number}</code> or just <code>{mod-name}</code>, for example <code>test-mod-thing</code>. The mod zip must be named in the pattern of <code>{mod-name}_{version-number}</code>, for example <code>test-mod-thing_0.0.1</code>. When using a zip file for the mod, the folder inside the zip file does not have any naming restrictions; only the zip file itself must be named with the <code>{mod-name}_{version-number}</code> pattern. The mod name and its version number are defined in the [[#info.json|info.json]] file.

=== Files ===
Inside the mod folder, the game automatically reads the following files during load:
* info.json — The only mandatory file. The [[#info.json|info.json]] identifies the mod, defines its version and other general properties.
* changelog.txt — Version history of the mod, to be shown in the mod browser. The changelog file must follow the strict [https://forums.factorio.com/viewtopic.php?t=67140 formatting requirements].
* thumbnail.png — Thumbnail to be shown on the mod portal and in the mod browser in-game. Ideally a 144x144px image file.
* settings.lua — This and the next two files are used to set up mod [[Tutorial:Mod settings|configuration options]].
* settings-updates.lua
* settings-final-fixes.lua
* data.lua — This and the next two files are used to define [[Prototype definitions|prototypes]].
* data-updates.lua — The load order of the three data*.lua files is explained on [https://lua-api.factorio.com/latest/Data-Lifecycle.html Data-Lifecycle].
* data-final-fixes.lua
* control.lua — This file is used for runtime scripting. Runtime scripting is documented on [https://lua-api.factorio.com/latest/index.html lua-api.factorio.com].

=== Subfolders ===
Furthermore, the following folders inside the mod folder are recognized by the game:
* locale — Can contain up to one subfolder per language, identified with the language code, for example <code>en</code> for English. The subfolder then has to contain at least one *.cfg file which defines the [[Tutorial:Localisation|translations]] for that language.
* scenarios — Custom [[scenario system|scenarios]] can be placed in subfolders of this folder.
* campaigns — Custom campaigns can be placed in subfolders of this folder.
* tutorials — Custom [[Prototype/Tutorial|tutorials]] can be placed in subfolders of this folder.
* migrations — [https://lua-api.factorio.com/latest/Migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.

=== Example ===
Here is an example directory structure for a mod titled <code>my-armor-mod</code> with a version number of <code>0.3.6</code>:

<pre>
my-armor-mod_0.3.6.zip
|- aFolderName/
|- control.lua
|- data.lua
|- info.json
|- thumbnail.png
</pre>

== info.json ==

The info.json file identifies the mod and defines its version. If the game encounters a problem when parsing the file, the error message can be found in the [[log file]]. A minimal info.json file can look like this:
{
"name": "test-mod-thing",
"version": "0.0.1",
"title": "My best test mod",
"author": "A very great tester",
"factorio_version": "1.1",
"dependencies": ["? optional-mod"]
}

The info.json file supports the following fields:

=== name ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The internal name of mod. The game accepts anything as a mod name, however the mod portal restricts mod names to only consist of alphanumeric characters, dashes and underscores. Note that the mod folder or mod zip file name has to contain the mod name, where the restrictions of the file system apply.

: The game accepts mod names with a maximum length of 100 characters. The mod portal only accepts mods with names that are longer than 3 characters and shorter than 50 characters.

=== version ===
: '''Type''': [[Types/string|string]]

: Mandatory field. Defines the version of the mod in the format <code>"number.number.number"</code> for <code>"main.major.minor"</code>, for example <code>"0.6.4"</code>. Each number can range from 0 to 65535.

=== title ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The display name of the mod, so it is not recommended to use someUgly_pRoGrAmMeR-name here. Can be overwritten with a locale entry in the <code>mod-name</code> category, using the internal mod name as the key.

: The game will reject a title field that is longer than 100 characters. However, this can be worked around by using the locale entry. The mod portal does not restrict mod title length.

=== author ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The author of the mod. This field does not have restrictions, it can also be a list of authors etc. The mod portal ignores this field, it will simply display the uploader's name as the author.

=== contact ===
: '''Type''': [[Types/string|string]]

: Optional field. How the mod author can be contacted, for example an email address.

=== homepage ===
: '''Type''': [[Types/string|string]]

: Optional field. Where the mod can be found on the internet. Note that the in-game mod browser shows the mod portal link additionally to this field. Please don't put "None" here, it makes the field on the mod portal website look ugly. Just leave the field empty if the mod doesn't have a website/forum thread/discord.

=== description ===
: '''Type''': [[Types/string|string]]

: Optional field. A short description of what your mod does. This is all that people get to see in-game. Can be overwritten with a locale entry in the <code>mod-description</code> category, using the internal mod name as the key.

=== factorio_version ===
: '''Type''': [[Types/string|string]]

: '''Default''': "0.12"

: Optional field. The major Factorio version that this mod supports. This can only be one version, not multiple. While the field is optional, usually mods are developed for major versions higher than the default 0.12, so the field has to be added anyway.
: Adding a minor version, e.g. "0.18.'''27'''" will make the mod portal reject the mod and the game act weirdly. That means this shouldn't be done; use only main and major version <code>"main.major"</code>, for example <code>"1.0"</code>.
: Mods with the factorio_version "0.18" can also be loaded in 1.0 and the mod portal will return them when queried for factorio_version 1.0 mods.

=== dependencies ===
: '''Type''': array of [[#Dependency]]

: '''Default''': ["base"]

: Optional field. Mods that this mod depends on or is incompatible with. If this mod depends on another, the other mod will load first, see [https://lua-api.factorio.com/latest/Data-Lifecycle.html Data-Lifecycle]. An empty array allows get around the default and have no dependencies at all.

: Example:
: <pre>"dependencies": ["mod-a", "? mod-c > 0.4.3", "! mod-g"]</pre>

:: <h4><span class="mw-headline" id="Dependency">Dependency</span></h4>
:: Each dependency is a string that consists of up to three parts: <code>"<prefix> internal-mod-name <equality-operator version>"</code>, for example <code>"? some-mod-everyone-loves >= 4.2.0"</code>. The possible prefixes are: <code>!</code> for incompatibility, <code>?</code> for an optional dependency, <code>(?)</code> for a hidden optional dependency, <code>~</code> for a dependency that does not affect load order, or no prefix for a hard requirement for the other mod. The equality operator (<code><, <=, =, >= or ></code>) combined with the version allows to define dependencies that require certain mod versions, but it is not required. Incompatibility does not support versions, if you use incompatibility you are incompatible with the entire mod.

Tutorial:Mod structure

2022-09-29T22:54:17Z

Raspberrypuppies: /* Files */ Aimed broken link at the only tutorial I know of

{{Languages}}Mods are expected to have a certain structure in order to be loaded by the game. This page aims to explain that file structure and what each file is used for.

== Mod folder and file structure ==

The mod must either be in a folder, or in a folder inside a zip file. The mod folder (no zip file) must either be named in the pattern of <code>{mod-name}_{version-number}</code> or just <code>{mod-name}</code>, for example <code>test-mod-thing</code>. The mod zip must be named in the pattern of <code>{mod-name}_{version-number}</code>, for example <code>test-mod-thing_0.0.1</code>. When using a zip file for the mod, the folder inside the zip file does not have any naming restrictions; only the zip file itself must be named with the <code>{mod-name}_{version-number}</code> pattern. The mod name and its version number are defined in the [[#info.json|info.json]] file.

=== Files ===
Inside the mod folder, the game automatically reads the following files during load:
* info.json — The only mandatory file. The [[#info.json|info.json]] identifies the mod, defines its version and other general properties.
* changelog.txt — Version history of the mod, to be shown in the mod browser. The changelog file must follow the strict [https://forums.factorio.com/viewtopic.php?t=67140].
* thumbnail.png — Thumbnail to be shown on the mod portal and in the mod browser in-game. Ideally a 144x144px image file.
* settings.lua — This and the next two files are used to set up mod [[Tutorial:Mod settings|configuration options]].
* settings-updates.lua
* settings-final-fixes.lua
* data.lua — This and the next two files are used to define [[Prototype definitions|prototypes]].
* data-updates.lua — The load order of the three data*.lua files is explained on [https://lua-api.factorio.com/latest/Data-Lifecycle.html Data-Lifecycle].
* data-final-fixes.lua
* control.lua — This file is used for runtime scripting. Runtime scripting is documented on [https://lua-api.factorio.com/latest/index.html lua-api.factorio.com].

=== Subfolders ===
Furthermore, the following folders inside the mod folder are recognized by the game:
* locale — Can contain up to one subfolder per language, identified with the language code, for example <code>en</code> for English. The subfolder then has to contain at least one *.cfg file which defines the [[Tutorial:Localisation|translations]] for that language.
* scenarios — Custom [[scenario system|scenarios]] can be placed in subfolders of this folder.
* campaigns — Custom campaigns can be placed in subfolders of this folder.
* tutorials — Custom [[Prototype/Tutorial|tutorials]] can be placed in subfolders of this folder.
* migrations — [https://lua-api.factorio.com/latest/Migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.

=== Example ===
Here is an example directory structure for a mod titled <code>my-armor-mod</code> with a version number of <code>0.3.6</code>:

<pre>
my-armor-mod_0.3.6.zip
|- aFolderName/
|- control.lua
|- data.lua
|- info.json
|- thumbnail.png
</pre>

== info.json ==

The info.json file identifies the mod and defines its version. If the game encounters a problem when parsing the file, the error message can be found in the [[log file]]. A minimal info.json file can look like this:
{
"name": "test-mod-thing",
"version": "0.0.1",
"title": "My best test mod",
"author": "A very great tester",
"factorio_version": "1.1",
"dependencies": ["? optional-mod"]
}

The info.json file supports the following fields:

=== name ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The internal name of mod. The game accepts anything as a mod name, however the mod portal restricts mod names to only consist of alphanumeric characters, dashes and underscores. Note that the mod folder or mod zip file name has to contain the mod name, where the restrictions of the file system apply.

: The game accepts mod names with a maximum length of 100 characters. The mod portal only accepts mods with names that are longer than 3 characters and shorter than 50 characters.

=== version ===
: '''Type''': [[Types/string|string]]

: Mandatory field. Defines the version of the mod in the format <code>"number.number.number"</code> for <code>"main.major.minor"</code>, for example <code>"0.6.4"</code>. Each number can range from 0 to 65535.

=== title ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The display name of the mod, so it is not recommended to use someUgly_pRoGrAmMeR-name here. Can be overwritten with a locale entry in the <code>mod-name</code> category, using the internal mod name as the key.

: The game will reject a title field that is longer than 100 characters. However, this can be worked around by using the locale entry. The mod portal does not restrict mod title length.

=== author ===
: '''Type''': [[Types/string|string]]

: Mandatory field. The author of the mod. This field does not have restrictions, it can also be a list of authors etc. The mod portal ignores this field, it will simply display the uploader's name as the author.

=== contact ===
: '''Type''': [[Types/string|string]]

: Optional field. How the mod author can be contacted, for example an email address.

=== homepage ===
: '''Type''': [[Types/string|string]]

: Optional field. Where the mod can be found on the internet. Note that the in-game mod browser shows the mod portal link additionally to this field. Please don't put "None" here, it makes the field on the mod portal website look ugly. Just leave the field empty if the mod doesn't have a website/forum thread/discord.

=== description ===
: '''Type''': [[Types/string|string]]

: Optional field. A short description of what your mod does. This is all that people get to see in-game. Can be overwritten with a locale entry in the <code>mod-description</code> category, using the internal mod name as the key.

=== factorio_version ===
: '''Type''': [[Types/string|string]]

: '''Default''': "0.12"

: Optional field. The major Factorio version that this mod supports. This can only be one version, not multiple. While the field is optional, usually mods are developed for major versions higher than the default 0.12, so the field has to be added anyway.
: Adding a minor version, e.g. "0.18.'''27'''" will make the mod portal reject the mod and the game act weirdly. That means this shouldn't be done; use only main and major version <code>"main.major"</code>, for example <code>"1.0"</code>.
: Mods with the factorio_version "0.18" can also be loaded in 1.0 and the mod portal will return them when queried for factorio_version 1.0 mods.

=== dependencies ===
: '''Type''': array of [[#Dependency]]

: '''Default''': ["base"]

: Optional field. Mods that this mod depends on or is incompatible with. If this mod depends on another, the other mod will load first, see [https://lua-api.factorio.com/latest/Data-Lifecycle.html Data-Lifecycle]. An empty array allows get around the default and have no dependencies at all.

: Example:
: <pre>"dependencies": ["mod-a", "? mod-c > 0.4.3", "! mod-g"]</pre>

:: <h4><span class="mw-headline" id="Dependency">Dependency</span></h4>
:: Each dependency is a string that consists of up to three parts: <code>"<prefix> internal-mod-name <equality-operator version>"</code>, for example <code>"? some-mod-everyone-loves >= 4.2.0"</code>. The possible prefixes are: <code>!</code> for incompatibility, <code>?</code> for an optional dependency, <code>(?)</code> for a hidden optional dependency, <code>~</code> for a dependency that does not affect load order, or no prefix for a hard requirement for the other mod. The equality operator (<code><, <=, =, >= or ></code>) combined with the version allows to define dependencies that require certain mod versions, but it is not required. Incompatibility does not support versions, if you use incompatibility you are incompatible with the entire mod.

Prototype/FluidStream

2022-09-29T22:47:31Z

Raspberrypuppies: /* Optional properties */

{{Prototype parent|Prototype/Entity}}
Used for example for the handheld flamethrower.

{{Prototype TOC|stream}}

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

{{Prototype property|particle_spawn_interval|[[Types/uint16|uint16]]}}
The stream will spawn one particle every particle_spawn_interval ticks until the particle_spawn_timeout is reached. The first particle will trigger an initial_action upon landing. Each particle triggers an action upon landing. Particles spawned within a single particle_spawn_timeout interval will be connected by a stretched spine_animation.

{{Prototype property|particle_horizontal_speed|[[Types/double|double]]}}
Must be larger than 0. particle_horizontal_speed has to be greater than particle_horizontal_speed_deviation.

{{Prototype property|particle_horizontal_speed_deviation|[[Types/double|double]]}}

{{Prototype property|particle_vertical_acceleration|[[Types/double|double]]}}

== Optional properties ==

{{Prototype property|initial_action|[[Types/Trigger|Trigger]]|optional=true}}
Action that is triggered when the first particle lands

{{Prototype property|action|[[Types/Trigger|Trigger]]|optional=true}}
Action that is triggered every time a particle lands

{{Prototype property|special_neutral_target_damage|[[Types/DamagePrototype|DamagePrototype]]|optional=true}}

{{Prototype property|width|[[Types/float|float]]|0.5|optional=true}}

{{Prototype property|particle_buffer_size|[[Types/uint32|uint32]]|20|optional=true}}
Number of spawned child particles of the stream. Must be greater than 0 and less than 256.

{{Prototype property|particle_spawn_timeout|[[Types/uint16|uint16]]|4 * <code>particle_spawn_interval</code>|optional=true}}

{{Prototype property|particle_start_alpha|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_end_alpha|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_start_scale|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_alpha_per_part|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_scale_per_part|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_fade_out_threshold|[[Types/float|float]]|1|optional=true}}
Value between 0 and 1.

{{Prototype property|particle_loop_exit_threshold|[[Types/float|float]]|0|optional=true}}
Value between 0 and 1.

{{Prototype property|particle_loop_frame_count|[[Types/uint16|uint16]]|1|optional=true}}
Will be set to 1 by the game if less than 1.

{{Prototype property|particle_fade_out_duration|[[Types/uint16|uint16]]|max uint16 (65553)|optional=true}}
Will be set to 1 by the game if less than 1.

{{Prototype property|spine_animation|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|particle|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|shadow|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|smoke_sources|[[Types/table|table]] of [[Types/SmokeSource|SmokeSource]]|optional=true}}
Smoke spawning is controlled by progress_to_create_smoke

{{Prototype property|progress_to_create_smoke|[[Types/float|float]]|0.5|optional=true}}
The point in the particles projectile arc to start spawning smoke. 0.5 (the default) starts spawning smoke at the halfway point between the source and target.

{{Prototype property|stream_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

{{Prototype property|ground_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

{{Prototype property|target_position_deviation|[[Types/double|double]]|0|optional=true}}

{{Prototype property|oriented_particle|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|shadow_scale_enabled|[[Types/bool|bool]]|false|optional=true}}

Prototype/FluidStream

2022-09-29T22:43:48Z

Raspberrypuppies: /* Mandatory properties */

{{Prototype parent|Prototype/Entity}}
Used for example for the handheld flamethrower.

{{Prototype TOC|stream}}

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

{{Prototype property|particle_spawn_interval|[[Types/uint16|uint16]]}}
The stream will spawn one particle every particle_spawn_interval ticks until the particle_spawn_timeout is reached. The first particle will trigger an initial_action upon landing. Each particle triggers an action upon landing. Particles spawned within a single particle_spawn_timeout interval will be connected by a stretched spine_animation.

{{Prototype property|particle_horizontal_speed|[[Types/double|double]]}}
Must be larger than 0. particle_horizontal_speed has to be greater than particle_horizontal_speed_deviation.

{{Prototype property|particle_horizontal_speed_deviation|[[Types/double|double]]}}

{{Prototype property|particle_vertical_acceleration|[[Types/double|double]]}}

== Optional properties ==

{{Prototype property|initial_action|[[Types/Trigger|Trigger]]|optional=true}}

{{Prototype property|action|[[Types/Trigger|Trigger]]|optional=true}}

{{Prototype property|special_neutral_target_damage|[[Types/DamagePrototype|DamagePrototype]]|optional=true}}

{{Prototype property|width|[[Types/float|float]]|0.5|optional=true}}

{{Prototype property|particle_buffer_size|[[Types/uint32|uint32]]|20|optional=true}}
Number of spawned child particles of the stream. Must be greater than 0 and less than 256.

{{Prototype property|particle_spawn_timeout|[[Types/uint16|uint16]]|4 * <code>particle_spawn_interval</code>|optional=true}}

{{Prototype property|particle_start_alpha|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_end_alpha|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_start_scale|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_alpha_per_part|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_scale_per_part|[[Types/float|float]]|1|optional=true}}

{{Prototype property|particle_fade_out_threshold|[[Types/float|float]]|1|optional=true}}
Value between 0 and 1.

{{Prototype property|particle_loop_exit_threshold|[[Types/float|float]]|0|optional=true}}
Value between 0 and 1.

{{Prototype property|particle_loop_frame_count|[[Types/uint16|uint16]]|1|optional=true}}
Will be set to 1 by the game if less than 1.

{{Prototype property|particle_fade_out_duration|[[Types/uint16|uint16]]|max uint16 (65553)|optional=true}}
Will be set to 1 by the game if less than 1.

{{Prototype property|spine_animation|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|particle|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|shadow|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|smoke_sources|[[Types/table|table]] of [[Types/SmokeSource|SmokeSource]]|optional=true}}

{{Prototype property|progress_to_create_smoke|[[Types/float|float]]|0.5|optional=true}}

{{Prototype property|stream_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

{{Prototype property|ground_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}

{{Prototype property|target_position_deviation|[[Types/double|double]]|0|optional=true}}

{{Prototype property|oriented_particle|[[Types/bool|bool]]|false|optional=true}}

{{Prototype property|shadow_scale_enabled|[[Types/bool|bool]]|false|optional=true}}