https://wiki.factorio.com/api.php?action=feedcontributions&feedformat=atom&user=CubeOfficial Factorio Wiki - User contributions [en]2026-04-21T14:45:52ZUser contributionsMediaWiki 1.43.5https://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=126176Types/AutoplaceSpecification2016-07-19T08:55:53Z<p>Cube: Clarified new influence calculation in starting area</p>
<hr />
<div>{{Languages}}<br />
Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability_Calculation|Probability Calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability_Calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness_Calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness_Calculation]].<br />
<br />
=== richness_multiplier_distance_bonus ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus to richness multiplier per tile of distance from starting point.<br />
See [[#Richness_Calculation]].<br />
<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== order ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
'''Since''': 0.9.0<br />
<br />
Order for placing the entity (has no effect when placing tiles). Entities whose order compares less are placed earlier (this influences placing multiple entities which collide with itself), from entities with equal order string only one with the highest probability is placed.<br />
<br />
=== size_control_multiplier ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Magic. Based on sum of influences of noises.<br />
<br />
'''Since''': 0.9.2<br />
<br />
'''Until''': 0.12.x<br />
<br />
This value times the size control setting is added to influence right before sharpness filter.<br />
Very small has a multiplier of -1, very big has 1.5.<br />
This value is replaced by ```coverage``` parameter in 0.13.0.<br />
<br />
=== random_probability_penalty ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
A random value between 0 and this number is subtracted from a probability after sharpness filter.<br />
Only works for entities.<br />
See [[#Probability_Calculation]].<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
=== coverage ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Calculated from existing peaks.<br />
<br />
'''Since''': 0.13.0<br />
<br />
Sets a fraction of surface that should be covered by this item.<br />
<br />
Internally this adds an additive influence modifier, so that expected fraction of tiles where total influence > 0.5 (the threshold for sharpness filter) equals the parameter.<br />
<br />
Because of the autoplace system's complexity, this is only accurate on simple rules and does some simplification on the more complex ones:<br />
* There is always just one combination of tile properties (see [[#Dimensions]]) for which the coverage is calculated. This combination is given by a first *_optimal value encountered of each type other than starting_area and tier_from_start. Starting_area value is fixed to 0 and tier_from_start to 4.<br />
* min_influence and max_influence are completely ignored.<br />
<br />
=== starting_area_amount ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
'''Since''': 0.13.10<br />
<br />
If this value is non zero, influence of this entity will be calculated differently in starting area:<br />
For each entity with this parameter a position in starting area is selected and a blob is placed centered on this position.<br />
The central tile of this blob will have approximately amount of resources selected by this value.<br />
<br />
=== starting_area_size ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': 10<br />
<br />
'''Since''': 0.13.10<br />
<br />
See [[#starting_area_amount]].<br />
Controls approximate radius of the blob in tiles.<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence_Calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
You can see sheets on the generation of trees, doodads, biomes, water and tiles on this page: [[AutoplaceSheets]]<br />
<br />
== Influence Calculation ==<br />
<br />
There are two possible modes in which influence is calculated.<br />
By default influence is calculated as a sum of influences of peaks (see next paragraph).<br />
When [[#starting_area_amount]] parameter is non zero a position in starting area is selected and a blob is placed centered on this position.<br />
Influence is then a maximum of the default calculated value and a value obtained from this blob.<br />
<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions and sum of these individual distances is used as a distance from optimal conditions.<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability_Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences plus a [[#size_control_multiplier|bonus for autoplace control]], passed through a [[#sharpness|sharpening filter]], multiplied by [[#max_probability|max_probability]] and finally a random value gets subtracted.<br />
<br />
max_probability * sharpness_filter(sum of influences + size modifier from GUI) - random(0, random_probability_penalty)<br />
<br />
== Richness_Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * ([[#richness_multiplier|richness_multiplier]] + distance * [[#richness_multiplier_distance_bonus|richness_multiplier_distance_bonus]]) + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=126152Types/AutoplaceSpecification2016-07-18T09:40:46Z<p>Cube: Added starting_area_amount.</p>
<hr />
<div>{{Languages}}<br />
Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability_Calculation|Probability Calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability_Calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness_Calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness_Calculation]].<br />
<br />
=== richness_multiplier_distance_bonus ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus to richness multiplier per tile of distance from starting point.<br />
See [[#Richness_Calculation]].<br />
<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== order ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
'''Since''': 0.9.0<br />
<br />
Order for placing the entity (has no effect when placing tiles). Entities whose order compares less are placed earlier (this influences placing multiple entities which collide with itself), from entities with equal order string only one with the highest probability is placed.<br />
<br />
=== size_control_multiplier ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Magic. Based on sum of influences of noises.<br />
<br />
'''Since''': 0.9.2<br />
<br />
'''Until''': 0.12.x<br />
<br />
This value times the size control setting is added to influence right before sharpness filter.<br />
Very small has a multiplier of -1, very big has 1.5.<br />
This value is replaced by ```coverage``` parameter in 0.13.0.<br />
<br />
=== random_probability_penalty ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
A random value between 0 and this number is subtracted from a probability after sharpness filter.<br />
Only works for entities.<br />
See [[#Probability_Calculation]].<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
=== coverage ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Calculated from existing peaks.<br />
<br />
'''Since''': 0.13.0<br />
<br />
Sets a fraction of surface that should be covered by this item.<br />
<br />
Internally this adds an additive influence modifier, so that expected fraction of tiles where total influence > 0.5 (the threshold for sharpness filter) equals the parameter.<br />
<br />
Because of the autoplace system's complexity, this is only accurate on simple rules and does some simplification on the more complex ones:<br />
* There is always just one combination of tile properties (see [[#Dimensions]]) for which the coverage is calculated. This combination is given by a first *_optimal value encountered of each type other than starting_area and tier_from_start. Starting_area value is fixed to 0 and tier_from_start to 4.<br />
* min_influence and max_influence are completely ignored.<br />
<br />
=== starting_area_amount ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
'''Since''': 0.13.10<br />
<br />
If this value is non zero, influence of this entity will be calculated differently in starting area:<br />
For each entity with this parameter a position in starting area is selected and a blob is placed centered on this position.<br />
The central tile of this blob will have approximately amount of resources selected by this value.<br />
<br />
=== starting_area_size ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': 10<br />
<br />
'''Since''': 0.13.10<br />
<br />
See [[#starting_area_amount]].<br />
Controls approximate radius of the blob in tiles.<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence_Calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
You can see sheets on the generation of trees, doodads, biomes, water and tiles on this page: [[AutoplaceSheets]]<br />
<br />
== Influence Calculation ==<br />
<br />
There are two possible modes in which influence is calculated.<br />
When [[#starting_area_amount]] parameter is non zero a position in starting area is selected and a blob is placed centered on this position.<br />
Otherwise influence is calculated as a sum of influences of peaks.<br />
<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions and sum of these individual distances is used as a distance from optimal conditions.<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability_Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences plus a [[#size_control_multiplier|bonus for autoplace control]], passed through a [[#sharpness|sharpening filter]], multiplied by [[#max_probability|max_probability]] and finally a random value gets subtracted.<br />
<br />
max_probability * sharpness_filter(sum of influences + size modifier from GUI) - random(0, random_probability_penalty)<br />
<br />
== Richness_Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * ([[#richness_multiplier|richness_multiplier]] + distance * [[#richness_multiplier_distance_bonus|richness_multiplier_distance_bonus]]) + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=125234Types/AutoplaceSpecification2016-05-25T08:41:20Z<p>Cube: Autoplace changes for 0.13.0</p>
<hr />
<div>{{Languages}}<br />
Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability_Calculation|Probability Calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability_Calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness_Calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness_Calculation]].<br />
<br />
=== richness_multiplier_distance_bonus ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus to richness multiplier per tile of distance from starting point.<br />
See [[#Richness_Calculation]].<br />
<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== order ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
'''Since''': 0.9.0<br />
<br />
Order for placing the entity (has no effect when placing tiles). Entities whose order compares less are placed earlier (this influences placing multiple entities which collide with itself), from entities with equal order string only one with the highest probability is placed.<br />
<br />
=== size_control_multiplier ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Magic. Based on sum of influences of noises.<br />
<br />
'''Since''': 0.9.2<br />
<br />
'''Until''': 0.12.x<br />
<br />
This value times the size control setting is added to influence right before sharpness filter.<br />
Very small has a multiplier of -1, very big has 1.5.<br />
This value is replaced by ```coverage``` parameter in 0.13.0.<br />
<br />
=== random_probability_penalty ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
A random value between 0 and this number is subtracted from a probability after sharpness filter.<br />
Only works for entities.<br />
See [[#Probability_Calculation]].<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
=== coverage ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Calculated from existing peaks.<br />
<br />
'''Since''': 0.13.0<br />
<br />
Sets a fraction of surface that should be covered by this item.<br />
<br />
Internally this adds an additive influence modifier, so that expected fraction of tiles where total influence > 0.5 (the threshold for sharpness filter) equals the parameter.<br />
<br />
Because of the autoplace system's complexity, this is only accurate on simple rules and does some simplification on the more complex ones:<br />
* There is always just one combination of tile properties (see [[#Dimensions]]) for which the coverage is calculated. This combination is given by a first *_optimal value encountered of each type other than starting_area and tier_from_start. Starting_area value is fixed to 0 and tier_from_start to 4.<br />
* min_influence and max_influence are completely ignored.<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence_Calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
You can see sheets on the generation of trees, doodads, biomes, water and tiles on this page: [[AutoplaceSheets]]<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability_Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences plus a [[#size_control_multiplier|bonus for autoplace control]], passed through a [[#sharpness|sharpening filter]], multiplied by [[#max_probability|max_probability]] and finally a random value gets subtracted.<br />
<br />
max_probability * sharpness_filter(sum of influences + size modifier from GUI) - random(0, random_probability_penalty)<br />
<br />
== Richness_Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * ([[#richness_multiplier|richness_multiplier]] + distance * [[#richness_multiplier_distance_bonus|richness_multiplier_distance_bonus]]) + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=119956Types/AutoplaceSpecification2015-06-29T10:29:27Z<p>Cube: Added random_probability_penalty</p>
<hr />
<div>{{Languages}}<br />
Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability_Calculation|Probability Calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability_Calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness_Calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness_Calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== order ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
'''Since''': 0.9.0<br />
<br />
Order for placing the entity (has no effect when placing tiles). Entities whose order compares less are placed earlier (this influences placing multiple entities which collide with itself), from entities with equal order string only one with the highest probability is placed.<br />
<br />
=== size_control_multiplier ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Magic. Based on sum of influences of noises.<br />
<br />
'''Since''': 0.9.2<br />
<br />
This value times the size control setting is added to influence right before sharpness filter.<br />
Very small has a multiplier of -1, very big has 1.5.<br />
<br />
=== random_probability_penalty ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
A random value between 0 and this number is subtracted from a probability after sharpness filter.<br />
Only works for entities.<br />
See [[#Probability_Calculation]].<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence_Calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
You can see sheets on the generation of trees, doodads, biomes, water and tiles on this page: [[AutoplaceSheets]]<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability_Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences plus a [[#size_control_multiplier|bonus for autoplace control]], passed through a [[#sharpness|sharpening filter]], multiplied by [[#max_probability|max_probability]] and finally a random value gets subtracted.<br />
<br />
max_probability * sharpness_filter(sum of influences + size modifier from GUI) - random(0, random_probability_penalty)<br />
<br />
== Richness_Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Multiplayer&diff=119634Multiplayer2015-06-11T08:58:35Z<p>Cube: Headless server in 0.12.0</p>
<hr />
<div>{{Languages}}<br />
<br />
The multiplayer feature was introduced with v0.11.0 and will be thought only for ''Lan-parties'' or ''Low-latency internet'', because there is no much lag latency hiding mechanics introduced.<br />
<br />
The game is technically a peer2peer game. Which means, there is no ''server'' needed.<br />
<br />
Anybody can join an existing game, if he knows the IP of the game. He connects to the game, the game stops and the second players game downloads the current map. If the first hoster stops, the second player can continue to play and the first player can rejoin at any time. If the game desynchronizes, the map is redownloaded automatically and the game can continue.<br />
<br />
== Playing over LAN / Internet ==<br />
<br />
Playing over Internet was not thought to work properly with v0.11. Noticeable lag could occur depending on connection speed/reaction time.<br />
<br />
* Both game instances need the installation of exactly same game-versions and mods. (Tip: Maybe someone has the scenario pack mod off?)<br />
* For a more fluid game the "clients" can turn off autosave.<br />
* Factorio uses the port '''34197'''. The port can be changed in the [[Application Directory|config]].<br />
* Factorio uses '''UDP only,''' so make sure, you configured your router correctly. (The game builds it's own "reliable delivery" layer built on UDP to deal with packet loss and reordering issues.)<br />
** Make sure, that there is no firewall or anti-virus blocking the UDP-packets.<br />
** read further, look into "more guides", to configure your router set up.<br />
** It is necessary that all of the peers can communicate with each other. It is however in theory not necessary that all the peers have public IP address - this should work even behind a NAT. See [http://www.factorioforums.com/forum/viewtopic.php?f=30&p=51201#p50553 Cube in ''Cannot Have 3+ Players connected at the same time.]''<br />
* The hard limit for the number of players is [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6481&p=50661#p50586 65535]. :) <br />
<br />
=== Voice Chat ===<br />
* it is recommended to use some voice chat (teamspeak, Skype), because you need to talk a lot (coordinate connection, building, handling attacks...). Teamspeak servers are posted in the [http://www.factorioforums.com/forum/viewforum.php?f=53 multiplayer forum].<br />
<br />
=== Finding other Peers ===<br />
<br />
* use the [http://www.factorioforums.com/forum/viewforum.php?f=53 multiplayer board in the forum].<br />
* many players use other software like Hamachi or Evolve to meet other players ... This has the "advantage" of creating a virtual private network between the players. See down under software.<br />
* some use also [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=9136 Steam] to find others.<br />
<br />
== Factorio servers or Why Peer-to-Peer? ==<br />
<br />
There where some discussions about, why Factorio doesn't use the client+server-model, but instead uses the peer-to-peer-priniciple.<br />
With v0.11 there will be no explicit support for making Factorio "servers". That will come with v0.12!<br />
<br />
If you want to make a world running 24/7 you need to start whole Factorio on your "server" machine and keep it running, it works just as a peer. The server instance will then have a character in the game just like anybody else. <br />
<br />
Some links<br />
<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=38&p=74091#p73402 developer statement]<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=6077#p47283 Older statement]<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=38&p=70874 Good explanation]<br />
<br />
==== Headless server ====<br />
{{Experimental|0.12.0}}<br />
<br />
A dedicated server can be started using the '--start-server' command line option.<br />
In this mode:<br />
* Graphics is not initialized (faster start up, less memory usage, works even on completely headless servers)<br />
* Game starts immediately, loads a save given as a parameter to the command<br />
* The server has no character in game<br />
* game is paused while there are no players connected<br />
* saves the game on exit (and autosaves normally)<br />
<br />
Workarounds in version 0.11.x:<br />
<br />
* Linux Headless server / vnc: http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6449<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6585 Dedicated Multiplayer Server Guide]<br />
<br />
== Game types ==<br />
<br />
=== Coop ===<br />
<br />
Coop-game runs without any further preparation ( http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6501 )<br />
<br />
=== PvP ===<br />
<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=14&t=8352 PvP with craftable biters]<br />
<br />
== Technical Implementation ==<br />
<br />
* [http://www.factorio.com/blog/post/fff-76 Friday facts article]<br />
<br />
== More Tools/Infos ==<br />
* use mods for planning. See [http://www.factorioforums.com/forum/viewtopic.php?f=14&t=6788 basic planner], [http://www.factorioforums.com/forum/viewtopic.php?f=14&t=4022 Planning-Tool-Mod]...<br />
* look into [http://www.factorioforums.com/forum/viewforum.php?f=53 multiplayer forum], most other questions are answered there.<br />
<br />
''And always remember that Factorio in v0.11 isn't intended to work well on internet connections, so keep patient. ;)<br />
<br />
== More Guides ==<br />
<br />
* [http://youtube.com/watch?v=MqsqRWNsbPM How To set up a Factorio Multiplayer Server | Guide | Tutorial], by Teaspoon<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6585 Dedicated Multiplayer Server Guide], by Icecube45<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6720 Tips to connect in multiplayer], by Nondre<br />
<br />
== Miscellaneous tips ==<br />
* the key for [[Console commands]] will now initiate a chat in MP. To execute commands you need to type '/c' before the command!<br />
* Set the player's color using the command<br />
/c game.players[x].color = {r=0.7, g=0.5, b=0.1, a=0.9}<br />
Where x is the player number. r, g and b are for red, green and blue respectively (possible values are between 0 and 1, use the right-most column on http://prideout.net/archive/colors.php). a is alpha channel aka Transparency of the color to the base texture. For single player, leave off the "[x]" to set the color.<br />
<br />
== Software for routing / establishing connection ==<br />
<br />
* http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6393<br />
* http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6386<br />
* http://www.factorioforums.com/forum/viewtopic.php?f=49&t=7690<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=7714 A guide for connecting with evolve]<br />
<br />
<br />
<br />
{{Stub}}</div>Cubehttps://wiki.factorio.com/index.php?title=Multiplayer&diff=119633Multiplayer2015-06-11T08:45:17Z<p>Cube: Multplayer is now stable.</p>
<hr />
<div>{{Languages}}<br />
<br />
The multiplayer feature was introduced with v0.11.0 and will be thought only for ''Lan-parties'' or ''Low-latency internet'', because there is no much lag latency hiding mechanics introduced.<br />
<br />
The game is technically a peer2peer game. Which means, there is no ''server'' needed.<br />
<br />
Anybody can join an existing game, if he knows the IP of the game. He connects to the game, the game stops and the second players game downloads the current map. If the first hoster stops, the second player can continue to play and the first player can rejoin at any time. If the game desynchronizes, the map is redownloaded automatically and the game can continue.<br />
<br />
== Playing over LAN / Internet ==<br />
<br />
Playing over Internet was not thought to work properly with v0.11. Noticeable lag could occur depending on connection speed/reaction time.<br />
<br />
* Both game instances need the installation of exactly same game-versions and mods. (Tip: Maybe someone has the scenario pack mod off?)<br />
* For a more fluid game the "clients" can turn off autosave.<br />
* Factorio uses the port '''34197'''. The port can be changed in the [[Application Directory|config]].<br />
* Factorio uses '''UDP only,''' so make sure, you configured your router correctly. (The game builds it's own "reliable delivery" layer built on UDP to deal with packet loss and reordering issues.)<br />
** Make sure, that there is no firewall or anti-virus blocking the UDP-packets.<br />
** read further, look into "more guides", to configure your router set up.<br />
** It is necessary that all of the peers can communicate with each other. It is however in theory not necessary that all the peers have public IP address - this should work even behind a NAT. See [http://www.factorioforums.com/forum/viewtopic.php?f=30&p=51201#p50553 Cube in ''Cannot Have 3+ Players connected at the same time.]''<br />
* The hard limit for the number of players is [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6481&p=50661#p50586 65535]. :) <br />
<br />
=== Voice Chat ===<br />
* it is recommended to use some voice chat (teamspeak, Skype), because you need to talk a lot (coordinate connection, building, handling attacks...). Teamspeak servers are posted in the [http://www.factorioforums.com/forum/viewforum.php?f=53 multiplayer forum].<br />
<br />
=== Finding other Peers ===<br />
<br />
* use the [http://www.factorioforums.com/forum/viewforum.php?f=53 multiplayer board in the forum].<br />
* many players use other software like Hamachi or Evolve to meet other players ... This has the "advantage" of creating a virtual private network between the players. See down under software.<br />
* some use also [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=9136 Steam] to find others.<br />
<br />
== Factorio servers or Why Peer-to-Peer? ==<br />
<br />
There where some discussions about, why Factorio doesn't use the client+server-model, but instead uses the peer-to-peer-priniciple.<br />
With v0.11 there will be no explicit support for making Factorio "servers". That will come with v0.12!<br />
<br />
If you want to make a world running 24/7 you need to start whole Factorio on your "server" machine and keep it running, it works just as a peer. The server instance will then have a character in the game just like anybody else. <br />
<br />
Some links<br />
<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=38&p=74091#p73402 developer statement]<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=6077#p47283 Older statement]<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=38&p=70874 Good explanation]<br />
<br />
==== Headless server ====<br />
<br />
* Linux Headless server / vnc (Maybe too soon?): http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6449<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6585 Dedicated Multiplayer Server Guide]<br />
<br />
== Game types ==<br />
<br />
=== Coop ===<br />
<br />
Coop-game runs without any further preparation ( http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6501 )<br />
<br />
=== PvP ===<br />
<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=14&t=8352 PvP with craftable biters]<br />
<br />
== Technical Implementation ==<br />
<br />
* [http://www.factorio.com/blog/post/fff-76 Friday facts article]<br />
<br />
== More Tools/Infos ==<br />
* use mods for planning. See [http://www.factorioforums.com/forum/viewtopic.php?f=14&t=6788 basic planner], [http://www.factorioforums.com/forum/viewtopic.php?f=14&t=4022 Planning-Tool-Mod]...<br />
* look into [http://www.factorioforums.com/forum/viewforum.php?f=53 multiplayer forum], most other questions are answered there.<br />
<br />
''And always remember that Factorio in v0.11 isn't intended to work well on internet connections, so keep patient. ;)<br />
<br />
== More Guides ==<br />
<br />
* [http://youtube.com/watch?v=MqsqRWNsbPM How To set up a Factorio Multiplayer Server | Guide | Tutorial], by Teaspoon<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6585 Dedicated Multiplayer Server Guide], by Icecube45<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6720 Tips to connect in multiplayer], by Nondre<br />
<br />
== Miscellaneous tips ==<br />
* the key for [[Console commands]] will now initiate a chat in MP. To execute commands you need to type '/c' before the command!<br />
* Set the player's color using the command<br />
/c game.players[x].color = {r=0.7, g=0.5, b=0.1, a=0.9}<br />
Where x is the player number. r, g and b are for red, green and blue respectively (possible values are between 0 and 1, use the right-most column on http://prideout.net/archive/colors.php). a is alpha channel aka Transparency of the color to the base texture. For single player, leave off the "[x]" to set the color.<br />
<br />
== Software for routing / establishing connection ==<br />
<br />
* http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6393<br />
* http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6386<br />
* http://www.factorioforums.com/forum/viewtopic.php?f=49&t=7690<br />
* [http://www.factorioforums.com/forum/viewtopic.php?f=53&t=7714 A guide for connecting with evolve]<br />
<br />
<br />
<br />
{{Stub}}</div>Cubehttps://wiki.factorio.com/index.php?title=Log_file&diff=117531Log file2015-01-14T09:49:02Z<p>Cube: added example for posting log files on the forum.</p>
<hr />
<div>Log files store details about the run of Factorio and contain information that help when solving bugs.<br />
Log files exist from version 0.10.0.<br />
<br />
== Log File Location ==<br />
Factorio keeps log files in the [[Application Directory]], that is next to the saves and mods directories.<br />
<br />
The file you need most of the time is '''factorio-current.log'''.<br />
Backup copy of the log file from previous run is in factorio-previous.log.<br />
<br />
== Bug Reporting ==<br />
Log files are important for finding crashes, especially ones related to automatic updates and graphic settings.<br />
Please attach the current log file to all crash reports.<br />
<br />
=== How to post bug report on the forum ===<br />
use the [code] bbcode tag, or if it is long then use also [spoiler] tag.<br />
Example bbcode:<br />
[spoiler=log file][code]<br />
353957.462433 Info Logger.cpp:148: 2015:01:14 10:44:20; Factorio 0.11.12 (Build 13084, linux64)<br />
353957.642242 Info ModManager.cpp:204: Loading mod core 0.0.0 (data.lua)<br />
353957.688258 Info ModManager.cpp:204: Loading mod base 0.11.12 (data.lua)<br />
353958.522936 Info ModManager.cpp:204: Loading mod Belts+ 0.1.0 (data.lua)<br />
353959.314368 Info ModManager.cpp:204: Loading mod Force Fields 1.0.0 (data.lua)<br />
353960.008032 Info ModManager.cpp:204: Loading mod Robo-Charge 0.3.2 (data.lua)<br />
353960.844953 Info ModManager.cpp:204: Loading mod Treefarm-Mod 1.2.4 (data.lua)<br />
353961.587995 Info ModManager.cpp:204: Loading mod UraniumPower 0.3.0 (data.lua)<br />
353962.365319 Info ModManager.cpp:204: Loading mod Yuoki 0.2.20 (data.lua)<br />
353963.513723 Info ModManager.cpp:204: Loading mod base 0.11.12 (data-updates.lua)<br />
353974.654409 Info AtlasSystem.cpp:152: Initial atlas bitmap size is 8192<br />
353974.718934 Info AtlasSystem.cpp:91: Created atlas bitmap 8192x8182<br />
353974.722727 Info AtlasSystem.cpp:91: Created atlas bitmap 8192x6347<br />
354011.404610 Notice Scenario.cpp:126: Loading map /home/cube/development/factorio/Factorio/saves/x1.zip<br />
354011.443453 Info Scenario.cpp:160: Map version 0.11.10-0<br />
354011.457256 Info PrototypeMigrationList.cpp:82: Activating migration Treefarm-Mod/100.json<br />
354011.457406 Info PrototypeMigrationList.cpp:82: Activating migration Treefarm-Mod/110.json<br />
354011.596778 Notice MigrationList.cpp:65: Applying migration: Robot Charging Station: RoboCharge.lua<br />
354011.610766 Notice MigrationList.cpp:65: Applying migration: Yuoki Industries: Yuoki_0.2.6.lua<br />
354015.703084 Info LocaleProvider.cpp:114: Using locale files from the pre 0.11.0 structure (__Treefarm-Mod__/script-locale/en.cfg)<br />
354019.170917 Info GlobalContext.cpp:470: Goodbye<br />
[/code][/spoiler]<br />
<br />
<br />
<br />
== Privacy ==<br />
Log files (in 0.10.5 and later) contain date and time of your Factorio session, your updater login name and full paths for some files belonging to Factorio or mods.<br />
Before 0.10.5 the log also could contain your updater token (not a password :-) ) as a part of update request URLs.</div>Cubehttps://wiki.factorio.com/index.php?title=Application_directory&diff=117217Application directory2014-12-18T10:44:29Z<p>Cube: Fixed the errors.</p>
<hr />
<div>{{Languages}}<br />
The application directory stores<br />
* the saves (every save is a zip-file)<br />
* the [[Mods]]<br />
* scenarios<br />
* configuration<br />
* [[Log File]] (since v0.10.0).<br />
<br />
The directory structure is self-explaining.<br />
<br />
You can delete for example the configuration-file; it will be generated new with the defaults.<br />
<br />
It is recommended to create backups from this directory, before you install a new version.<br />
<br />
== Windows ==<br />
=== Installation by Zip-package ===<br />
Application directory is the same as the unpacked factorio directory.<br />
<br />
For example, if you unpacked the zip to<br />
C:\Factorio<br />
Then your saves can be found in <br />
C:\Factorio\saves<br />
and mods in <br />
C:\Factorio\mods<br />
<br />
=== Installation via Installer ===<br />
Installation package follows UAC. For that case the factorio directory is where you install it (Program files by default) and the user data (saves, player data etc) are stored in<br />
C:\Users\<username>\AppData\Roaming\Factorio<br />
Windows Vista and newer (UAC active):<br />
%appdata%\factorio<br />
<br />
== MacOSx ==<br />
The application should be by default installed in the Apps-folder.<br />
<br />
Whereas the data is stored under<br />
/users/<replace with your username>/Library/Application Support/factorio<br />
<br />
Which is equivalent to<br />
~/Library/Application Support/factorio<br />
You can type in this into the finder (press SHIFT-COMMAND-G for goto folder) and put in exactly this line.<br />
<br />
'''If you still don't see this folder it might be invisible for you.''' Search in the internet for for example about ''"make library folder visible macos"''.<br />
<br />
Example link: http://finerthings.in/featured/lion-library-folder-visible/<br />
<br />
== Linux ==<br />
Data is stored under<br />
~/.factorio<br />
<br />
==Changing the application directory==<br />
<br />
It is possible to change the application directory location for Factorio. This can be done by editing the location of the "write-data" entry in the file ''config.ini''. This affects the location of mods, scenario and temp. If you want to move only the location of your save files you can [[Application_Directory/Changing_the_save_directory|change the the save directory using symlinks]].</div>Cubehttps://wiki.factorio.com/index.php?title=Multiplayer&diff=116028Multiplayer2014-11-04T15:55:58Z<p>Cube: Factorio doesn't use TCP.</p>
<hr />
<div>{{Languages}}<br />
{{Experimental|Alpha 0.11.0}}<br />
<br />
The multiplayer feature will be introduced with v0.11.0 and will be thought only for ''Lan-parties'' or ''Low-latency internet'', because there is no much lag latency hiding mechanics introduced.<br />
<br />
There is no ''server'' needed. Anybody can join an existing game, if he knows the IP of the game. He connects to the game, the game stops and the second players game downloads the current map. If the first hoster stops, the second player can continue to play and the first player can rejoin at any time. If the game desynchronizes, the map is redownloaded automatically and the game can continue<br />
<br />
There will be no explicit support for making Factorio servers. If you want to make a world running 24/7 you need to start whole Factorio on your server machine and keep it running. The server instance will then have a character in the game just like anybody else. (http://www.factorioforums.com/forum/viewtopic.php?f=38&t=6220&hilit=server&start=40#p48983) (or you can use lua commands to get rid of the character)<br />
<br />
Some links<br />
* About how multiplayer is planned to work: TODO<br />
* Interesting article: http://www.factorioforums.com/forum/viewtopic.php?f=5&t=6077#p47283<br />
<br />
== Playing over LAN ==<br />
<br />
Both game instances need the installation of exactly same game-versions and mods!<br />
<br />
== Playing over LAN/Internet ==<br />
<br />
Factorio uses the port 34197. The port can be changed in the [[Application Directory|config]].<br />
<br />
Factorio uses only UDP. (The game builds it's own "reliable delivery" layer built on UDP to deal with packet loss and reordering issues.)<br />
<br />
== Issues ==<br />
<br />
http://www.factorioforums.com/forum/viewtopic.php?f=5&t=6284#p49393<br />
<br />
Report bugs and read Reportes bugs: http://www.factorioforums.com/forum/viewforum.php?f=52<br />
<br />
Read this: http://www.factorioforums.com/forum/viewtopic.php?f=52&t=6283<br />
<br />
== Miscellaneous tips ==<br />
* the key for [[Console commands]] will now initiate a chat in MP. To execute commands you need to type '/c' before the command!<br />
* The key-combination SHIFT+SPACE pauses the game, even when typing in the chat input box. To prevent this from happening, change the keybinding in Options -> Other -> Pause game (bottom right)<br />
* Set the player's color using the command<br />
/c game.player[x].color = {r=0.7, g=0.5, b=0.1, a=0.9}<br />
Where x is the player number. r, g and b are for red, green and blue respectively (possible values are between 0 and 1, use the right-most column on http://prideout.net/archive/colors.php). a is alpha channel aka Transparency of the color to the base texture. For single player, leave off the "[x]" to set the color.<br />
<br />
== Software for routing / establishing connection ==<br />
<br />
* http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6393<br />
* http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6386<br />
<br />
<br />
== Headless server ==<br />
<br />
http://www.factorioforums.com/forum/viewtopic.php?f=53&t=6449<br />
<br />
{{Stub/sandbox}}</div>Cubehttps://wiki.factorio.com/index.php?title=Prototype/Car&diff=114392Prototype/Car2014-10-21T09:41:52Z<p>Cube: Formating fixes.</p>
<hr />
<div>==Basics==<br />
Entity with specialized properties for acceleration, braking, and turning.<br />
Extends the [[Prototype/EntityWithHealth]]<br />
== Usage in base==<br />
*[[Car]]<br />
* Since 0.11.0: [[Tank]]<br />
== Properties ==<br />
=== pictures ===<br />
'''Type''': [[Types/RotatedSprite]]<br />
'''Until''': 0.10.12<br />
<br />
=== animation ===<br />
'''Type''': [[Types/RotatedAnimation]]<br />
<br />
'''Since''': 0.11.0<br />
<br />
Default animation speed is 1 frame / tile.<br />
<br />
=== turret_animation ===<br />
'''Type''': [[Types/RotatedAnimation]]<br />
<br />
'''Since''': 0.11.0<br />
<br />
Optional. Default animation speed is 1 frame / tile.<br />
<br />
=== acceleration_per_energy ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Until''': 0.10.12<br />
<br />
=== effectivity ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Since''': 0.11.0<br />
<br />
Same meaning as the old acceleration_per_energy.<br />
Modifies the efficiency of energy transfer from burner output to wheels.<br />
<br />
=== breaking_speed ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Until''': 0.10.12<br />
<br />
=== braking_power ===<br />
'''Type''': [[Types/Energy]]<br />
<br />
'''Since''': 0.11.0<br />
<br />
=== consumption ===<br />
'''Type''': [[Types/Energy]]<br />
<br />
=== friction ===<br />
'''Type''': [[Types/double]]<br />
<br />
=== rotation_speed ===<br />
'''Type''': [[Types/double]]<br />
<br />
=== turret_rotation_speed ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Since''': 0.11.0<br />
<br />
'''Default''': 0.01<br />
<br />
=== turret_return_timeout ===<br />
'''Type''': [[Types/uint32_t]]<br />
<br />
'''Since''': 0.11.0<br />
<br />
'''Default''': 60<br />
<br />
Timeout in ticks specifying how long the turret must be inactive to return to the default position.<br />
<br />
=== burner ===<br />
'''Type''': [[Types/EnergySource]]-Burner<br />
<br />
=== inventory_size ===<br />
'''Type''': [[Types/InventorySize]]<br />
<br />
== Example ==<br />
{<br />
type = "car",<br />
name = "car",<br />
icon = "__base__/graphics/icons/car.png",<br />
flags = {"pushable", "placeable-neutral", "player-creation"},<br />
minable = {mining_time = 1, result = "car"},<br />
max_health = 500,<br />
corpse = "medium-remnants",<br />
resistances = <br />
{<br />
{<br />
type = "fire",<br />
percent = 50<br />
}<br />
},<br />
collision_box = {{-0.7, -1}, {0.7, 1}},<br />
selection_box = {{-0.7, -1}, {0.7, 1}},<br />
acceleration_per_energy = 0.001,<br />
breaking_speed = 0.01,<br />
burner =<br />
{<br />
effectivity = 1,<br />
fuel_inventory_size = 1,<br />
smoke =<br />
{<br />
{<br />
name = "smoke",<br />
deviation = {0.25, 0.25},<br />
frequency = 50,<br />
position = {0, 1.5},<br />
slow_down_factor = 0.9,<br />
starting_frame = 3,<br />
starting_frame_deviation = 5,<br />
starting_frame_speed = 0,<br />
starting_frame_speed_deviation = 5<br />
}<br />
}<br />
},<br />
consumption = 10,<br />
friction = 0.02,<br />
light = {intensity = 0.4, size = 25},<br />
pictures =<br />
{<br />
filename = "__base__/graphics/entity/car/car-sheet.png",<br />
line_length = 8,<br />
frame_width = 130,<br />
frame_height = 93,<br />
shift = {0.5, 0},<br />
axially_symmetrical = false,<br />
direction_count = 64<br />
},<br />
rotation_speed = 0.015,<br />
weight = 50,<br />
inventory_size = 12<br />
}</div>Cubehttps://wiki.factorio.com/index.php?title=Prototype/Car&diff=114391Prototype/Car2014-10-21T09:40:42Z<p>Cube: Added prototype changes in 0.11.0</p>
<hr />
<div>==Basics==<br />
Entity with specialized properties for acceleration, braking, and turning.<br />
Extends the [[Prototype/EntityWithHealth]]<br />
== Usage in base==<br />
*[[Car]]<br />
* Since 0.11.0: [[Tank]]<br />
== Properties ==<br />
=== pictures ===<br />
'''Type''': [[Types/RotatedSprite]]<br />
'''Until''': 0.10.12<br />
<br />
=== animation ===<br />
'''Type''': [[Types/RotatedAnimation]]<br />
'''Since''': 0.11.0<br />
<br />
Default animation speed is 1 frame / tile.<br />
<br />
=== turret_animation ===<br />
'''Type''': [[Types/RotatedAnimation]]<br />
'''Since''': 0.11.0<br />
<br />
Optional. Default animation speed is 1 frame / tile.<br />
<br />
=== acceleration_per_energy ===<br />
'''Type''': [[Types/double]]<br />
'''Until''': 0.10.12<br />
<br />
=== effectivity ===<br />
'''Type''': [[Types/double]]<br />
'''Since''': 0.11.0<br />
<br />
Same meaning as the old acceleration_per_energy.<br />
Modifies the efficiency of energy transfer from burner output to wheels.<br />
<br />
=== breaking_speed ===<br />
'''Type''': [[Types/double]]<br />
'''Until''': 0.10.12<br />
<br />
=== braking_power ===<br />
'''Type''': [[Types/Energy]]<br />
'''Since''': 0.11.0<br />
<br />
=== consumption ===<br />
'''Type''': [[Types/Energy]]<br />
<br />
=== friction ===<br />
'''Type''': [[Types/double]]<br />
<br />
=== rotation_speed ===<br />
'''Type''': [[Types/double]]<br />
<br />
=== turret_rotation_speed ===<br />
'''Type''': [[Types/double]]<br />
'''Since''': 0.11.0<br />
'''Default''': 0.01<br />
<br />
=== turret_return_timeout ===<br />
'''Type''': [[Types/uint32_t]]<br />
'''Since''': 0.11.0<br />
'''Default''': 60<br />
<br />
Timeout in ticks specifying how long the turret must be inactive to return to the default position.<br />
<br />
=== burner ===<br />
'''Type''': [[Types/EnergySource]]-Burner<br />
<br />
=== inventory_size ===<br />
'''Type''': [[Types/InventorySize]]<br />
<br />
== Example ==<br />
{<br />
type = "car",<br />
name = "car",<br />
icon = "__base__/graphics/icons/car.png",<br />
flags = {"pushable", "placeable-neutral", "player-creation"},<br />
minable = {mining_time = 1, result = "car"},<br />
max_health = 500,<br />
corpse = "medium-remnants",<br />
resistances = <br />
{<br />
{<br />
type = "fire",<br />
percent = 50<br />
}<br />
},<br />
collision_box = {{-0.7, -1}, {0.7, 1}},<br />
selection_box = {{-0.7, -1}, {0.7, 1}},<br />
acceleration_per_energy = 0.001,<br />
breaking_speed = 0.01,<br />
burner =<br />
{<br />
effectivity = 1,<br />
fuel_inventory_size = 1,<br />
smoke =<br />
{<br />
{<br />
name = "smoke",<br />
deviation = {0.25, 0.25},<br />
frequency = 50,<br />
position = {0, 1.5},<br />
slow_down_factor = 0.9,<br />
starting_frame = 3,<br />
starting_frame_deviation = 5,<br />
starting_frame_speed = 0,<br />
starting_frame_speed_deviation = 5<br />
}<br />
}<br />
},<br />
consumption = 10,<br />
friction = 0.02,<br />
light = {intensity = 0.4, size = 25},<br />
pictures =<br />
{<br />
filename = "__base__/graphics/entity/car/car-sheet.png",<br />
line_length = 8,<br />
frame_width = 130,<br />
frame_height = 93,<br />
shift = {0.5, 0},<br />
axially_symmetrical = false,<br />
direction_count = 64<br />
},<br />
rotation_speed = 0.015,<br />
weight = 50,<br />
inventory_size = 12<br />
}</div>Cubehttps://wiki.factorio.com/index.php?title=Application_directory&diff=111198Application directory2014-08-01T12:01:31Z<p>Cube: Link to log file page.</p>
<hr />
<div>The application directory stores<br />
* the saves (every save is a zip-file)<br />
* the [[Mods]]<br />
* scenarios<br />
* configuration<br />
* [[Log File]] (since v0.10.0).<br />
<br />
The directory structure is self-explaining.<br />
<br />
You can delete for example the configuration-file; it will be generated new with the defaults.<br />
<br />
It is recommended to create backups from this directory, before you install a new version.<br />
<br />
<br />
== Installation by Zip-package ==<br />
Zip package is just one Factorio directory that doesn't need to be installed, all the saves are there locally easy to find.<br />
<br />
== Installation via Installer ==<br />
=== Windows ===<br />
<br />
Installation package follows UAC. For that case the factorio directory is where you install it (Program files by default) and the user data (saves, player data etc) are stored in<br />
C:\Users\<username>\AppData\Roaming\Factorio<br />
Windows Vista and newer (UAC active):<br />
%appdata%\factorio<br />
contained<br />
=== MacOSx ===<br />
The application should be by default installed in the Apps-folder.<br />
<br />
Whereas the data is stored under<br />
/users/<replace with your username>/Library/Application Support/factorio<br />
<br />
Which is equivalent to<br />
~/Library/Application Support/factorio<br />
You can type in this into the finder (press SHIFT-COMMAND-G for goto folder) and put in exactly this line.<br />
<br />
'''If you still don't see this folder it might be invisible for you.''' Search in the internet for for example about ''"make library folder visible macos"''.<br />
<br />
Example link: http://finerthings.in/featured/lion-library-folder-visible/<br />
<br />
=== Linux ===<br />
Data is stored under<br />
~/.factorio<br />
<br />
==Changing the save directory==<br />
<br />
It is possible to change the save directory for Factorio. This can be done by editing the location of the "write-data" entry in the ''config-paths.cfg'' file, though this also affects the location of the other directories (mods, scenario, temp). If you want to move only the location of your save files you can [[Application_Directory/Changing_the_save_directory|change the the save directory using symlinks]].</div>Cubehttps://wiki.factorio.com/index.php?title=Log_file&diff=111197Log file2014-08-01T12:00:39Z<p>Cube: Created page with "Log files store details about the run of Factorio and contain information that help when solving bugs. Log files exist from version 0.10.0. == Log File Location == Factorio k..."</p>
<hr />
<div>Log files store details about the run of Factorio and contain information that help when solving bugs.<br />
Log files exist from version 0.10.0.<br />
<br />
== Log File Location ==<br />
Factorio keeps log files in the [[Application Directory]], that is next to the saves and mods directories.<br />
<br />
The file you need most of the time is '''factorio-current.log'''.<br />
Backup copy of the log file from previous run is in factorio-previous.log.<br />
<br />
== Bug Reporting ==<br />
Log files are important for finding crashes, especially ones related to automatic updates and graphic settings.<br />
Please attach the current log file to all crash reports.<br />
<br />
== Privacy ==<br />
Log files (in 0.10.5 and later) contain date and time of your Factorio session, your updater login name and full paths for some files belonging to Factorio or mods.<br />
Before 0.10.5 the log also could contain your updater token (not a password :-) ) as a part of update request URLs.</div>Cubehttps://wiki.factorio.com/index.php?title=Application_directory&diff=111196Application directory2014-08-01T11:46:19Z<p>Cube: typo</p>
<hr />
<div>The application directory stores<br />
* the saves (every save is a zip-file)<br />
* the [[Mods]]<br />
* scenarios<br />
* configuration<br />
* logs (since v0.10.0).<br />
<br />
The directory structure is self-explaining.<br />
<br />
You can delete for example the configuration-file; it will be generated new with the defaults.<br />
<br />
It is recommended to create backups from this directory, before you install a new version.<br />
<br />
<br />
== Installation by Zip-package ==<br />
Zip package is just one Factorio directory that doesn't need to be installed, all the saves are there locally easy to find.<br />
<br />
== Installation via Installer ==<br />
=== Windows ===<br />
<br />
Installation package follows UAC. For that case the factorio directory is where you install it (Program files by default) and the user data (saves, player data etc) are stored in<br />
C:\Users\<username>\AppData\Roaming\Factorio<br />
Windows Vista and newer (UAC active):<br />
%appdata%\factorio<br />
<br />
=== MacOSx ===<br />
The application should be by default installed in the Apps-folder.<br />
<br />
Whereas the data is stored under<br />
/users/<replace with your username>/Library/Application Support/factorio<br />
<br />
Which is equivalent to<br />
~/Library/Application Support/factorio<br />
You can type in this into the finder (press SHIFT-COMMAND-G for goto folder) and put in exactly this line.<br />
<br />
'''If you still don't see this folder it might be invisible for you.''' Search in the internet for for example about ''"make library folder visible macos"''.<br />
<br />
Example link: http://finerthings.in/featured/lion-library-folder-visible/<br />
<br />
=== Linux ===<br />
Data is stored under<br />
~/.factorio<br />
<br />
==Changing the save directory==<br />
<br />
It is possible to change the save directory for Factorio. This can be done by editing the location of the "write-data" entry in the ''config-paths.cfg'' file, though this also affects the location of the other directories (mods, scenario, temp). If you want to move only the location of your save files you can [[Application_Directory/Changing_the_save_directory|change the the save directory using symlinks]].</div>Cubehttps://wiki.factorio.com/index.php?title=User_talk:Preizhour&diff=110762User talk:Preizhour2014-07-04T14:12:30Z<p>Cube: </p>
<hr />
<div>'''Welcome to ''factorio''!'''<br />
We hope you will contribute much and well.<br />
You will probably want to read the [[Help:Contents|help pages]].<br />
Again, welcome and have fun! [[User:Slpwnd|Slpwnd]] ([[User talk:Slpwnd|talk]]) 09:41, 4 July 2014 (CEST)<br />
<br />
<br />
Hi, I'm not sure that you read your forum PMs, but you should do it now :-), there were some problems with the edits you made recently<br />
--[[User:Cube|Cube]] ([[User talk:Cube|talk]]) 16:12, 4 July 2014 (CEST)</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=108195Types/AutoplaceSpecification2014-02-27T16:18:55Z<p>Cube: </p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== order ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
'''Since''': 0.9.0<br />
<br />
Order for placing the entity (has no effect when placing tiles). Entities whose order compares less are placed earlier (this influences placing multiple entities which collide with itself), from entities with equal order string only one with the highest probability is placed.<br />
<br />
=== size_control_multiplier ===<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Magic. Based on sum of influences of noises.<br />
<br />
'''Since''': 0.9.2<br />
<br />
This value times the size control setting is added to influence right before sharpness filter.<br />
Very small has a multiplier of -1, very big has 1.5.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences plus a [[#size_control_multiplier|bonus for autoplace control]], passed through a [[#sharpness|sharpening filter]]<br />
and multiplied by [[#max_probability|max_probability]]<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=108194Types/AutoplaceSpecification2014-02-27T15:09:16Z<p>Cube: /* Properties */</p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== order ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
'''Since''': 0.9.0<br />
<br />
Order for placing the entity (has no effect when placing tiles). Entities whose order compares less are placed earlier (this influences placing multiple entities which collide with itself), from entities with equal order string only one with the highest probability is placed.<br />
<br />
=== size_control_multiplier ==<br />
''' Type''': [[Types/double]]<br />
<br />
'''Default''': Magic. Based on sum of influences of noises.<br />
<br />
'''Since''': 0.9.2<br />
<br />
This value times the size control setting is added to probability.<br />
Very small has a multiplier of -1, very big has 1.5.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences, passed through a [[#sharpness|sharpening filter]]<br />
and multiplied by [[#max_probability|max_probability]]<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=107952Types/AutoplaceSpecification2014-02-12T15:46:13Z<p>Cube: </p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== order ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
'''Since''': 0.9.0<br />
<br />
Order for placing the entity (has no effect when placing tiles). Entities whose order compares less are placed earlier (this influences placing multiple entities which collide with itself), from entities with equal order string only one with the highest probability is placed.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences, passed through a [[#sharpness|sharpening filter]]<br />
and multiplied by [[#max_probability|max_probability]]<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=107943Types/AutoplaceSpecification2014-02-12T13:45:00Z<p>Cube: </p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== order ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
'''Since''': 0.9.0<br />
<br />
Order for placing the entity. Entities whose order compares less are placed earlier (this influences placing multiple entities which collide with itself), from entities with equal order string only one with the highest probability is placed.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences, passed through a [[#sharpness|sharpening filter]]<br />
and multiplied by [[#max_probability|max_probability]]<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=107351Types/AutoplaceSpecification2014-01-07T14:53:03Z<p>Cube: </p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability calculation]].<br />
<br />
=== tile_restriction ===<br />
'''Type''': list of specifications, see below<br />
<br />
'''Default''': empty list<br />
<br />
'''Since''': 0.9.0<br />
<br />
Restricts surfaces or transition the entity can appear on.<br />
<br />
Contains list of specifications, each specification is a single [[Types/string]] with the ID of an allowed tile, or a <br />
list of two [[Types/string]]s for entities allowed on transitions.<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences, passed through a [[#sharpness|sharpening filter]]<br />
and multiplied by [[#max_probability|max_probability]]<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=107350Types/AutoplaceSpecification2014-01-07T10:05:02Z<p>Cube: Adding max_probability for 0.9.0</p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== max_probability ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
'''Since''': 0.9.0<br />
<br />
Multiplier for output of the sharpness filter.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences, passed through a [[#sharpness|sharpening filter]]<br />
and multiplied by [[#max_probability|max_probability]]<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=106692Types/AutoplaceSpecification2013-12-05T12:11:42Z<p>Cube: Undo revision 106691 by Cube (talk) (this will not get it to 0.8)</p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences and passed through a [[#sharpness|sharpening filter]].<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=106691Types/AutoplaceSpecification2013-12-05T12:08:26Z<p>Cube: /* Autoplace Peaks */</p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_shift ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': 0<br />
<br />
'''Since''': 0.8.0<br />
<br />
Number to add to noise value (before applying the peak influence).<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences and passed through a [[#sharpness|sharpening filter]].<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Prototype/Entity&diff=106564Prototype/Entity2013-11-28T10:53:39Z<p>Cube: added example to entity autoplace.</p>
<hr />
<div>==Basics==<br />
The common properties of all entities in the game.<br />
Entity is basically everything that can be on the map (except tiles).<br />
For in game script access to entity, take a look at [[Lua/Entity]]<br />
== Extensions ==<br />
*[[Prototype/EntityWithHealth]]<br />
**[[Prototype/Accumulator]]<br />
**[[Prototype/Character]]<br />
**[[Prototype/Unit]]<br />
**[[Prototype/PipeConnectable]]<br />
**[[Prototype/Car]]<br />
**[[Prototype/Market]]<br />
*[[Prototype/Resource]]<br />
*[[Prototype/ItemEntity]]<br />
<br />
== Properties ==<br />
=== type ===<br />
'''Type''': [[Types/string]]<br />
<br />
Specification of the [[Prototypes/EntityPrototypeTypes|type]] of the prototype.<br />
<br />
=== name ===<br />
'''Type''': [[Types/string]]<br />
<br />
Unique identification of the prototype.<br />
<br />
=== flags ===<br />
'''Type''': [[Types/EntityPrototypeFlags]]<br />
<br />
=== icon ===<br />
'''Type''': [[Types/FileName]]<br />
<br />
Mandatory for entities that have at least one of these flags active placeable-neutral, placeable-player, placeable-neutral.<br />
<br />
The icon will be used in the editor building selection.<br />
icon = "__base__/graphics/icons/wooden-chest.png"<br />
<br />
=== collision_box ===<br />
'''Type: [[Types/AABBbox]]<br />
<br />
'''Default''': Empty={{0, 0}, {0, 0}} it means no collisions.<br />
<br />
Specification of the entity collision boundaries.<br />
<br />
Empty collision box is used for smoke, projectiles, particles, explosions etc.<br />
collision_box = {{-0.4, -0.4}, {0.4, 0.4}}<br />
The {0,0} coordinate in the collision box will match the entity position.<br />
<br />
It should be near the center of the collision box, to keep correct entity drawing order.<br />
<br />
Note, that for buildings, it is custom to leave 0.1 wide border between the edge of the tile and the edge of the building, this lets the player move between the building and electric poles/inserters etc. and prevents stucked items on transport belt in some special casese (curves around the corner etc).<br />
<br />
=== selection_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': Empty = {{0, 0}, {0, 0}}<br />
<br />
Specification of the entity selection area.<br />
When empty the entity will have no selection area (and thus is not selectable).<br />
selection_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
The selection box is usualy little bit bigger than the collision box, for tilable entities (like buildings) it should match the tile size of the building.<br />
<br />
=== drawing_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': The value of selection_box<br />
<br />
Specification of space needed to see the whole entity.<br />
<br />
This is used to calculate the correct zoom and positioning in the entity info gui.<br />
drawing_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
<br />
=== sticker_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': The value of collision box.<br />
<br />
Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear.<br />
It is optional and the collision box is used when not specified.<br />
sticker_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
<br />
=== weight ===<br />
'''Type''': [[Types/float]]<br />
<br />
'''Default''': 1<br />
<br />
Weight of the entity used for physics calculation when car hits something.<br />
weight = 5.7<br />
<br />
=== minable ===<br />
'''Type''': [[Types/MinableProperties]]<br />
<br />
=== emissions_per_tick ===<br />
'''Type''': [[Types/double]]<br />
<br />
Amount of emissions created (positive number) or cleaned (negative number) every tick by the entity.<br />
This is passive, and it is independent concept of the emissions of machines, these are created actively depending on the power consumption.<br />
Currently used just for trees.<br />
emissions_per_tick = -0.0005 -- cleaning effect of big tree<br />
<br />
=== fast_replacable_group ===<br />
'''Type''': [[Types/string]]<br />
<br />
=== tile_width ===<br />
'''Type''': [[Types/unsigned]]<br />
<br />
'''Default''': calculated by the collision box width rounded up.<br />
<br />
Used to determine how the center of the entity should be positioned when building (unless the offgrid [[Types/EntityPrototypeFlags|flag]] is specified).<br />
When the tile width is odd, the center will be in the center of the tile, when it is even, the center is on the tile transition.<br />
<br />
=== tile_height ===<br />
'''Type''': [[Types/unsigned]]<br />
<br />
'''Default''': calculated by the collision box height rounded up.<br />
<br />
=== autoplace ===<br />
'''Type''': [[Types/AutoplaceSpecification]]<br />
<br />
'''Default''': Entity is not autoplacable<br />
<br />
Used to specify the rules for placing this entity during map generation.<br />
<br />
autoplace =<br />
{<br />
sharpness = 0.5,<br />
control = "forest",<br />
peaks =<br />
{<br />
{<br />
influence = 0.2,<br />
water_optimal = 0.3,<br />
water_range = 0.2,<br />
water_max_range = 0.4<br />
},<br />
{<br />
influence = 0.9,<br />
noise_layer = "trees",<br />
noise_persistence = 0.5,<br />
}<br />
}<br />
}<br />
<br />
== Example ==<br />
{<br />
type = "container",<br />
name = "wooden-chest",<br />
icon = "__base__/graphics/icons/wooden-chest.png",<br />
flags = {"placeable-neutral", "player-creation"},<br />
minable = {mining_time = 1, result = "wooden-chest"},<br />
collision_box = {{-0.4, -0.4}, {0.4, 0.4}},<br />
selection_box = {{-0.5, -0.5}, {0.5, 0.5}},<br />
max_health = 50,<br />
corpse = "small-remnants",<br />
fast_replaceable_group = "container",<br />
inventory_size = 16,<br />
picture =<br />
{<br />
filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",<br />
priority = "extra-high",<br />
width = 46,<br />
height = 33,<br />
shift = {0.3, 0}<br />
}<br />
}</div>Cubehttps://wiki.factorio.com/index.php?title=Prototype/Entity&diff=106563Prototype/Entity2013-11-28T10:51:52Z<p>Cube: /* autoplace */</p>
<hr />
<div>==Basics==<br />
The common properties of all entities in the game.<br />
Entity is basically everything that can be on the map (except tiles).<br />
For in game script access to entity, take a look at [[Lua/Entity]]<br />
== Extensions ==<br />
*[[Prototype/EntityWithHealth]]<br />
**[[Prototype/Accumulator]]<br />
**[[Prototype/Character]]<br />
**[[Prototype/Unit]]<br />
**[[Prototype/PipeConnectable]]<br />
**[[Prototype/Car]]<br />
**[[Prototype/Market]]<br />
*[[Prototype/Resource]]<br />
*[[Prototype/ItemEntity]]<br />
<br />
== Properties ==<br />
=== type ===<br />
'''Type''': [[Types/string]]<br />
<br />
Specification of the [[Prototypes/EntityPrototypeTypes|type]] of the prototype.<br />
<br />
=== name ===<br />
'''Type''': [[Types/string]]<br />
<br />
Unique identification of the prototype.<br />
<br />
=== flags ===<br />
'''Type''': [[Types/EntityPrototypeFlags]]<br />
<br />
=== icon ===<br />
'''Type''': [[Types/FileName]]<br />
<br />
Mandatory for entities that have at least one of these flags active placeable-neutral, placeable-player, placeable-neutral.<br />
<br />
The icon will be used in the editor building selection.<br />
icon = "__base__/graphics/icons/wooden-chest.png"<br />
<br />
=== collision_box ===<br />
'''Type: [[Types/AABBbox]]<br />
<br />
'''Default''': Empty={{0, 0}, {0, 0}} it means no collisions.<br />
<br />
Specification of the entity collision boundaries.<br />
<br />
Empty collision box is used for smoke, projectiles, particles, explosions etc.<br />
collision_box = {{-0.4, -0.4}, {0.4, 0.4}}<br />
The {0,0} coordinate in the collision box will match the entity position.<br />
<br />
It should be near the center of the collision box, to keep correct entity drawing order.<br />
<br />
Note, that for buildings, it is custom to leave 0.1 wide border between the edge of the tile and the edge of the building, this lets the player move between the building and electric poles/inserters etc. and prevents stucked items on transport belt in some special casese (curves around the corner etc).<br />
<br />
=== selection_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': Empty = {{0, 0}, {0, 0}}<br />
<br />
Specification of the entity selection area.<br />
When empty the entity will have no selection area (and thus is not selectable).<br />
selection_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
The selection box is usualy little bit bigger than the collision box, for tilable entities (like buildings) it should match the tile size of the building.<br />
<br />
=== drawing_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': The value of selection_box<br />
<br />
Specification of space needed to see the whole entity.<br />
<br />
This is used to calculate the correct zoom and positioning in the entity info gui.<br />
drawing_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
<br />
=== sticker_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': The value of collision box.<br />
<br />
Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear.<br />
It is optional and the collision box is used when not specified.<br />
sticker_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
<br />
=== weight ===<br />
'''Type''': [[Types/float]]<br />
<br />
'''Default''': 1<br />
<br />
Weight of the entity used for physics calculation when car hits something.<br />
weight = 5.7<br />
<br />
=== minable ===<br />
'''Type''': [[Types/MinableProperties]]<br />
<br />
=== emissions_per_tick ===<br />
'''Type''': [[Types/double]]<br />
<br />
Amount of emissions created (positive number) or cleaned (negative number) every tick by the entity.<br />
This is passive, and it is independent concept of the emissions of machines, these are created actively depending on the power consumption.<br />
Currently used just for trees.<br />
emissions_per_tick = -0.0005 -- cleaning effect of big tree<br />
<br />
=== fast_replacable_group ===<br />
'''Type''': [[Types/string]]<br />
<br />
=== tile_width ===<br />
'''Type''': [[Types/unsigned]]<br />
<br />
'''Default''': calculated by the collision box width rounded up.<br />
<br />
Used to determine how the center of the entity should be positioned when building (unless the offgrid [[Types/EntityPrototypeFlags|flag]] is specified).<br />
When the tile width is odd, the center will be in the center of the tile, when it is even, the center is on the tile transition.<br />
<br />
=== tile_height ===<br />
'''Type''': [[Types/unsigned]]<br />
<br />
'''Default''': calculated by the collision box height rounded up.<br />
<br />
=== autoplace ===<br />
'''Type''': [[Types/AutoplaceSpecification]]<br />
<br />
'''Default''': Entity is not autoplacable<br />
<br />
Used to specify the rules for placing this entity during map generation.<br />
<br />
== Example ==<br />
{<br />
type = "container",<br />
name = "wooden-chest",<br />
icon = "__base__/graphics/icons/wooden-chest.png",<br />
flags = {"placeable-neutral", "player-creation"},<br />
minable = {mining_time = 1, result = "wooden-chest"},<br />
collision_box = {{-0.4, -0.4}, {0.4, 0.4}},<br />
selection_box = {{-0.5, -0.5}, {0.5, 0.5}},<br />
max_health = 50,<br />
corpse = "small-remnants",<br />
fast_replaceable_group = "container",<br />
inventory_size = 16,<br />
picture =<br />
{<br />
filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",<br />
priority = "extra-high",<br />
width = 46,<br />
height = 33,<br />
shift = {0.3, 0}<br />
}<br />
}</div>Cubehttps://wiki.factorio.com/index.php?title=Prototype/Entity&diff=106562Prototype/Entity2013-11-28T10:43:06Z<p>Cube: /* Extensions */</p>
<hr />
<div>==Basics==<br />
The common properties of all entities in the game.<br />
Entity is basically everything that can be on the map (except tiles).<br />
For in game script access to entity, take a look at [[Lua/Entity]]<br />
== Extensions ==<br />
*[[Prototype/EntityWithHealth]]<br />
**[[Prototype/Accumulator]]<br />
**[[Prototype/Character]]<br />
**[[Prototype/Unit]]<br />
**[[Prototype/PipeConnectable]]<br />
**[[Prototype/Car]]<br />
**[[Prototype/Market]]<br />
*[[Prototype/Resource]]<br />
*[[Prototype/ItemEntity]]<br />
<br />
== Properties ==<br />
=== type ===<br />
'''Type''': [[Types/string]]<br />
<br />
Specification of the [[Prototypes/EntityPrototypeTypes|type]] of the prototype.<br />
<br />
=== name ===<br />
'''Type''': [[Types/string]]<br />
<br />
Unique identification of the prototype.<br />
<br />
=== flags ===<br />
'''Type''': [[Types/EntityPrototypeFlags]]<br />
<br />
=== icon ===<br />
'''Type''': [[Types/FileName]]<br />
<br />
Mandatory for entities that have at least one of these flags active placeable-neutral, placeable-player, placeable-neutral.<br />
<br />
The icon will be used in the editor building selection.<br />
icon = "__base__/graphics/icons/wooden-chest.png"<br />
<br />
=== collision_box ===<br />
'''Type: [[Types/AABBbox]]<br />
<br />
'''Default''': Empty={{0, 0}, {0, 0}} it means no collisions.<br />
<br />
Specification of the entity collision boundaries.<br />
<br />
Empty collision box is used for smoke, projectiles, particles, explosions etc.<br />
collision_box = {{-0.4, -0.4}, {0.4, 0.4}}<br />
The {0,0} coordinate in the collision box will match the entity position.<br />
<br />
It should be near the center of the collision box, to keep correct entity drawing order.<br />
<br />
Note, that for buildings, it is custom to leave 0.1 wide border between the edge of the tile and the edge of the building, this lets the player move between the building and electric poles/inserters etc. and prevents stucked items on transport belt in some special casese (curves around the corner etc).<br />
<br />
=== selection_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': Empty = {{0, 0}, {0, 0}}<br />
<br />
Specification of the entity selection area.<br />
When empty the entity will have no selection area (and thus is not selectable).<br />
selection_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
The selection box is usualy little bit bigger than the collision box, for tilable entities (like buildings) it should match the tile size of the building.<br />
<br />
=== drawing_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': The value of selection_box<br />
<br />
Specification of space needed to see the whole entity.<br />
<br />
This is used to calculate the correct zoom and positioning in the entity info gui.<br />
drawing_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
<br />
=== sticker_box ===<br />
'''Type''': [[Types/AABBbox]]<br />
<br />
'''Default''': The value of collision box.<br />
<br />
Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear.<br />
It is optional and the collision box is used when not specified.<br />
sticker_box = {{-0.5, -0.5}, {0.5, 0.5}}<br />
<br />
=== weight ===<br />
'''Type''': [[Types/float]]<br />
<br />
'''Default''': 1<br />
<br />
Weight of the entity used for physics calculation when car hits something.<br />
weight = 5.7<br />
<br />
=== minable ===<br />
'''Type''': [[Types/MinableProperties]]<br />
<br />
=== emissions_per_tick ===<br />
'''Type''': [[Types/double]]<br />
<br />
Amount of emissions created (positive number) or cleaned (negative number) every tick by the entity.<br />
This is passive, and it is independent concept of the emissions of machines, these are created actively depending on the power consumption.<br />
Currently used just for trees.<br />
emissions_per_tick = -0.0005 -- cleaning effect of big tree<br />
<br />
=== fast_replacable_group ===<br />
'''Type''': [[Types/string]]<br />
<br />
=== tile_width ===<br />
'''Type''': [[Types/unsigned]]<br />
<br />
'''Default''': calculated by the collision box width rounded up.<br />
<br />
Used to determine how the center of the entity should be positioned when building (unless the offgrid [[Types/EntityPrototypeFlags|flag]] is specified).<br />
When the tile width is odd, the center will be in the center of the tile, when it is even, the center is on the tile transition.<br />
<br />
=== tile_height ===<br />
'''Type''': [[Types/unsigned]]<br />
<br />
'''Default''': calculated by the collision box height rounded up.<br />
<br />
=== autoplace ===<br />
'''Type''': [[Types/AutoplaceSpecification]]<br />
<br />
== Example ==<br />
{<br />
type = "container",<br />
name = "wooden-chest",<br />
icon = "__base__/graphics/icons/wooden-chest.png",<br />
flags = {"placeable-neutral", "player-creation"},<br />
minable = {mining_time = 1, result = "wooden-chest"},<br />
collision_box = {{-0.4, -0.4}, {0.4, 0.4}},<br />
selection_box = {{-0.5, -0.5}, {0.5, 0.5}},<br />
max_health = 50,<br />
corpse = "small-remnants",<br />
fast_replaceable_group = "container",<br />
inventory_size = 16,<br />
picture =<br />
{<br />
filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",<br />
priority = "extra-high",<br />
width = 46,<br />
height = 33,<br />
shift = {0.3, 0}<br />
}<br />
}</div>Cubehttps://wiki.factorio.com/index.php?title=Prototype_definitions&diff=106561Prototype definitions2013-11-28T10:40:13Z<p>Cube: </p>
<hr />
<div>== Warning ==<br />
This is work in progress of descrption of the prototype specification possibilities.<br />
<br />
'''The game is in early stage, and the interface will change in the future for sure.'''<br />
== Basics ==<br />
* Prototype objects are specified in lua script called data.lua in the root of every mod (base game works as mod as well)<br />
* Individual objects are usually sorted into different groups in the prototypes folder.<br />
== Prototypes ==<br />
* [[Prototype/Entity]]<br />
** [[Prototype/EntityWithHealth]]<br />
*** [[Prototype/Accumulator]]<br />
*** [[Prototype/Character]]<br />
*** [[Prototype/Unit]]<br />
*** [[Prototype/PipeConnectable]]<br />
*** [[Prototype/Car]]<br />
*** [[Prototype/AssemblingMachine]]<br />
*** [[Prototype/Market]]<br />
*** [[Prototype/Inserter]]<br />
** [[Prototype/Resource]]<br />
** [[Prototype/ItemEntity]]<br />
* [[Prototype/Tile]]</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=106560Types/AutoplaceSpecification2013-11-28T10:34:16Z<p>Cube: /* Autoplace Peaks */</p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence Calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence Calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences and passed through a [[#sharpness|sharpening filter]].<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=106476Types/AutoplaceSpecification2013-11-08T16:48:41Z<p>Cube: fix</p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "neutral"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Influence ceiling.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences and passed through a [[#sharpness|sharpening filter]].<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=106473Types/AutoplaceSpecification2013-11-08T16:06:37Z<p>Cube: Added new field force.</p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== force ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': "enemy"<br />
<br />
'''Since''': 0.8.0<br />
<br />
Force of the placed entity. One of "enemy", "player" or "neutral". Only matters for EntityWithForce or EntityWithOwner.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Influence ceiling.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences and passed through a [[#sharpness|sharpening filter]].<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/int32&diff=106133Types/int322013-10-20T23:20:56Z<p>Cube: Created page with "32 bit signed number. The range is [-2^31, 2^31 - 1)"</p>
<hr />
<div>32 bit signed number.<br />
<br />
The range is [-2^31, 2^31 - 1)</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=106125Types/AutoplaceSpecification2013-10-20T22:43:11Z<p>Cube: </p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Influence ceiling.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get influence of -1.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Dimensions ==<br />
Peaks may reference a number of tile properties, specifying range of optimal values of the property<br />
and a range over which it is interpolated to no effect.<br />
<br />
Currently the properties are:<br />
* starting_area_weight -- Number from 1 (inside starting area) to 0 (not influenced by starting area).<br />
* roughness -- a number between -1.5 and 1.5 which describe roughness of the terrain. In 0.7.2 roughness is visible only on the edges of lakes (smooth vs jagged).<br />
* elevation -- elevation of the terrain, up to 5000. Values smaller than 0 mean under water (elevation < 0 doesn't imply water tile, though)<br />
* water -- amount of available water on tile. Very simple dependence on elevation for now.<br />
* temperature -- average temperature on tile. Depends on elevation and some noise.<br />
* tier_from_start -- Distance from start in starting area sizes, rounded to integers.<br />
<br />
== Influence Calculation ==<br />
Influence of a peak is obtained by calculating a distance from each of its dimensions.<br />
A sum of these individual distances is used as a distance from optimal conditions.<br />
<br />
Based on this distance a peak gets influence between -1 and 1, which is then multiplied<br />
by the noise function, if it is specified, and by the [[#influence|influence]] constant (or by [[#influence|influence]] + [[#richness_influence|richness_influence]]<br />
if calculating richness).<br />
Finally this value is clamped to a range between [[#min_influence|min_influence]] and [[#max_influence|max_influence]].<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences and passed through a [[#sharpness|sharpening filter]].<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise multiplied with its influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use (see [[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Controls ==<br />
If the autoplace specification has a [[#control|control]] selected, then its influence is affected by the row in map generator gui.<br />
Autoplace controls must be defined before use, see [[Prototype/AutoplaceControl]].<br />
<br />
* Frequency -- If frequency is set to low, then it increases number of octaves for all noises in this specification<br />
* Size -- Set to large adds a bonus to all the final influence, also very slightly increases number of octaves<br />
* Richness -- Adds a simple multiplier to richness.<br />
<br />
In case you are wondering why we can "very slightly increase number of octaves" and not just add whole octaves, it is because we sacrificed a goat to gods of computer graphics and to Ken Perlin in particular.</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=106122Types/AutoplaceSpecification2013-10-20T22:08:10Z<p>Cube: </p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Influence ceiling.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
See [[#Noise]].<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
See [[#Noise]].<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
See [[#Noise]]<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get zero weight.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].<br />
<br />
== Influence Calculation ==<br />
<br />
== Probability Calculation ==<br />
Probability of placing an entity at a given position is calculated as a sum of influences and passed through a sharpening filter ([[#sharpness]]).<br />
<br />
== Richness Calculation ==<br />
If an entity is to be placed at a position and it a resource or a part of an enemy base, then richness is calculated in the next step.<br />
as sum of influences * [[#richness_multiplier|richness_multiplier]] + [[#richness_base|richness_base]].<br />
<br />
Note, that when calculating richness, influences of individual peaks use [[#richness_influence|richness_influence]] bonus.<br />
<br />
== Noise ==<br />
A peak may have a noise added to its value before multiplication by influence.<br />
Noise used is a 2D multioctave perlin noise ( http://freespace.virgin.net/hugo.elias/models/m_perlin.htm ).<br />
Range of the noise is approximately from -1.5 to 1.5.<br />
<br />
Factorio uses up to 256 different (non correlated) layers of perlin noise, a noise layer has to be defined as a prototype before use ([[Prototype/NoiseLayer]]).<br />
<br />
Intended use is to have noise layers separate for different types of objects that might appear (trees vs dry_trees vs enemy-bases).<br />
Also it has proven useful not to mix peaks containing noise with peaks referencing tile properties.<br />
<br />
== Dimensions ==<br />
Each peak</div>Cubehttps://wiki.factorio.com/index.php?title=Types/AutoplaceSpecification&diff=106120Types/AutoplaceSpecification2013-10-20T21:22:08Z<p>Cube: Created page with "Autoplace specification is used to determine which entities are placed when generating map. Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, ..."</p>
<hr />
<div>Autoplace specification is used to determine which entities are placed when generating map.<br />
Currently (0.7.3) it is used for enemy bases, resources and other entities (trees, fishes, ...).<br />
<br />
<br />
== General structure ==<br />
Autoplace specification consists of a set of peaks that describe conditions for placing the entity and<br />
several parameters.<br />
<br />
== Properties ==<br />
<br />
=== sharpness ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
[[File:sharpness.png|thumb|Example of sharpness filter with value 0.5]]<br />
<br />
Parameter of the sharpness filter for post-processing probability of entity placement. Value of 0 disables the filter, with value 1, the filter is a step function centered around 0.5.<br />
See [[#Probability calculation]].<br />
<br />
=== richness_base ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== richness_multiplier ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
See [[#Richness calculation]].<br />
<br />
=== control ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/AutoplaceControl|autoplace control]] that applies to this entity.<br />
<br />
=== peaks ===<br />
'''Type''': list of [[#Autoplace Peaks]]<br />
<br />
If this property is missing, then the whole autoplace specification is interpreted as a single peak<br />
<br />
== Autoplace Peaks ==<br />
<br />
=== influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 1<br />
<br />
Influence multiplier.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Influence ceiling.<br />
See [[#Influence calculation]].<br />
<br />
=== min_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': min double<br />
<br />
Minimal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== max_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Maximal influence (after all calculations) of current peak.<br />
See [[#Influence calculation]].<br />
<br />
=== richness_influence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Bonus for influence multiplier when calculating richness.<br />
See [[#Influence calculation]].<br />
<br />
=== noise_layer ===<br />
'''Type''': [[Types/string]]<br />
<br />
'''Default''': ""<br />
<br />
ID of [[Prototype/NoiseLayer|noise layer]] to use for this peak.<br />
If empty, then no noise is added to this peak.<br />
<br />
See http://freespace.virgin.net/hugo.elias/models/m_perlin.htm.<br />
<br />
=== noise_persistence ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0.5<br />
<br />
'''Min''': 0<br />
<br />
'''Max''': 1<br />
<br />
Persistence of the noise.<br />
<br />
=== noise_octaves_difference ===<br />
'''Type''': [[Types/int]]<br />
<br />
'''Default''': 0<br />
<br />
Difference between number of octaves of the world and of the noise.<br />
<br />
=== *_optimal ===<br />
'''Type''': [[Types/double]]<br />
<br />
Optimal value of a tile property. If the property is close to this value, peak influence is 1.<br />
See [[#Dimensions]].<br />
<br />
=== *_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': 0<br />
<br />
Distance from the optimal parameters that is still considered optimal.<br />
See [[#Dimensions]].<br />
<br />
=== *_max_range ===<br />
'''Type''': [[Types/double]]<br />
<br />
Distance from the optimal parameters that get zero weight.<br />
See [[#Dimensions]].<br />
<br />
=== *_top_property_limit ===<br />
'''Type''': [[Types/double]]<br />
<br />
'''Default''': max double<br />
<br />
Limit distance from the optimum on a single (positive) side. This is pure magic.<br />
See [[#Dimensions]].</div>Cube