Difference between revisions of "BGS Doc"

From Elite Wiki
m (cleanup)
m (updated OXPConfig settable properties)
Line 4: Line 4:
  
 
== Properties ==
 
== Properties ==
 +
<sup>OXPC</sup> - Marked properties can be configured via OXPConfig.
 +
 
=== ambientSounds ===
 
=== 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.
+
:Boolean. Switches ambientSounds on/off. This switch affects the crowd layer in stations and engine mumble inflight. Default is true.<sup>OXPC</sup>
  
 
=== fxSounds ===
 
=== 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.
+
:Boolean. Switches fxSounds on/off. This switch affects the screen based sounds in stations and engine up/down inflight. Default is true.<sup>OXPC</sup>
  
 
=== logging ===
 
=== logging ===
:Boolean. Switches extended logging on/off and can be configured via OXPConfig2. Default is false.
+
:Boolean. Switches extended logging on/off. Default is false.<sup>OXPC</sup>
  
 
=== stationMusic ===
 
=== stationMusic ===
:Boolean. Switches music in stations on/off and can be configured via OXPConfig2. Default is true.
+
:Boolean. Switches music in stations on/off. Default is true.<sup>OXPC</sup>
  
 
=== bgsCountOffset ===
 
=== bgsCountOffset ===
:Number. Switches the nextTime for the countdown timer to clock.absoluteSeconds+offset (0...0.3). This can help to ‘correct’ the countdown if the displayed messages are not in sync with the spoken countdown. Default 0.
+
:Number. Switches the nextTime for the countdown timer to clock.absoluteSeconds+offset (0...0.3). This can help to ‘correct’ the countdown if the displayed messages are not in sync with the spoken countdown. Default 0.<sup>OXPC</sup>
  
 
=== bgsDelay ===
 
=== bgsDelay ===
:Integer. Defines the delay in milliseconds between mission screens before BGS re-enables its features. Default 600.
+
:Integer. Defines the delay in milliseconds between mission screens before BGS re-enables its features. Default 600.<sup>OXPC</sup>
  
 
=== bgsDisableChatter ===
 
=== bgsDisableChatter ===
:Boolean. Disables radio chatter when in station aegis. Default false.
+
:Boolean. Disables radio chatter when in station aegis. Default false.<sup>OXPC</sup>
  
 
=== bgsDisableCrowd ===
 
=== bgsDisableCrowd ===
:Boolean. Disables crowd noise in stations. Default is false.
+
:Boolean. Disables crowd noise in stations. Default is false.<sup>OXPC</sup>
  
 
=== bgsDisableJump ===
 
=== bgsDisableJump ===
:Boolean. Disables spoken jumpcountdown. Default false.
+
:Boolean. Disables spoken jumpcountdown. Default false.<sup>OXPC</sup>
  
 
=== bgsHyperFX ===
 
=== bgsHyperFX ===
:Boolean. Shader effect for hyperjumps. If no shader support available the script sets it to false. Default true.
+
:Boolean. Shader effect for hyperjumps. If no shader support available the script sets it to false. Default true.<sup>OXPC</sup>
  
 
=== bgsHyperMove ===
 
=== bgsHyperMove ===
:Number. Move the playership forward to get rid of the breakpattern rings. Set to 0 to disable it. Ignored if bgsHyperFX is false. Default 500.
+
:Number. Move the playership forward to get rid of the breakpattern rings. Set to 0 to disable it. Ignored if bgsHyperFX is false. Default 500.<sup>OXPC</sup>
  
 
=== bgsOff ===
 
=== bgsOff ===
Line 42: Line 44:
  
 
=== bgsQPatch ===
 
=== bgsQPatch ===
:Boolean. QMine monkeypatch. If true, implement sound for QMines. Only processed on startUp. Default false. (New in v1.4)
+
:Boolean. QMine monkeypatch. If true, implement sound for QMines. Only processed on startUp. Default false.<sup>OXPC</sup>
  
  

Revision as of 11:50, 29 May 2012

Overview

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


Properties

OXPC - Marked properties can be configured via OXPConfig.

ambientSounds

Boolean. Switches ambientSounds on/off. This switch affects the crowd layer in stations and engine mumble inflight. Default is true.OXPC

fxSounds

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

logging

Boolean. Switches extended logging on/off. Default is false.OXPC

stationMusic

Boolean. Switches music in stations on/off. Default is true.OXPC

bgsCountOffset

Number. Switches the nextTime for the countdown timer to clock.absoluteSeconds+offset (0...0.3). This can help to ‘correct’ the countdown if the displayed messages are not in sync with the spoken countdown. Default 0.OXPC

bgsDelay

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

bgsDisableChatter

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

bgsDisableCrowd

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

bgsDisableJump

Boolean. Disables spoken jumpcountdown. Default false.OXPC

bgsHyperFX

Boolean. Shader effect for hyperjumps. If no shader support available the script sets it to false. Default true.OXPC

bgsHyperMove

Number. Move the playership forward to get rid of the breakpattern rings. Set to 0 to disable it. Ignored if bgsHyperFX is false. Default 500.OXPC

bgsOff

Boolean. Disables some BGS functions (all when docked, chatter when inflight). 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;

bgsQPatch

Boolean. QMine monkeypatch. If true, implement sound for QMines. Only processed on startUp. Default false.OXPC


shipdata.plist

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

Keys

bgs_chatter
String. Station - Chatter sound files for mainStation. Multiple files can be separated by “|”.
bgs_countonly
Boolean. Playership - spoken countdown only.
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_music
String/Filename. Station - music file for specific station.
bgs_nocrowd
Boolean. Station - disables the crowd sounds and switches images on F5.
bgs_nomusic
Boolean. Station - disables the music.

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-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 “|”.
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-COUNTONLY
String. Bypasses ambient sounds for jumping, but leaves the countdown. Set to “No” to avoid deactivation.
BGS-DISABLEJUMP
String. Disables timed jumpcountdown (overrides this.bgsDisableJump). Set to “No” to avoid deactivation.
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 “|”.

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.

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.
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.
silence
If you want to disable a specific customsounds sound set the value to “bgs-m_silence.ogg” in customsounds.plist.