BGS Doc

From Elite Wiki
Revision as of 12:44, 25 March 2011 by Svengali (talk | contribs)

Overview

BGS-M is the script for ambient sounds, music and image switches.


Properties

logging

Boolean. Switches extended logging on/off and can be configured via OXPConfig2. Default is false.

stationMusic

Boolean. Switches music in stations on/off and can be configured via OXPConfig2. Default is true.

ambientSounds

Boolean. Switches ambientSounds on/off and can be configured via OXPConfig2. This switch affects the crowd layer in stations and engine mumble inflight. Default is true.

fxSounds

Boolean. Switches fxSounds on/off and can be configured via OXPConfig2. This switch affects the screen based sounds in stations and engine up/down inflight. Default is true.

bgsDisableCrowd

Boolean. Disables crowd noise in stations. Default is false.

bgsDisableJump

Boolean. Disables spoken jumpcountdown. Default false.

bgsDisableChatter

Boolean. Disables radio chatter when in station aegis. Default false.

bgsCountMode

Boolean. Switches the nextTime for the countdown timer to clock.absoluteSeconds. This can help to ‘correct’ the countdown if the displayed messages are not in sync with the spoken countdown. Default false.

bgsOff

Boolean. Disables all BGS functions. It is primarily meant for mission OXPs and stations where no additional functions are available or if the features would interfere. Scripts are responsible to reset it when used, but BGS resets it on its own on shipWillLaunchFromStation, playerCancelledJumpCountdown, playerJumpFailed and playerStartedAutoPilot. Default false.
worldScripts["BGS-M"].bgsOff = true;

bgsDelay

Integer. Defines the delay in milliseconds between mission screens before BGS re-enables its features. Default 600.


shipdata.plist

Additional keys for specific entities are available and can be specified via script_info dictionary.

Keys

bgs_engine
String/Filename. Playership - engine mumble sound.
bgs_engineUp
String/Filename. Playership - engine acceleration sound.
bgs_engineDown
String/Filename. Playership - engine deceleration sound.
bgs_countonly
Boolean. Playership - spoken countdown only.
bgs_music
String/Filename. Station - music file for specific station.
bgs_nomusic
Boolean. Station - disables the music.
bgs_nocrowd
Boolean. Station - disables the crowd sounds and switches images on F5.

Examples:

Playership (with preloaded sounds):

script_info = {"bgs_engine" = "[vector_engine]"; "bgs_engineUp" = "[vector_engineUp]"; "bgs_engineDown" = "[vector_engineDown]";};

Playership (without preloaded sounds):

script_info = {"bgs_engine" = "myEngine.ogg"; "bgs_engineUp" = "myEngineUp.ogg"; "bgs_engineDown" = "myEngineDown.ogg";};

Station:

script_info = {"bgs_music" = "buoyRepair_music.ogg"; "bgs_nocrowd" = true;};


missiontext.plist

Additional keys specially for other soundpacks are available.

Keys

BGS-DISABLEJUMP
String. Disables timed jumpcountdown (overrides this.bgsDisableJump). Set to “No” to avoid deactivation.
BGS-COUNTONLY
String. Bypasses ambient sounds for jumping, but leaves the countdown. Set to “No” to avoid deactivation.
BGS-COUNT
String. Defines used countdown in range 1-10.
BGS-COUNTDOWN
String. Defines names for used countdown. [BGS-COUNT] is required! The filenames will be build -> name+[BGS-COUNT]+’.ogg’ and counted down to zero! So BGS expects [BGS-COUNT] + 1 files!
BGS-COUNTLAYER
String. Defines name of ambient part for galactic and standard jump. BGS looks for name+”g.ogg” and name+”h.ogg”.
BGS-STATIONMUSIC_1
String. Ambient music files to be added to the musicPool. Keys “BGS-STATIONMUSIC_1” ... “BGS-STATIONMUSIC_5” are examined. Multiple files can be separated by “|”.
BGS-CHATTER_1
String. Chatter sound files to be added to the soundPool. Keys “BGS-CHATTER_1” ... “BGS-CHATTER_5” are examined. Multiple files can be separated by “|”.

Example:

"BGS-COUNT" = "5";
"BGS-COUNTDOWN" = "bgstest";
"BGS-COUNTLAYER" = "bgstest";
"BGS-COUNTONLY" = "No";
"BGS-DISABLEJUMP" = "No";
"BGS-STATIONMUSIC_1" = "myMusicA.ogg";
// Without preloading
"BGS-CHATTER_1" = "myChatterA.ogg";
// With preloading
"BGS-CHATTER_1" = "[myChatterA]";


Additional features

BGS ships some ‘hidden’ features.

silence
If you want to disable a specific customsounds sound set the value to “bgs-m_silence.ogg” in customsounds.plist.
messages
If you want to disable some onscreen messages BGS ships now a “_descriptions.plist” that cleans them out. Rename this file to activate it.
hidden sounds
The alternative trumble sounds are outcommented. To activate them remove the comment (“//”) for both keys (“[trumble-idle]” and “[trumble-squeal]”) in customsounds.plist.