Audio2DScripts

Summary

This file defines the primary background and foreground sounds for each screen and playing attribute. These include the music for the opening, map and diplomacy screens and primary background for the city screen. Foreground sounds would be tech discoveries, structure and unit builds and mouse clicks.

Single-Line Tags

Text Tags

ScriptID This is the name of the sound object used by the Audio2D script, This ID is used in CIV4LeaderHeadInfos, AudioSoundscapeScripts and by Python CyAudioGame.Play2DSound() function. The IDs are prefixed with AS2D_ for easier identification and followed by the filename.
SoundID Implemented in AudioDefines to retrieve the sound file.
SoundType Indicates whick volume slider to use under Game Options -> Audio AMBIENCE, INTERFACE, MUSIC, SFX or SPEECH These are prefixed with GAME_ for easy identification. Values are defined in AudioDefines.

Boolean Tags

bLooping Indicates whether the sound will "loop", ie: repeat indefinately.
bTaperForSoundtracks unknown. Set to 0.

Integer Tags

iMinVolume Minimum volume to play this sound. Values are from 0 to 100.
iMaxVolume Maximum volume to play this sound. Values are from 0 to 100.
iPitchChangeDown unknown Set to 0.
iPitchChangeUp unknown Set to 0.
iMinLeftPan unknown Set to -1.
iMaxLeftPan unknown Set to -1.
iMinRightPan unknown Set to -1.
iMaxRightPan unknown Set to -1.
iMinTimeDelay unknown Minimum time in delay playing sound. Values in milliseconds.
iMaxTimeDelay unknown Maximum.time in delay playing sound. Values in millisecons.
iLengthOfSound unknown Set to 0.
iNotPlayPercent unknown Set to 0. Only in BtS.

Floating-Point Tags

fMinDryLevel unknown Set to 1.0.
fMaxDryLevel unknown Set to 1.0.
fMinWetLevel unknown Set to 0.0.
fMaxWetLevel unknown Set to 0.0.

Example

<Script2DSound>
    <ScriptID>AS2D_ERROR</ScriptID>
    <SoundID>SND_ERROR</SoundID>
    <SoundType>GAME_SFX</SoundType>
    <iMinVolume>80</iMinVolume>
    <iMaxVolume>80</iMaxVolume>
    <iPitchChangeDown>0</iPitchChangeDown>
    <iPitchChangeUp>0</iPitchChangeUp>
    <iMinLeftPan>-1</iMinLeftPan>
    <iMaxLeftPan>-1</iMaxLeftPan>
    <iMinRightPan>-1</iMinRightPan>
    <iMaxRightPan>-1</iMaxRightPan>
    <bLooping>0</bLooping>
    <iMinTimeDelay>0</iMinTimeDelay>
    <iMaxTimeDelay>0</iMaxTimeDelay>
    <bTaperForSoundtracks>0</bTaperForSoundtracks>
    <iLengthOfSound>0</iLengthOfSound>
    <fMinDryLevel>1.0</fMinDryLevel>
    <fMaxDryLevel>1.0</fMaxDryLevel>
    <fMinWetLevel>0.0</fMinWetLevel>
    <fMaxWetLevel>0.0</fMaxWetLevel>
</Script2DSound>
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License