449 KiB
449 KiB
| 1 | # If the text in the first column of a row starts with a # character, the row is ignored | If the first column for a row is blank, then the row is ignored | |
|---|---|---|---|
| 2 | # You can leave out keys, but the "name" and "file" keys must always be present. | ||
| 3 | # You can invent new keys, but the game will ignore them if it doesn't know about them. | ||
| 4 | # This means it is safe to swap entire columns around, though you should never swap partial columns. | ||
| 5 | # The first non-comment line of a sound alias file specifies the key name for all values appearing in this column. | ||
| 6 | If the first column for a row is blank, then the row is ignored | ||
| 7 | name | name of the alias that is used to play this sound (required) | |
| 8 | sequence | used to uniquely identify alias entries when more than one sound goes to an alias, used only to catch unwanted duplicates (default = 0) | |
| 9 | file | the name of the file that contains the sound data (required) | |
| 10 | vol_min | 0 is silent, 1 is full volume (default = 1) | |
| 11 | vol_max | 0 is silent, 1 is full volume (default = same as vol_min) | |
| 12 | vol_mod | blank causes no effect on vol_min and vol_max, otherwise the string must match a string in the volumemodgroups.def file and the value in that file corresponding to that string will be used to adjust vol_min and vol_max, clamped to the valid range | |
| 13 | pitch_min | 1 is normal playback, 2 is twice as fast, 0.5 is half as fast (default = 1) | |
| 14 | pitch_max | 1 is normal playback, 2 is twice as fast, 0.5 is half as fast (default = same as pitch_min) | |
| 15 | dist_min | within this distance in inches, the sound is always full volume (default = 120) | |
| 16 | dist_max | outside this distance in inches, the sound is not started. If left blank or set to 0, the sound will play from any distance. This does not affect sound volume falloff. | |
| 17 | channel | auto, menu, weapon, voice, item, body, local, music, announcer (default = auto) | |
| 18 | type | primed (a streamed sound which gets primed on some platforms) / streamed / loaded (default = loaded) | |
| 19 | probability | weight to use for the weighted probability of playing this sound instead of another sound (default = 1) | |
| 20 | loop | whether this sound is "looping" or "nonlooping" (default = "nonlooping") | |
| 21 | masterslave | if "master", this is a master sound. If a number, then this sound's volume will be multiplied by that number (a percentage between 0 and 1) any master sound is playing. If blank, then neither master nor slave. | |
| 22 | loadspec | space-separated list of which maps should use this alias; eg, "burnville dawnville". If blank, the alias is used on all maps. | |
| 23 | compression | a string corresponding to an entry in "XMAUpdate.tbl" which is used to determine compression by XMAUpdate.exe | |
| 24 | secondaryaliasname | defined the name of an additional sound alias to play in addition to the current alias being played. Note that it is an error for the secondaryalias to also define a secondaryaliasname (eg, if B is a secondaryalias of A, B is not allowed to have its own secondaryalias). | |
| 25 | volumefalloffcurve | if blank uses the linear curve which can not be changed. A string 'XXXX' corresponds to the curve defined by the file 'soundaliases/XXXX.vfcurve' | |
| 26 | startdelay | defaults to no delay. The value is the number of milliseconds to delay starting the sound by | |
| 27 | speakermap | if blank uses the default speakermappings which cannot be changed. A string 'XXXX' corresponds to the speakermap defined by the file 'soundaliases/XXXX.spkrmap'. | |
| 28 | reverb | blank means the alias is affected normally by wet and dry levels, "fulldrylevel" forces the alias to use a full drylevel (ignoring the global drylevel), "nowetlevel" forces the alias to use no wetlevel (ignoring the global wetlevel) | |
| 29 | lfe percentage | this determines what percentage of the highest calculated spatialized speaker volume should be passed to the LFE. blank means no LFE for the sound | |
| 30 | center percentage | this determines what percentage of the volume should be redirected to the center channel (equal percentage taken from all speakers). | |
| 31 | platform | used by XMAUpdate to determine whether the alias should be processed for a particular platform. If blank, process for all platforms. Platforms are PC, XB, PS, WI. Multiple values should be separated by spaces. !PC will exclude alias from PC but include in all other platforms. PC will only include alias for PC. !PC XB is invalid. |