AudioDefines

This page is incomplete and is missing information.
Please do not remove this notice until it is completed.

Summary

This file defines values for attribures in [[[xml:audio2dscripts|Audio2DScripts]], Audio3DScripts and AudioSoundscapeScripts. This file also defines values for the audio system which is built into the executable files and is not accessible through the SDK or Python.

Because the audio system is built into the executable files many sections of this file CAN NOT BE ALTERED. This will be indicated for each section and a reference of the values they contain will be provided.

SoundDatas

This section contains multiple SoundData tags.

Single-Line Tags

Text Tags

SoundID Referenced with SoundID in [[[xml:audio2dscripts|Audio2DScripts]]} and Audio3DScripts.
Filename Location of sound file within Assets\Sounds\
LoadType unknown. Can be either RESIDENT, STREAMED or DYNAMIC_RES
ContextType unknown. Only occures once, is Generic.
SoundType unknown. Presents GAME_AMBIENCE, GAME_INTERFACE, GAME_MUSIC, GAME_SFX or GAME_SPEECH. Seems to define the five SoundTypes from Audio2DScripts & Audio3DScripts
PositionType = unknown. Seems to define the available Start & EndPositions for Audio3DScripts
ScriptType = unknown.
LoadType = unknown. Presents the three LoadTypes seen above.
EffectType = unknown.
GameEnvironmentType = unknown.
SpeakerConfig = unknown.

Boolean Tags

bIsCompressed = unknown. Is always 1.
bInGeneric = unknown. Is always 1.

Multi-Line Tags

ReverbData = unknown.
floating-point fReverbTime = unknown.
floating-point fReverbPredelay = unknown.
floating-point fReverbDamping = unknown.
floating-point fReverbDryLevel = unknown.
floating-point fReverbWetLevel = unknown.
AudioSystemInit = unknown.
integer iSampleRate = unknown.
integer iSampleBits = unknown.
integer iMultiChannelPref = unknown.
integer iNum2DSamples = unknown.
integer iNum3DSamples = unknown.
integer iNum2DStreams = unknown.
integer iNum3DStreams = unknown.
floating-point fPercentSamplesFor3D = unknown.

ContextTypes

Do not modify.

SoundTypes

Do not modify.

PositionTypes

Do not modify.

ScriptTypes

Do not modify.

LoadTypes

Do not modify.

EffectTypes

Do not modify.

GameEnvironmentTypes

Do not modify.

Effects

Do not modify.

SpeakerConfigs

DO NOT MODIFY
These are the options offered in
Game Options -> Audio -> Audio Speakers

AudioSystemInit

DO NOT MODIFY
Initializes the audio system.

Integer Tags

iSampleRate 22050
iSampleBits 16
iMultiChannelPref 2
iNum2DSamples 64
iNum3DSamples 64
iNum2DStreams 10
iNum3DStreams 0

Float Tags

fSamplesFor3D 0.6

Example

<SoundData>
    <SoundID>SND_ERROR</SoundID>
    <Filename>Sounds/Error</Filename>
    <LoadType>RESIDENT</LoadType>
    <bIsCompressed>1</bIsCompressed>
    <bInGeneric>1</bInGeneric>
</SoundData>
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License