Types/PlaySoundTriggerEffectItem: Difference between revisions
(Migrated prototype doc to separate website) |
m (Protected "Types/PlaySoundTriggerEffectItem": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))) |
Revision as of 17:51, 16 August 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