diff --git a/docs/zengin/scripts/classes/c_sndsys_cfg.md b/docs/zengin/scripts/classes/c_sndsys_cfg.md new file mode 100644 index 000000000..7a28e0906 --- /dev/null +++ b/docs/zengin/scripts/classes/c_sndsys_cfg.md @@ -0,0 +1,71 @@ +--- +title: C_SNDSYS_CFG +--- + +# C_SNDSYS_CFG Daedalus class +Class `C_SndSys_CFG` defines the global settings for the game's sounds. + +An instance of this class is declared only once. +## Class definition +Class definition as it is defined in [`Scripts/System/_intern/SFX.d`](https://github.com/VaanaCZ/gothic-2-addon-scripts/blob/Unified-EN/_work/Data/Scripts/System/_intern/SFX.d#L19-L27) script file. + +??? "C_SndSys_CFG Daedalus class" + ```dae + class C_SNDSYS_CFG + { + VAR FLOAT volume; // Sound volume + VAR INT bitResolution; // Sound quality + VAR INT sampleRate; // Frequency + VAR INT useStereo; // Stereo sound + VAR INT numSFXChannels; // Number of sound channels + VAR STRING used3DProviderName; // Name of the 3D sound provider + }; + ``` +## Class members + +| Variable | Type | Description | +|---------------------------------------------|--------|--------------------------------------------------------------| +| [volume](#volume) | float | Overall sound volume | +| [bitResolution](#bitresolution) | int | Sound quality | +| [sampleRate](#samplerate) | int | Frequency | +| [useStereo](#usestereo) | int | Stereo sound | +| [numSFXChannels](#numsfxchannels) | int | Number of sound channels | +| [used3DProviderName](#used3dprovidername) | string | Name of the 3D sound provider | + +## Class member overview +Description of the class member variables. +### volume +The overall volume of the background music (soundtrack). This value ranges from 0.0 to 1.0, where 0.0 is completely muted and 1.0 is the maximum volume. + +### bitResolution +Defines the sound quality in terms of bit depth. It can be either 8-bit or 16-bit, with 16-bit providing higher audio fidelity. + +### sampleRate +Specifies the frequency at which the sound is sampled. This value ranges from 11050 Hz to 44100 Hz, with higher values offering better sound quality. + +### useStereo +A flag indicating whether stereo sound is enabled. A value of 1 means stereo sound is used, while 0 means mono sound. + +### numSFXChannels +Determines the number of sound effect channels available. This value ranges from 1 to 32, allowing for multiple sound effects to be played simultaneously. + +### reverbBufferSize +Specifies the size of the reverb buffer, which affects the quality and duration of the reverb effect in the game's audio. + +### used3DProviderName +Name of the 3D sound provider. One of the constants defined in [`Scripts/System/_intern/SFX.d`](https://github.com/VaanaCZ/gothic-2-addon-scripts/blob/Unified-EN/_work/Data/Scripts/System/_intern/SFX.d#L4-L15). + +```dae +CONST STRING PROV_DOLBY_SURR = "Dolby Surround"; +CONST STRING PROV_A3D = "Aureal A3D Interactive(TM)"; +CONST STRING PROV_D3D_HW = "DirectSound3D Hardware Support"; +CONST STRING PROV_D3D_SW = "DirectSound3D Software Emulation"; +CONST STRING PROV_D3D_EAX = "DirectSound3D with Creative Labs EAX(TM)"; +CONST STRING PROV_D3D7_FULL_HRTF = "DirectSound3D 7+ Software - Full HRTF"; +CONST STRING PROV_D3D7_LIGHT_HRTF = "DirectSound3D 7+ Software - Light HRTF"; +CONST STRING PROV_D3D7_PAN = "DirectSound3D 7+ Software - Pan and Volume"; +CONST STRING PROV_EAX = "Creative Labs EAX (TM)"; +CONST STRING PROV_EAX2 = "Creative Labs EAX 2 (TM)"; +CONST STRING PROV_MILES_2D = "Miles Fast 2D Positional Audio"; +CONST STRING PROV_RSX = "RAD Game Tools RSX 3D Audio"; +``` \ No newline at end of file