Audio2DScripts

The Audio2DScripts 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 the primary background for the city screen. Foreground sounds include those for tech discoveries, structure and unit builds, and mouse clicks.

All tags must be opened and closed; the first is the "open", the second the "close" tag. If nothing goes inside a "list tag", then it should just be the opening tag with a "/" before the closing bracket. The following tables contain all available tags, as well as their purpose and accepted values.

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

Tags

Text

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.

Integer

All of these tags have a numerical value. Though it sometimes can be negative, it usually is not.

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. (Beyond the Sword only)

Boolean

All of these can either be 1 (on, or true) or 0 (off, or false). Be careful, as you can wind up with a double-negative, which the game will interpret as "True".

Tag Name	Description
bLooping	Indicates whether the sound will "loop" (repeat indefinitely).
bTaperForSoundtracks	unknown. Set to 0.

Floating-Point

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

In the following example of code, please note that there is a specific order of all of the tags. You must list the tags in this order for the game to properly interpret your file.

<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>

Civ4 XML Files GlobalDefines • GlobalDefinesAlt • GlobalTypes • PythonCallbackDefines Art: Civ4ArtDefines_Bonus • Civ4ArtDefines_Building • Civ4ArtDefines_Civilization • Civ4ArtDefines_Feature • Civ4ArtDefines_Improvement • Civ4ArtDefines_Interface • Civ4ArtDefines_Leaderhead • Civ4ArtDefines_Misc • Civ4ArtDefines_Movie • Civ4ArtDefines_Terrain • Civ4ArtDefines_Unit • Civ4MainMenus • Civ4RiverModelInfos • Civ4RouteModelInfos Audio; Buildings: Audio2DScripts • Audio3DScripts • AudioDefines • AudioSoundscapeScripts • Civ4BuildingClassInfos • Civ4BuildingInfos • Civ4CityLSystem • Civ4PlotLSystem • Civ4SpecialBuildingInfos BasicInfos: Civ4AttitudeInfos • Civ4BasicInfos • Civ4CalendarInfos • Civ4CityTabInfos • Civ4DenialInfos • Civ4DomainInfos • Civ4InvisibleInfos • Civ4MemoryInfos • Civ4MonthInfos • Civ4NewConceptInfos • Civ4SeasonInfos • Civ4UnitAIInfos • Civ4UnitCombatInfos Civilizations; Events: Civ4CivilizationInfos • Civ4LeaderHeadInfos • Civ4TraitInfos • Civ4UnitArtStyleTypeInfos • Civ4EventInfos • Civ4EventTriggerInfos GameInfo: Civ4CivicInfos • Civ4CivicOptionInfos • Civ4ClimateInfo • Civ4CommerceInfo • Civ4CorporationInfo • Civ4CultureLevelInfo • Civ4CursorInfo • Civ4DiplomacyInfos • Civ4EmphasizeInfos • Civ4EspionageMissionInfo • Civ4EraInfos • Civ4ForceControlInfos • Civ4GameOptionInfos • Civ4GameSpeedInfo • Civ4GoodyInfo • Civ4GraphicOptionInfos • Civ4HandicapInfo • Civ4Hints • Civ4MPOptionInfos • Civ4PlayerOptionInfos • Civ4ProcessInfo • Civ4ReligionInfo • Civ4SeaLevelInfo • Civ4SpecialistInfos • Civ4TurnTimerInfo • Civ4UpKeepInfo • Civ4VictoryInfo • Civ4VoteInfo • Civ4VoteSourceInfos • Civ4WorldInfo Interface: Civ4AdvisorInfos • Civ4CameraInfos • Civ4ColorVals • Civ4InterfaceModeInfos • Civ4PlayerColorInfos • Civ4SlideShowInfos • Civ4SlideShowRandomInfos • Civ4SpaceShipInfos • Civ4ThroneRoomeInfos • Civ4ThroneRoomCameraInfos • Civ4ThroneRoomStyleInfos • Civ4WorldPickerInfos Misc: Civ4AttachableInfos • Civ4CameraOverlayInfos • Civ4DetailManager • Civ4EffectInfos • Civ4QuestInfos • Civ4RiverInfos • Civ4RouteInfos • Civ4TerrainPlainInfos • Civ4TutorialInfos • Civ4WaterPlaneInfos Technologies: Civ4TechInfos Terrain: Civ4BonusClassInfos • Civ4BonusInfos • Civ4FeatureInfos • Civ4ImprovementInfos • Civ4SymbolMeshPaths • Civ4TerrainInfos • Civ4TerrainSettings • Civ4YieldInfos Units: Civ4AnimationInfos • Civ4AnimationPathInfos • Civ4AutomateInfos • Civ4BuildInfos • Civ4CommandInfos • Civ4ControlInfos • Civ4EntityEventInfos • Civ4FormationInfos • Civ4MissionInfos • Civ4PromotionInfos • Civ4SpecialUnitInfos • Civ4UnitClassInfos • Civ4UnitInfos Schemas: Civ4GlobalDefinesSchema • Civ4GlobalTypesSchema • Civ4ArtDefinesSchema • AudioDefinesSchema • AudioScriptSchema • Civ4BasicInfoSchema • Civ4BuildingSchema • Civ4LSystemSchema • Civ4CivilizationSchema • Civ4EventSchema • Civ4GameInfoSchema • Civ4InterfaceSchema • Civ4MiscSchema • Civ4TutorialSchema • Civ4DetailManagerSchema • Civ4TechnologiesSchema • Civ4TerrainSchema • Civ4FormationSchema • Civ4UnitSchema Italics: Beyond the Sword only