Official Factorio Wiki - User contributions [en]

Types/BaseAttackParameters

2020-05-16T13:30:48Z

Boodals: /* rotate_penalty */

The abstract base of all attack parameters.

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

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

=== 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

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

'''Default''': 1

If this is <= 0, it is set to 1.

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

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

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

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

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

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

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

=== 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_category</code> is not given, otherwise ignored.

Types/BaseAttackParameters

2020-05-16T13:10:46Z

Boodals: /* health_penalty */

The abstract base of all attack parameters.

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

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

=== 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

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

'''Default''': 1

If this is <= 0, it is set to 1.

=== 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

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

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

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

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

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

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

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

=== 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_category</code> is not given, otherwise ignored.

Prototype/Recipe

2019-09-09T21:48:34Z

Boodals: /* Recipe data */

{{Prototype parent|PrototypeBase}}
A recipe. It can be a crafting recipe, a smelting recipe, or a custom type of recipe (see [[Prototype/RecipeCategory]]).

{{Prototype TOC|recipe}}

== General properties ==
Inherits all properties from [[PrototypeBase]].

{{Prototype property|category|[[Types/string|string]]|"crafting"|optional=true}}
Optional. The category of this recipe. The built-in categories can be found [[Data.raw#recipe-category|here]]. See also [[Prototype/RecipeCategory]].

{{Prototype property|subgroup|[[Types/string|string]]||optional=true}}
Optional. The subgroup of this recipe. If not specified, defaults to the subgroup of the product if there is only 1, or main_product if multiple products exist. If multiple products exit and no main_product is specified, the subgroup is required.

{{Prototype property|icons, icon, icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]|optional=true}}
An icon is mandatory for recipe with more than 1 product and no main_product. Otherwise defaults to the icon of main_product/1 product.

If given, it overwrites the icon of the main_product/1 product.

{{Prototype property|crafting_machine_tint|[[Types/table|table]] of [[Types/Color|Color]]|optional=true}}
Optional.

Format:
<syntaxhighlight lang="lua">crafting_machine_tint = { primary = {r=0,g=0,b=0,a=0}, secondary = {r=0,g=0,b=0,a=0}, tertiary = {r=0,g=0,b=0,a=0}, quaternary = {r=0,g=0,b=0,a=0}}</syntaxhighlight>

Each key/value pair is optional and defaults to the above value.

== Recipe data ==
If the recipe does not have a difficulty, this is located directly in the prototype. Otherwise, if the "'''normal'''" or "'''expensive'''" property exists, the recipe has difficulty. Then, the recipe data has to be specified for each difficulty instead of directly in the prototype. If at least one difficulty has recipe data defined, the other difficulty can be set to <code>false</code>. This will disable the recipe for the difficulty, same as setting it <code>enabled = false</code>. If it is enabled (by technologies etc), it will use the data from the other difficulty. Not setting a difficulty, e.g. <code>normal = nil</code>, is possible and gives that difficulty the exact same properties as the difficulty that is defined. See below for examples.

{{Prototype property|ingredients|[[Types/table|table]] of [[Types/IngredientPrototype|IngredientPrototype]]}}
A table containing ingredient names and counts. Can also contain information about fluid temperature and catalyst amounts.
<syntaxhighlight lang="lua">
ingredients = {{"iron-stick", 2}, {"iron-plate", 3}}
</syntaxhighlight>
The same with full format:
<syntaxhighlight lang="lua">
ingredients = {{type = "item", name = "iron-stick", amount = 2}, {type = "item", name = "iron-plate", amount = 3}}
</syntaxhighlight>
For fluids, the full format always has to be used:
<syntaxhighlight lang="lua">
ingredients = {{type="fluid", name="water", amount=50}, {type="fluid", name="crude-oil", amount=100}}
</syntaxhighlight>
Maximal ingredient amount is 65535. The catalyst amounts are automatically calculated from the recipe, or can be set manually.[https://factorio.com/blog/post/fff-256]

{{Prototype property|result|[[Types/string|string]]|optional=true}}
Can be replaced with the results parameter. The item created by this recipe. Must be the name of an item, such as "iron-gear-wheel".

{{Prototype property|result_count|[[Types/uint32|uint32]]|1|optional=true}}
Optional. The number of items created by this recipe.

{{Prototype property|results|[[Types/table|table]] of [[Types/ProductPrototype|ProductPrototype]]|optional=true}}
A table containing result names and counts. Can also contain information about fluid temperature and catalyst amounts. The catalyst amounts are automatically calculated from the recipe, or can be set manually.[https://factorio.com/blog/post/fff-256]

<syntaxhighlight lang="lua">
results=
{
{type="fluid", name="heavy-oil", amount=3},
{type="fluid", name="light-oil", amount=3},
{type="fluid", name="petroleum-gas", amount=4}
},
</syntaxhighlight>
<syntaxhighlight lang="lua">
results =
{
{type = "item", name = "iron-nuggets", amount = 9},
{type = "item", name = "gold-nuggets", amount = 1}
},
</syntaxhighlight>

{{Prototype property|energy_required|[[Types/double|double]]|0.5|optional=true}}
Optional. The amount of time it takes to make this recipe.

This is the number of seconds it takes to craft at crafting speed 1.

{{Prototype property|emissions_multiplier|[[Types/double|double]]|1.0|optional=true}}

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

{{Prototype property|overload_multiplier|[[Types/uint32|uint32]]|0|optional=true}}
Used to determine how many extra items are put into an assembling machine before it's considered "full enough".

If set to 0, it instead uses the following formula: 1.166 / (energy_required / the assembler's crafting_speed), rounded up, and clamped between 2 and 100.

{{Prototype property|enabled|[[Types/bool|bool]]|true|optional=true}}
Optional. This can be false to disable the recipe at the start of the game, or "true" to leave it enabled.

If your recipe is unlocked by a technology, you should set this to "false".

{{Prototype property|hidden|[[Types/bool|bool]]|false|optional=true}}
Optional. Hides the recipe from crafting menus.

{{Prototype property|hide_from_stats|[[Types/bool|bool]]|false|optional=true}}
Optional. Hides the recipe from flow stats (item/fluid production statistics).

{{Prototype property|hide_from_player_crafting|[[Types/bool|bool]]|false|optional=true}}
Optional. Hides the recipe from the player's crafting screen. The recipe will still show up for selection in machines.

{{Prototype property|allow_decomposition|[[Types/bool|bool]]|true|optional=true}}
Optional. Whether this recipe is allowed to be broken down for the recipe tooltip "Total raw" calculations.

{{Prototype property|allow_as_intermediate|[[Types/bool|bool]]|true|optional=true}}
Optional. Whether the recipe can be used as an intermediate recipe in hand-crafting.

{{Prototype property|allow_intermediates|[[Types/bool|bool]]|true|optional=true}}
Optional. Whether the recipe is allowed to use intermediate recipes when hand-crafting.

{{Prototype property|always_show_made_in|[[Types/bool|bool]]|false|optional=true}}
Optional. Whether the "Made in: {Machine}" part of the tool-tip should always be present, not only when the recipe can not be hand-crafted.

{{Prototype property|show_amount_in_title|[[Types/bool|bool]]|true|optional=true}}
Optional. Whether the recipe name should have the product amount in front of it, e.g. "2 [[transport belt]]"

{{Prototype property|always_show_products|[[Types/bool|bool]]|false|optional=true}}
Optional. Whether the products are always shown in the recipe tool-tip.

{{Prototype property|main_product|[[Types/string|string]]|optional=true}}
Optional.

For recipes with more than one product: This defines of which result the icon, subgroup and name is used. If it is not set and the recipe has more than 1 result the recipe will use the recipe-name and recipe-description locale and its own subgroup and icon.

For recipes with 1 result: The recipe uses the icon, subgroup and name of the result by default. If set this property is set to an empty string, the recipe will use the properties of the recipe instead of the result.

== Examples ==

=== "iron-plate" ===
<syntaxhighlight lang="lua">
{
type = "recipe",
name = "iron-plate",
category = "smelting",
energy_required = 3.5,
ingredients = {{"iron-ore", 1}},
result = "iron-plate"
}</syntaxhighlight>

=== "coal-liquefaction" ===

<syntaxhighlight lang="lua">{
type = "recipe",
name = "coal-liquefaction",
category = "oil-processing",
subgroup = "fluid-recipes",
order = "a[oil-processing]-c[coal-liquefaction]",
enabled = false,
energy_required = 5,
icon = "__base__/graphics/icons/fluid/coal-liquefaction.png",
icon_size = 32,
ingredients =
{
{type="item", name="coal", amount=10},
{type="fluid", name="heavy-oil", amount=25},
{type="fluid", name="steam", amount=50}
},
results=
{
{type="fluid", name="heavy-oil", amount=35},
{type="fluid", name="light-oil", amount=15},
{type="fluid", name="petroleum-gas", amount=20}
},
allow_decomposition = false
}</syntaxhighlight>

=== "iron-gear-wheel" — recipe with difficulty ===
<syntaxhighlight lang="lua"> {
type = "recipe",
name = "iron-gear-wheel",
normal =
{
ingredients = {{"iron-plate", 2}},
result = "iron-gear-wheel"
},
expensive =
{
ingredients = {{"iron-plate", 4}},
result = "iron-gear-wheel"
}
},</syntaxhighlight>

==== Modified so that it cannot be crafted in normal mode, unless unlocked via command/research ====
<syntaxhighlight lang="lua"> {
type = "recipe",
name = "iron-gear-wheel",
normal = false,
expensive =
{
ingredients = {{"iron-plate", 4}},
result = "iron-gear-wheel"
}
},</syntaxhighlight>

==== Modified so that the expensive recipe is always used, even in normal mode ====
<syntaxhighlight lang="lua"> {
type = "recipe",
name = "iron-gear-wheel",
normal = nil, --this line can be omitted
expensive =
{
ingredients = {{"iron-plate", 4}},
result = "iron-gear-wheel"
}
},</syntaxhighlight>

Types/EntityPrototypeFlags

2019-01-05T05:39:54Z

Boodals: Replaced old references to creepers with biters, and fixed a typo

== "not-rotatable" ==
Can't be rotated before or after placing.

== "placeable-[force]" ==
*"placeable-player"
*"placeable-neutral"
*"placeable-enemy"
placeable neutral/player/enemy will add the entities to the screens in the map editor. For example, the biter-spawner has the placeable-player and placeable-enemy flags. If you go into the map editor and use 'f' to switch between player entities and enemy entities you will see that both have a biter spawner. If you were to place one of each in the map (along with a player) and then save/play it, you would see the biters attacking each other since they are on opposing forces. On the other hand, if you were to add the "placeable-neutral" flag and (after restarting factorio if you left it running) place one next to the two previous spawners, the neutral biters would neither attack the other biters nor be attacked by them.

== "placeable-off-grid" ==
placeable-off-grid refers to the fact that most entities are placed on an invisible 'grid' within the world, entities with the placeable-off-grid flag do not have to line up with this grid (like trees and land-mines)

== "player-creation" ==
Makes it possible for the biter AI to target the entity as a distraction.

== "building-direction-8-way" ==
Uses 45 degree angle increments when selecting direction.

== "filter-directions" ==
Used to automatically detect the proper direction, if possible. Used by base with the pump, train stop, and train signal.

== "fast-replaceable-no-build-while-moving" ==
Fast replace will not apply when building while moving.

== "breaths-air" ==
This is used to specify that the entity breaths air, and so is affected by poison (currently [[Poison_capsule|Poison Capsules]] are the only source).

== "not-repairable" ==
Used to specify that the entity can not be 'healed' by repair-packs (or construction robots with repair packs)

== "not-blueprintable" ==
The entity can't be used in blueprints.

== "not-deconstructable" ==
The entity can't be deconstructed.

== "not-on-map" ==
The entity does not get drawn on the map.

== "hide-from-bonus-gui" ==
Hides the entity from the bonus GUI (button above the map).

== "hide-alt-info" ==
Hides the alt-info of an entity in alt-mode, for example the recipe icon.

== "fast-replaceable-no-cross-type-while-moving" ==
Do not fast replace over other entity types when building while moving.

== "no-gap-fill-while-building" ==

== "not-flammable" ==
Do not apply fire stickers to the entity.

== Example ==
flags = {"placeable-neutral", "player-creation"}

Prototype/Technology

2019-01-03T16:02:57Z

Boodals: /* effects */

==Basics==
More in [[Research]]

== General properties ==
Inherits all properties from [[Prototype]].

=== icons, icon, icon_size (IconSpecification) ===
'''Type''': [[Types/IconSpecification]]

=== name ===
:''See [[Prototype#name ]]''

Inherited from [[Prototype]]. If the name ends with <code>-number</code>, the number is ignored for localization purposes. E. g. if the name is <code>whatever-name-3</code>, the game looks for the <code>technology-name.whatever-name</code> localization. The technology tree will also show the number on the technology icon.

== Technology data ==
If the technology does not have a difficulty, this is located directly in the prototype. Otherwise, if the "normal" or "expensive" property exists, the technology has difficulty. Then, the technology data has to be specified for each difficulty instead of directly in the prototype. If at least one difficulty has technology data defined, the other difficulty can be set to false. This will give it the exact same properties as the difficulty that is defined.

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

'''Default''': false

When set to true, and the technology contains several levels, only the relevant one is displayed in the technology screen.
<syntaxhighlight lang="lua"> {
type = "technology",
name = "rocket-damage-2",
...
upgrade = "true"
}</syntaxhighlight>

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

'''Default''': true

=== unit ===
It contains
* count — [[Types/double]] — How many units are needed. Must be positive.
* count_formula — [[Types/string]] — Formula that specifies how many units are needed per level of the infinite technology. May not be specified if count is speficied.
* time — [[Types/double]] — How much time is needed per one unit, in lab with crafting speed 1 it is the number of seconds.
* ingredients — list of ingredients needed for one units
unit =
{
count = 20,
time = 5,
ingredients = { ["science-pack-1"] = 1 }
}

=== max_level ===
'''Type''': [[Types/uint32]] or [[Types/string]]

'''Default''': Same as the level of the technology, which is 0 for non-upgrades, and the level of the upgrade for upgrades.

"infinite" for infinite technologies, otherwise uint.

=== prerequisites ===
List of technologies needed to be researched before this one can be researched.
prerequisites = {"explosives", "military-2"}

=== effects ===
'''Type''': [[Types/table]] of [http://lua-api.factorio.com/latest/Concepts.html#Modifier Modifier]

List of effects of the technology (applied when the technology is researched).

{
{
type = "unlock-recipe",
recipe = "land-mine"
}
}