Audio3DScripts

Summary

This file defines attribures for sounds used by the 3D sound script operations. These attribures define how and if I sound is played at a distance from a source. Most notably when you are zoomed into a resource (i.e. cows) on the screen so that they are louder the closer you are zoomed in and if they are centered on the screen.

Single-Line Tags

Text Tags

ScriptID The script object name prefixed with AS3D_ followed by the file name. Used in AudioSoundscapeScripts and by Python CyAudioGame.Play3DSound() function.
SoundID Implemented in AudioDefines to retrieve the sound file.
SoundType Indicates which volume slider to use under Game Option -> Audio. Values are defined in AudioDefines and are prefixed with GAME_. Values are AMBIENCE, INTERFACE, MUSIC, SFX or SPEECH.
StartPosition Position to player where the sounds appears to come from when it starts (most effective for surround sound setups.) Values are defined in AudioDefines. Values are NONE, RANDOM, ALL, FRONT, BACK, BACK_LEFT, BACK_RIGHT, LEFT, RIGHT, FRONT_LEFT, FRONT_RIGHT and REARS
EndPosition Position to player where the sounds appears to come from when it ends (most effective for surround sound setups.) Values are defined in AudioDefines. Values are NONE, RANDOM, ALL, FRONT, BACK, BACK_LEFT, BACK_RIGHT, LEFT, RIGHT, FRONT_LEFT, FRONT_RIGHT and REARS

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 from 0 to 100.
iMaxVolume Maximum volume to play this sound. Values from 0 to 100.
iPitchChangeDown unknown Negative values (in Hz? Known values are 0, -2000, -3000, -4000, -5000, -7000)
iPitchChangeUp unkown Positive values (in Hz? known values are 0, 2000, 3000, 4000, 5000, 7000)
iMinTimeDelay unknown Minimum time delay before playing sound. Values in milliseconds
iMaxTimeDelay unknown Maximum time delay before playing sound. Values in milliseconds.
iLengthOfSound unknown Set to 0.
iMinVelocity unknown Minimum velocity to play the sound. Set to 0
iMaxVelocity unknown Maximum velocity to play the sound. Set to 0.
iMinDistanceFromListener unknown Minimum distance in meters from listen before playing the sound.
iMaxDistanceFromListener unknown Maximum distance in meters from listen before playing the sound.
iMinDistanceForMaxVolume Minimum distance in meters to play the sound at maximum volume.
iMaxDistanceForMaxVolume Maximum distance in meters to play the sound at maximum volume.
iMinCutoffDistance Minimum distance in meters before stop playing the sound.
iMaxCutoffDistance Maximum distance in meters before stop playing the sound.
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 Values between 0.0 - 1.0.
fMaxWetLevel unknown Values between 0.0 - 1.0.

Example

<Script3DSound>
    <ScriptID>AS3D_ERROR</ScriptID>
    <SoundID>SND_ERROR</SoundID>
    <SoundType>GAME_SFX</SoundType>
    <iMinVolume>80</iMinVolume>
    <iMaxVolume>80</iMaxVolume>
    <iPitchChangeDown>0</iPitchChangeDown>
    <iPitchChangeUp>0</iPitchChangeUp>
    <bLooping>0</bLooping>
    <iMinTimeDelay>0</iMinTimeDelay>
    <iMaxTimeDelay>0</iMaxTimeDelay>
    <StartPosition>FRONT</StartPosition>
    <EndPosition>FRONT</EndPosition>
    <iMinVelocity>0</iMinVelocity>
    <iMaxVelocity>0</iMaxVelocity>
    <iMinDistanceFromListener>0</iMinDistanceFromListener>
    <iMaxDistanceFromListener>0</iMaxDistanceFromListener>
    <iMinDistanceForMaxVolume>100000</iMinDistanceForMaxVolume>
    <iMaxDistanceForMaxVolume>100000</iMaxDistanceForMaxVolume>
    <iMinCutoffDistance>100000</iMinCutoffDistance>
    <iMaxCutoffDistance>100000</iMaxCutoffDistance>
    <bTaperForSoundtracks>0</bTaperForSoundtracks>
    <iLengthOfSound>0</iLengthOfSound>
    <fMinDryLevel>1.0</fMinDryLevel>
    <fMaxDryLevel>1.0</fMaxDryLevel>
    <fMinWetLevel>0.0</fMinWetLevel>
    <fMaxWetLevel>0.0</fMaxWetLevel>
</Script3DSound>
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License