Types/Effect: Difference between revisions
(Descriptions and minimums, for modules at least) |
(Updated styling of prototype doc migration note) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/Effect.html https://lua-api.factorio.com/latest/types/Effect.html] | |||
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | |||
A [[Types/table|table]] with the below listed properties. | A [[Types/table|table]] with the below listed properties. | ||
When applied to modules, the resulting effect is a sum of all module affects, multiplied through calculations: (1 + sum module effects) or, for productivity (0 + sum) | When applied to modules, the resulting effect is a sum of all module affects, multiplied through calculations: (1 + sum module effects) or, for productivity (0 + sum). | ||
== Optional properties == | == Optional properties == | ||
| Line 8: | Line 14: | ||
'''Types''': [[Types/table]] | '''Types''': [[Types/table]] | ||
Multiplier to energy used during operation (not idle/drain use). The minimum sum is | Multiplier to energy used during operation (not idle/drain use). The minimum possible sum is -80%. | ||
Table with the following optional member: | Table with the following optional member: | ||
| Line 16: | Line 22: | ||
'''Types''': [[Types/table]] | '''Types''': [[Types/table]] | ||
Modifier to crafting speed, research speed, etc. The minimum sum is | Modifier to crafting speed, research speed, etc. The minimum possible sum is -80%. | ||
Table with the following optional member: | Table with the following optional member: | ||
| Line 24: | Line 30: | ||
'''Types''': [[Types/table]] | '''Types''': [[Types/table]] | ||
Multiplied against work completed, adds to the bonus results of operating. E.g. an extra crafted recipe or immediate research bonus. The minimum possible sum is 0%. | |||
Table with the following optional member: | Table with the following optional member: | ||
| Line 32: | Line 38: | ||
'''Types''': [[Types/table]] | '''Types''': [[Types/table]] | ||
Multiplier to the pollution factor of an entity's pollution during use. The minimum sum is | Multiplier to the pollution factor of an entity's pollution during use. The minimum possible sum is -80%. | ||
Table with the following optional member: | Table with the following optional member: | ||
* bonus - [[Types/double]] - Default is 0. Precision is ignored beyond two decimals - 17.567 results in 17.56 etc. | * bonus - [[Types/double]] - Default is 0. Precision is ignored beyond two decimals - 17.567 results in 17.56 etc. | ||
Latest revision as of 10:42, 21 September 2023
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/Effect.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
A table with the below listed properties.
When applied to modules, the resulting effect is a sum of all module affects, multiplied through calculations: (1 + sum module effects) or, for productivity (0 + sum).
Optional properties
consumption
Types: Types/table
Multiplier to energy used during operation (not idle/drain use). The minimum possible sum is -80%.
Table with the following optional member:
- bonus - Types/double - Default is 0. Precision is ignored beyond two decimals - 17.567 results in 17.56 etc.
speed
Types: Types/table
Modifier to crafting speed, research speed, etc. The minimum possible sum is -80%.
Table with the following optional member:
- bonus - Types/double - Default is 0. Precision is ignored beyond two decimals - 17.567 results in 17.56 etc.
productivity
Types: Types/table
Multiplied against work completed, adds to the bonus results of operating. E.g. an extra crafted recipe or immediate research bonus. The minimum possible sum is 0%.
Table with the following optional member:
- bonus - Types/double - Default is 0. Precision is ignored beyond two decimals - 17.567 results in 17.56 etc.
pollution
Types: Types/table
Multiplier to the pollution factor of an entity's pollution during use. The minimum possible sum is -80%.
Table with the following optional member:
- bonus - Types/double - Default is 0. Precision is ignored beyond two decimals - 17.567 results in 17.56 etc.