Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Prototype Docs Version 2.0.77

# PlaySoundTriggerEffectItem - Prototype Docs

## PlaySoundTriggerEffectItem :: struct

Inherits from TriggerEffectItem

## Properties

- default
- sorted

type | :: `"play-sound"` |
sound | :: Sound |
min_distance optional | :: float | Negative values are silently clamped to 0.
Negative values are silently clamped to 0.
max_distance optional | :: float | Negative values are silently clamped to 0.
Negative values are silently clamped to 0.
play_on_target_position optional | :: boolean |

Inherited from TriggerEffectItem

repeat_count optional | :: uint16 |
repeat_count_deviation optional | :: uint16 |
probability optional | :: float | Must be greater than `0` and less than or equal to `1`.
Must be greater than `0` and less than or equal to `1`.
affects_target optional | :: boolean |
show_in_tooltip optional | :: boolean |
damage_type_filters optional | :: DamageTypeFilters | Guaranteed to work with EntityWithHealthPrototype::damaged_trigger_effect and EntityWithHealthPrototype::dying_trigger_effect. [...]
Guaranteed to work with EntityWithHealthPrototype::damaged_trigger_effect and EntityWithHealthPrototype::dying_trigger_effect. [...]

sound | :: Sound |
type | :: `"play-sound"` |
max_distance optional | :: float | Negative values are silently clamped to 0.
Negative values are silently clamped to 0.
min_distance optional | :: float | Negative values are silently clamped to 0.
Negative values are silently clamped to 0.
play_on_target_position optional | :: boolean |

Inherited from TriggerEffectItem

affects_target optional | :: boolean |
damage_type_filters optional | :: DamageTypeFilters | Guaranteed to work with EntityWithHealthPrototype::damaged_trigger_effect and EntityWithHealthPrototype::dying_trigger_effect. [...]
Guaranteed to work with EntityWithHealthPrototype::damaged_trigger_effect and EntityWithHealthPrototype::dying_trigger_effect. [...]
probability optional | :: float | Must be greater than `0` and less than or equal to `1`.
Must be greater than `0` and less than or equal to `1`.
repeat_count optional | :: uint16 |
repeat_count_deviation optional | :: uint16 |
show_in_tooltip optional | :: boolean |

## Properties

### type :: `"play-sound"`

### sound :: Sound

### min_distance :: float optional

Default: `0`

Negative values are silently clamped to 0.

### max_distance :: float optional

Default: 1e21

Negative values are silently clamped to 0.

### play_on_target_position :: boolean optional

Default: `false`

Type used in

- TriggerEffect