|
[*Back to Index*](index.md.html) |
|
|
|
Sound |
|
=============== |
|
|
|
This mod item allows you to create sound presets which are used to play sound effects via ActionFXSound. You can read more about the ActionFXSound mod item [here](ModItemActionFXSound.md.html). Each sound preset consists of a list of samples. These samples contain the path to the sound file (in the opus file format) and a frequency. When the sound is played, a sample is picked at random based on the given sample frequencies. Samples with higher frequency values will be played more often than the ones with lower values. |
|
|
|
Properties |
|
--------------- |
|
|
|
Sound Type (self.type) |
|
: This is the type of the sound preset. See the Sound Types section for more information. |
|
|
|
looping (self.looping) |
|
: Defines whether the chosen sample should be played once, or looped until explicitly stopped. Note that the sample to be played is picked at the beginning and will not change during the loop. |
|
|
|
periodic (self.periodic) |
|
: When periodic is set to true, different samples with random delay between them will be chosen. |
|
|
|
volume (self.volume) |
|
: The volume at which the sound will be played. |
|
|
|
mindistance (self.mindistance) |
|
: No attenuation below this distance (in meters). In case of zero, the sound type mindistance is used. |
|
|
|
silence_frequency (self.silence_frequency) |
|
: Defines the chance of not playing any sound when the FX action is played. This works similarly to how samples from the list are chosen based on their frequencies. |
|
|
|
silence_duration (self.silence_duration) |
|
: Silence duration. Enabled only when periodic is set to true. |
|
|
|
periodic_delay (self.periodic_delay) |
|
: Periodic delay (in ms). Enabled only when periodic is set to true. |
|
|
|
random_periodic_delay (self.random_periodic_delay) |
|
: Maximum amount of random delay added to periodic_delay (in ms). Enabled only when periodic is set to true. |
|
|
|
loop_start (self.loop_start) |
|
: The time (in ms) from the beginning of the sample at which the loop should start. |
|
|
|
loop_end (self.loop_end) |
|
: The time (in ms) from the beginning of the sample at which the loop should end. |
|
|
|
Sound Types |
|
=============== |
|
Each sound preset has a sound type. The sound type defines common properties for all the sounds associated with it. It also imposes a limit on the maximum number of sounds from a type which can be playing at the same time. |
|
|
|
Properties |
|
--------------- |
|
menu_group |
|
: The menu group to which this sound type belongs. These groups are in turn associated with SoundOptionGroups the volumes of which can be controlled through the options menu. |
|
|
|
channels |
|
: The maximum number of sounds from this sound type which can be played at once. |
|
|
|
volume |
|
: Volume of the sound type. |
|
|
|
replace |
|
: Replace a playing sound if no free channels are available. |
|
|
|
positional |
|
: Enable 3D (only for mono sounds). |
|
|
|
reverb |
|
: Enable reverb effect (only for mono sounds). |
|
|
|
enable |
|
: Enable or disable all sounds from this type. |
|
|
|
pause |
|
: Can be paused. |
|
|
|
restricted |
|
: Whether the sound can be broadcast when streaming. Used for sounds or music which are not licensed for streaming. |
|
|
|
mindistance |
|
: No attenuation below that distance (in meters). In case of zero the sound group mindistance is used. |
|
|
|
(insert footer.md.html here) |
|
<link rel="stylesheet" type="text/css" href="Style.css" /> |
|
<style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script> |
|
|
