Audio2DScripts

From Civilization Modding Wiki
Revision as of 23:19, 10 May 2009 by Draco (talk | contribs) (1st entry of data, copied from "civ4.wikidot.com".)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
Previous article
Back to XML Reference



This page is missing information. Do not remove this notice until it is complete.

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

Tag Name Description
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 which 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

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


Integer Tags

Tag Name Description
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 milliseconds.
iLengthOfSound unknown. Set to 0.
iNotPlayPercent unknown. Set to 0. Only in BtS.


Floating-Point Tags

Tag Name Description
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>
Next article
Back to XML Reference