Cabal Common Library Doc Music - Revision history

Svengali: formatting

2013-09-15T23:36:58Z

formatting

Svengali at 10:46, 29 January 2013

2013-01-29T10:46:08Z

Svengali: added handler for scooping fuel

2012-10-24T18:32:56Z

added handler for scooping fuel

Svengali: Preparation for v1.6

2012-06-14T20:36:53Z

Preparation for v1.6

Svengali: /* Overview */

2012-05-29T22:49:28Z

‎Overview

Svengali at 14:32, 10 August 2011

2011-08-10T14:32:38Z

Svengali at 22:21, 9 August 2011

2011-08-09T22:21:52Z

Svengali at 22:06, 9 August 2011

2011-08-09T22:06:30Z

Svengali at 18:31, 9 August 2011

2011-08-09T18:31:44Z

Svengali at 14:03, 9 August 2011

2011-08-09T14:03:21Z

@@ Line 13: / Line 13: @@
 musicfiles. For the volume it is adviced to use at least -9 db (peak) to avoid conflicts with spoken inflight messages
 and digital clipping.
 == Properties ==
@@ Line 18: / Line 19: @@
 On startUp created set of handlers (Array) for Cabal_Common_Music.
-{{CodeEx|codeex=var a = worldScripts.Cabal_Common_Music.requestHandlerSet;
+  var a = worldScripts.Cabal_Common_Music.requestHandlerSet;
-a -> [ [aegis, enter, exit], [alert, red, ... ] ... ]}}
+  a -> [ [aegis, enter, exit], [alert, red, ... ] ... ]
@@ Line 38: / Line 39: @@
 :;launch:Object. Allowed members: ent, inter, goneNova, doNova, main, any.
 :;planet:Object. Allowed members: ent<sup>3</sup>, enterMain<sup>3</sup>, enterSun<sup>3</sup>, exitMain<sup>3</sup>, exitSun<sup>3</sup>.
-:;scooped:Object. Allowed members: ent<sup>2</sup>, fuel<sup>4</sup> (New in v1.6.1).
+:;scooped:Object. Allowed members: ent<sup>2</sup>, fuel<sup>4</sup> {{AV|1.6.1}}.
 :;track:Object. Allowed members: byName.
@@ Line 81: / Line 82: @@
 == Structure ==
 A short overview about the expected structure:
-{{CodeEx|codeex=var eventMusic = {
+  var eventMusic = {
-:who:this.name,<br>
+    who:this.name,
-:start:true,<br>
+    start:true,
-:aegis:{<br>
+    aegis:{
-::exit:[<br>
+      exit:[
-:::{prop:"myProperty",music:"myMusic.ogg"}<br>
+        {prop:"myProperty",music:"myMusic.ogg"}
-::]<br>
-:}<br>
-};<br>
+  };
-worldScripts.Cabal_Common_Music.addMedia(eventMusic);}}
+  worldScripts.Cabal_Common_Music.addMedia(eventMusic);
 The objects that are holding the music itself have a set of available properties as well.

@@ Line 27: / Line 27: @@
 {{CodeExTime|native=0.000097|extension=0.000032|js=0.000455}}
 Adds incoming object to the list and associates the entries to the sending worldScript.
-Internally every entry gets a group ID, so don't pass non-writable, sealed or frozen objects.
+Internally every entry gets a group ID, so make sure that the object is extensible and not sealed or frozen.
 '''Properties:'''

@@ Line 38: / Line 38: @@
 :;launch:Object. Allowed members: ent, inter, goneNova, doNova, main, any.
 :;planet:Object. Allowed members: ent<sup>3</sup>, enterMain<sup>3</sup>, enterSun<sup>3</sup>, exitMain<sup>3</sup>, exitSun<sup>3</sup>.
-:;scooped:Object. Allowed members: ent<sup>2</sup>.
+:;scooped:Object. Allowed members: ent<sup>2</sup>, fuel<sup>4</sup> (New in v1.6.1).
 :;track:Object. Allowed members: byName.
@@ Line 45: / Line 45: @@
 <sup>1</sup> If other handlers have fired blocked for 10 seconds.<br>
-<sup>2</sup> The handler is only fired for scripted pods.<br>
+<sup>2</sup> The handler is only fired for scripted pods. (Changed in Oolite v1.77)<br>
-<sup>3</sup> Can collide, because aegis and planet vicinities can be close together.
+<sup>3</sup> Can collide, because aegis and planet vicinities can be close together.<br>

@@ Line 24: / Line 24: @@
 == Functions ==
 === addMedia() ===
-{{CodeEx|codeex=addMedia = function( obj )}}
+{{CodeEx|codeex=worldScripts.Cabal_Common_Music.addMedia( obj )}}
 {{CodeExTime|native=0.000097|extension=0.000032|js=0.000455}}
 Adds incoming object to the list and associates the entries to the sending worldScript.
@@ Line 54: / Line 54: @@
 === removeMedia() ===
-{{CodeEx|codeex=removeMedia = function( who )}}
+{{CodeEx|codeex=worldScripts.Cabal_Common_Music.removeMedia( who )}}
 {{CodeExTime|native=0.000040|extension=0.000012|js=0.000346}}
 Removes all entries of a group from the stored list.
@@ Line 66: / Line 66: @@
 === changeStatus() ===
-{{CodeEx|codeex=changeStatus = function( who, status )}}
+{{CodeEx|codeex=worldScripts.Cabal_Common_Music.changeStatus( who, status )}}
 {{CodeExTime|native=0.000040|extension=0.000017|js=0.000104}}
 Changes the group state for a specific group.

@@ Line 1: / Line 1: @@
 == Overview ==
-This is the main class for the event driven inflight music for missions.
+This is the main class for the event driven inflight music for missions and part of the [[Cabal_Common_Library]].
 The script handles incoming data from worldScripts to play music in specific situations.
@@ Line 13: / Line 13: @@
 musicfiles. For the volume it is adviced to use at least -9 db (peak) to avoid conflicts with spoken inflight messages
 and digital clipping.
 == Properties ==

@@ Line 89: / Line 89: @@
 worldScripts.Cabal_Common_Music.addMedia(eventMusic);}}
-The objects that are holding the music itself have a set of available properties as well, but only '''music''' is required.
+The objects that are holding the music itself have a set of available properties as well.
-:;dist:Number. Min. distance to entity. Only available in '''track'''.
+:;dist:Number. Min. distance to entity. Required in '''track.byName'''.
-:;ent:String/Number. Either entity.name (String) or entity.radius (Number). Available in '''destroyed''', '''launch''', '''planet''' (radius), '''scooped''' and '''track'''.
+:;ent:String/Number. Either entity.name (String) or entity.radius (Number). Required in '''destroyed.ent''', '''launch.ent''', '''planet.ent''' (radius), '''scooped.ent''' and '''track.byName'''.
-:;fadeQ:Number. Sound as transition between musicfiles. If used must be 1 (will be expanded).
+:;fadeQ:Number. Optional. Sound as transition between musicfiles. If used must be 1 (will be expanded).
-:;music:String. Filename with fileextension.
+:;music:String. Required. Filename with fileextension.
-:;prop:String. Name of worldScript property to be checked.
+:;prop:String. Optional. Name of worldScript property to be checked.

@@ Line 8: / Line 8: @@
 Additionally a property can be assigned to a specific event, means that different entries
 can be de/activated by using different properties.
 == Properties ==
 === requestHandlerSet ===
-On startUp created set of handlers for Cabal_Common_Music.
+On startUp created set of handlers (Array) for Cabal_Common_Music.
 {{CodeEx|codeex=var a = worldScripts.Cabal_Common_Music.requestHandlerSet;
-a -> [ [aegis, enter, exit], [alert, red, ... ]}}
+a -> [ [aegis, enter, exit], [alert, red, ... ] ... ]}}
@@ Line 27: / Line 32: @@
 :;who:String. Required. Name of the sending worldScript.
 :;start:Boolean. Required. Starting state after insertion.
-:;aegis:Object. Allowed members: enter, exit.
+:;aegis:Object. Allowed members: enter<sup>3</sup>, exit<sup>3</sup>.
-:;alert:Object. Allowed members: red, yellow, green.
+:;alert:Object. Allowed members: red, yellow<sup>1</sup>, green<sup>1</sup>.
 :;destroyed:Object. Allowed members: ent.
 :;exitWS:Object. Allowed members: inter, goneNova, doNova, standard, any.
 :;launch:Object. Allowed members: ent, inter, goneNova, doNova, main, any.
-:;planet:Object. Allowed members: ent, enterMain, enterSun, exitMain, exitSun.
+:;planet:Object. Allowed members: ent<sup>3</sup>, enterMain<sup>3</sup>, enterSun<sup>3</sup>, exitMain<sup>3</sup>, exitSun<sup>3</sup>.
-:;scooped:Object. Allowed members: ent.
+:;scooped:Object. Allowed members: ent<sup>2</sup>.
 :;track:Object. Allowed members: byName.
 '''Returns'''
 :;Boolean: True on success, false on failure.