PlaySoundTriggerEffectItem - Prototype Docs

Home / Types / PlaySoundTriggerEffectItem <>

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.
volume_modifier optional	:: float	Negative values are silently clamped to 0.
Negative values are silently clamped to 0.
audible_distance_modifier optional	:: float	Negative values are silently clamped to 0.
Negative values are silently clamped to 0.
play_on_target_position optional	:: bool

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	:: bool
show_in_tooltip optional	:: bool
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.

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.

volume_modifier :: float optional

Default: 1

Negative values are silently clamped to 0.

audible_distance_modifier :: float optional

Default: 1

Negative values are silently clamped to 0.

play_on_target_position :: bool optional

Default: false

Type used in

TriggerEffect

Factorio Prototype Docs Version 1.1.91

PlaySoundTriggerEffectItem :: struct

Properties

Properties

type :: `"play-sound"`

sound :: Sound

min_distance :: float optional

max_distance :: float optional

volume_modifier :: float optional

audible_distance_modifier :: float optional

play_on_target_position :: bool optional

Prototypes

Types

Factorio Prototype Docs Version 1.1.91

PlaySoundTriggerEffectItem :: struct

Properties

Properties

type :: "play-sound"

sound :: Sound

min_distance :: float optional

max_distance :: float optional

volume_modifier :: float optional

audible_distance_modifier :: float optional

play_on_target_position :: bool optional

Prototypes

Types

type :: `"play-sound"`