Types/PlaySoundTriggerEffectItem: Difference between revisions
(1.0.0: added min_distance, max_distance, volume_modifier, audible_distance_modifier, play_on_target_position) |
(Updated styling of prototype doc migration note) |
||
| (2 intermediate revisions by the same user 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/PlaySoundTriggerEffectItem.html https://lua-api.factorio.com/latest/types/PlaySoundTriggerEffectItem.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> | |||
Extends [[Types/TriggerEffectItem]]. | Extends [[Types/TriggerEffectItem]]. | ||
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/PlaySoundTriggerEffectItem.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.
Extends Types/TriggerEffectItem.
Mandatory properties
Inherits all properties from Types/TriggerEffectItem.
sound
Type: Types/Sound
Optional properties
min_distance
Type: float
Default: 0
Negative values are silently clamped to 0.
max_distance
Type: float
Default: 1e21 (10^21)
Negative values are silently clamped to 0.
volume_modifier
Type: float
Default: 1
Negative values are silently clamped to 0.
audible_distance_modifier
Type: float
Default: 1
Negative values are silently clamped to 0.
play_on_target_position
Type: bool
Default: false