Types/PlaySoundTriggerEffectItem: Difference between revisions
Jump to navigation
Jump to search
(Created page with "Extends Types/TriggerEffectItem. == Mandatory properties == Inherits all properties from Types/TriggerEffectItem. === sound === '''Type''': Types/Sound") |
(1.0.0: added min_distance, max_distance, volume_modifier, audible_distance_modifier, play_on_target_position) |
||
| Line 6: | Line 6: | ||
=== sound === | === sound === | ||
'''Type''': [[Types/Sound]] | '''Type''': [[Types/Sound]] | ||
== Optional properties == | |||
=== min_distance === | |||
'''Type''': [[Types/float|float]] | |||
'''Default''': 0 | |||
Negative values are silently clamped to 0. | |||
=== max_distance === | |||
'''Type''': [[Types/float|float]] | |||
'''Default''': 1e21 (10^21) | |||
Negative values are silently clamped to 0. | |||
=== volume_modifier === | |||
'''Type''': [[Types/float|float]] | |||
'''Default''': 1 | |||
Negative values are silently clamped to 0. | |||
=== audible_distance_modifier === | |||
'''Type''': [[Types/float|float]] | |||
'''Default''': 1 | |||
Negative values are silently clamped to 0. | |||
=== play_on_target_position === | |||
'''Type''': [[Types/bool|bool]] | |||
'''Default''': false | |||
Revision as of 11:45, 8 September 2020
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