AudioSoundscapeScripts

Previous article

Back to XML Reference

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

Summary

This file groups the 2D and 3D sounds together to form "soundscapes" which are used in various parts of the game.

Single-Line Tags

Text Tags

Tag Name	Description
ScriptID	The name of the audio soundscape script prefixed with ASSS_ for easier identification.

Integer Tags

Tag Name	Description
iMinVolume	Minimum volume for all sounds in this soundscape.
iMaxVolume	Maximum volume for all sounds in this soundscape.

Multi-Line Tags

Tag Name	Description
SoundscapeElement	The audio script object and the script engine it uses. Generally this will consist of one primary screen background using the 2D script engine and multiple additional sounds using the 3D script engine.
Text	ScriptType The audio script engine. Defined in AudioDefines. Values are 2D or 3D.
Text	ScriptID The sound name defined in Audio2DScripts or Audio3DScripts.

Example

<ScriptSoundscape>
   <ScriptID>ASSS_CITY_LATE_LARGE_SELECT_AMB</ScriptID>
   <iMinVolume>100</iMinVolume>
   <iMaxVolume>100</iMaxVolume>
   <SoundscapeElement>
       <ScriptType>2D</ScriptType>
       <ScriptID>AS2D_SS_CITY_LATE_LARGE_BED</ScriptID>
   </SoundscapeElement>
   <SoundscapeElement>
       <ScriptType>3D</ScriptType>
       <ScriptID>AS3D_SS_HORN</ScriptID>
   </SoundscapeElement>
   <SoundscapeElement>
       <ScriptType>3D</ScriptType>
       <ScriptID>AS3D_SS_AUTO_PASSING</ScriptID>
   </SoundscapeElement>
   <SoundscapeElement>
       <ScriptType>3D</ScriptType>
       <ScriptID>AS3D_SS_FOOTSTEPS</ScriptID>
   </SoundscapeElement>
   <SoundscapeElement>
       <ScriptType>3D</ScriptType>
       <ScriptID>AS3D_SS_HORN_DOPPLER</ScriptID>
   </SoundscapeElement>
   <SoundscapeElement>
       <ScriptType>3D</ScriptType>
       <ScriptID>AS3D_SS_SIREN</ScriptID>
   </SoundscapeElement>
</ScriptSoundscape>

Next article

Back to XML Reference