Types/TriggerEffectItem: Difference between revisions
Jump to navigation
Jump to search
(Created page with "== Extensions == * Types/DamageTriggerEffectItem * Types/CreateEntityTriggerEffectItem ** Types/CreateExplosionTriggerEffectItem ** Types/CreateFireTriggerEffect...") |
(Updated styling of prototype doc migration note) |
||
| (7 intermediate revisions by 2 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/TriggerEffectItem.html https://lua-api.factorio.com/latest/types/TriggerEffectItem.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> | |||
The abstract base for all trigger effect items loaded by [[Types/TriggerEffect]]. | |||
== Extensions == | == Extensions == | ||
* [[Types/DamageTriggerEffectItem]] | * [[Types/DamageTriggerEffectItem]] | ||
| Line 5: | Line 12: | ||
** [[Types/CreateFireTriggerEffectItem]] | ** [[Types/CreateFireTriggerEffectItem]] | ||
** [[Types/CreateSmokeTriggerEffectItem]] | ** [[Types/CreateSmokeTriggerEffectItem]] | ||
* [[Types/CreateTrivialSmokeEffectItem]] | * [[Types/CreateTrivialSmokeEffectItem]] | ||
* [[Types/CreateParticleTriggerEffectItem]] | |||
* [[Types/CreateStickerTriggerEffectItem]] | * [[Types/CreateStickerTriggerEffectItem]] | ||
* [[Types/CreateDecorativesTriggerEffectItem]] | |||
* [[Types/NestedTriggerEffectItem]] | * [[Types/NestedTriggerEffectItem]] | ||
* [[Types/PlaySoundTriggerEffectItem]] | * [[Types/PlaySoundTriggerEffectItem]] | ||
| Line 13: | Line 21: | ||
* [[Types/DestroyCliffsTriggerEffectItem]] | * [[Types/DestroyCliffsTriggerEffectItem]] | ||
* [[Types/ShowExplosionOnChartTriggerEffectItem]] | * [[Types/ShowExplosionOnChartTriggerEffectItem]] | ||
* [[Types/InsertItemTriggerEffectItem]] | |||
* [[Types/ScriptTriggerEffectItem]] | |||
* [[Types/SetTileTriggerEffectItem]] | |||
* [[Types/InvokeTileEffectTriggerEffectItem]] | |||
* [[Types/DestroyDecorativesTriggerEffectItem]] | |||
* [[Types/CameraEffectTriggerEffectItem]] | |||
== Optional properties == | == Optional properties == | ||
=== repeat_count === | === repeat_count === | ||
'''Type''': [[Types/ | '''Type''': [[Types/uint16]] | ||
'''Default''': 1 | '''Default''': 1 | ||
=== repeat_count_deviation === | |||
'''Type''': [[Types/uint16]] | |||
'''Default''': 0 | |||
=== probability === | |||
'''Type''': [[Types/float]] | |||
'''Default''': 1 | |||
Must be greater than 0 and less than or equal to 1. | |||
=== affects_target === | === affects_target === | ||
| Line 25: | Line 51: | ||
'''Default''': false | '''Default''': false | ||
=== show_in_tooltip === | |||
'''Type''': [[Types/bool]] | |||
'''Default''': true | |||
=== damage_type_filters === | |||
'''Type''': [[Types/DamageTypeFilters]] | |||
Guaranteed to work with [[Prototype/EntityWithHealth#damaged_trigger_effect]] and [[Prototype/EntityWithHealth#dying_trigger_effect]], unknown if it works with other properties that use [[Types/TriggerEffect]]. | |||
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/TriggerEffectItem.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.
The abstract base for all trigger effect items loaded by Types/TriggerEffect.
Extensions
- Types/DamageTriggerEffectItem
- Types/CreateEntityTriggerEffectItem
- Types/CreateTrivialSmokeEffectItem
- Types/CreateParticleTriggerEffectItem
- Types/CreateStickerTriggerEffectItem
- Types/CreateDecorativesTriggerEffectItem
- Types/NestedTriggerEffectItem
- Types/PlaySoundTriggerEffectItem
- Types/PushBackTriggerEffectItem
- Types/DestroyCliffsTriggerEffectItem
- Types/ShowExplosionOnChartTriggerEffectItem
- Types/InsertItemTriggerEffectItem
- Types/ScriptTriggerEffectItem
- Types/SetTileTriggerEffectItem
- Types/InvokeTileEffectTriggerEffectItem
- Types/DestroyDecorativesTriggerEffectItem
- Types/CameraEffectTriggerEffectItem
Optional properties
repeat_count
Type: Types/uint16
Default: 1
repeat_count_deviation
Type: Types/uint16
Default: 0
probability
Type: Types/float
Default: 1
Must be greater than 0 and less than or equal to 1.
affects_target
Type: Types/bool
Default: false
show_in_tooltip
Type: Types/bool
Default: true
damage_type_filters
Type: Types/DamageTypeFilters
Guaranteed to work with Prototype/EntityWithHealth#damaged_trigger_effect and Prototype/EntityWithHealth#dying_trigger_effect, unknown if it works with other properties that use Types/TriggerEffect.